Release version v0.41.3 (#4125)

* Release version v0.41.3 * Update release note
pipe-cd · Jan 13, 2023 · 0509734 · 0509734
1 parent 8cf884b
commit 0509734
Show file tree

Hide file tree

Showing 8 changed files with 170 additions and 5 deletions.
diff --git a/RELEASE b/RELEASE
@@ -1,4 +1,4 @@
-tag: v0.41.2
+tag: v0.41.3
 
 releaseNoteGenerator:
   showCommitter: false

diff --git a/docs/content/en/blog/releases/v0.41.3.md b/docs/content/en/blog/releases/v0.41.3.md
@@ -0,0 +1,29 @@
+---
+title: "Release v0.41.3"
+linkTitle: "Release v0.41.3"
+date: 2023-01-12
+description: >
+ Release v0.41.3
+---
+
+## Changes since v0.41.2
+
+### New Features
+
+* Support standalone ECS task ([#4084](https://github.com/pipe-cd/pipecd/pull/4084))
+* Add pipectl disable application command ([#4119](https://github.com/pipe-cd/pipecd/pull/4119))
+
+### Notable Changes
+
+* Add new line in detailsFormat to fix plan preview format ([#4122](https://github.com/pipe-cd/pipecd/pull/4122))
+* Prevent diff by keeping new line at EOF for applications' manifests ([#4033](https://github.com/pipe-cd/pipecd/pull/4033))
+
+### Internal Changes
+
+* Add document how to disable ([#4123](https://github.com/pipe-cd/pipecd/pull/4123))
+* Add kenvin to contributiors list ([#4121](https://github.com/pipe-cd/pipecd/pull/4121))
+* Run update go deps ([#4117](https://github.com/pipe-cd/pipecd/pull/4117))
+* Add update contributions command ([#4114](https://github.com/pipe-cd/pipecd/pull/4114))
+* Bump json5 from 2.1.3 to 2.2.3 in /web ([#4115](https://github.com/pipe-cd/pipecd/pull/4115))
+* Fix the example for running make release/pick ([#4113](https://github.com/pipe-cd/pipecd/pull/4113))
+* Add example for ecs standalone task ([#4104](https://github.com/pipe-cd/pipecd/pull/4104))
diff --git a/docs/content/en/docs-v0.41.x/examples/_index.md b/docs/content/en/docs-v0.41.x/examples/_index.md
@@ -81,6 +81,8 @@ https://github.com/pipe-cd/examples
 | [bluegreen](https://github.com/pipe-cd/examples/tree/master/ecs/bluegreen) | Deployment pipeline with blue-green strategy. |
 | [secret-management](https://github.com/pipe-cd/examples/tree/master/ecs/secret-management) | Demonstrate how to manage sensitive data by using [Secret Management](../user-guide/managing-application/secret-management/) feature. |
 | [wait-approval](https://github.com/pipe-cd/examples/tree/master/ecs/wait-approval) | Deployment pipeline that contains a manual approval stage. |
+| [standalone-task](https://github.com/pipe-cd/examples/tree/master/ecs/standalone-task) | Deployment Standalone Task. (`Standalone task is only supported for Quick sync`) |
+
 
 ### Deployment chain
 

diff --git a/docs/content/en/docs-v0.41.x/user-guide/command-line-tool.md b/docs/content/en/docs-v0.41.x/user-guide/command-line-tool.md
@@ -193,6 +193,17 @@ pipectl application list \
     --app-kind=KUBERNETES \
 ```
 
+### Disable an application
+
+Disable an application with given id:
+
+``` console
+pipectl application disable \
+    --address={CONTROL_PLANE_API_ADDRESS} \
+    --api-key={API_KEY} \
+    --app-id={APPLICATION_ID}
+```
+
 ### Deleting an application
 
 Delete an application with given id:

diff --git a/.../docs-v0.41.x/user-guide/managing-application/defining-app-configuration/ecs.md b/.../docs-v0.41.x/user-guide/managing-application/defining-app-configuration/ecs.md
@@ -6,14 +6,70 @@ description: >
   Specific guide to configuring deployment for Amazon ECS application.
 ---
 
-Deploying an Amazon ECS application requires `TaskDefinition` and `Service` configuration files placing inside the application directory. Those files contain all configuration for [ECS TaskDefinition](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html) object and [ECS Service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) object, and will be used by Piped agent while deploy your application/service to ECS cluster.
+There are two main ways to deploy an Amazon ECS application.
+- Your application is a one-time or periodic batch job.
+  - it's a standalone task.
+  - you need to prepare `TaskDefinition`
+- Your application is deployed to run continuously or behind a load balancer.
+  - you need to prepare `TaskDefinition` and `Service`
+
+To deploy an Amazon ECS application, the `TaskDefinition` configuration file must be located in the application directory. This file contains all configuration for [ECS TaskDefinition](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html) object and will be used by Piped agent while deploying your application/service to the ECS cluster.
+
+To deploy your application to run continuously or to place it behind a load balancer, You need to create [ECS Service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html). The `Service` configuration file also must be located in the application directory. This file contains all configurations for [ECS Service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) object.
 
 If you're not familiar with ECS, you can get examples for those files from [here](../../../../examples/#ecs-applications).
 
 ## Quick sync
 
 By default, when the [pipeline](../../../configuration-reference/#ecs-application) was not specified, PipeCD triggers a quick sync deployment for the merged pull request.
 Quick sync for an ECS deployment will roll out the new version and switch all traffic to it immediately.
+> In case of standalone task, only Quick sync is supported.
+
+Here is an example for Quick sync.
+
+  {{< tabpane >}}
+  {{< tab lang="yaml" header="application" >}}
+apiVersion: pipecd.dev/v1beta1
+kind: ECSApp
+spec:
+  name: simple
+  labels:
+    env: example
+    team: xyz
+  input:
+    # Path to Service configuration file in Yaml/JSON format.
+    serviceDefinitionFile: servicedef.yaml
+    # Path to TaskDefinition configuration file in Yaml/JSON format.
+    # Default is `taskdef.json`
+    taskDefinitionFile: taskdef.yaml
+    targetGroups:
+      primary:
+        targetGroupArn: arn:aws:elasticloadbalancing:ap-northeast-1:XXXX:targetgroup/ecs-lb/YYYY
+        containerName: web
+        containerPort: 80
+  {{< /tab >}}
+  {{< tab lang="yaml" header="standalone task" >}}
+apiVersion: pipecd.dev/v1beta1
+kind: ECSApp
+spec:
+  name: standalonetask-fargate
+  labels:
+    env: example
+    team: xyz
+  input:
+    # Path to TaskDefinition configuration file in Yaml/JSON format.
+    # Default is `taskdef.json`
+    taskDefinitionFile: taskdef.yaml
+    clusterArn: arn:aws:ecs:ap-northeast-1:XXXX:cluster/test-cluster
+    awsvpcConfiguration:
+      assignPublicIp: ENABLED
+      subnets:
+        - subnet-YYYY
+        - subnet-YYYY
+      securityGroups:
+          - sg-YYYY
+  {{< /tab >}}
+  {{< /tabpane >}}
 
 ## Sync with the specified pipeline
 
@@ -46,7 +102,6 @@ kind: ECSApp
 spec:
   input:
     # Path to Service configuration file in Yaml/JSON format.
-    # Default is `service.json`
     serviceDefinitionFile: servicedef.yaml
     # Path to TaskDefinition configuration file in Yaml/JSON format.
     # Default is `taskdef.json`

diff --git a/docs/content/en/docs/examples/_index.md b/docs/content/en/docs/examples/_index.md
@@ -81,6 +81,8 @@ https://github.com/pipe-cd/examples
 | [bluegreen](https://github.com/pipe-cd/examples/tree/master/ecs/bluegreen) | Deployment pipeline with blue-green strategy. |
 | [secret-management](https://github.com/pipe-cd/examples/tree/master/ecs/secret-management) | Demonstrate how to manage sensitive data by using [Secret Management](../user-guide/managing-application/secret-management/) feature. |
 | [wait-approval](https://github.com/pipe-cd/examples/tree/master/ecs/wait-approval) | Deployment pipeline that contains a manual approval stage. |
+| [standalone-task](https://github.com/pipe-cd/examples/tree/master/ecs/standalone-task) | Deployment Standalone Task. (`Standalone task is only supported for Quick sync`) |
+
 
 ### Deployment chain
 

diff --git a/docs/content/en/docs/user-guide/command-line-tool.md b/docs/content/en/docs/user-guide/command-line-tool.md
@@ -193,6 +193,17 @@ pipectl application list \
     --app-kind=KUBERNETES \
 ```
 
+### Disable an application
+
+Disable an application with given id:
+
+``` console
+pipectl application disable \
+    --address={CONTROL_PLANE_API_ADDRESS} \
+    --api-key={API_KEY} \
+    --app-id={APPLICATION_ID}
+```
+
 ### Deleting an application
 
 Delete an application with given id:

diff --git a/...ntent/en/docs/user-guide/managing-application/defining-app-configuration/ecs.md b/...ntent/en/docs/user-guide/managing-application/defining-app-configuration/ecs.md
@@ -6,14 +6,70 @@ description: >
   Specific guide to configuring deployment for Amazon ECS application.
 ---
 
-Deploying an Amazon ECS application requires `TaskDefinition` and `Service` configuration files placing inside the application directory. Those files contain all configuration for [ECS TaskDefinition](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html) object and [ECS Service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) object, and will be used by Piped agent while deploy your application/service to ECS cluster.
+There are two main ways to deploy an Amazon ECS application.
+- Your application is a one-time or periodic batch job.
+  - it's a standalone task.
+  - you need to prepare `TaskDefinition`
+- Your application is deployed to run continuously or behind a load balancer.
+  - you need to prepare `TaskDefinition` and `Service`
+
+To deploy an Amazon ECS application, the `TaskDefinition` configuration file must be located in the application directory. This file contains all configuration for [ECS TaskDefinition](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html) object and will be used by Piped agent while deploying your application/service to the ECS cluster.
+
+To deploy your application to run continuously or to place it behind a load balancer, You need to create [ECS Service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html). The `Service` configuration file also must be located in the application directory. This file contains all configurations for [ECS Service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) object.
 
 If you're not familiar with ECS, you can get examples for those files from [here](../../../../examples/#ecs-applications).
 
 ## Quick sync
 
 By default, when the [pipeline](../../../configuration-reference/#ecs-application) was not specified, PipeCD triggers a quick sync deployment for the merged pull request.
 Quick sync for an ECS deployment will roll out the new version and switch all traffic to it immediately.
+> In case of standalone task, only Quick sync is supported.
+
+Here is an example for Quick sync.
+
+  {{< tabpane >}}
+  {{< tab lang="yaml" header="application" >}}
+apiVersion: pipecd.dev/v1beta1
+kind: ECSApp
+spec:
+  name: simple
+  labels:
+    env: example
+    team: xyz
+  input:
+    # Path to Service configuration file in Yaml/JSON format.
+    serviceDefinitionFile: servicedef.yaml
+    # Path to TaskDefinition configuration file in Yaml/JSON format.
+    # Default is `taskdef.json`
+    taskDefinitionFile: taskdef.yaml
+    targetGroups:
+      primary:
+        targetGroupArn: arn:aws:elasticloadbalancing:ap-northeast-1:XXXX:targetgroup/ecs-lb/YYYY
+        containerName: web
+        containerPort: 80
+  {{< /tab >}}
+  {{< tab lang="yaml" header="standalone task" >}}
+apiVersion: pipecd.dev/v1beta1
+kind: ECSApp
+spec:
+  name: standalonetask-fargate
+  labels:
+    env: example
+    team: xyz
+  input:
+    # Path to TaskDefinition configuration file in Yaml/JSON format.
+    # Default is `taskdef.json`
+    taskDefinitionFile: taskdef.yaml
+    clusterArn: arn:aws:ecs:ap-northeast-1:XXXX:cluster/test-cluster
+    awsvpcConfiguration:
+      assignPublicIp: ENABLED
+      subnets:
+        - subnet-YYYY
+        - subnet-YYYY
+      securityGroups:
+          - sg-YYYY
+  {{< /tab >}}
+  {{< /tabpane >}}
 
 ## Sync with the specified pipeline
 
@@ -46,7 +102,6 @@ kind: ECSApp
 spec:
   input:
     # Path to Service configuration file in Yaml/JSON format.
-    # Default is `service.json`
     serviceDefinitionFile: servicedef.yaml
     # Path to TaskDefinition configuration file in Yaml/JSON format.
     # Default is `taskdef.json`