| |
@@ -0,0 +1,43 @@
|
| |
+ # Developing with the Helm Chart
|
| |
+ > This docu provides you detailed instructions for easily developing
|
| |
+ > this Helm Chart (ie. testing, deploying the app et. al.)
|
| |
+
|
| |
+ ## Prerequisites
|
| |
+
|
| |
+ In order to start hacking locally without hassle, you're gonna need to install
|
| |
+ * [k3d][1] - installation instructions in readme
|
| |
+ * [kubectl][2] - for running commands in the Kubernetes cluster
|
| |
+
|
| |
+ ## Spinning up a mini Kubernetes cluster locally
|
| |
+ Helm Charts run on Kubernetes, therefore a Kubernetes cluster is a requirement, this is
|
| |
+ how you can spin up your tiny Kubernetes cluster locally with [k3d][1]
|
| |
+
|
| |
+ ```bash
|
| |
+ # create the cluster
|
| |
+ k3d create
|
| |
+
|
| |
+ # authenticate to execute commands in cluster
|
| |
+ export KUBECONFIG="$(k3d get-kubeconfig --name='k3s-default')"
|
| |
+
|
| |
+ # check if you have the cluster ready
|
| |
+ kubectl get nodes -owide
|
| |
+ ```
|
| |
+
|
| |
+ ## Start hacking
|
| |
+
|
| |
+ Install the helm chart in your local Kubernetes cluster now
|
| |
+
|
| |
+ ```bash
|
| |
+ helm install --name pagure helm/pagure
|
| |
+ ```
|
| |
+
|
| |
+ ## Teardown
|
| |
+
|
| |
+ If you decide to call it a day, just destroy the local Kubernetes cluster
|
| |
+
|
| |
+ ```bash
|
| |
+ k3d delete
|
| |
+ ```
|
| |
+
|
| |
+ [1]: https://github.com/rancher/k3d
|
| |
+ [2]: https://kubernetes.io/docs/tasks/tools/install-kubectl/
|
| |
\ No newline at end of file
|
| |
just pushed it to https://hub.docker.com/repository/docker/dminca/pagure-web for now, to catch some speed; will update the image later on