README
¶
Config Sync
Config Sync lets cluster operators and platform administrators deploy consistent configurations and policies across multiple clusters. This simplifies and automates configuration and policy management at scale.
Start using Config Sync
Follow the installation guide to install OSS Config Sync. If you are using GKE or Anthos, you can also install Config Sync through the Google Cloud GUI or Google Cloud CLI.
Start contributing to Config Sync
We welcome contributions to Config Sync from the community. Take a look at our contribution guide and [development guide] to get started.
Community, discussion and support
You can reach the maintainers of this project at:
- Config Sync discussions
- Config Sync issues
- #kpt channel on k8s slack
Directories
¶
| Path | Synopsis |
|---|---|
|
clientgen
|
|
|
apis
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
apis/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
apis/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
apis/typed/configmanagement/v1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
apis/typed/configmanagement/v1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
apis/typed/configsync/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
apis/typed/configsync/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
apis/typed/configsync/v1beta1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
apis/typed/configsync/v1beta1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
apis/typed/hub/v1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
apis/typed/hub/v1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
cmd
|
|
|
git-importer
Controller responsible for importing policies from a Git repo and materializing CRDs on the local cluster.
|
Controller responsible for importing policies from a Git repo and materializing CRDs on the local cluster. |
|
monitor
Controller responsible for monitoring the state of Nomos resources on the cluster.
|
Controller responsible for monitoring the state of Nomos resources on the cluster. |
|
nomos/status
Package status contains logic for the nomos status CLI command.
|
Package status contains logic for the nomos status CLI command. |
|
Package e2e and its subpacakages define go e2e tests for Nomos.
|
Package e2e and its subpacakages define go e2e tests for Nomos. |
|
pkg
|
|
|
api/configmanagement/v1
Package v1 contains the version 1 data definition for the ConfigManagement custom resources.
|
Package v1 contains the version 1 data definition for the ConfigManagement custom resources. |
|
api/configmanagement/v1/repo
Package repo contains the user interface definition for the repo structure.
|
Package repo contains the user interface definition for the repo structure. |
|
api/configsync/v1alpha1
Package v1alpha1 contains the version 1alpha1 data definition for the ConfigSync custom resources.
|
Package v1alpha1 contains the version 1alpha1 data definition for the ConfigSync custom resources. |
|
api/configsync/v1beta1
Package v1beta1 contains the version 1beta1 data definition for the ConfigSync custom resources.
|
Package v1beta1 contains the version 1beta1 data definition for the ConfigSync custom resources. |
|
api/hub/v1
Package v1 contains the version v1 data definition for the Fleet membership custom resources.
|
Package v1 contains the version v1 data definition for the Fleet membership custom resources. |
|
bugreport
Package bugreport provides tools for assembling debug information for nomos.
|
Package bugreport provides tools for assembling debug information for nomos. |
|
configsync
Package configsync is a temporary package for use in refactoring the Importer and the Syncer into a single binary.
|
Package configsync is a temporary package for use in refactoring the Importer and the Syncer into a single binary. |
|
declared
Package declared contains types and functions for interacting with resource declarations which are parsed from a Git repo.
|
Package declared contains types and functions for interacting with resource declarations which are parsed from a Git repo. |
|
diff
Package diff contains code for diffing sync-enabled resources, not necessarily known at compile time.
|
Package diff contains code for diffing sync-enabled resources, not necessarily known at compile time. |
|
importer/analyzer/ast
Package ast declares the types used for loading Kubernetes resources from the filesystem into something like an Abstract Syntax Tree (AST) that allows for writing reusable visitors.
|
Package ast declares the types used for loading Kubernetes resources from the filesystem into something like an Abstract Syntax Tree (AST) that allows for writing reusable visitors. |
|
importer/analyzer/hnc
Package hnc adds additional HNC-understandable annotation and labels to namespaces managed by ACM.
|
Package hnc adds additional HNC-understandable annotation and labels to namespaces managed by ACM. |
|
importer/analyzer/validation/hierarchyconfig
Package hierarchyconfig defines validation done on HierarchyConfig Resources
|
Package hierarchyconfig defines validation done on HierarchyConfig Resources |
|
importer/analyzer/validation/metadata
Package metadata provides validation checks for errors in Resource metadata
|
Package metadata provides validation checks for errors in Resource metadata |
|
importer/analyzer/validation/semantic
Package semantic package provides validation checks for semantic errors in Nomos resource directories.
|
Package semantic package provides validation checks for semantic errors in Nomos resource directories. |
|
importer/analyzer/validation/syntax
Package syntax package provides validation checks for syntax errors in Nomos resource directories.
|
Package syntax package provides validation checks for syntax errors in Nomos resource directories. |
|
importer/filesystem
Package filesystem provides functionality to read Kubernetes objects from a filesystem tree and converting them to Nomos Custom Resource Definition objects.
|
Package filesystem provides functionality to read Kubernetes objects from a filesystem tree and converting them to Nomos Custom Resource Definition objects. |
|
importer/filesystem/cmpath
Package cmpath is a library dedicated specifically to handling paths in a Nomos repository in a type safe way.
|
Package cmpath is a library dedicated specifically to handling paths in a Nomos repository in a type safe way. |
|
importer/git
Package git provides functionality related to Git repos.
|
Package git provides functionality related to Git repos. |
|
importer/id
Package id holds interfaces which objects must satisfy in order to be uniquely identifiable.
|
Package id holds interfaces which objects must satisfy in order to be uniquely identifiable. |
|
lifecycle
Package lifecycle defines the client-side lifecycle directives ACM honors.
|
Package lifecycle defines the client-side lifecycle directives ACM honors. |
|
metadata
Package metadata contains Config Sync metadata (annotations and labels) and related functions.
|
Package metadata contains Config Sync metadata (annotations and labels) and related functions. |
|
monitor
Package monitor contains the controller for monitoring the state of Nomos on a cluster.
|
Package monitor contains the controller for monitoring the state of Nomos on a cluster. |
|
monitor/clusterconfig
Package clusterconfig contains the controller for monitoring Nomos ClusterConfigs.
|
Package clusterconfig contains the controller for monitoring Nomos ClusterConfigs. |
|
monitor/namespaceconfig
Package namespaceconfig contains the controller for monitoring Nomos NamespaceConfigs.
|
Package namespaceconfig contains the controller for monitoring Nomos NamespaceConfigs. |
|
monitor/state
Package state contains information about the state of Nomos on a cluster.
|
Package state contains information about the state of Nomos on a cluster. |
|
policycontroller
Package policycontroller includes a meta-controller and reconciler for PolicyController resources.
|
Package policycontroller includes a meta-controller and reconciler for PolicyController resources. |
|
policycontroller/constraint
Package constraint includes a controller and reconciler for PolicyController constraints.
|
Package constraint includes a controller and reconciler for PolicyController constraints. |
|
policycontroller/constrainttemplate
Package constrainttemplate includes a controller and reconciler for PolicyController constraint templates.
|
Package constrainttemplate includes a controller and reconciler for PolicyController constraint templates. |
|
policycontroller/util
Package util contains shared functionality for constraints and constraint templates.
|
Package util contains shared functionality for constraints and constraint templates. |
|
reconciler
Package reconciler declares the reconciler process which is described in go/config-sync-multi-repo.
|
Package reconciler declares the reconciler process which is described in go/config-sync-multi-repo. |
|
syncer/cache
Package cache includes controller caches.
|
Package cache includes controller caches. |
|
syncer/client
Package client contains an enhanced client.
|
Package client contains an enhanced client. |
|
syncer/controller
Package controller contains controllers for the Syncer.
|
Package controller contains controllers for the Syncer. |
|
syncer/decode
Package decode is used for decoding serialized data in Nomos resources.
|
Package decode is used for decoding serialized data in Nomos resources. |
|
syncer/differ
Package differ contains code for diffing sync-enabled resources, not necessarily known at compile time.
|
Package differ contains code for diffing sync-enabled resources, not necessarily known at compile time. |
|
syncer/meta
Package meta includes controllers responsible for managing other controllers based on Syncs and CRDs.
|
Package meta includes controllers responsible for managing other controllers based on Syncs and CRDs. |
|
syncer/reconcile
Package reconcile contains Reconcilers for the Syncer's controllers.
|
Package reconcile contains Reconcilers for the Syncer's controllers. |
|
testing/discoverytest
Package discoverytest contains a fake implementation of the API discovery mechanism seeded with the types used in Config Sync.
|
Package discoverytest contains a fake implementation of the API discovery mechanism seeded with the types used in Config Sync. |
|
util/watch
Package watch includes a RestartableManager for dynamically watching resources.
|
Package watch includes a RestartableManager for dynamically watching resources. |
|
webhook
Package webhook contains the implementation of the validating admission webhook.
|
Package webhook contains the implementation of the validating admission webhook. |
|
scripts
|
|
|
testing
|
|
Click to show internal directories.
Click to hide internal directories.