From 3b3250d0ca0778a6a80bf56cf940696e19073b59 Mon Sep 17 00:00:00 2001 From: Rafael Esposito Date: Wed, 20 Apr 2022 15:12:16 +0200 Subject: [PATCH 1/7] Created helm chart template --- chart/koa-mongo-k8s/.helmignore | 23 +++++ chart/koa-mongo-k8s/Chart.yaml | 24 ++++++ chart/koa-mongo-k8s/templates/NOTES.txt | 22 +++++ chart/koa-mongo-k8s/templates/_helpers.tpl | 62 ++++++++++++++ chart/koa-mongo-k8s/templates/deployment.yaml | 83 ++++++++++++++++++ chart/koa-mongo-k8s/templates/hpa.yaml | 28 +++++++ chart/koa-mongo-k8s/templates/ingress.yaml | 61 ++++++++++++++ .../templates/mongo-deployment.yaml | 38 +++++++++ .../templates/mongo-service.yaml | 14 ++++ chart/koa-mongo-k8s/templates/secret.yaml | 8 ++ chart/koa-mongo-k8s/templates/service.yaml | 15 ++++ .../templates/serviceaccount.yaml | 12 +++ .../templates/tests/test-connection.yaml | 15 ++++ chart/koa-mongo-k8s/values.yaml | 84 +++++++++++++++++++ 14 files changed, 489 insertions(+) create mode 100644 chart/koa-mongo-k8s/.helmignore create mode 100644 chart/koa-mongo-k8s/Chart.yaml create mode 100644 chart/koa-mongo-k8s/templates/NOTES.txt create mode 100644 chart/koa-mongo-k8s/templates/_helpers.tpl create mode 100644 chart/koa-mongo-k8s/templates/deployment.yaml create mode 100644 chart/koa-mongo-k8s/templates/hpa.yaml create mode 100644 chart/koa-mongo-k8s/templates/ingress.yaml create mode 100644 chart/koa-mongo-k8s/templates/mongo-deployment.yaml create mode 100644 chart/koa-mongo-k8s/templates/mongo-service.yaml create mode 100644 chart/koa-mongo-k8s/templates/secret.yaml create mode 100644 chart/koa-mongo-k8s/templates/service.yaml create mode 100644 chart/koa-mongo-k8s/templates/serviceaccount.yaml create mode 100644 chart/koa-mongo-k8s/templates/tests/test-connection.yaml create mode 100644 chart/koa-mongo-k8s/values.yaml diff --git a/chart/koa-mongo-k8s/.helmignore b/chart/koa-mongo-k8s/.helmignore new file mode 100644 index 0000000..0e8a0eb --- /dev/null +++ b/chart/koa-mongo-k8s/.helmignore @@ -0,0 +1,23 @@ +# 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 +*.orig +*~ +# Various IDEs +.project +.idea/ +*.tmproj +.vscode/ diff --git a/chart/koa-mongo-k8s/Chart.yaml b/chart/koa-mongo-k8s/Chart.yaml new file mode 100644 index 0000000..b5e8007 --- /dev/null +++ b/chart/koa-mongo-k8s/Chart.yaml @@ -0,0 +1,24 @@ +apiVersion: v2 +name: koajs-k8s +description: A Helm chart for Kubernetes + +# A chart can be either an 'application' or a 'library' chart. +# +# Application charts are a collection of templates that can be packaged into versioned archives +# to be deployed. +# +# Library charts provide useful utilities or functions for the chart developer. They're included as +# a dependency of application charts to inject those utilities and functions into the rendering +# pipeline. Library charts do not define any templates and therefore cannot be deployed. +type: application + +# This is the chart version. This version number should be incremented each time you make changes +# to the chart and its templates, including the app version. +# Versions are expected to follow Semantic Versioning (https://semver.org/) +version: 0.1.0 + +# This is the version number of the application being deployed. This version number should be +# incremented each time you make changes to the application. Versions are not expected to +# follow Semantic Versioning. They should reflect the version the application is using. +# It is recommended to use it with quotes. +appVersion: "1.16.0" diff --git a/chart/koa-mongo-k8s/templates/NOTES.txt b/chart/koa-mongo-k8s/templates/NOTES.txt new file mode 100644 index 0000000..50682e5 --- /dev/null +++ b/chart/koa-mongo-k8s/templates/NOTES.txt @@ -0,0 +1,22 @@ +1. Get the application URL by running these commands: +{{- if .Values.ingress.enabled }} +{{- range $host := .Values.ingress.hosts }} + {{- range .paths }} + http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }} + {{- end }} +{{- end }} +{{- else if contains "NodePort" .Values.service.type }} + export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "koajs-k8s.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 "koajs-k8s.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "koajs-k8s.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 "koajs-k8s.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 +{{- end }} diff --git a/chart/koa-mongo-k8s/templates/_helpers.tpl b/chart/koa-mongo-k8s/templates/_helpers.tpl new file mode 100644 index 0000000..e0f3515 --- /dev/null +++ b/chart/koa-mongo-k8s/templates/_helpers.tpl @@ -0,0 +1,62 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "koajs-k8s.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). +If release name contains chart name it will be used as a full name. +*/}} +{{- define "koajs-k8s.fullname" -}} +{{- if .Values.fullnameOverride }} +{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }} +{{- else }} +{{- $name := default .Chart.Name .Values.nameOverride }} +{{- if contains $name .Release.Name }} +{{- .Release.Name | trunc 63 | trimSuffix "-" }} +{{- else }} +{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }} +{{- end }} +{{- end }} +{{- end }} + +{{/* +Create chart name and version as used by the chart label. +*/}} +{{- define "koajs-k8s.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "koajs-k8s.labels" -}} +helm.sh/chart: {{ include "koajs-k8s.chart" . }} +{{ include "koajs-k8s.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "koajs-k8s.selectorLabels" -}} +app.kubernetes.io/name: {{ include "koajs-k8s.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} + +{{/* +Create the name of the service account to use +*/}} +{{- define "koajs-k8s.serviceAccountName" -}} +{{- if .Values.serviceAccount.create }} +{{- default (include "koajs-k8s.fullname" .) .Values.serviceAccount.name }} +{{- else }} +{{- default "default" .Values.serviceAccount.name }} +{{- end }} +{{- end }} diff --git a/chart/koa-mongo-k8s/templates/deployment.yaml b/chart/koa-mongo-k8s/templates/deployment.yaml new file mode 100644 index 0000000..da7729b --- /dev/null +++ b/chart/koa-mongo-k8s/templates/deployment.yaml @@ -0,0 +1,83 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "koajs-k8s.fullname" . }} + labels: + {{- include "koajs-k8s.labels" . | nindent 4 }} +spec: + {{- if not .Values.autoscaling.enabled }} + replicas: {{ .Values.replicaCount }} + {{- end }} + selector: + matchLabels: + {{- include "koajs-k8s.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "koajs-k8s.selectorLabels" . | nindent 8 }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + serviceAccountName: {{ include "koajs-k8s.serviceAccountName" . }} + securityContext: + {{- toYaml .Values.podSecurityContext | nindent 8 }} + containers: + - name: {{ .Chart.Name }} + securityContext: + {{- toYaml .Values.securityContext | nindent 12 }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + ports: + - name: http + containerPort: 4000 + livenessProbe: + httpGet: + path: /api/status + port: http + initialDelaySeconds: 1 + periodSeconds: 5 + readinessProbe: + httpGet: + path: /api/status + port: http + initialDelaySeconds: 5 + periodSeconds: 1 + env: + - name: MONGODB_NAME + value: mydb + - name: MONGODB_URI + value: mongodb://mongo:27017 + - name: MONGODB_USER + valueFrom: + secretKeyRef: + name: mongodb-secret + key: mongo-root-username + - name: MONGODB_PASS + valueFrom: + secretKeyRef: + name: mongodb-secret + key: mongo-root-password + lifecycle: + postStart: + exec: + command: ["/bin/sh", "-c", "npm run migrate:up"] + resources: + {{- toYaml .Values.resources | nindent 12 }} + {{- with .Values.nodeSelector }} + nodeSelector: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.affinity }} + affinity: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.tolerations }} + tolerations: + {{- toYaml . | nindent 8 }} + {{- end }} diff --git a/chart/koa-mongo-k8s/templates/hpa.yaml b/chart/koa-mongo-k8s/templates/hpa.yaml new file mode 100644 index 0000000..c5721c8 --- /dev/null +++ b/chart/koa-mongo-k8s/templates/hpa.yaml @@ -0,0 +1,28 @@ +{{- if .Values.autoscaling.enabled }} +apiVersion: autoscaling/v2beta1 +kind: HorizontalPodAutoscaler +metadata: + name: {{ include "koajs-k8s.fullname" . }} + labels: + {{- include "koajs-k8s.labels" . | nindent 4 }} +spec: + scaleTargetRef: + apiVersion: apps/v1 + kind: Deployment + name: {{ include "koajs-k8s.fullname" . }} + minReplicas: {{ .Values.autoscaling.minReplicas }} + maxReplicas: {{ .Values.autoscaling.maxReplicas }} + metrics: + {{- if .Values.autoscaling.targetCPUUtilizationPercentage }} + - type: Resource + resource: + name: cpu + targetAverageUtilization: {{ .Values.autoscaling.targetCPUUtilizationPercentage }} + {{- end }} + {{- if .Values.autoscaling.targetMemoryUtilizationPercentage }} + - type: Resource + resource: + name: memory + targetAverageUtilization: {{ .Values.autoscaling.targetMemoryUtilizationPercentage }} + {{- end }} +{{- end }} diff --git a/chart/koa-mongo-k8s/templates/ingress.yaml b/chart/koa-mongo-k8s/templates/ingress.yaml new file mode 100644 index 0000000..84f6dd4 --- /dev/null +++ b/chart/koa-mongo-k8s/templates/ingress.yaml @@ -0,0 +1,61 @@ +{{- if .Values.ingress.enabled -}} +{{- $fullName := include "koajs-k8s.fullname" . -}} +{{- $svcPort := .Values.service.port -}} +{{- if and .Values.ingress.className (not (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion)) }} + {{- if not (hasKey .Values.ingress.annotations "kubernetes.io/ingress.class") }} + {{- $_ := set .Values.ingress.annotations "kubernetes.io/ingress.class" .Values.ingress.className}} + {{- end }} +{{- end }} +{{- if semverCompare ">=1.19-0" .Capabilities.KubeVersion.GitVersion -}} +apiVersion: networking.k8s.io/v1 +{{- else if semverCompare ">=1.14-0" .Capabilities.KubeVersion.GitVersion -}} +apiVersion: networking.k8s.io/v1beta1 +{{- else -}} +apiVersion: extensions/v1beta1 +{{- end }} +kind: Ingress +metadata: + name: {{ $fullName }} + labels: + {{- include "koajs-k8s.labels" . | nindent 4 }} + {{- with .Values.ingress.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + {{- if and .Values.ingress.className (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion) }} + ingressClassName: {{ .Values.ingress.className }} + {{- end }} + {{- if .Values.ingress.tls }} + tls: + {{- range .Values.ingress.tls }} + - hosts: + {{- range .hosts }} + - {{ . | quote }} + {{- end }} + secretName: {{ .secretName }} + {{- end }} + {{- end }} + rules: + {{- range .Values.ingress.hosts }} + - host: {{ .host | quote }} + http: + paths: + {{- range .paths }} + - path: {{ .path }} + {{- if and .pathType (semverCompare ">=1.18-0" $.Capabilities.KubeVersion.GitVersion) }} + pathType: {{ .pathType }} + {{- end }} + backend: + {{- if semverCompare ">=1.19-0" $.Capabilities.KubeVersion.GitVersion }} + service: + name: {{ $fullName }} + port: + number: {{ $svcPort }} + {{- else }} + serviceName: {{ $fullName }} + servicePort: {{ $svcPort }} + {{- end }} + {{- end }} + {{- end }} +{{- end }} diff --git a/chart/koa-mongo-k8s/templates/mongo-deployment.yaml b/chart/koa-mongo-k8s/templates/mongo-deployment.yaml new file mode 100644 index 0000000..f2cb5ca --- /dev/null +++ b/chart/koa-mongo-k8s/templates/mongo-deployment.yaml @@ -0,0 +1,38 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + creationTimestamp: null + labels: + app: mongo + name: mongo +spec: + replicas: 1 + selector: + matchLabels: + app: mongo + strategy: {} + template: + metadata: + creationTimestamp: null + labels: + app: mongo + spec: + containers: + - image: registry.hub.docker.com/library/mongo + name: mongo + ports: + - containerPort: 27017 + env: + - name: MONGO_INITDB_ROOT_USERNAME + valueFrom: + secretKeyRef: + name: mongodb-secret + key: mongo-root-username + - name: MONGO_INITDB_ROOT_PASSWORD + valueFrom: + secretKeyRef: + name: mongodb-secret + key: mongo-root-password + resources: {} + restartPolicy: Always +status: {} diff --git a/chart/koa-mongo-k8s/templates/mongo-service.yaml b/chart/koa-mongo-k8s/templates/mongo-service.yaml new file mode 100644 index 0000000..bf8f95b --- /dev/null +++ b/chart/koa-mongo-k8s/templates/mongo-service.yaml @@ -0,0 +1,14 @@ +apiVersion: v1 +kind: Service +metadata: + creationTimestamp: null + labels: + app: mongo + name: mongo +spec: + ports: + - name: '27017' + port: 27017 + targetPort: 27017 + selector: + app: mongo diff --git a/chart/koa-mongo-k8s/templates/secret.yaml b/chart/koa-mongo-k8s/templates/secret.yaml new file mode 100644 index 0000000..eb6b8fc --- /dev/null +++ b/chart/koa-mongo-k8s/templates/secret.yaml @@ -0,0 +1,8 @@ +apiVersion: v1 +kind: Secret +metadata: + name: mongodb-secret +type: Opaque +data: + mongo-root-username: cm9vdA== + mongo-root-password: cGFzc3dvcmQ= \ No newline at end of file diff --git a/chart/koa-mongo-k8s/templates/service.yaml b/chart/koa-mongo-k8s/templates/service.yaml new file mode 100644 index 0000000..258c634 --- /dev/null +++ b/chart/koa-mongo-k8s/templates/service.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "koajs-k8s.fullname" . }} + labels: + {{- include "koajs-k8s.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: http + protocol: TCP + name: http + selector: + {{- include "koajs-k8s.selectorLabels" . | nindent 4 }} diff --git a/chart/koa-mongo-k8s/templates/serviceaccount.yaml b/chart/koa-mongo-k8s/templates/serviceaccount.yaml new file mode 100644 index 0000000..86fa60c --- /dev/null +++ b/chart/koa-mongo-k8s/templates/serviceaccount.yaml @@ -0,0 +1,12 @@ +{{- if .Values.serviceAccount.create -}} +apiVersion: v1 +kind: ServiceAccount +metadata: + name: {{ include "koajs-k8s.serviceAccountName" . }} + labels: + {{- include "koajs-k8s.labels" . | nindent 4 }} + {{- with .Values.serviceAccount.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +{{- end }} diff --git a/chart/koa-mongo-k8s/templates/tests/test-connection.yaml b/chart/koa-mongo-k8s/templates/tests/test-connection.yaml new file mode 100644 index 0000000..c50b74f --- /dev/null +++ b/chart/koa-mongo-k8s/templates/tests/test-connection.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Pod +metadata: + name: "{{ include "koajs-k8s.fullname" . }}-test-connection" + labels: + {{- include "koajs-k8s.labels" . | nindent 4 }} + annotations: + "helm.sh/hook": test +spec: + containers: + - name: wget + image: busybox + command: ['wget'] + args: ['{{ include "koajs-k8s.fullname" . }}:{{ .Values.service.port }}'] + restartPolicy: Never diff --git a/chart/koa-mongo-k8s/values.yaml b/chart/koa-mongo-k8s/values.yaml new file mode 100644 index 0000000..cc8ccb7 --- /dev/null +++ b/chart/koa-mongo-k8s/values.yaml @@ -0,0 +1,84 @@ +# Default values for koajs-k8s. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +replicaCount: 1 + +image: + repository: rafaelesposito/node-koa-boilerplate + pullPolicy: IfNotPresent + # Overrides the image tag whose default is the chart appVersion. + tag: "0.1.0" + +imagePullSecrets: [] +nameOverride: "" +fullnameOverride: "" + +serviceAccount: + # Specifies whether a service account should be created + create: true + # Annotations to add to the service account + annotations: {} + # The name of the service account to use. + # If not set and create is true, a name is generated using the fullname template + name: "" + +podAnnotations: {} + +podSecurityContext: {} + # fsGroup: 2000 + +securityContext: {} + # capabilities: + # drop: + # - ALL + # readOnlyRootFilesystem: true + # runAsNonRoot: true + # runAsUser: 1000 + +service: + type: NodePort + port: 4000 + +ingress: + enabled: false + className: "" + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + hosts: + - host: chart-example.local + paths: + - path: / + pathType: ImplementationSpecific + tls: [] + # - 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 + +autoscaling: + enabled: false + minReplicas: 1 + maxReplicas: 100 + targetCPUUtilizationPercentage: 80 + # targetMemoryUtilizationPercentage: 80 + +nodeSelector: {} + +tolerations: [] + +affinity: {} + + From 6b2056443adda29c9b708e54e6bc0a694570bb1a Mon Sep 17 00:00:00 2001 From: Rafael Esposito Date: Wed, 20 Apr 2022 16:49:08 +0200 Subject: [PATCH 2/7] Add Kubernetes deployment to readme --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.md b/README.md index 61e5c6d..f208f35 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,16 @@ A boilerplate for a simple API in [Node.js](https://nodejs.org/) using the [Koa. * [Node.js](https://nodejs.org/) v14.x or later * Connection details (URI, user, password and db name) to a running instance of [MongoDB](https://www.mongodb.com/) +### Prerequisites for Kubernetes deployment with Helm chart + +* You have [kubectl](https://kubernetes.io/docs/tasks/tools/) installed and configured for your cluster + +* You have a Kubernetes cluster like [Minikube](https://kubernetes.io/docs/setup/minikube/) + +* You have the [Helm](https://helm.sh/docs/intro/install/) command line installed + +* You have created and published a Docker image for your application, in this example we use the public repository rafaelesposito/node-koa-boilerplate + ## Installation Use the package manager [npm](https://www.npmjs.com/) to install the dependencies. @@ -57,6 +67,25 @@ Make sure your `.env` file has the line `NODE_ENV=development` commented out, th npm run build ``` +### Deploy to Kubernetes using the chart + +From the directory `chart` run: + +```sh +# Deploy with helm +helm install my-release koa-mongo-k8s +``` + +For change the database username and password create the secrets with base64 encoded: +```sh +echo -n 'username' | base64 +dXNlcm5hbWU= + +echo -n 'password' | base64 +cGFzc3dvcmQ= +``` +and replace the values ​​in the secret.yaml file. + ### API documentation Documentation built with [Swagger](https://swagger.io/) is available under "api/swagger-html" (only in development environment). From f394c769a947bc4f58b45a3a8999c1aa7cb82c6d Mon Sep 17 00:00:00 2001 From: Rafael Esposito Date: Wed, 4 May 2022 11:28:05 +0200 Subject: [PATCH 3/7] Fix readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3620073..f9b078c 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ A boilerplate for a simple API in [Node.js](https://nodejs.org/) using the [Koa. ### Prerequisites for Kubernetes deployment with Helm chart -* You have [kubectl](https://kubernetes.io/docs/tasks/tools/) installed and configured for your cluster +* You have [kubectl](https://kubernetes.io/docs/tasks/tools/) installed and configured for your cluster * You have a Kubernetes cluster like [Minikube](https://kubernetes.io/docs/setup/minikube/) From feb1d6cfba84dfd4b3a7108bad825ed7861105aa Mon Sep 17 00:00:00 2001 From: Rafael Esposito Date: Wed, 4 May 2022 11:33:32 +0200 Subject: [PATCH 4/7] Fix terminology readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f9b078c..dd5fe66 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ A boilerplate for a simple API in [Node.js](https://nodejs.org/) using the [Koa. * You have a Kubernetes cluster like [Minikube](https://kubernetes.io/docs/setup/minikube/) -* You have the [Helm](https://helm.sh/docs/intro/install/) command line installed +* You have the [Helm](https://helm.sh/docs/intro/install/) command-line installed * You have created and published a Docker image for your application, in this example we use the public repository rafaelesposito/node-koa-boilerplate From b3b03331cdf1611026f4e7ec6b5d7cc6e076ca6b Mon Sep 17 00:00:00 2001 From: Gianpaolo Macario Date: Wed, 4 May 2022 11:56:47 +0200 Subject: [PATCH 5/7] README.md: Cosmetic fixes --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index dd5fe66..07115ac 100644 --- a/README.md +++ b/README.md @@ -73,20 +73,22 @@ npm run build From the directory `chart` run: -```sh +```bash # Deploy with helm helm install my-release koa-mongo-k8s ``` -For change the database username and password create the secrets with base64 encoded: -```sh +For changing the database username and password create the secrets with base64 encoded: + +```bash echo -n 'username' | base64 dXNlcm5hbWU= echo -n 'password' | base64 cGFzc3dvcmQ= ``` -and replace the values ​​in the secret.yaml file. + +and replace the values in the `secret.yaml` file. ### API documentation From 84b654a3ba1f4b00e741fab4ffff79fb843c1a23 Mon Sep 17 00:00:00 2001 From: Gianpaolo Macario Date: Wed, 4 May 2022 11:58:03 +0200 Subject: [PATCH 6/7] secret.yaml: Add trailing EOL --- chart/koa-mongo-k8s/templates/secret.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/chart/koa-mongo-k8s/templates/secret.yaml b/chart/koa-mongo-k8s/templates/secret.yaml index eb6b8fc..f9d60dc 100644 --- a/chart/koa-mongo-k8s/templates/secret.yaml +++ b/chart/koa-mongo-k8s/templates/secret.yaml @@ -5,4 +5,4 @@ metadata: type: Opaque data: mongo-root-username: cm9vdA== - mongo-root-password: cGFzc3dvcmQ= \ No newline at end of file + mongo-root-password: cGFzc3dvcmQ= From 9a2eb1dc08d659fd4da9279bb21dec13262f879f Mon Sep 17 00:00:00 2001 From: Gianpaolo Macario Date: Wed, 4 May 2022 11:58:49 +0200 Subject: [PATCH 7/7] Update values.yaml --- chart/koa-mongo-k8s/values.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/chart/koa-mongo-k8s/values.yaml b/chart/koa-mongo-k8s/values.yaml index cc8ccb7..326648f 100644 --- a/chart/koa-mongo-k8s/values.yaml +++ b/chart/koa-mongo-k8s/values.yaml @@ -81,4 +81,4 @@ tolerations: [] affinity: {} - +# EOF