Skip to content

Commit

Permalink
[docs] Describe restrictions in configuring ECS serviceDef & taskDef (#…
Browse files Browse the repository at this point in the history
…4962)

* Add restrictions of servicedef,taskdef: dev

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* Add restrictions of servicedef,taskdef: v0.47.x

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

* Fix: copied missing

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>

---------

Signed-off-by: t-kikuc <tkikuchi07f@gmail.com>
  • Loading branch information
t-kikuc authored Jun 10, 2024
1 parent 1e9c1d9 commit 851c596
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 4 deletions.
24 changes: 22 additions & 2 deletions docs/content/en/docs-dev/user-guide/configuration-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -505,12 +505,32 @@ One of `yamlField` or `regex` is required.

| Field | Type | Description | Required |
|-|-|-|-|
| serviceDefinitionFile | string | The path ECS Service configuration file. Allow file in both `yaml` and `json` format. The default value is `service.json`. See [here](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service_definition_parameters.html) for parameters.| No |
| taskDefinitionFile | string | The path to ECS TaskDefinition configuration file. Allow file in both `yaml` and `json` format. The default value is `taskdef.json`. See [here](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) for parameters. | No |
| serviceDefinitionFile | string | The path ECS Service configuration file. Allow file in both `yaml` and `json` format. The default value is `service.json`. See [here](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service_definition_parameters.html) and [Restrictions](#restrictions-of-service-definition) for parameters.| No |
| taskDefinitionFile | string | The path to ECS TaskDefinition configuration file. Allow file in both `yaml` and `json` format. The default value is `taskdef.json`. See [here](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) and [Restrictions](#restrictions-of-task-definition) for parameters. | No |
| targetGroups | [ECSTargetGroupInput](#ecstargetgroupinput) | The target groups configuration, will be used to routing traffic to created task sets. | Yes (if you want to perform progressive delivery) |
| runStandaloneTask | bool | Run standalone tasks during deployments. About standalone task, see [here](https://docs.aws.amazon.com/AmazonECS/latest/userguide/ecs_run_task-v2.html). The default value is `true`. |
| accessType | string | How the ECS service is accessed. One of `ELB` or `SERVICE_DISCOVERY`. See examples [here](https://github.com/pipe-cd/examples/tree/master/ecs/servicediscovery/simple). The default value is `ELB`. |

### Restrictions of Service Definition

There are some restrictions in configuring a service definition file.

- `capacityProviderStrategy` is not supported.
- `clientToken` is not supported.
- `deploymentController` is required and must be `EXTERNAL`.
- `loadBalancers` is not supported. Use `targetGroups` in [ECSDeploymentInput](#ecsdeploymentinput) instead.
- `platformFamily` is not supported.
- `propagateTags` is always set as `SERVICE`.
- `taskDefinition` is not supported. PipeCD uses the definition in `taskDefinitionFile` in [ECSDeploymentInput](#ecsdeploymentinput).

### Restrictions of Task Definition

There are some restrictions in configuring a task definition file.

- `placementConstraints` is not supported.
- `proxyConfiguration` is not supported.
- `tags` is not supported.

### ECSTargetGroupInput

| Field | Type | Description | Required |
Expand Down
24 changes: 22 additions & 2 deletions docs/content/en/docs-v0.47.x/user-guide/configuration-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -505,12 +505,32 @@ One of `yamlField` or `regex` is required.

| Field | Type | Description | Required |
|-|-|-|-|
| serviceDefinitionFile | string | The path ECS Service configuration file. Allow file in both `yaml` and `json` format. The default value is `service.json`. See [here](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service_definition_parameters.html) for parameters.| No |
| taskDefinitionFile | string | The path to ECS TaskDefinition configuration file. Allow file in both `yaml` and `json` format. The default value is `taskdef.json`. See [here](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) for parameters. | No |
| serviceDefinitionFile | string | The path ECS Service configuration file. Allow file in both `yaml` and `json` format. The default value is `service.json`. See [here](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service_definition_parameters.html) and [Restrictions](#restrictions-of-service-definition) for parameters.| No |
| taskDefinitionFile | string | The path to ECS TaskDefinition configuration file. Allow file in both `yaml` and `json` format. The default value is `taskdef.json`. See [here](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) and [Restrictions](#restrictions-of-task-definition) for parameters. | No |
| targetGroups | [ECSTargetGroupInput](#ecstargetgroupinput) | The target groups configuration, will be used to routing traffic to created task sets. | Yes (if you want to perform progressive delivery) |
| runStandaloneTask | bool | Run standalone tasks during deployments. About standalone task, see [here](https://docs.aws.amazon.com/AmazonECS/latest/userguide/ecs_run_task-v2.html). The default value is `true`. |
| accessType | string | How the ECS service is accessed. One of `ELB` or `SERVICE_DISCOVERY`. See examples [here](https://github.com/pipe-cd/examples/tree/master/ecs/servicediscovery/simple). The default value is `ELB`. |

### Restrictions of Service Definition

There are some restrictions in configuring a service definition file.

- `capacityProviderStrategy` is not supported.
- `clientToken` is not supported.
- `deploymentController` is required and must be `EXTERNAL`.
- `loadBalancers` is not supported. Use `targetGroups` in [ECSDeploymentInput](#ecsdeploymentinput) instead.
- `platformFamily` is not supported.
- `propagateTags` is always set as `SERVICE`.
- `taskDefinition` is not supported. PipeCD uses the definition in `taskDefinitionFile` in [ECSDeploymentInput](#ecsdeploymentinput).

### Restrictions of Task Definition

There are some restrictions in configuring a task definition file.

- `placementConstraints` is not supported.
- `proxyConfiguration` is not supported.
- `tags` is not supported.

### ECSTargetGroupInput

| Field | Type | Description | Required |
Expand Down

0 comments on commit 851c596

Please sign in to comment.