Skip to content

Commit 5d239d6

Browse files
Add content
1 parent e8feb0e commit 5d239d6

File tree

1 file changed

+109
-0
lines changed
  • content/en/user-guide/aws/codedeploy

1 file changed

+109
-0
lines changed

content/en/user-guide/aws/codedeploy/index.md

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,113 @@ The supported operations are listed on the [API coverage page]({{< ref "coverage
1717

1818
## Getting Started
1919

20+
This guide will walk through the process of creating CodeDeploy applications, deployment configuration, deployment groups, and deployments.
21+
22+
Basic knowledge of the AWS CLI and the [`awslocal`](https://github.com/localstack/awscli-local) wrapper is expected.
23+
24+
Start LocalStack using your preferred method.
25+
26+
### Applications
27+
28+
An application is a CodeDeploy construct that uniquely identifies your targetted application.
29+
Create an application with the [CreateApplication](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateApplication.html) operation:
30+
31+
{{< command >}}
32+
$ awslocal deploy create-application --application-name hello --compute-platform Server
33+
<disable-copy>
34+
{
35+
"applicationId": "063714b6-f438-4b90-bacb-ce04af7f5e83"
36+
}
37+
</disable-copy>
38+
{{< /command >}}
39+
40+
Make note of the application name, which can be used with other operations such as [GetApplication](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_GetApplication.html), [UpdateApplication](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_UpdateApplication.html) and [DeleteApplication](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_DeleteApplication.html).
41+
42+
{{< command >}}
43+
$ awslocal deploy get-application --application-name hello
44+
<disable-copy>
45+
{
46+
"application": {
47+
"applicationId": "063714b6-f438-4b90-bacb-ce04af7f5e83",
48+
"applicationName": "hello",
49+
"createTime": 1747663397.271634,
50+
"computePlatform": "Server"
51+
}
52+
}
53+
</disable-copy>
54+
{{< /command >}}
55+
56+
You can list all application using [ListApplications](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_ListApplications.html).
57+
58+
{{< command >}}
59+
$ awslocal deploy list-applications
60+
<disable-copy>
61+
{
62+
"applications": [
63+
"hello"
64+
]
65+
}
66+
</disable-copy>
67+
{{< /command >}}
68+
69+
{{< command >}}
70+
<disable-copy>
71+
</disable-copy>
72+
{{< /command >}}
73+
74+
### Deployment configuration
75+
76+
A deployment configuration consists of rules for deployment along with success and failure criteria.
77+
78+
Create a deployment configuration using [CreateDeploymentConfig](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeploymentConfig.html):
79+
80+
{{< command >}}
81+
$ awslocal deploy create-deployment-config --deployment-config-name hello-conf \
82+
--compute-platform Server \
83+
--minimum-healthy-hosts '{"type": "HOST_COUNT", "value": 1}'
84+
<disable-copy>
85+
{
86+
"deploymentConfigId": "0327ce0a-4637-4884-8899-49af7b9423b6"
87+
}
88+
</disable-copy>
89+
{{< /command >}}
90+
91+
92+
[ListDeploymentConfigs](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_ListDeploymentConfigs.html) can be used to list all available configs:
93+
94+
{{< command >}}
95+
$ awslocal deploy list-deployment-configs
96+
<disable-copy>
97+
{
98+
"deploymentConfigsList": [
99+
"hello-conf"
100+
]
101+
}
102+
</disable-copy>
103+
{{< /command >}}
104+
105+
Use [GetDeploymentConfig](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_GetDeploymentConfig.html) and [DeleteDeploymentConfig](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_DeleteDeploymentConfig.html) to manage deployment configurations.
106+
107+
{{< command >}}
108+
$ awslocal deploy get-deployment-config --deployment-config-name hello-conf
109+
<disable-copy>
110+
{
111+
"deploymentConfigInfo": {
112+
"deploymentConfigId": "0327ce0a-4637-4884-8899-49af7b9423b6",
113+
"deploymentConfigName": "hello-conf",
114+
"minimumHealthyHosts": {
115+
"type": "HOST_COUNT",
116+
"value": 1
117+
},
118+
"createTime": 1747663716.208291,
119+
"computePlatform": "Server"
120+
}
121+
}
122+
</disable-copy>
123+
{{< /command >}}
124+
125+
### Deployment groups
126+
127+
### Deployments
128+
20129
## Limitations

0 commit comments

Comments
 (0)