Skip to content

Add ECSTargetGroupObject to the configuration reference documentation #4649

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
khanhtc1202 merged 2 commits into from
Nov 2, 2023
+24 −6
Merged

Add ECSTargetGroupObject to the configuration reference documentation #4649

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0b16370
Add ECSTargetGroupObject to the configuration reference documentation
ouchi2501 Nov 2, 2023
35f1505
Add docs-dev and Change markdown table formatting
ouchi2501 Nov 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions docs/content/en/docs-dev/user-guide/configuration-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
15 changes: 12 additions & 3 deletions docs/content/en/docs-v0.45.x/user-guide/configuration-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down