home/charts
2
0
Fork 0
mirror of https://github.com/wahyd4/charts.git synced 2026-08-20 18:46:11 +10:00
Code Issues Packages Projects Releases Wiki Activity

Use 'node' chart as base for 'mean'

Browse Source
This commit is contained in:
Carlos Rodriguez Hernandez
2018-05-21 12:18:05 +02:00
parent d3f7012d79
commit 3c8d46fa34
12 changed files with 648 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
bitnami/mean-prod/Chart.yaml
+17
View File
@@ -0,0 +1,17 @@
name: node
version: 2.0.1
appVersion: 9.11.1
description: Event-driven I/O server-side JavaScript environment based on V8
keywords:
- node
- javascript
- nodejs
- git
home: http://nodejs.org/
sources:
- https://github.com/bitnami/bitnami-docker-node
maintainers:
- name: Bitnami
email: containers@bitnami.com
engine: gotpl
icon: https://bitnami.com/assets/stacks/nodejs/img/nodejs-stack-110x117.png
bitnami/mean-prod/README.md
+211
View File
@@ -0,0 +1,211 @@
# Node
[Node](https://www.nodejs.org) Event-driven I/O server-side JavaScript environment based on V8
## TL;DR
```console
$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm install bitnami/node
```
## Introduction
This chart bootstraps a [Node](https://github.com/bitnami/bitnami-docker-node) deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
It clones and deploys a Node.js application from a git repository. Optionally you can set un an Ingress resource to access your application and provision an external database using the k8s service catalog and the Open Service Broker for Azure.
## Prerequisites
- Kubernetes 1.4+ with Beta APIs enabled
- PV provisioner support in the underlying infrastructure
## Installing the Chart
To install the chart with the release name `my-release`:
```console
$ helm install --name my-release bitnami/node
```
The command deploys Node.js on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation. Also includes support for MariaDB chart out of the box.
Due that the Helm Chart clones the application on the /app volume while the container is initializing, a persistent volume is not required.
> **Tip**: List all releases using `helm list`
## Uninstalling the Chart
To uninstall/delete the `my-release` deployment:
```console
$ helm delete my-release
```
The command removes all the Kubernetes components associated with the chart and deletes the release.
## Configuration
The following table lists the configurable parameters of the Node chart and their default values.
| Parameter | Description | Default |
|-----------------------------------------|-----------------------------------------------------------|-----------------------------------------------------------|
| `image.registry` | NodeJS image registry | `docker.io` |
| `image.repository` | NodeJS Image name | `bitnami/node` |
| `image.tag` | NodeJS Image tag | `{VERSION}` |
| `image.pullPolicy` | NodeJS image pull policy | `IfNotPresent` |
| `image.pullSecrets` | Specify image pull secrets | `nil` (does not add image pull secrets to deployed pods) |
| `gitImage.registry` | Git image registry | `docker.io` |
| `gitImage.repository` | Git Image name | `alpine/git` |
| `gitImage.tag` | Git Image tag | `latest` |
| `gitImage.pullPolicy` | Git image pull policy | `Always` if `imageTag` is `latest`, else `IfNotPresent` |
| `gitImage` | Image used for initContainers | `alpine/git` |
| `repository` | Repo of the application | `https://github.com/bitnami/sample-mean.git` |
| `revision` | Revision to checkout | `master` |
| `replicas` | Number of replicas for the application | `1` |
| `applicationPort` | Port where the application will be running | `3000` |
| `serviceType` | Kubernetes Service type | `LoadBalancer` |
| `persistence.enabled` | Enable persistence using PVC | `false` |
| `persistence.path` | Path to persisted directory | `/app/data` |
| `persistence.accessMode` | PVC Access Mode | `ReadWriteOnce` |
| `persistence.size` | PVC Storage Request | `1Gi` |
| `mongodb.install` | Wheter to install or not the MongoDB chart | `true` |
| `externaldb.secretName` | Secret containing existing database credentials | `nil` |
| `externaldb.type` | Type of database that defines the database secret mapping | `osba` |
| `externaldb.broker.serviceInstanceName` | The existing ServiceInstance to be used | `nil` |
| `ingress.enabled` | Enable ingress creation | `false` |
| `ingress.path` | Ingress path | `/` |
| `ingress.host` | Ingress host | `example.local` |
| `ingress.tls` | TLS configuration for the ingress | `{}` |
The above parameters map to the env variables defined in [bitnami/node](http://github.com/bitnami/bitnami-docker-node). For more information please refer to the [bitnami/node](http://github.com/bitnami/bitnami-docker-node) image documentation.
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
```console
$ helm install --name my-release \
--set repository=https://github.com/jbianquetti-nami/simple-node-app.git,replicas=2 \
bitnami/node
```
The above command clones the remote git repository to the `/app/` directory of the container. Additionally it sets the number of `replicas` to `2`.
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,
```console
$ helm install --name my-release -f values.yaml bitnami/node
```
> **Tip**: You can use the default [values.yaml](values.yaml)
## Persistence
The [Bitnami Node](https://github.com/bitnami/bitnami-docker-node) image stores the Node application and configurations at the `/app` path of the container.
Persistent Volume Claims are used to keep the data across deployments. This is known to work in GCE, AWS, and minikube.
See the [Configuration](#configuration) section to configure the PVC or to disable persistence.
## Set up an Ingress controller
First install the nginx-ingress controller via helm:
```
$ helm install stable/nginx-ingress
```
Now deploy the node helm chart:
```
$ helm install --name my-release bitnami/node --set ingress.enabled=true,ingress.host=example.com,serviceType=ClusterIP
```
### Configure TLS termination for your ingress controller
You must manually create a secret containing the certificate and key for your domain. You can do it with this command:
```
$ kubectl create secret tls my-tls-secret --cert=path/to/file.cert --key=path/to/file.key
```
Then ensure you deploy the Helm chart with the following ingress configuration:
```
ingress:
enabled: false
path: /
host: example.com
annotations:
kubernetes.io/ingress.class: nginx
tls:
hosts:
- example.com
```
## Connect your application to an already existing database
1. Create a secret containing your database credentials:
```
$ kubectl create secret generic my-database-secret --from-literal=host=YOUR_DATABASE_HOST --from-literal=port=YOUR_DATABASE_PORT --from-literal=username=YOUR_DATABASE_USER --from-literal=password=YOUR_DATABASE_PASSWORD --from-literal=database=YOUR_DATABASE_NAME
```
`YOUR_DATABASE_HOST`, `YOUR_DATABASE_PORT`, `YOUR_DATABASE_USER`, `YOUR_DATABASE_PASSWORD`, and `YOUR_DATABASE_NAME` are placeholders that must be replaced with correct values.
2. Deploy the node chart specifying the secret name
```
$ helm install --name node-app --set mongodb.install=false,externaldb.secretName=my-database-secret bitnami/node
```
## Provision a database using the Open Service Broker for Azure
1. Install Service Catalog in your Kubernetes cluster following [this instructions](https://kubernetes.io/docs/tasks/service-catalog/install-service-catalog-using-helm/)
2. Install the Open Service Broker for Azure in your Kubernetes cluster following [this instructions](https://github.com/Azure/open-service-broker-azure/tree/master/contrib/k8s/charts/open-service-broker-azure)
> TIP: you may want to install the osba chart setting the `modules.minStability=EXPERIMENTAL` to see all the available services.
>
> $ helm install azure/open-service-broker-azure --name osba --namespace osba \
> --set azure.subscriptionId=$AZURE_SUBSCRIPTION_ID \
> --set azure.tenantId=$AZURE_TENANT_ID \
> --set azure.clientId=$AZURE_CLIENT_ID \
> --set azure.clientSecret=$AZURE_CLIENT_SECRET \
> --set modules.minStability=EXPERIMENTAL
3. Create and deploy a ServiceInstance to provision a database server in Azure cloud.
```
apiVersion: servicecatalog.k8s.io/v1beta1
kind: ServiceInstance
metadata:
name: azure-mongodb-instance
labels:
app: mongodb
spec:
clusterServiceClassExternalName: azure-cosmosdb-mongo-account
clusterServicePlanExternalName: account
parameters:
location: YOUR_AZURE_LOCATION
resourceGroup: mongodb-k8s-service-catalog
ipFilters:
allowedIPRanges:
- "0.0.0.0/0"
```
Please update the `YOUR_AZURE_LOCATION` placeholder in the above example.
```
$ kubectl create -f mongodb-service-instance.yml
```
4. Deploy the helm chart:
```
$ helm install --name node-app --set mongodb.install=false,externaldb.broker.serviceInstanceName=azure-mongodb-instance bitnami/node
```
Once the instance has been provisioned in Azure, a new secret should have been automatically created with the connection parameters for your application.
Deploying the helm chart enabling the Azure external database makes the following assumptions:
- You would want an Azure CosmosDB MongoDB database
- Your application uses DATABASE_HOST, DATABASE_PORT, DATABASE_USER, DATABASE_PASSWORD, and DATABASE_NAME environment variables to connect to the database.
You can read more about the kubernetes service catalog at https://github.com/kubernetes-bitnami/service-catalog
bitnami/mean-prod/requirements.lock
+9
View File
@@ -0,0 +1,9 @@
dependencies:
- name: mongodb
repository: https://kubernetes-charts.storage.googleapis.com/
version: 2.0.2
- name: bitnami-common
repository: https://charts.bitnami.com/bitnami
version: 0.0.3
digest: sha256:ee5c2000d2e7598d1c82e0a1aceb87fb96a77a1b95efed2e281205471f1d055c
generated: 2018-04-23T15:42:13.156026+02:00
bitnami/mean-prod/requirements.yaml
+8
View File
@@ -0,0 +1,8 @@
dependencies:
- name: mongodb
repository: https://kubernetes-charts.storage.googleapis.com/
version: x.x.x
condition: mongodb.install
- name: bitnami-common
repository: https://charts.bitnami.com/bitnami
version: 0.0.x
bitnami/mean-prod/templates/NOTES.txt
+23
View File
@@ -0,0 +1,23 @@
1. Get the URL of your Node app by running:
{{- if contains "NodePort" .Values.serviceType }}
export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ template "node.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.serviceType }}
NOTE: It may take a few minutes for the LoadBalancer IP to be available.
Watch the status with: 'kubectl get svc -w {{ template "node.fullname" . }} --namespace {{ .Release.Namespace }}'
export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ template "node.fullname" . }} -o jsonpath='{.status.loadBalancer.ingress[0].ip}')
echo http://$SERVICE_IP/
{{- else if contains "ClusterIP" .Values.serviceType }}
export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app={{ template "node.name" . }}" -o jsonpath="{.items[0].metadata.name}")
kubectl port-forward $POD_NAME 3000:3000
Access to http://127.0.0.1:3000/
{{- end }}
bitnami/mean-prod/templates/_helpers.tpl
+42
View File
@@ -0,0 +1,42 @@
{{/* vim: set filetype=mustache: */}}
{{/*
Expand the name of the chart.
*/}}
{{- define "node.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 "node.fullname" -}}
{{- $name := default .Chart.Name .Values.nameOverride -}}
{{- printf "%s-%s" .Release.Name $name | 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 "node.mongodb.fullname" -}}
{{- printf "%s-%s" .Release.Name "mongodb" | trunc 63 | trimSuffix "-" -}}
{{- end -}}
{{/*
Create chart name and version as used by the chart label.
*/}}
{{- define "node.chart" -}}
{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
{{- end -}}
{{/*
Custom template to get proper service name
*/}}
{{- define "node.secretName" -}}
{{- if .Values.externaldb.secretName }}
{{- printf "%s" .Values.externaldb.secretName }}
{{- else }}
{{- printf "%s-%s" .Release.Name "mongodb-binding" | trunc 63 | trimSuffix "-" -}}
{{- end }}
{{- end -}}
bitnami/mean-prod/templates/deployment.yaml
+138
View File
@@ -0,0 +1,138 @@
apiVersion: extensions/v1beta1
kind: Deployment
metadata:
name: {{ template "node.fullname" . }}
labels:
app: {{ template "node.name" . }}
chart: {{ template "node.chart" . }}
release: "{{ .Release.Name }}"
heritage: "{{ .Release.Service }}"
spec:
replicas: {{ .Values.replicas }}
template:
metadata:
labels:
app: {{ template "node.name" . }}
release: {{ .Release.Name | quote }}
spec:
{{- if .Values.image.pullSecrets }}
imagePullSecrets:
{{- range .Values.image.pullSecrets }}
- name: {{ . }}
{{- end}}
{{- end }}
initContainers:
- name: git-clone-repository
image: "{{ .Values.gitImage.registry }}/{{ .Values.gitImage.repository }}:{{ .Values.gitImage.tag }}"
imagePullPolicy: {{ .Values.gitImage.pullPolicy | quote }}
command: [ '/bin/sh', '-c' , 'git clone {{ .Values.repository }} /app && cd /app && git checkout {{ .Values.revision }}']
volumeMounts:
- name: app
mountPath: /app
- name: npm-install
image: "{{ .Values.image.registry }}/{{ .Values.image.repository }}:{{ .Values.image.tag }}"
imagePullPolicy: {{ .Values.image.pullPolicy | quote }}
workingDir: /app
command: ['/bin/bash', '-c', 'useradd bitnami && chown -R bitnami:bitnami /app && npm install']
volumeMounts:
- name: app
mountPath: /app
containers:
- name: {{ template "node.fullname" . }}
image: "{{ .Values.image.registry }}/{{ .Values.image.repository }}:{{ .Values.image.tag }}"
imagePullPolicy: {{ .Values.image.pullPolicy | quote }}
env:
{{- if .Values.mongodb.install }}
- name: DATABASE_HOST
value: {{ template "node.mongodb.fullname" . }}
- name: DATABASE_PORT
value: "27017"
- name: DATABASE_USER
value: {{ .Values.mongodb.mongodbUsername | quote }}
- name: DATABASE_PASSWORD
valueFrom:
secretKeyRef:
name: {{ template "node.mongodb.fullname" . }}
key: mongodb-password
- name: DATABASE_NAME
value: {{ .Values.mongodb.mongodbDatabase | quote }}
- name: DATABASE_CONNECTION_OPTIONS
value: ""
{{ else }}
{{- $type := dict "type" .Values.externaldb.type }}
- name: DATABASE_HOST
valueFrom:
secretKeyRef:
name: {{ template "node.secretName" . }}
key: {{ template "externaldb.host" $type }}
{{- if not .Values.externaldb.broker.serviceInstanceName }}
- name: DATABASE_NAME
valueFrom:
secretKeyRef:
name: {{ template "node.secretName" . }}
key: database
{{ else }}
- name: DATABASE_NAME
value: ""
{{- end }}
- name: DATABASE_PORT
valueFrom:
secretKeyRef:
name: {{ template "node.secretName" . }}
key: {{ template "externaldb.port" $type }}
- name: DATABASE_USER
valueFrom:
secretKeyRef:
name: {{ template "node.secretName" . }}
key: {{ template "externaldb.username" $type }}
- name: DATABASE_PASSWORD
valueFrom:
secretKeyRef:
name: {{ template "node.secretName" . }}
key: {{ template "externaldb.password" $type }}
{{- if .Values.externaldb.ssl }}
- name: DATABASE_CONNECTION_OPTIONS
value: "ssl=true"
{{ else }}
- name: DATABASE_CONNECTION_OPTIONS
value: ""
{{- end }}
{{- end }}
- name: DATA_FOLDER
value: "/app"
workingDir: /app
command: ['/bin/bash', '-c', 'useradd bitnami && su bitnami -c "PATH=/opt/bitnami/node/bin:$PATH npm start"']
ports:
- name: http
containerPort: {{ .Values.applicationPort }}
livenessProbe:
httpGet:
path: /
port: http
initialDelaySeconds: 60
timeoutSeconds: 5
failureThreshold: 6
readinessProbe:
httpGet:
path: /
port: http
initialDelaySeconds: 10
timeoutSeconds: 3
periodSeconds: 5
resources:
{{ toYaml .Values.resources | indent 10 }}
volumeMounts:
- name: app
mountPath: /app
- name: data
mountPath: {{ .Values.persistence.path }}
volumes:
- name: app
emptyDir: {}
- name: data
{{- if .Values.persistence.enabled }}
persistentVolumeClaim:
claimName: {{ template "fullname" . }}
{{- else }}
emptyDir: {}
{{- end }}
bitnami/mean-prod/templates/ingress.yaml
+28
View File
@@ -0,0 +1,28 @@
{{- if .Values.ingress.enabled -}}
apiVersion: extensions/v1beta1
kind: Ingress
metadata:
labels:
app: {{ template "node.name" . }}
chart: {{ template "node.chart" . }}
heritage: {{ .Release.Service }}
release: {{ .Release.Name }}
name: {{ template "node.fullname" . }}
annotations:
{{- range $key, $value := .Values.ingress.annotations }}
{{ $key }}: {{ $value | quote }}
{{- end }}
spec:
rules:
- host: {{ .Values.ingress.host }}
http:
paths:
- path: {{ .Values.ingress.path }}
backend:
serviceName: {{ include "node.fullname" . }}
servicePort: 80
{{- if .Values.ingress.tls }}
tls:
{{ toYaml .Values.ingress.tls | indent 4 }}
{{- end -}}
{{- end -}}
bitnami/mean-prod/templates/mongodb-binding.yaml
+15
View File
@@ -0,0 +1,15 @@
{{- if .Values.externaldb.broker.serviceInstanceName }}
apiVersion: servicecatalog.k8s.io/v1beta1
kind: ServiceBinding
metadata:
name: {{ template "node.mongodb.fullname" . }}-binding
labels:
app: {{ template "node.name" . }}
chart: {{ template "node.chart" . }}
release: "{{ .Release.Name }}"
heritage: "{{ .Release.Service }}"
spec:
instanceRef:
name: {{ .Values.externaldb.broker.serviceInstanceName }}
secretName: {{ template "node.secretName" . }}
{{- end }}
bitnami/mean-prod/templates/pvc.yaml
+23
View File
@@ -0,0 +1,23 @@
{{- if .Values.persistence.enabled }}
kind: PersistentVolumeClaim
apiVersion: v1
metadata:
name: {{ template "node.fullname" . }}
labels:
app: {{ template "node.name" . }}
chart: {{ template "node.chart" . }}
release: "{{ .Release.Name }}"
heritage: "{{ .Release.Service }}"
annotations:
{{- if .Values.persistence.storageClass }}
volume.beta.kubernetes.io/storage-class: {{ .Values.persistence.storageClass | quote }}
{{- else }}
volume.alpha.kubernetes.io/storage-class: default
{{- end }}
spec:
accessModes:
- {{ .Values.persistence.accessMode | quote }}
resources:
requests:
storage: {{ .Values.persistence.size | quote }}
{{- end }}
bitnami/mean-prod/templates/svc.yaml
+18
View File
@@ -0,0 +1,18 @@
apiVersion: v1
kind: Service
metadata:
name: {{ template "node.fullname" . }}
labels:
app: {{ template "node.name" . }}
chart: {{ template "node.chart" . }}
release: "{{ .Release.Name }}"
heritage: "{{ .Release.Service }}"
spec:
type: {{ .Values.serviceType }}
ports:
- name: http
port: 80
targetPort: http
selector:
app: {{ template "node.name" . }}
release: "{{ .Release.Name }}"
bitnami/mean-prod/values.yaml
+116
View File
@@ -0,0 +1,116 @@
## Bitnami node image version
## ref: https://hub.docker.com/r/bitnami/node/tags/
##
image:
registry: docker.io
repository: bitnami/node
tag: 9.11.1-prod
## Specify a imagePullPolicy
## Defaults to 'Always' if image tag is 'latest', else set to 'IfNotPresent'
## ref: http://kubernetes.io/docs/user-guide/images/#pre-pulling-images
##
pullPolicy: IfNotPresent
## Optionally specify an array of imagePullSecrets.
## Secrets must be manually created in the namespace.
## ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
##
# pullSecrets:
# - myRegistrKeySecretName
gitImage:
registry: docker.io
repository: alpine/git
tag: latest
pullPolicy: IfNotPresent
## Git repository http/https
##
repository: https://github.com/bitnami/sample-mean.git
## Git repository revision to checkout
##
revision: master
## Specify the number of replicas for the application
##
replicas: 1
## Specify the port where your applucation will be running
##
applicationPort: 3000
## Kubernetes configuration
## For minikube, set this to NodePort, elsewhere use LoadBalancer
##
serviceType: ClusterIP
## Enable persistence using Persistent Volume Claims
## ref: http://kubernetes.io/docs/user-guide/persistent-volumes/
##
persistence:
enabled: false
path: /app/data
## If defined, volume.beta.kubernetes.io/storage-class: <storageClass>
## Default: volume.alpha.kubernetes.io/storage-class: default
##
# storageClass:
accessMode: ReadWriteOnce
size: 1Gi
## Configure resource requests and limits
## ref: http://kubernetes.io/docs/user-guide/compute-resources/
##
resources: {}
# limits:
# cpu: 500m
# memory: 512Mi
# requests:
# cpu: 500m
# memory: 512Mi
##
## MongoDB chart configuration
##
mongodb:
## Whether to deploy a mongodb server to satisfy the applications database requirements.
## To use an external database set this to false and configure the externaldb parameters
install: true # Check mongodb chart for configuration values
## MongoDB custom user and database
## ref: https://github.com/bitnami/bitnami-docker-mongodb/blob/master/README.md#creating-a-user-and-database-on-first-run
##
mongodbUsername: user
mongodbDatabase: test_db
mongodbPassword: secret_password
## Provision an external database (Only if mongodb.install is false)
## You can:
## 1) Pass an already existing Secret with your database credentials
## 2) Pass an already existing ServiceInstance name and specify the service catalog broker to automatically create a ServiceBinding for your application.
externaldb:
# Set to true if your external database has ssl enabled
ssl: false
# You can use an existing secret containing your database credentials
# Please refer to the respective section in the README to know the details about this secret.
secretName:
# Only if using Kubernetes Service Catalog you can specify the kind of broker used. Available options are osba|gce|aws
type: osba
# If you provide the serviceInstanceName, the chart will create a ServiceBinding for that ServiceInstance
broker:
serviceInstanceName:
## Configure ingress resource that allow you to access the application.
## ref: http://kubernetes.io/docs/user-guide/ingress/
##
ingress:
enabled: false
path: /
# Used to create an Ingress record.
host: example.local
# annotations:
# kubernetes.io/ingress.class: nginx
# kubernetes.io/tls-acme: "true"
# tls:
# Secrets must be manually created in the namespace.
# - secretName: your-tls-cert
# hosts:
# - example.local