Skip to content

Commit 64099cf

Browse files
Add Helm NOTES.txt (#272)
Fixes aws-controllers-k8s/community#1135 Description of changes: Adds a cute, descriptive NOTES.txt file for our Helm chart - shown to users when they install the chart. Example after running `helm install --generate-name s3-chart`: ``` s3-chart has been installed. This chart deploys "public.ecr.aws/aws-controllers-k8s/s3-controller:v0.0.10". Check its status by running: kubectl --namespace default get pods -l "app.kubernetes.io/instance=chart-1642804573" You are now able to create Amazon Simple Storage Service (S3) resources in your cluster! The controller is running in "cluster" mode. The controller is configured to run in the region: "us-west-2" Visit https://aws-controllers-k8s.github.io/community/reference/ for an API reference of all the resources that can be created using this controller. For more information on the AWS Controller for Kubernetes (ACK) project, visit: https://aws-controllers-k8s.github.io/community/ ``` By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
1 parent 1338d18 commit 64099cf

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

pkg/generate/ack/release.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ var (
2828
"helm/Chart.yaml.tpl",
2929
"helm/values.yaml.tpl",
3030
"helm/values.schema.json",
31+
"helm/templates/NOTES.txt.tpl",
3132
"helm/templates/role-reader.yaml.tpl",
3233
"helm/templates/role-writer.yaml.tpl",
3334
"helm/templates/_controller-role-kind-patch.yaml.tpl",
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{{ "{{ .Chart.Name }}" }} has been installed.
2+
This chart deploys "{{ .ImageRepository }}:{{ .ReleaseVersion }}".
3+
4+
Check its status by running:
5+
kubectl --namespace {{ "{{ .Release.Namespace }}" }} get pods -l "app.kubernetes.io/instance={{ "{{ .Release.Name }}" }}"
6+
7+
You are now able to create {{ .Metadata.Service.FullName }} ({{ .Metadata.Service.ShortName }}) resources!
8+
9+
The controller is running in "{{ "{{ .Values.installScope }}" }}" mode.
10+
The controller is configured to run in the region: "{{ "{{ .Values.aws.region }}" }}"
11+
12+
Visit https://aws-controllers-k8s.github.io/community/reference/ for an API
13+
reference of all the resources that can be created using this controller.
14+
15+
For more information on the AWS Controller for Kubernetes (ACK) project, visit:
16+
https://aws-controllers-k8s.github.io/community/

0 commit comments

Comments
 (0)