Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

51 lines (37 loc) · 1.64 KB
Raw

Development environment

Get the latest development version. Fork and clone the repo:

$ git clone [email protected]:<your-username>/helm-charts.git

Install Helm and Skaffold.

Install a local Kubernetes cluster:

  • Docker Desktop - recommended
  • Kind - it needs additional configuration to expose ingress 👇
  • K3d - not supported yet

Kind cluster

Kind does not expose ports by default. To enable this, you need to create the cluster with the following command:

$ kind create cluster --config kind-config.yaml

That's it. You should be ready to make changes, run tests, and make commits! 🎉

Running skaffold

Run skaffold in the root of the repo:

$ skaffold dev

Wait for the deployment to finish. You can check the status of the deployment in console. When it is ready, open the browser and go to http://localhost. You should see the Studio page.

Note

Skaffold contains a configuration to install ingress-nginx for kind and docker-desktop. The profile will be used automatically when you run skaffold with the dev profile and the name of the current kubeContext matches kind-* or docker-desktop.

Skaffold profile - local

If you want to run skaffold with local profile, you need to create values-local-dev.yaml file in charts/studio/values-local-dev.yaml. The values should contain the overrides for the values of the chart.

To use the profile, run skaffold with following command:

$ skaffold dev -p local