New to Config Syncer? Please start here.

Installation Guide

Config Syncer operator can be installed via a script or as a Helm chart.

Get a Free License

Download a FREE license from AppsCode License Server.

Config Syncer licensing process has been designed to work with CI/CD workflow. You can automatically obtain a license from your CI/CD pipeline by following the guide from here.

Install

• Helm 3 (Recommended)
• YAML

$ helm install config-syncer \
  oci://ghcr.io/appscode-charts/config-syncer \
  --version v0.15.0 \
  --namespace kubeops --create-namespace \
  --set-file license=/path/to/the/license.txt \
  --wait --burst-limit=10000 --debug

$ helm template config-syncer \
  oci://ghcr.io/appscode-charts/config-syncer \
  --version v0.15.0 \
  --namespace kubeops --create-namespace \
  --set-file license=/path/to/the/license.txt \
  --no-hooks | kubectl apply -f -

Installing in GKE Cluster

If you are installing Config Syncer on a GKE cluster, you will need cluster admin permissions to install Config Syncer operator. Run the following command to grant admin permision to the cluster.

$ kubectl create clusterrolebinding "cluster-admin-$(whoami)" \
  --clusterrole=cluster-admin \
  --user="$(gcloud config get-value core/account)"

In addition, if your GKE cluster is a private cluster, you will need to either add an additional firewall rule that allows master nodes access port 8443/tcp on worker nodes, or change the existing rule that allows access to ports 443/tcp and 10250/tcp to also allow access to port 8443/tcp. The procedure to add or modify firewall rules is described in the official GKE documentation for private clusters mentioned before.

Verify installation

Config Syncer includes a check command to verify a cluster config. Download the pre-built binary from config-syncer Github releases and put the binary to some directory in your PATH.

$ kubed check --clusterconfig=./hack/deploy/config.yaml
Cluster config was parsed successfully.

Purchase Config Syncer License

If you are interested in purchasing Config Syncer license, please contact us via sales@appscode.com for further discussion. You can also set up a meeting via our calendly link.

If you are willing to purchase Config Syncer but need more time to test in your dev cluster, feel free to contact sales@appscode.com. We will be happy to extend your trial period.