Commit 645cf0e1 authored by Matt Butcher's avatar Matt Butcher Committed by GitHub

Merge pull request #868 from technosophos/docs/unify-examples

docs(examples): unify the examples
parents ca6151f8 5e63b5e9
#Alpine: A simple Helm chart
Run a single pod of Alpine Linux.
This example was generated using the command `helm create alpine`. This example was generated using the command `helm create alpine`.
The `templates/` directory contains a very simple pod resource with a The `templates/` directory contains a very simple pod resource with a
......
...@@ -3,13 +3,23 @@ kind: Pod ...@@ -3,13 +3,23 @@ kind: Pod
metadata: metadata:
name: {{.Release.Name}}-{{.Chart.Name}} name: {{.Release.Name}}-{{.Chart.Name}}
labels: labels:
# The "heritage" label is used to track which tool deployed a given chart.
# It is useful for admins who want to see what releases a particular tool
# is responsible for.
heritage: {{.Release.Service}} heritage: {{.Release.Service}}
chartName: {{.Chart.Name}} # The "release" convention makes it easy to tie a release to all of the
chartVersion: {{.Chart.Version | quote}} # Kubernetes resources that were created as part of that release.
release: {{.Release.Name}}
# This makes it easy to audit chart usage.
chart: {{.Chart.Name}}-{{.Chart.Version}}
annotations: annotations:
"helm.sh/created": "{{.Release.Time.Seconds}}" "helm.sh/created": "{{.Release.Time.Seconds}}"
spec: spec:
restartPolicy: {{default "Never" .restart_policy}} # This shows how to use a simple value. This will look for a passed-in value
# called restartPolicy. If it is not found, it will use the default value.
# {{default "Never" .restartPolicy}} is a slightly optimized version of the
# more conventional syntax: {{.restartPolicy | default "Never"}}
restartPolicy: {{default "Never" .restartPolicy}}
containers: containers:
- name: waiter - name: waiter
image: "alpine:3.3" image: "alpine:3.3"
......
...@@ -7,6 +7,7 @@ metadata: ...@@ -7,6 +7,7 @@ metadata:
labels: labels:
release: {{.Release.Name}} release: {{.Release.Name}}
app: {{template "fullname" .}} app: {{template "fullname" .}}
heritage: {{.Release.Service}}
data: data:
# When the config map is mounted as a volume, these will be created as # When the config map is mounted as a volume, these will be created as
# files. # files.
......
...@@ -6,10 +6,10 @@ metadata: ...@@ -6,10 +6,10 @@ metadata:
# multiple times into the same namespace. # multiple times into the same namespace.
name: {{template "fullname" .}} name: {{template "fullname" .}}
labels: labels:
# This is a convention. It makes it possible for an admin to query a cluster # The "heritage" label is used to track which tool deployed a given chart.
# using Kubectl and find out what packages are managed by Helm. Helm itself # It is useful for admins who want to see what releases a particular tool
# does not depend on this label, though. # is responsible for.
heritage: helm heritage: {{.Release.Service}}
# This makes it easy to search for all components of a release using kubectl. # This makes it easy to search for all components of a release using kubectl.
release: {{.Release.Name}} release: {{.Release.Name}}
# This makes it easy to audit chart usage. # This makes it easy to audit chart usage.
......
...@@ -5,7 +5,7 @@ kind: Service ...@@ -5,7 +5,7 @@ kind: Service
metadata: metadata:
name: {{template "fullname" .}} name: {{template "fullname" .}}
labels: labels:
heritage: helm heritage: {{.Release.Service}}
release: {{.Release.Name}} release: {{.Release.Name}}
chart: {{.Chart.Name}}-{{.Chart.Version}} chart: {{.Chart.Name}}-{{.Chart.Version}}
spec: spec:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment