tyler.durden
/
compose
mirror of https://github.com/docker/compose.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Apply suggestions from code review 

Co-authored-by: Chris Crone <christopher.crone@docker.com>

Signed-off-by: Guillaume Tardif <guillaume.tardif@docker.com>
This commit is contained in:
Guillaume Tardif 2020-10-07 10:50:59 +02:00 committed by Guillaume Tardif
parent c85a584046
commit e3b22ecd0b
1 changed files with 29 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
docs/aci-compose-features.md
View File

@ -1,45 +1,45 @@
# Compose - Azure Container Instances mapping
This document outlines mapping between `docker-compose.yaml` files and corresponding ACI equivalents.
This document outlines the conversion of an application defined in a Compose file to ACI objects.
At a high-level, each Compose deployment is mapped to a single ACI container group.
Each service is mapped to a container in the container group, the Docker ACI integration provides no scaling of services.
Each service is mapped to a container in the container group. The Docker ACI integration provides does not allow scaling of services.
## Compose fields mapping
Table bellow list supported Compose file fields with equivalent ACI when supported.
The table below lists supported Compose file fields and their ACI counterparts.
__Glossary:__
__Legend:__
- __✓:__ Converts
- __✓:__ Implemented
- __n:__ Not yet implemented
- __x:__ Not applicable / no 1-1 conversion
- __x:__ Not applicable / no available conversion
| Keys | Map| Notes |
|--------------------------------|----|--------------------------------------------------------------|
| __Service__ | ✓ | |
| service.service.build | x | Ignored. no image build support on ACI. |
| service.service.build | x | Ignored. No image build support on ACI. |
| service.cap_add, cap_drop | x | |
| service.command | ✓ | Override container Command. on ACI, specifying command will currently also override image entrypoint if the image has an Entrypoint defined |
| service.configs | n | |
| service.cgroup_parent | x |
| service.container_name | x | Service name is used as container name in ACI |
| service.container_name | x | Service name is used as container name on ACI. |
| service.credential_spec | x | |
| service.deploy | ✓ | |
| service.deploy.endpoint_mode | x | |
| service.deploy.mode | x | |
| service.deploy.replicas | x | Only one replica is started for each service with the docker-ACI integration. |
| service.deploy.replicas | x | Only one replica is started for each service. |
| service.deploy.placement | x |
| service.deploy.update_config | x |
| service.deploy.resources | ✓ | Restriction: ACI Resource limits cannot be greater than the sum of resource requests for all containers in the container group. This will allow one containers in the same container group to compete with resources.
| service.deploy.restart_policy | ✓ | One of: any - none - on-failure. Restriction: All services must have the ame restart policy. The entire ACI container group will be restarted if needed. |
| service.deploy.labels | x | ACI does not have container-level labels. In addition, Azure tag are too restrictive to support Docker container labels.|
| service.deploy.restart_policy | ✓ | One of: `any`, `none`, `on-failure`. Restriction: All services must have the ame restart policy. The entire ACI container group will be restarted if needed. |
| service.deploy.labels | x | ACI does not have container-level labels. |
| service.devices | x |
| service.depends_on | x |
| service.dns | x |
| service.dns_search | x |
| service.domainname | ✓ | Mapped to ACI DNSLabelName. Restriction: all services must specify the same domainname, if specified.
| service.domainname | ✓ | Mapped to ACI DNSLabelName. Restriction: all services must specify the same `domainname`, if specified. |
| service.tmpfs | x |
| service.entrypoint | x | ACI allows to override Command, but not Entrypoint.
| service.entrypoint | x | ACI only supports overriding the container command. |
| service.env_file | ✓ |
| service.environment | ✓ |
| service.expose | x |
@ -49,13 +49,13 @@ __Glossary:__
| service.group_add | x |
| service.healthcheck | x |
| service.hostname | x |
| service.image | ✓ | Private images will be accessible if the user is logged in against the corresponding registry at deploy time. Users will be automatically logged in to Azure Container Registry from Azure login if possible.
| service.image | ✓ | Private images will be accessible if the user is logged into the corresponding registry at deploy time. Users will be automatically logged in to Azure Container Registry using their Azure login if possible. |
| service.isolation | x |
| service.labels | x | ACI does not have container-level labels. In addition, Azure tag are too restrictive to support Docker container labels. |
| service.labels | x | ACI does not have container-level labels. |
| service.links | x |
| service.logging | x |
| service.network_mode | x |
| service.networks | x | Communication between services is supported by defining mapping for each service in `/etc/hosts` in the container group. Each service can resolve names for other services and the resulting network calls will be redirected to `localhost`.
| service.networks | x | Communication between services is implemented by defining mapping for each service in the shared `/etc/hosts` file of the container group. Each service can resolve names for other services and the resulting network calls will be redirected to `localhost`. |
| service.pid | x |
| service.ports | ✓ |
| service.secrets | ✓ |
@ -66,7 +66,7 @@ __Glossary:__
| service.ulimits | x |
| service.userns_mode | x |
| service.volumes | ✓ | Mapped to AZure File Shares. See #persistent_volumes
| service.restart | x | Replaced by service.deployment.restrt_policy |
| service.restart | x | Replaced by service.deployment.restart_policy |
| | | |
| __Volume__ | x | |
| driver | ✓ | |
@ -82,19 +82,19 @@ __Glossary:__
| | | |
## Port Exposure
## Exposing ports
When one of the service exposes ports, the entire ACI container group will be exposed and will get a public IP allocated.
Since all services are mapped to containers in the same container group, several services cannot expose the same port number.
[ACI does not support port mapping](https://feedback.azure.com/forums/602224-azure-container-instances/suggestions/34082284-support-for-port-mapping), so source and target port defined in the Compose file must be identical.
When one or more services expose ports, the entire ACI container group will be exposed and will get a public IP allocated.
As all services are mapped to containers in the same container group, only one service cannot expose a given port number.
[ACI does not support port mapping](https://feedback.azure.com/forums/602224-azure-container-instances/suggestions/34082284-support-for-port-mapping), so the source and target ports defined in the Compose file must be the same.
When exposing ports, a service can also specify the service `domainname` field to set a DNS hostname. `domainname` will be used to specify ACI DNS Label Name, and the ACI container group will be reachable at <domainname>.region.azurecontainer.io.
All services specifying a domainname must set the same value, applied to the entire container group.
When exposing ports, a service can also specify the service `domainname` field to set a DNS hostname. `domainname` will be used to specify the ACI DNS Label Name, and the ACI container group will be reachable at <domainname>.<region>.azurecontainer.io.
All services specifying a `domainname` must set the same value, as it is applied to the entire container group.
## Persistent Volumes
## Persistent volumes
Docker volumes are mapped to Azure File Shares. The compose file must define volumes in the `volume` section in order to be able to use them for one or several services.
Volumes are defined with a name, the `driver` field must be set to `azure_file`, and `driver_options` must define the storage account and fileshare to use for the volume.
Docker volumes are mapped to Azure file shares. Only the long Compose volume format is supported meaning that volumes must be defined in the `volume` section.
Volumes are defined with a name, the `driver` field must be set to `azure_file`, and `driver_options` must define the storage account and file share to use for the volume.
A service can then reference the volume by its name, and specify the target path to be mounted in the container.
```yaml
@ -112,7 +112,7 @@ volumes:
storage_account_name: mystorageaccount
```
Short volume syntax is not allowed for ACI volumes, as it wa designed for local path when running local containers.
A Compose file can defined several volumes, with different Azure file shares or storage accounts.
The short volume syntax is not allowed for ACI volumes, as it was designed for local path bind mounting when running local containers.
A Compose file can define several volumes, with different Azure file shares or storage accounts.
Credentials for storage account will be automatically fetched at deployment time, using the Azure login to retrive storage account key for each storage account used.
Credentials for storage accounts will be automatically fetched at deployment time using the Azure login to retrieve the storage account key for each storage account used.