From 03d8ed11f09665aa640fde8039dc00fa11cf8df2 Mon Sep 17 00:00:00 2001 From: Yahav Biran Date: Fri, 24 Nov 2017 23:53:54 -0800 Subject: [PATCH] Add guestbook example for Helm. Issue #3191 --- docs/examples/README.md | 6 ++ docs/examples/guestbook/.helmignore | 21 +++++++ docs/examples/guestbook/Chart.yaml | 9 +++ docs/examples/guestbook/templates/NOTES.txt | 17 ++++++ .../examples/guestbook/templates/_helpers.tpl | 16 +++++ .../templates/frontend-deployment.yaml | 39 ++++++++++++ .../guestbook/templates/frontend-service.yaml | 17 ++++++ .../templates/redis-master-deployment.yaml | 29 +++++++++ .../templates/redis-master-service.yaml | 19 ++++++ .../templates/redis-slave-deployment.yaml | 32 ++++++++++ .../templates/redis-slave-service.yaml | 18 ++++++ docs/examples/guestbook/values.yaml | 59 +++++++++++++++++++ 12 files changed, 282 insertions(+) create mode 100644 docs/examples/guestbook/.helmignore create mode 100644 docs/examples/guestbook/Chart.yaml create mode 100644 docs/examples/guestbook/templates/NOTES.txt create mode 100644 docs/examples/guestbook/templates/_helpers.tpl create mode 100644 docs/examples/guestbook/templates/frontend-deployment.yaml create mode 100644 docs/examples/guestbook/templates/frontend-service.yaml create mode 100644 docs/examples/guestbook/templates/redis-master-deployment.yaml create mode 100644 docs/examples/guestbook/templates/redis-master-service.yaml create mode 100644 docs/examples/guestbook/templates/redis-slave-deployment.yaml create mode 100644 docs/examples/guestbook/templates/redis-slave-service.yaml create mode 100644 docs/examples/guestbook/values.yaml diff --git a/docs/examples/README.md b/docs/examples/README.md index 723040ca8..230354aa0 100644 --- a/docs/examples/README.md +++ b/docs/examples/README.md @@ -17,3 +17,9 @@ and it illustrates more complex template usage. It deploys a `deployment` (which creates a `replica set`), a `config map`, and a `service`. The replica set starts an nginx pod. The config map stores the files that the nginx server can serve. + +## Guestbook + +The `guestbook` chart is a simple multi-tier app. The first tier is Apache httpd-based app that uses Redis master-slave cluster (the second tier). + +The app comprises of `deployment` for the each tier that are accessible thru its corresponding `service` diff --git a/docs/examples/guestbook/.helmignore b/docs/examples/guestbook/.helmignore new file mode 100644 index 000000000..f0c131944 --- /dev/null +++ b/docs/examples/guestbook/.helmignore @@ -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 diff --git a/docs/examples/guestbook/Chart.yaml b/docs/examples/guestbook/Chart.yaml new file mode 100644 index 000000000..3d69bfb04 --- /dev/null +++ b/docs/examples/guestbook/Chart.yaml @@ -0,0 +1,9 @@ +apiVersion: v1 +name: guestbook +version: 0.1.0 +description: Guestbook Helm chart for Kubernetes. +sources: + - https://github.com/kubernetes/kubernetes/tree/master/examples/guestbook +maintainers: + - name: Yahav Biran + - email: ybiran@colostate.edu diff --git a/docs/examples/guestbook/templates/NOTES.txt b/docs/examples/guestbook/templates/NOTES.txt new file mode 100644 index 000000000..6f6a5060d --- /dev/null +++ b/docs/examples/guestbook/templates/NOTES.txt @@ -0,0 +1,17 @@ +1. Get the application URL by running these commands: +{{- if .Values.ingress.enabled }} +{{- range .Values.ingress.hosts }} + http://{{ . }} +{{- end }} +{{- else if contains "NodePort" .Values.service.frontend.type }} + export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ template "gbhelm.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.frontend.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 svc -w {{ template "gbhelm.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ template "gbhelm.fullname" . }} -o jsonpath='{.status.loadBalancer.ingress[0].ip}') + echo http://$SERVICE_IP:{{ .Values.service.externalPort }} +{{- else if contains "ClusterIP" .Values.service.frontend.type }} + export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app={{ template "gbhelm.name" . }},release={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") +{{- end }} diff --git a/docs/examples/guestbook/templates/_helpers.tpl b/docs/examples/guestbook/templates/_helpers.tpl new file mode 100644 index 000000000..3d9b261e2 --- /dev/null +++ b/docs/examples/guestbook/templates/_helpers.tpl @@ -0,0 +1,16 @@ +{{/* vim: set filetype=mustache: */}} +{{/* +Expand the name of the chart. +*/}} +{{- define "gbhelm.name" -}} +{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}} +{{- end -}} + +{{/* +Create a default fully qualified app name. +We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). +*/}} +{{- define "gbhelm.fullname" -}} +{{- $name := default .Chart.Name .Values.nameOverride -}} +{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}} +{{- end -}} diff --git a/docs/examples/guestbook/templates/frontend-deployment.yaml b/docs/examples/guestbook/templates/frontend-deployment.yaml new file mode 100644 index 000000000..7701c078d --- /dev/null +++ b/docs/examples/guestbook/templates/frontend-deployment.yaml @@ -0,0 +1,39 @@ +apiVersion: extensions/v1beta1 +kind: Deployment +metadata: + name: {{ "frontend" }} + labels: + app: {{ template "gbhelm.name" . }} + chart: {{ .Chart.Name }}-{{ .Chart.Version | replace "+" "_" }} + release: {{ .Release.Name }} + heritage: {{ .Release.Service }} +spec: + replicas: {{ "1" }} + template: + metadata: + labels: + app: {{ "guestbook" }} + tier: {{"frontend"}} + release: {{ .Release.Name }} + spec: + containers: + - name: {{ "php-redis" }} + image: "{{ .Values.image.frontend_deployment.repository }}:{{ .Values.image.frontend_deployment.tag }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + ports: + - containerPort: {{ .Values.service.frontend.port }} + livenessProbe: + httpGet: + path: / + port: {{ .Values.service.frontend.port }} + readinessProbe: + httpGet: + path: / + port: {{ .Values.service.frontend.port }} + resources: + requests: + cpu: {{"100m"}} + memory: {{"100Mi"}} + env: + - name: {{"GET_HOSTS_FROM"}} + value: {{"dns"}} diff --git a/docs/examples/guestbook/templates/frontend-service.yaml b/docs/examples/guestbook/templates/frontend-service.yaml new file mode 100644 index 000000000..a61d1bb7c --- /dev/null +++ b/docs/examples/guestbook/templates/frontend-service.yaml @@ -0,0 +1,17 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ "frontend" }} + labels: + app: {{ "guestbook" }} + tier: {{ "frontend" }} + chart: {{ .Chart.Name }}-{{ .Chart.Version | replace "+" "_" }} + release: {{ .Release.Name }} + heritage: {{ .Release.Service }} +spec: + type: {{ .Values.service.frontend.type }} + ports: + - port: {{.Values.service.frontend.port}} + selector: + app: {{.Values.service.frontend.selector.app}} + tier: {{.Values.service.frontend.selector.tier}} diff --git a/docs/examples/guestbook/templates/redis-master-deployment.yaml b/docs/examples/guestbook/templates/redis-master-deployment.yaml new file mode 100644 index 000000000..fa60f9f10 --- /dev/null +++ b/docs/examples/guestbook/templates/redis-master-deployment.yaml @@ -0,0 +1,29 @@ +apiVersion: extensions/v1beta1 +kind: Deployment +metadata: + name: {{ "redis-master" }} + labels: + app: {{ template "gbhelm.name" . }} + chart: {{ .Chart.Name }}-{{ .Chart.Version | replace "+" "_" }} + release: {{ .Release.Name }} + heritage: {{ .Release.Service }} +spec: + replicas: {{ "1" }} + template: + metadata: + labels: + app: {{ "redis" }} + tier: {{"backend"}} + role: {{"master"}} + release: {{ .Release.Name }} + spec: + containers: + - name: {{ "master" }} + image: "{{ .Values.image.redis_master.repository }}:{{ .Values.image.redis_master.tag }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + ports: + - containerPort: {{ "6379" }} + resources: + requests: + cpu: {{"100m"}} + memory: {{"100Mi"}} diff --git a/docs/examples/guestbook/templates/redis-master-service.yaml b/docs/examples/guestbook/templates/redis-master-service.yaml new file mode 100644 index 000000000..cc4aa5717 --- /dev/null +++ b/docs/examples/guestbook/templates/redis-master-service.yaml @@ -0,0 +1,19 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ "redis-master" }} + labels: + app: {{ "redis" }} + role: {{ "master" }} + tier: {{ "backend" }} + chart: {{ .Chart.Name }}-{{ .Chart.Version | replace "+" "_" }} + release: {{ .Release.Name }} + heritage: {{ .Release.Service }} +spec: + ports: + - port: {{ .Values.service.redis_master.port }} + targetPort: {{ .Values.service.redis_master.targetPort }} + selector: + app: {{ .Values.service.redis_master.selector.app}} + role: {{ .Values.service.redis_master.selector.role }} + tier: {{ .Values.service.redis_master.selector.tier }} diff --git a/docs/examples/guestbook/templates/redis-slave-deployment.yaml b/docs/examples/guestbook/templates/redis-slave-deployment.yaml new file mode 100644 index 000000000..fa313d623 --- /dev/null +++ b/docs/examples/guestbook/templates/redis-slave-deployment.yaml @@ -0,0 +1,32 @@ +apiVersion: extensions/v1beta1 +kind: Deployment +metadata: + name: {{ "redis-slave" }} + labels: + app: {{ template "gbhelm.name" . }} + chart: {{ .Chart.Name }}-{{ .Chart.Version | replace "+" "_" }} + release: {{ .Release.Name }} + heritage: {{ .Release.Service }} +spec: + replicas: {{ "1" }} + template: + metadata: + labels: + app: {{ "redis" }} + tier: {{"backend"}} + role: {{"slave"}} + release: {{ .Release.Name }} + spec: + containers: + - name: {{ "slave" }} + image: "{{ .Values.image.redis_slave.repository }}:{{ .Values.image.redis_slave.tag }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + ports: + - containerPort: {{ "6379" }} + resources: + requests: + cpu: {{"100m"}} + memory: {{"100Mi"}} + env: + - name: {{"GET_HOSTS_FROM"}} + value: {{"dns"}} diff --git a/docs/examples/guestbook/templates/redis-slave-service.yaml b/docs/examples/guestbook/templates/redis-slave-service.yaml new file mode 100644 index 000000000..bc128ec5f --- /dev/null +++ b/docs/examples/guestbook/templates/redis-slave-service.yaml @@ -0,0 +1,18 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ "redis-slave" }} + labels: + app: {{ "redis" }} + role: {{ "slave" }} + tier: {{ "backend" }} + chart: {{ .Chart.Name }}-{{ .Chart.Version | replace "+" "_" }} + release: {{ .Release.Name }} + heritage: {{ .Release.Service }} +spec: + ports: + - port: {{.Values.service.redis_slave.port}} + selector: + app: {{.Values.service.redis_slave.selector.app}} + role: {{.Values.service.redis_slave.selector.role}} + tier: {{.Values.service.redis_slave.selector.tier}} diff --git a/docs/examples/guestbook/values.yaml b/docs/examples/guestbook/values.yaml new file mode 100644 index 000000000..ffa694fdf --- /dev/null +++ b/docs/examples/guestbook/values.yaml @@ -0,0 +1,59 @@ +# Default values for mychart. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. +replicaCount: 1 +image: + frontend_deployment: + repository: gcr.io/google-samples/gb-frontend + tag: v4 + redis_master: + repository: gcr.io/google_containers/redis + tag: e2e + redis_slave: + repository: gcr.io/google_samples/gb-redisslave + tag: v1 + pullPolicy: IfNotPresent +service: + frontend: + type: LoadBalancer + port: 80 + selector: + app: guestbook + tier: frontend + redis_master: + port: 6379 + targetPort: 6379 + selector: + app: redis + role: master + tier: backend + redis_slave: + port: 6379 + selector: + app: redis + role: slave + tier: backend +ingress: + enabled: false + # Used to create an Ingress record. + hosts: + - chart-example.local + annotations: + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + tls: + # Secrets must be manually created in the namespace. + # - secretName: chart-example-tls + # hosts: + # - chart-example.local +resources: {} + # We usually recommend not to specify default resources and to leave this as a conscious + # choice for the user. This also increases chances charts run on environments with little + # resources, such as Minikube. If you do want to specify resources, uncomment the following + # lines, adjust them as necessary, and remove the curly braces after 'resources:'. + # limits: + # cpu: 100m + # memory: 128Mi + # requests: + # cpu: 100m + # memory: 128Mi