shipmight-stack

Shipmight stack (Helm Chart)

This is the recommended installation chart for most users, because it comes pre-configured. You can simply enable the dependencies you need.

The chart installs Shipmight and the following (optional) dependencies:

Chart	Enabled by default	Repository
Ingress-NGINX	Yes	kubernetes/ingress-nginx
Loki		grafana/helm-charts
Promtail		grafana/helm-charts
Cert-Manager		cert-manager/cert-manager
Metrics Server		kubernetes-sigs/metrics-server

Usage

helm repo add shipmight https://shipmight.github.io/helm-charts
helm repo update
helm install shipmight shipmight/shipmight-stack

Examples

Default installation (includes Ingress-NGINX)

helm install shipmight shipmight/shipmight-stack

Enable Loki

helm install shipmight shipmight/shipmight-stack \
  --set promtail.enabled=true \
  --set loki.enabled=true \
  --set loki.config.storage_config.aws.s3=s3://<access-key>:<secret-access-key>@<s3-endpoint>/<bucket-name> \
  --set shipmight.config.lokiEndpoint=http://shipmight-loki:3100

More information can be found in the docs.

Enable Cert-Manager

helm install shipmight shipmight/shipmight-stack \
  --set cert-manager.enabled=true
# Create a ClusterIssuer with `cert-manager-issuer.shipmight.com/id: <id>` annotation
kubectl create -f your-cluster-issuer.yaml

More information and example ACME (Let's Encrypt) issuer YAML can be found in the docs.

Enable Metrics Server

Note: if your cloud provider offers a one-click installation of Metrics Server, use it instead. Installation via Helm may require additional configuration depending on your cloud platform.

helm install shipmight shipmight/shipmight-stack \
  --set metrics-server.enabled=true

More information can be found in the docs.

Disable Ingress-NGINX

helm install shipmight shipmight/shipmight-stack \
  --set ingress-nginx.enabled=false

Configure Shipmight

Shipmight is a dependency chart, so prepend all configuration values with shipmight.. For example:

helm install shipmight shipmight/shipmight-stack \
  --set shipmight.config.selfUpdateRepository=... \
  --set shipmight.image.tag=...

See the shipmight chart for descriptions of available configuration options.

Options

Dependencies

This chart does not have any configuration of its own. All configuration is done via dependency charts.

Option	Description
shipmight.*	See README.md and values.yaml
ingress-nginx.*	See README.md and values.yaml
loki.*	See README.md and values.yaml
promtail.*	See README.md and values.yaml
cert-manager.*	See README.md and values.yaml
metrics-server.*	See README.md and values.yaml