Skip to content

usage.md

Latest commit

 

History

History
42 lines (30 loc) · 1.93 KB

usage.md

File metadata and controls

42 lines (30 loc) · 1.93 KB

Using Open Source Config Sync

This document provides instructions on how to use Config Sync in a Kubernetes cluster. This assumes Config Sync has already been installed on the cluster. Installing Config Sync creates the Custom Resource Definitions (CRDs) which are used to configure Config Sync.

Config Sync CRDs

Config Sync uses a concept of Root repositories and Namespace repositories. These concepts map to the RootSync and RepoSync CRDs, respectively.

Installing Config Sync using Anthos Config Management (ACM) includes the ConfigManagement CRD and ACM Operator, but those are not included in OSS installation.

API Fields

See RootSync/RepoSync fields for a high level overview of the API fields exposed by the RootSync and RepoSync objects. References to the ConfigManagement CRD and ACM Operator (i.e. the config-management-operator Deployment in the config-management-system namespace) can be ignored since they are not included in OSS installation.

For the most accurate API information based on which version is installed on your cluster, you can also inspect the CRDs yourself.

kubectl get crd rootsyncs.configsync.gke.io -oyaml
kubectl get crd reposyncs.configsync.gke.io -oyaml

Configuring Config Sync

See Configure syncing from multiple repositories for some patterns and examples on how to configure RootSync and RepoSync objects.