Metadata-Version: 2.4
Name: netunicorn-connector-docker
Version: 0.1.7
Summary: Local Docker connector for netunicorn
Author-email: Roman Beltiukov <rbeltiukov@ucsb.edu>
License: MIT
Keywords: netunicorn
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: netunicorn-base<0.5.0,>=0.4.0
Requires-Dist: docker
Requires-Dist: returns
Dynamic: license-file

# netunicorn-connector-docker
This is a netunicorn connector for a local Docker infrastructure.


This connector works only with the local Docker daemon, requires current user to be in the docker group
and always presents a single host with the name "dockerhost".

## Usage
This connector is supposed to be installed as a part of netunicorn-director-infrastructure package or container.

Install the package:
```bash
pip install netunicorn-connector-docker
```
Ensure that the user (netunicorn-director-infrastructure process owner) is in the docker group (or root).

Then, add the connector to the netunicorn-director-infrastructure configuration:
```yaml
  local-docker:  # unique name
    enabled: true
    module: "netunicorn.director.infrastructure.connectors.docker_connector"  # where to import from
    class: "DockerConnector"  # class name
    config: "configuration-example.yaml"     # path to configuration file
```
