Skip to main content
Version: v0.9

Installation

Install with helm

Controller Mesh requires Kubernetes version >= 1.18

# Firstly add charts repository if you haven't do this.
$ helm repo add kusionstack https://kusionstack.github.io/charts

# To update the kusionstack repo.
$ helm repo update kusionstack

# Install the latest version.
$ helm install ctrlmesh kusionstack/ctrlmesh

# Upgrade to the latest version
$ helm upgrade ctrlmesh kusionstack/ctrlmesh

# Uninstall
$ helm uninstall ctrlmesh

Helm is a tool for managing packages of pre-configured Kubernetes resources.

Optional: chart parameters

The following table lists the configurable parameters of the chart and their default values.

ParameterDescriptionDefault
namespacenamespace for controller mesh installationctrlmesh
namespaceEnabledWhether to create the installation.namespacetrue
manager.replicasReplicas of ctrlmesh-manager deployment2
manager.image.repoRepository for ctrlmesh-manager imagekusionstack/ctrlmesh-manager
manager.image.pullPolicyImage pull policy for ctrlmesh-managerIfNotPresent
manager.image.tagTag for ctrlmesh-managerv0.1.0
manager.resources.limits.cpuCPU resource limit of ctrlmesh-manager container500m
manager.resources.limits.memoryMemory resource limit of ctrlmesh-manager container512Mi
manager.resources.requests.cpuCPU resource request of ctrlmesh-manager container10m
manager.resources.requests.memoryMemory resource request of ctrlmesh-manager container64Mi
proxy.image.repoRepository for ctrlmesh-proxy imagekusionstack/ctrlmesh-proxy
proxy.image.pullPolicyImage pull policy for ctrlmesh-proxyIfNotPresent
proxy.image.tagTag for ctrlmesh-proxyv0.1.0
proxy.resources.limits.cpuCPU resource requests of ctrlmesh-proxy container100m
proxy.resources.limits.memoryMemory resource requests of ctrlmesh-proxy container100Mi
init.image.repoRepository for ctrlmesh-init imagekusionstack/ctrlmesh-init
init.image.tagTag for ctrlmesh-initv0.1.0
shardingGroupVersionKindsSharding resource lists(yaml)

config groupVersionKinds in file:

ctrlmesh.kusionstack.io/v1alpha1:
- '*'
v1:
- Pod
- PersistentVolumeClaim
- Service
- ConfigMap
- Endpoint
apps/v1:
- StatefulSet
- ReplicaSet
- ControllerRevision

Specify each parameter using the --set key=value argument to helm install or helm upgrade.