Synax Helm Charts

This repository hosts some helm charts which we commonly use in our projects. Kubernetes

Install Helm

Get the latest Helm release.

Install Charts

You need to add this Chart repo to Helm:

helm repo add synax https://charts.synax.io/
helm repo update

Note: For instructions on how to install a chart follow instructions in its README.md.

Contributing to Charts

Fork the repo, make changes and then please run make lint to lint charts locally, and at last install the chart to see it is working. :)

On success make a pull request (PR).

Upon successful review, someone will give the PR a LGTM (looks good to me) in the review thread. Two LGTM are needed to get the PR approved and merged.

Linting charts locally

Note: Docker must be running on your Mac/Linux machine. The command will only lint changed charts.

To lint all charts:

make lint

Forcing to lint unchanged charts

Note: Chart version bump check will be ignored.

You can force to lint one chart with --charts flag:

make lint -- --charts stable/<chart-name>

You can force to lint a list of charts (separated by comma) with --charts flag:

make lint -- --charts stable/<chart-name-0>,stable/xray<chart-name-1>

You can force to lint all charts with --all flag:

make lint -- --all

Manually testing charts with Docker for Mac

Note: Make sure 'Show system containers (advanced)' is enabled in Preferences/Kubernetes.

On the Mac you can install and test all changed charts in Docker for Mac:

make mac

Forcing to install unchanged charts

You can force to install one chart with --charts flag:

make mac -- --charts stable/<chart-name>

You can force to install a list of charts (separated by comma) with --charts flag:

make mac -- --charts stable/<chart-name-0>,stable/<chart-name-1>

You can force to install all charts with --all flag:

make mac -- --all

Note: It might take a while to run install test for all charts in Docker for Mac.

Manually testing charts with remote GKE cluster

You can install and test changed charts with GKE cluster set in kubeconfig context:

make gke

Forcing to install unchanged charts

You can force to install one chart with --charts flag:

make gke -- --charts stable/<chart-name>

You can force to install a list of charts (separated by comma) with --charts flag:

make gke -- --charts stable/<chart-name-0>,stable/<chart-name-1>

You can force to install all charts with --all flag:

make gke -- --all

Using dedicated GKE cluster for manual charts testing

By default it uses the GKE cluster set in kubeconfig context, you can specify the dedicated cluster (it must be set in the kubeconfig) in the file CLUSTER:

GKE_CLUSTER=gke_my_cluster_context_name

Then store the CLUSTER file in the root folder of the repo. It is also ignored by git.

In such setup your local default cluster can be different from the charts testing one.

Docs

For more information on using Helm, refer to the Helm's documentation.

To get a quick introduction to Charts see this Chart's documentation.