From 6eb1ca375f7be5fe86926b6110d1394d12fc24f7 Mon Sep 17 00:00:00 2001
From: Chi-En Wu <jason.wu@hahow.in>
Date: Wed, 22 Apr 2020 15:33:50 +0800
Subject: [PATCH] docs: add description about `common.service`

---
 README.md | 116 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 115 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 45f2346..2796415 100644
--- a/README.md
+++ b/README.md
@@ -40,4 +40,118 @@ A limitation of the Go template library is that a template can only take a singl
 
 The `common.service` template is responsible for rendering the templates with the root context and merging any overrides. As you can see, this makes it very easy to create a basic `Service` resource without having to copy around the standard metadata and labels.
 
-Each implemented base resource is described in greater detail below.
\ No newline at end of file
+Each implemented base resource is described in greater detail below.
+
+
+
+### `common.service`
+
+The `common.service` template accepts a list of three values:
+
+- the top context
+- `$service`, a dictionary of values used in the service template
+- [optional] the template name of the overrides
+
+It creates a basic `Service` resource with the following defaults:
+
+- Service type (ClusterIP, NodePort, LoadBalancer) made configurable by `$service.type`
+- Named port `http` configured on port `$service.port`
+- Selector set to
+
+  ```yaml
+  app.kubernetes.io/name: {{ template "common.name" }}
+  app.kubernetes.io/instance: {{ .Release.Name }}
+  ```
+
+  to match the default used in the `Deployment` resource
+
+Example template:
+
+```yaml
+{{- template "common.service" (list . .Values.service "mychart.mail.service") -}}
+{{- define "mychart.mail.service" -}}
+{{- $top := first . -}}
+metadata:
+  name: {{ template "common.fullname" $top }}-mail  # overrides the default name to add a suffix
+  labels:                                           # appended to the labels section
+    protocol: mail
+spec:
+  ports:                                            # composes the `ports` section of the service definition.
+  - name: smtp
+    port: 25
+    targetPort: 25
+  - name: imaps
+    port: 993
+    targetPort: 993
+  selector:                                         # this is appended to the default selector
+    protocol: mail
+{{- end }}
+---
+{{ template "common.service" (list . .Values.service "mychart.web.service") -}}
+{{- define "mychart.web.service" -}}
+{{- $top := first . -}}
+metadata:
+  name: {{ template "common.fullname" $top }}-www   # overrides the default name to add a suffix
+  labels:                                           # appended to the labels section
+    protocol: www
+spec:
+  ports:                                            # composes the `ports` section of the service definition.
+  - name: www
+    port: 80
+    targetPort: 8080
+{{- end -}}
+```
+
+The above template defines _two_ services: a web service and a mail service.
+
+The most important part of a service definition is the `ports` object, which defines the ports that this service will listen on. Most of the time, `selector` is computed for you. But you can replace it or add to it.
+
+The output of the example above is:
+
+```yaml
+apiVersion: v1
+kind: Service
+metadata:
+  labels:
+    app.kubernetes.io/instance: release-name
+    app.kubernetes.io/managed-by: Helm
+    app.kubernetes.io/name: mychart
+    app.kubernetes.io/version: 1.16.0
+    helm.sh/chart: mychart-0.1.0
+    protocol: www
+  name: release-name-mychart-www
+spec:
+  ports:
+  - name: www
+    port: 80
+    targetPort: 8080
+  selector:
+    app.kubernetes.io/instance: release-name
+    app.kubernetes.io/name: mychart
+  type: ClusterIP
+---
+apiVersion: v1
+kind: Service
+metadata:
+  labels:
+    app.kubernetes.io/instance: release-name
+    app.kubernetes.io/managed-by: Helm
+    app.kubernetes.io/name: mychart
+    app.kubernetes.io/version: 1.16.0
+    helm.sh/chart: mychart-0.1.0
+    protocol: mail
+  name: release-name-mychart-mail
+spec:
+  ports:
+  - name: smtp
+    port: 25
+    targetPort: 25
+  - name: imaps
+    port: 993
+    targetPort: 993
+  selector:
+    app.kubernetes.io/instance: release-name
+    app.kubernetes.io/name: mychart
+    protocol: mail
+  type: ClusterIP
+```