How-to guides

Installing and managing Config Sync

• Installing Config Sync

  Install and configure the Config Sync Operator in each cluster that you want to manage.

• Installing Hierarchy Controller

  Extend regular Kubernetes namespaces to allow for hierarchical policies and creation without modifying the Config Sync repository.

• Using the Config Sync repo

  Initialize the repo and configure the Operator to read from it.

• Using an unstructured repo

  Organize your repo arbitrarily without following the default repo directory structure.

• Syncing from multiple repositories (preview)

  Learn how to sync configuration from multiple repositories to the same set of clusters.

Configuring objects

• Configuring Kubernetes objects overview

  Learn the basics of configuring your clusters with Config Sync.

• Configuring clusters and cluster-scoped objects

  Automatically configure clusters and cluster-scoped objects such as labels and annotations.

• Configuring namespaces and namespace-scoped objects

  Automatically configure namespaces and Kubernetes objects within them, including how namespaces can inherit configs.

• Configuring only a subset of clusters

  Limit which clusters a config affects, based on the cluster's set of labels.

• Managing existing cluster objects

  Start managing an existing object, and stop managing an object that is currently managed without deleting the object.

• Validating configs

  Validate any changes to config files in your CI/CD pipeline.

Troubleshooting

• Using the nomos command

  Use the nomos command to view the status of your enrolled clusters and perform validation on your configs and repo.

• Stopping and resuming syncing configs

  Learn how to quickly stop syncing, and how to resume syncing when the problem is fixed.

• Observing hierarchical workloads

  Learn how Hierarchy Controller and Cloud Logging can work together to give you better observability into your workloads based on the hierarchical structure of your GKE cluster's namespaces.

• Viewing Config Sync logs

  View and interpret logs when troubleshooting problems with configs or your Config Sync installation.

• Monitoring Config Sync

  Configure and use Prometheus to understand the real-time performance of Config Sync.