@@ -134,29 +134,35 @@ This is by design, and [per the Semantic Versioning specification][semver-zero]:
134134[ semver-zero ] : https://semver.org/#spec-item-4
135135
136136For ACK components that have a binary distributable -- i.e. a Docker image --
137- the creation of a new SemVer Git tag on the source code repository will trigger
137+ the creation of a new SemVer Git tag on the source code repository triggers the
138138automatic building and publishing of a Docker image with an image tag including
139- the SemVer version. For example, if a Git tag of ` v1.2.6 ` was created on the
139+ the SemVer version.
140+
141+ For example, if a Git tag of ` v1.2.6 ` was created on the
140142[ github.com/aws-controllers-k8s/s3-controller] [ s3-ctrl ] repository, a Docker
141- image with a tag ` s3-v1.2.6 ` would be published to the
142- [ aws-controllers-k8s/controller] [ ecr-ack-ctrl ] ECR repository.
143+ image with a tag ` v1.2.6 ` would be published to the
144+ [ public.ecr.aws/aws-controllers-k8s/s3-controller] [ ecr-ack-ctrl ] ECR Public
145+ repository.
143146
144147[ s3-ctrl ] : https://github.com/aws-controllers-k8s/s3-controller
145- [ ecr-ack-ctrl ] : https://gallery.ecr.aws/aws-controllers-k8s/controller
148+ [ ecr-ack-ctrl ] : https://gallery.ecr.aws/aws-controllers-k8s/s3- controller
146149
147150!!! note
148- Binaries for ACK components are published in our Amazon ECR
149- Public [ registry ] [ ecr-ack-ctrl ] .
151+ Binaries for individual ACK service controllers components are published in
152+ separate Amazon ECR Public repositories .
150153
151154For ACK components that have a Helm Chart distributable -- i.e. an ACK service
152155controller -- the creation of a new SemVer Git tag on the source code
153- repository will trigger automatic building and publishing of a Helm Chart with
154- an artifact tag including the SemVer version. For example, a Git tag of
155- ` v1.2.6 ` on the [ github.com/aws-controllers-k8s/s3-controller] [ s3-ctrl ]
156- repository means a Helm chart with a tag ` s3-v1.2.6 ` would be published to the
157- [ aws-controllers-k8s/chart] [ ecr-ack-chart ] ECR repository.
156+ repository triggers automatic building and publishing of a Helm Chart with
157+ an artifact tag including the SemVer version.
158+
159+ For example, a Git tag of ` v1.2.6 ` on the
160+ [ github.com/aws-controllers-k8s/s3-controller] [ s3-ctrl ]
161+ repository means a Helm chart with a tag ` v1.2.6 ` would be published to the
162+ [ public.ecr.aws/aws-controllers-k8s/s3-chart] [ ecr-ack-chart ] ECR Public
163+ repository.
158164
159- [ ecr-ack-chart ] : https://gallery.ecr.aws/aws-controllers-k8s/chart
165+ [ ecr-ack-chart ] : https://gallery.ecr.aws/aws-controllers-k8s/s3- chart
160166
161167#### A Word About Dependencies
162168
@@ -189,14 +195,16 @@ a specific version of the ACK common runtime.
189195[ recommend-helm ] : https://aws-controllers-k8s.github.io/community/user-docs/install/#helm-recommended
190196
191197Some ACK service controllers will have Helm Charts with a
192- ` $SERVICE- v$MAJOR_VERSION-stable` tag, referred from here out as just a
198+ ` v$MAJOR_VERSION-stable ` tag, referred from here out as just a
193199"` stable ` artifact tag". There will only be one of these tags for the ACK
194- service controller ** in a major version series** . For example, the ` stable `
195- artifact tag for the ElastiCache ACK service controller's "v1" major version
196- series would be ` elasticache-v1-stable ` .
200+ service controller ** in a major version series** . For example, the full
201+ ` stable ` artifact tag for the ElastiCache ACK service controller's "v1" major
202+ version series would be
203+ ` public.ecr.aws/aws-controllers-k8s/elasticache-chart:v1-stable ` .
197204
198205This ` stable ` artifact tag points to a Helm chart that has configuration values
199206that have been tested with a specific SemVer Docker image.
207+
200208Typically these tests are "soak" tests and allow the team maintaining that ACK
201209controller's source code to have a high degree of confidence in the
202210controller's long-running operation.
@@ -212,17 +220,17 @@ service controller may update the configuration values and associated SemVer
212220Docker image tag for the controller binary to point to a newer image.
213221
214222For example, consider the ElastiCache ACK service controller maintainer team
215- has executed a series of long-running tests of the controller image tagged with
216- the ` elasticache-v1.2.6 ` SemVer tag. The maintainer team is confident that the
217- controller is stable for production use. In the ` stable ` Git branch of the
218- ElastiCache service controller's source repository, the team would update the
219- Helm Chart 's Deployment, setting the
220- ` Deployment.spec.template.spec.containers[0].image ` to
221- ` public.ecr.aws/aws-controllers-k8s/controller/ elasticache-v1.2.6 ` .
223+ has executed a series of long-running tests of the
224+ ` public.ecr.aws/aws-controllers-k8s/elasticache-controller ` image tagged with
225+ the ` v1.2.6 ` SemVer tag. The maintainer team is confident that the controller
226+ is stable for production use. In the ` stable ` Git branch of the ElastiCache
227+ service controller 's source repository, the team would update the Helm Chart's
228+ Deployment, setting the ` Deployment.spec.template.spec.containers[0].image ` to
229+ ` public.ecr.aws/aws-controllers-k8s/elasticache-controller: v1.2.6 ` .
222230
223231They then package the Helm Chart and publish it as an OCI Artifact to the
224- ` public.ecr.aws/aws-controllers-k8s/chart ` registry, using an OCI artifact tag
225- of ` elasticache- v1-stable` .
232+ ` public.ecr.aws/aws-controllers-k8s/elasticache- chart ` registry, using an OCI
233+ artifact tag of ` v1-stable ` .
226234
227235A couple months later, the maintainer team has added a few minor, non-breaking
228236features to their controller along with a number of bug fixes. The latest
@@ -233,10 +241,10 @@ the `v1.3.2` controller image and are confident that this release is
233241appropriate for production use. The maintainer team would update the Helm Chart
234242in their ` stable ` Git branch to have its
235243` Deployment.spec.template.spec.containers[0].image ` set to
236- ` public.ecr.aws/aws-controllers-k8s/controller/ elasticache-v1.3.2 ` . They would
244+ ` public.ecr.aws/aws-controllers-k8s/elasticache-controller: v1.3.2 ` . They would
237245then package this Helm Chart and push overwrite the
238- ` public.ecr.aws/aws-controllers-k8s/chart: elasticache-v1-stable ` OCI Artifact tag
239- to point to this newly-updated Helm Chart that refers to the ` v1.3.2 `
246+ ` public.ecr.aws/aws-controllers-k8s/elasticache-chart: v1-stable ` OCI Artifact
247+ tag to point to this newly-updated Helm Chart that refers to the ` v1.3.2 `
240248controller image.
241249
242250## Maintenance Phases
0 commit comments