@@ -105,10 +105,6 @@ that installs the controller into a target Kubernetes cluster. Both these
105
105
artifacts will have tags that correspond to the Semantic Version Git tag
106
106
applied against the source code repository for the controller.
107
107
108
- Service controllers may have a [ Stable Helm Chart] ( #stable-helm-charts ) that
109
- will install a version of the service controller binary that the maintainer
110
- team is confident will hold up to production use.
111
-
112
108
### Semantic Versioning
113
109
114
110
ACK is a collection of custom Kubernetes controllers, one for each supported
@@ -152,7 +148,7 @@ the SemVer version.
152
148
153
149
For example, if a Git tag of ` v1.2.6 ` was created on the
154
150
[ github.com/aws-controllers-k8s/s3-controller] [ s3-ctrl ] repository, a container
155
- image with a tag ` v1 .2.6` would be published to the
151
+ image with a tag ` 1 .2.6` would be published to the
156
152
[ public.ecr.aws/aws-controllers-k8s/s3-controller] [ ecr-ack-ctrl ] ECR Public
157
153
repository.
158
154
@@ -171,7 +167,7 @@ an artifact tag including the SemVer version.
171
167
172
168
For example, a Git tag of ` v1.2.6 ` on the
173
169
[ github.com/aws-controllers-k8s/s3-controller] [ s3-ctrl ]
174
- repository means a Helm chart with a tag ` v1 .2.6` would be published to the
170
+ repository means a Helm chart with a tag ` 1 .2.6` would be published to the
175
171
[ public.ecr.aws/aws-controllers-k8s/s3-chart] [ ecr-ack-chart ] ECR Public
176
172
repository.
177
173
@@ -200,69 +196,6 @@ Go's module infrastructure to pin the dependency between the code generator and
200
196
the common runtime.
201
197
{{% /hint %}}
202
198
203
- ### Stable Helm Charts
204
-
205
- {{% hint type="success" title="Tip" %}}
206
- We [ recommend] ( ../../user-docs/install/#install-an-ack-service-controller-with-helm-recommended ) using Helm to install an ACK service
207
- controller.
208
- {{% /hint %}}
209
-
210
-
211
- Some ACK service controllers will have Helm Charts with a
212
- ` v$MAJOR_VERSION-stable ` tag, referred from here out as just a
213
- "` stable ` artifact tag". There will only be one of these tags for the ACK
214
- service controller ** in a major version series** . For example, the full
215
- ` stable ` artifact tag for the ElastiCache ACK service controller's "v1" major
216
- version series would be
217
- ` public.ecr.aws/aws-controllers-k8s/elasticache-chart:v1-stable ` .
218
-
219
- This ` stable ` artifact tag points to a Helm chart that has configuration values
220
- that have been tested with a specific SemVer container image.
221
-
222
- Typically these tests are "soak" tests and allow the team maintaining that ACK
223
- controller's source code to have a high degree of confidence in the
224
- controller's long-running operation.
225
-
226
- {{% hint %}}
227
- Please note that not all ACK service controllers will have a Helm chart
228
- with a ` stable ` artifact tag. Furthermore, there will only ever be a single
229
- ` stable ` Helm Chart tag ** per major version series of a controller** .
230
- {{% /hint %}}
231
-
232
-
233
- This ` stable ` Helm Chart tag (an OCI Artifact tag) will point to different
234
- Helm Chart packages over time. From time to time, the maintainer team for a
235
- service controller may update the configuration values and associated SemVer
236
- container image tag for the controller binary to point to a newer image.
237
-
238
- For example, consider the ElastiCache ACK service controller maintainer team
239
- has executed a series of long-running tests of the
240
- ` public.ecr.aws/aws-controllers-k8s/elasticache-controller ` image tagged with
241
- the ` v1.2.6 ` SemVer tag. The maintainer team is confident that the controller
242
- is stable for production use. In the ` stable ` Git branch of the ElastiCache
243
- service controller's source repository, the team would update the Helm Chart's
244
- Deployment, setting the ` Deployment.spec.template.spec.containers[0].image ` to
245
- ` public.ecr.aws/aws-controllers-k8s/elasticache-controller:v1.2.6 ` .
246
-
247
- They then package the Helm Chart and publish it as an OCI Artifact to the
248
- ` public.ecr.aws/aws-controllers-k8s/elasticache-chart ` registry, using an OCI
249
- artifact tag of ` v1-stable ` .
250
-
251
- A couple months later, the maintainer team has added a few minor, non-breaking
252
- features to their controller along with a number of bug fixes. The latest
253
- SemVer tag for the ElastiCache controller image is at ` v1.3.9 ` .
254
-
255
- The maintainer team has separately been executing long-running tests against
256
- the ` v1.3.2 ` controller image and are confident that this release is
257
- appropriate for production use. The maintainer team would update the Helm Chart
258
- in their ` stable ` Git branch to have its
259
- ` Deployment.spec.template.spec.containers[0].image ` set to
260
- ` public.ecr.aws/aws-controllers-k8s/elasticache-controller:v1.3.2 ` . They would
261
- then package this Helm Chart and push overwrite the
262
- ` public.ecr.aws/aws-controllers-k8s/elasticache-chart:v1-stable ` OCI Artifact
263
- tag to point to this newly-updated Helm Chart that refers to the ` v1.3.2 `
264
- controller image.
265
-
266
199
## Maintenance Phases
267
200
268
201
As noted above, individual ACK service controllers all use Semantic Versioning
@@ -294,7 +227,7 @@ through long-running "soak" tests and are recommended for production use by the
294
227
team maintaining that controller.
295
228
296
229
All ACK controllers in the ` General Availability ` Maintenance Phase will have a
297
- Helm Chart with the ` stable ` artifact tag .
230
+ Helm Chart tagged with the major version >0 (eg. ` 1.0.0 ` ) .
298
231
299
232
Users who submit bug reports using Github Issues that reference a `General
300
233
Availability` controller will have their bug reports prioritized by the
0 commit comments