From fd5af4b449ab7411ef2a64e11121831ffd350533 Mon Sep 17 00:00:00 2001 From: uncle Date: Thu, 2 Nov 2023 16:42:21 +0900 Subject: [PATCH] Add ECSTargetGroupObject to the configuration reference documentation (#4649) * Add ECSTargetGroupObject to the configuration reference documentation Signed-off-by: uncle * Add docs-dev and Change markdown table formatting Signed-off-by: uncle --------- Signed-off-by: uncle --- .../user-guide/configuration-reference.md | 15 ++++++++++++--- .../user-guide/configuration-reference.md | 15 ++++++++++++--- 2 files changed, 24 insertions(+), 6 deletions(-) diff --git a/docs/content/en/docs-dev/user-guide/configuration-reference.md b/docs/content/en/docs-dev/user-guide/configuration-reference.md index 68b0bcdaae..b3d67eee47 100644 --- a/docs/content/en/docs-dev/user-guide/configuration-reference.md +++ b/docs/content/en/docs-dev/user-guide/configuration-reference.md @@ -450,10 +450,19 @@ One of `yamlField` or `regex` is required. | Field | Type | Description | Required | |-|-|-|-| -| primary | ECSTargetGroupObject | The PRIMARY target group, will be used to register the PRIMARY ECS task set. | Yes | -| canary | ECSTargetGroupObject | The CANARY target group, will be used to register the CANARY ECS task set if exist. It's required to enable PipeCD to perform the multi-stage deployment. | No | +| primary | [ECSTargetGroupObject](#ecstargetgroupobject) | The PRIMARY target group, will be used to register the PRIMARY ECS task set. | Yes | +| canary | [ECSTargetGroupObject](#ecstargetgroupobject) | The CANARY target group, will be used to register the CANARY ECS task set if exist. It's required to enable PipeCD to perform the multi-stage deployment. | No | -Note: You can get examples for those object from [here](../../examples/#ecs-applications). +#### ECSTargetGroupObject + +| Field | Type | Description | Required | +|-|-|-|-| +| targetGroupArn | string | The name of the container (as it appears in a container definition) to　associate with the load balancer | Yes | +| containerName | string | The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set. | Yes | +| containerPort | int | The port on the container to associate with the load balancer. | Yes | +| LoadBalancerName | string | The name of the load balancer to associate with the Amazon ECS service or task set. | No | + +Note: The available values are identical to those found in the aws-sdk-go-v2 Types.LoadBalancer. For more details, please refer to [this link](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/ecs/types#LoadBalancer) . ## ECSQuickSync diff --git a/docs/content/en/docs-v0.45.x/user-guide/configuration-reference.md b/docs/content/en/docs-v0.45.x/user-guide/configuration-reference.md index 3375e80382..1362f74d73 100644 --- a/docs/content/en/docs-v0.45.x/user-guide/configuration-reference.md +++ b/docs/content/en/docs-v0.45.x/user-guide/configuration-reference.md @@ -450,10 +450,19 @@ One of `yamlField` or `regex` is required. | Field | Type | Description | Required | |-|-|-|-| -| primary | ECSTargetGroupObject | The PRIMARY target group, will be used to register the PRIMARY ECS task set. | Yes | -| canary | ECSTargetGroupObject | The CANARY target group, will be used to register the CANARY ECS task set if exist. It's required to enable PipeCD to perform the multi-stage deployment. | No | +| primary | [ECSTargetGroupObject](#ecstargetgroupobject) | The PRIMARY target group, will be used to register the PRIMARY ECS task set. | Yes | +| canary | [ECSTargetGroupObject](#ecstargetgroupobject) | The CANARY target group, will be used to register the CANARY ECS task set if exist. It's required to enable PipeCD to perform the multi-stage deployment. | No | -Note: You can get examples for those object from [here](../../examples/#ecs-applications). +#### ECSTargetGroupObject + +| Field | Type | Description | Required | +|-|-|-|-| +| targetGroupArn | string | The name of the container (as it appears in a container definition) to　associate with the load balancer | Yes | +| containerName | string | The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set. | Yes | +| containerPort | int | The port on the container to associate with the load balancer. | Yes | +| LoadBalancerName | string | The name of the load balancer to associate with the Amazon ECS service or task set. | No | + +Note: The available values are identical to those found in the aws-sdk-go-v2 Types.LoadBalancer. For more details, please refer to [this link](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service/ecs/types#LoadBalancer) . ## ECSQuickSync