-
Notifications
You must be signed in to change notification settings - Fork 2
Helm Values yaml documentation #9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
5cabf68
WIP: internal documentation for values.yaml
mikechu-optimizely d387540
WIP: pause unplanned work :-(
mikechu-optimizely a6f6a02
Finished internal documentation of values.yaml
mikechu-optimizely 7673eb3
Refactor; correct notes
mikechu-optimizely 31cbbf5
WIP: adding NOTES.txt to this branch
mikechu-optimizely c6261a1
Applying code review suggestions
mikechu-optimizely 0254e1c
Add image tag to values
mikechu-optimizely 7c5e734
Complete edits ot NOTES.txt post-install info
mikechu-optimizely 588cb16
Conditionally include secrets.yaml
mikechu-optimizely 1aa28be
Add .helmignore
mikechu-optimizely 59e5607
Add disabled message for auto-scaling
mikechu-optimizely 28cdae0
Bug fix for autoscaling NOTE
mikechu-optimizely 5c5ec37
Corrections to toleration, names
mikechu-optimizely 52ce521
Reformat tolerations NOTES output
mikechu-optimizely 9c68096
Unconditionally generate secrets.yaml
mikechu-optimizely 87fd0e2
Get/display ClusterIP address + better doc
mikechu-optimizely File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # Patterns to ignore when building packages. | ||
| # This supports shell glob matching, relative path matching, and | ||
| # negation (prefixed with !). Only one pattern per line. | ||
| .DS_Store | ||
| # Common VCS dirs | ||
| .git/ | ||
| .gitignore | ||
| .bzr/ | ||
| .bzrignore | ||
| .hg/ | ||
| .hgignore | ||
| .svn/ | ||
| # Common backup files | ||
| *.swp | ||
| *.bak | ||
| *.tmp | ||
| *~ | ||
| # Various IDEs | ||
| .project | ||
| .idea/ | ||
| *.tmproj |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,26 +1,107 @@ | ||
| {{- if .Values.ingress.enabled }} | ||
| 1. Map ingress Address to Application URL's in /etc/hosts. | ||
| 2. Application URL's: | ||
| {{- range $host := .Values.ingress.hosts }} | ||
| {{- range .paths }} | ||
| http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }} | ||
| {{- end }} | ||
| *** Configuration Summary *** | ||
|
|
||
| Name Override: | ||
| {{ default "[no name override; using generated name]" .Values.nameOverride }} | ||
| Full Name Override: | ||
| {{ default "[no full name override; using generated full name]" .Values.fullnameOverride }} | ||
|
|
||
| Image Used: | ||
| {{ .Values.image.repository }}:{{ default "latest" .Values.image.tag }} | ||
|
|
||
| Service Account: | ||
| {{- if .Values.serviceAccount.create }} | ||
| {{ default "[account name will be generated]" .Values.serviceAccount.name }} | ||
| {{- else }} | ||
| [no service account used] | ||
| {{- end }} | ||
| {{ else }} | ||
| 1. Get the application URL by running these commands: | ||
| {{- if contains "NodePort" .Values.service.type }} | ||
| export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "optimizely-agent.fullname" . }}) | ||
| export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}") | ||
| echo http://$NODE_IP:$NODE_PORT | ||
| {{- else if contains "LoadBalancer" .Values.service.type }} | ||
| NOTE: It may take a few minutes for the LoadBalancer IP to be available. | ||
| You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "optimizely-agent.fullname" . }}' | ||
| export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "optimizely-agent.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}") | ||
| echo http://$SERVICE_IP:{{ .Values.service.port }} | ||
| {{- else if contains "ClusterIP" .Values.service.type }} | ||
| export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "optimizely-agent.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") | ||
| export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}") | ||
| echo "Visit http://127.0.0.1:8080 to use your application" | ||
| kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT | ||
|
|
||
| Replica Count: {{ .Values.replicaCount }} | ||
|
|
||
| Auto-Scaling: | ||
| {{- if .Values.autoscaling.enabled }} | ||
| Replicas between {{ .Values.autoscaling.minReplicas }} to {{ .Values.autoscaling.maxReplicas }} | ||
| Target CPU at {{ .Values.autoscaling.targetCPUUtilizationPercentage }}% | ||
| Target Memory at {{ .Values.autoscaling.targetMemoryUtilizationPercentage }}% | ||
| {{- else }} | ||
| [auto-scaling is disabled] | ||
| {{- end }} | ||
|
|
||
| Node Selector: | ||
| {{ default "[no node selectors applied]" .Values.nodeSelector }} | ||
|
|
||
| Node Affinity: | ||
| {{ default "[no node affinity applied]" .Values.affinity }} | ||
|
|
||
| Node Tolerations: | ||
| {{- if .Values.tolerations }} | ||
| {{- range $toleration := .Values.tolerations }} | ||
| Key: {{ $toleration.key }} | ||
| Operator: {{ $toleration.operator }} | ||
| Effect: {{ $toleration.effect }} | ||
| {{- end }} | ||
| {{- else }} | ||
| [no node tolarations applied] | ||
| {{- end }} | ||
|
|
||
| Pod Annotations Applied: | ||
| {{ default "[no annotations applied]" .Values.podAnnotations }} | ||
|
|
||
| Pod Security Context: | ||
| {{ default "[no pod security context applied]" .Values.podSecurityContext }} | ||
|
|
||
| Container Security Context: | ||
| {{ default "[no container security context applied]" .Values.securityContext }} | ||
|
|
||
| Network Service: | ||
| Type: {{ .Values.service.type }} | ||
| Ports: | ||
| {{- range $port := .Values.service.ports }} | ||
| {{ $port.name }}: {{ $port.targetPort }} [internal] <== {{ $port.port }} [external] | ||
| {{- end }} | ||
|
|
||
| Network Ingress: | ||
| {{- if .Values.ingress.enabled }} | ||
| Application URLs: | ||
| {{- range $host := .Values.ingress.hosts }} | ||
| {{- range .paths }} | ||
| http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }} | ||
| {{- end }} | ||
| {{- end }} | ||
| Ingress Annotations: | ||
| {{ default "[no ingress annotations applied]" .Values.ingress.annotations }} | ||
| {{- else }} | ||
| Run the following in a *nix terminal to access the running | ||
| {{- if contains "NodePort" .Values.service.type }} | ||
| {{- " NodePort service endpoint" }} | ||
| export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "optimizely-agent.fullname" . }}) | ||
| export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}") | ||
| echo http://$NODE_IP:$NODE_PORT | ||
| {{- else if contains "LoadBalancer" .Values.service.type }} | ||
| {{- " LoadBalancer service endpoint" }} | ||
| NOTE: It may take a few minutes for the LoadBalancer IP to be available. | ||
| You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "optimizely-agent.fullname" . }}' | ||
| export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "optimizely-agent.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}") | ||
| echo http://$SERVICE_IP:{{ .Values.service.port }} | ||
| {{- else if contains "ClusterIP" .Values.service.type }} | ||
| {{- " ClusterIP service IP address" }} | ||
| export CLUSTER_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "optimizely-agent.fullname" . }} -o jsonpath='{.spec.clusterIP}') | ||
| echo http://$CLUSTER_IP:8080 | ||
| {{- end }} | ||
| {{- end }} | ||
|
|
||
| Resources: | ||
| {{ default "[no resources declarations applied]" .Values.resources }} | ||
|
|
||
| Logging: | ||
| Level set to {{ .Values.logs.level | upper }} with friendly formatting {{ if $.Values.logs.pretty }}ON{{ else }}OFF{{ end }}. | ||
| SDK Key WILL {{- if not .Values.logs.includeSdkKey }} NOT {{- end }} be included in logs. | ||
|
|
||
| Environment Variables: | ||
| {{ default "[no environment variables applied]" .Values.env.variables }} | ||
|
|
||
| Secrets: | ||
| {{- if .Values.env.secrets }} | ||
| *** Secrets were applied *** | ||
| {{- else }} | ||
| [no secrets applied] | ||
| {{- end }} | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@msohailhussain I thought it was good to keep the outputs from the other service types. 😄
My research points to our need to run
kubectlcommands to access info from the running deployments like IP, Ports, etc. It appears that helm resolves templates earlier before the deployment is necessarily online ie no access to post-install values in the NOTES. ...again, from what I can tell.I'm certain @yasirfolio3 can take this further than my knowledge/experience.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's have a ticket, and will fix later. For now it's good we may release as it is.