diff --git a/README.md b/README.md index cf56fee..9a8f8c1 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,63 @@ # demo-helm -A demo helm chart to deploy a simple web app written in Python +A demo helm chart to deploy a simple web app written in Python. +## Build and push the sample app image + +Use the `Makefile` to build and push the image. + +``` +make push-app-image +``` + +## Helm install/upgrade + +### New Deployments + +``` +helm install charts/demo-helm +OR +helm install charts/demo-helm --generate-name +``` + +### Upgrading Deployments + +Get your deployment ID +``` +helm list +``` + +``` +helm upgrade demo-helm-1633825301 charts/demo-helm +``` ## Setting registry pull secrets -From: [The k8s docs](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/#create-a-secret-by-providing-credentials-on-the-command-line) +You have to have an image pull secret. So first you need the secrets: + +From: [The k8s docs] ``` kubectl create secret docker-registry regcred \ - --docker-server= \ + --docker-server=https://registry.runcible.io \ --docker-username= \ --docker-password= \ --docker-email= -``` \ No newline at end of file +``` + +Then you need to specify the secret in your deployment spec like so: + +``` + spec: + containers: + - image: registry.runcible.io/demo-helm:1.0.1 + imagePullPolicy: Always + name: backend + ports: + - name: backend + containerPort: 5000 + imagePullSecrets: + - name: regcred +``` + +[The k8s docs](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/#create-a-secret-by-providing-credentials-on-the-command-line) \ No newline at end of file