Skip to content

Commit 7404eaf

Browse files
Remove references to v prefix in Helm charts (#1794)
Issue #, if available: #1715 Description of changes: This pull request removes all references to Helm charts and images prefixed with `v`. Some parts of the release documentation still reference mono-repo style image tags. For those parts, I have partially updated them where applicable, but honestly they need to be entirely rewritten to match the current structure. By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
1 parent c570cb4 commit 7404eaf

File tree

10 files changed

+21
-21
lines changed

10 files changed

+21
-21
lines changed

docs/content/docs/community/releases.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ will be incremented. If the commits simply fix bugs and do not introduce any
135135
features or interface changes, the patch version ("Z") will be incremented.
136136

137137
Releases of any ACK component that have a zero major release number (e.g.
138-
`v0.0.2`) may have breaking changes to the public API or interfaces exposed by
138+
`0.0.2`) may have breaking changes to the public API or interfaces exposed by
139139
that component.
140140

141141
This is by design, and [per the Semantic Versioning specification][semver-zero]:

docs/content/docs/contributor-docs/release.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ a ACK service controller's release artifacts.
1919

2020
Once ACK service controller changes are tested by the service team and they wish to
2121
release latest artifacts, service team only needs to create a new release for service-controller
22-
github repository with a semver tag (Ex: v0.0.1).
22+
github repository with a semver tag (Ex: `0.0.1`).
2323
Steps below show how to create a new release with semver tag.
2424

2525
{{% hint type="info" title="Semver" %}}
@@ -49,12 +49,12 @@ controllers:
4949

5050
The container image is built and pushed with an image tag that indicates the
5151
release version for the controller along with the AWS service. For example,
52-
assume a release semver tag of `v0.1.0` that includes service controllers for
52+
assume a release semver tag of `0.1.0` that includes service controllers for
5353
S3 and SNS. There would be two container images built for this release, one each
5454
containing the ACK service controllers for S3 and SNS. The container images would
55-
have the following image tags: `s3-v0.1.0` and `sns-v0.1.0`. Note
55+
have the following image tags: `s3-0.1.0` and `sns-0.1.0`. Note
5656
that the full image name would be
57-
`public.ecr.aws/aws-controllers-k8s/controller:s3-v0.1.0`
57+
`public.ecr.aws/aws-controllers-k8s/s3-controller:0.1.0`
5858

5959
The Helm chart artifact can be used to install the ACK service controller as a
6060
Kubernetes Deployment; the Deployment's Pod image will refer to the exact
@@ -121,7 +121,7 @@ whenever there is a code push on `stable` git branch. Follow the steps below
121121
to cut a stable release for an ACK controller.
122122

123123
1) Checkout the ACK controller release which will be marked as stable.
124-
Example below uses s3-controller v0.0.19 release.
124+
Example below uses s3-controller `0.0.19` release.
125125
```bash
126126
cd $GOSRC/github.com/aws-controllers-k8s
127127
export SERVICE=s3
@@ -135,8 +135,8 @@ git checkout -b stable-$STABLE_RELEASE $STABLE_RELEASE
135135
nomenclature of stable branch and helm chart version please read our
136136
[release phase guide](../../community/releases/).
137137

138-
For the above example, replace `version: v0.0.19` inside `helm/Chart.yaml`
139-
with `version: v0-stable`. Without this update the postsubmit prowjob will
138+
For the above example, replace `version: 0.0.19` inside `helm/Chart.yaml`
139+
with `version: 0-stable`. Without this update the postsubmit prowjob will
140140
fail because validation error due to chart version mismatch.
141141

142142
3) Commit your changes from step2

docs/content/docs/tutorials/apigatewayv2-reference-example.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ aws ecr-public get-login-password --region us-east-1 | helm registry login --use
5050
Deploy the ACK service controller for Amazon APIGatewayv2 using the [apigatewayv2-chart Helm chart](https://gallery.ecr.aws/aws-controllers-k8s/apigatewayv2-chart). Resources should be created in the `us-east-1` region:
5151

5252
```bash
53-
helm install --create-namespace -n ack-system oci://public.ecr.aws/aws-controllers-k8s/apigatewayv2-chart --version=v0.0.17 --generate-name --set=aws.region=us-east-1
53+
helm install --create-namespace -n ack-system oci://public.ecr.aws/aws-controllers-k8s/apigatewayv2-chart --version=0.0.17 --generate-name --set=aws.region=us-east-1
5454
```
5555

5656
For a full list of available values to the Helm chart, please [review the values.yaml file](https://github.com/aws-controllers-k8s/apigatewayv2-controller/blob/main/helm/values.yaml).

docs/content/docs/tutorials/autoscaling-example.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,10 +143,10 @@ Get the Application Auto Scaling Helm chart and make it available on the client
143143
```bash
144144
export HELM_EXPERIMENTAL_OCI=1
145145
export SERVICE=applicationautoscaling
146-
export RELEASE_VERSION=`curl -sL https://api.github.com/repos/aws-controllers-k8s/$SERVICE-controller/releases/latest | grep '"tag_name":' | cut -d'"' -f4`
146+
export RELEASE_VERSION=$(curl -sL https://api.github.com/repos/aws-controllers-k8s/$SERVICE-controller/releases/latest | grep '"tag_name":' | cut -d'"' -f4)
147147

148148
if [[ -z "$RELEASE_VERSION" ]]; then
149-
RELEASE_VERSION=v1.0.2
149+
RELEASE_VERSION=1.0.2
150150
fi
151151

152152
export CHART_EXPORT_PATH=/tmp/chart

docs/content/docs/tutorials/emr-on-eks-example.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ eksctl create iamidentitymapping \
8484
Now we can go ahead and install EMR on EKS controller. First, let's export environment variables needed for setup
8585
```
8686
export SERVICE=emrcontainers
87-
export RELEASE_VERSION=`curl -sL https://api.github.com/repos/aws-controllers-k8s/$SERVICE-controller/releases/latest | grep '"tag_name":' | cut -d'"' -f4`
87+
export RELEASE_VERSION=$(curl -sL https://api.github.com/repos/aws-controllers-k8s/$SERVICE-controller/releases/latest | grep '"tag_name":' | cut -d'"' -f4)
8888
export ACK_SYSTEM_NAMESPACE=ack-system
8989
```
9090
We cam use Helm for the installation
@@ -104,7 +104,7 @@ REVISION: 1
104104
TEST SUITE: None
105105
NOTES:
106106
emrcontainers-chart has been installed.
107-
This chart deploys "public.ecr.aws/aws-controllers-k8s/emrcontainers-controller:v0.0.6".
107+
This chart deploys "public.ecr.aws/aws-controllers-k8s/emrcontainers-controller:0.0.6".
108108
109109
Check its status by running:
110110
kubectl --namespace ack-system get pods -l "app.kubernetes.io/instance=ack-emrcontainers-controller"

docs/content/docs/tutorials/memorydb-example.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ You can install the Helm chart to deploy the ACK service controller for Amazon M
4646
For example, to specify that the Amazon MemoryDB API calls go to the `us-east-1` region, you can deploy the service controller with the following command:
4747

4848
```bash
49-
helm install --create-namespace -n ack-system oci://public.ecr.aws/aws-controllers-k8s/memorydb-chart --version=v1.0.0 --generate-name --set=aws.region=us-east-1
49+
helm install --create-namespace -n ack-system oci://public.ecr.aws/aws-controllers-k8s/memorydb-chart --version=1.0.0 --generate-name --set=aws.region=us-east-1
5050
```
5151
You can find the latest version of ACK MemoryDB controller on GitHub [release page](https://github.com/aws-controllers-k8s/memorydb-controller/releases).
5252
Replace value for `--version` to the desired version.

docs/content/docs/tutorials/rds-example.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ You can now use the Helm chart to deploy the ACK service controller for Amazon R
5151
For example, to specify that the RDS API calls go to the `us-east-1` region, you can deploy the service controller with the following command:
5252

5353
```bash
54-
helm install --create-namespace -n ack-system oci://public.ecr.aws/aws-controllers-k8s/rds-chart --version=v0.0.27 --generate-name --set=aws.region=us-east-1
54+
helm install --create-namespace -n ack-system oci://public.ecr.aws/aws-controllers-k8s/rds-chart --version=0.0.27 --generate-name --set=aws.region=us-east-1
5555
```
5656

5757
For a full list of available values to the Helm chart, please [review the values.yaml file](https://github.com/aws-controllers-k8s/rds-controller/blob/main/helm/values.yaml).

docs/content/docs/tutorials/sagemaker-example.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ Get the SageMaker Helm chart and make it available on the client machine with th
142142
```bash
143143
export HELM_EXPERIMENTAL_OCI=1
144144
export SERVICE=sagemaker
145-
export RELEASE_VERSION=`curl -sL https://api.github.com/repos/aws-controllers-k8s/$SERVICE-controller/releases/latest | grep '"tag_name":' | cut -d'"' -f4`
145+
export RELEASE_VERSION=$(curl -sL https://api.github.com/repos/aws-controllers-k8s/$SERVICE-controller/releases/latest | grep '"tag_name":' | cut -d'"' -f4)
146146

147147
if [[ -z "$RELEASE_VERSION" ]]; then
148148
RELEASE_VERSION=v1.2.0

docs/content/docs/user-docs/ack-tags.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ controller will automatically ensure are on all resources that it manages.
2020

2121
The two default tags added by ACK controller are `services.k8s.aws/controller-version`
2222
and `services.k8s.aws/namespace`. The *controller-version* tag value is the name of
23-
corresponding AWS service and version for that controller(Ex: `s3-v0.1.3`).
23+
corresponding AWS service and version for that controller(Ex: `s3-0.1.3`).
2424
And the *namespace* tag value is the Kubernetes namespace for the ACK
2525
resource.(Ex: `default`)
2626

@@ -56,7 +56,7 @@ aws ecr list-tags-for-resource --resource-arn arn:aws:ecr:us-west-2:************
5656
"tags": [
5757
{
5858
"Key": "services.k8s.aws/controller-version",
59-
"Value": "ecr-v0.1.4"
59+
"Value": "ecr-0.1.4"
6060
},
6161
{
6262
"Key": "first",

docs/content/docs/user-docs/install.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Before installing a Helm chart, you can query the controller repository to find
4242

4343
```bash
4444
export SERVICE=s3
45-
export RELEASE_VERSION=`curl -sL https://api.github.com/repos/aws-controllers-k8s/$SERVICE-controller/releases/latest | grep '"tag_name":' | cut -d'"' -f4`
45+
export RELEASE_VERSION=$(curl -sL https://api.github.com/repos/aws-controllers-k8s/$SERVICE-controller/releases/latest | grep '"tag_name":' | cut -d'"' -f4)
4646
export ACK_SYSTEM_NAMESPACE=ack-system
4747
export AWS_REGION=us-west-2
4848

@@ -81,8 +81,8 @@ helm list --namespace $ACK_SYSTEM_NAMESPACE -o yaml
8181
The `helm list` command should return your newly-deployed Helm chart release information:
8282

8383
```bash
84-
app_version: v0.1.1
85-
chart: s3-chart-v0.1.1
84+
app_version: 0.1.1
85+
chart: s3-chart-0.1.1
8686
name: ack-s3-controller
8787
namespace: ack-system
8888
revision: "1"

0 commit comments

Comments
 (0)