Use an unstructured repository
Using an unstructured repository lets you organize your repository in the way that is most
convenient to you. This flexibility lets you sync your existing Kubernetes
configuration to your Config Sync repository. For example, if you want to sync a
Helm chart to your cluster, you can run the
helm template command
and commit the rendered manifest to your repository. For more information,
see the Using Config Sync with Helm
Unstructured repos are recommended for most users. However, you can also create a hierarchical repository to separate configs into distinct categories. If you want to create hierarchical policies without adhering to the rules of the hierarchical repository, consider using Hierarchy Controller.
Unstructured repositories have the following limitations:
You cannot use the
HierarchyConfigKubernetes objects in an unstructured repository.
Abstract namespaces are not supported in unstructured repositories.
If you are using the
nomos vetcommand, add the
--source-format=unstructuredflag. For example:
nomos vet --source-format=unstructured
You can declare NamespaceSelectors in an unstructured repository. To declare a
NamespaceSelector, add either the
metadata.namespace or the
annotation. Declaring both annotations is invalid. If namespace-scoped
resources don't declare
metadata.namespace or the
annotation, then Config Sync uses the "default" namespace of the cluster.
To learn more, see Limit which namespaces a config affects.
In an unstructured repository,
ClusterSelectors function normally.
Configure an unstructured repository
To configure an unstructured repository, set the value of
unstructured in your RootSync object or ConfigManagement object.
The following RootSync object configures Anthos Config Management to sync from an unstructured repository:
# root-sync.yaml apiVersion: configsync.gke.io/v1beta1 kind: RootSync metadata: name: ROOT_SYNC_NAME namespace: config-management-system spec: sourceFormat: unstructured git: repo: https://github.com/GoogleCloudPlatform/anthos-config-management-samples branch: main dir: config-sync-quickstart/multirepo/root auth: ssh secretRef: name: SECRET_NAME
Replace the following:
ROOT_SYNC_NAME: add the name of your RootSync object. The name should be unique in the cluster and have no more than 26 characters.
SECRET_NAMEwith the name of the Secret.
The following ConfigManagement object sets up a continuous integration pipeline and specifies that the repository that it syncs to is unstructured:
# config-management.yaml apiVersion: configmanagement.gke.io/v1 kind: ConfigManagement metadata: name: config-management spec: # clusterName is required and must be unique among all managed clusters clusterName: CLUSTER_NAME sourceFormat: unstructured git: syncRepo: https://github.com/GoogleCloudPlatform/anthos-config-management-samples syncBranch: main secretType: ssh policyDir: ci-pipeline-unstructured
For a complete list of fields that you can add to the
spec field, see
Convert a hierarchical repository to an unstructured repository
nomos hydrate PATH
PATH with the path to your directory.
This command creates a
compiled/ directory in the current working directory. Within
that directory, a subdirectory is created for each enrolled cluster, with the
fully resolved configs, and each subdirectory can be used in an unstructured
For more details, see
If you prefer converting your repository manually, complete the following instructions:
Repoconfigs in the
system/directory from your Git repository. The
Reporesource is not needed for an unstructured repository.
The abstract namespace directory isn't supported in an unstructured repository. Therefore, you must declare the namespace of all resources originally included in the
namespaces/directory and its subdirectories.
Namespace inheritance isn't supported in the unstructured repository. Therefore, you must declare all resources that are originally inherited in descendant namespaces, namely the ones originally under the
Example format for an unstructured repository
The following example demonstrates how you might organize your configs (including Google Cloud resources) in an unstructured repository:
├── manifests │ ├── access-control │ │ ├── ... │ ├── change-control │ │ ├── ... │ ├── git-ops │ │ └── ... │ ├── logging-monitoring │ │ └── ... │ ├── networking │ │ └── ... │ ├── project-factory │ │ └── ... │ └── resource-hierarchy │ │ └── ... ├── raw-configs │ ├── access-control │ │ └── ... │ ├── change-control │ │ └── ... │ ├── git-ops │ │ └── ... │ ├── logging-monitoring │ │ └── ... │ ├── networking │ │ └── ... │ ├── project-factory │ │ └── ... │ └── resource-hierarchy │ │ └── ... └── scripts └── render.sh
In this example, the raw configs are in a
raw-configs directory. You could
then use a script or an automated pipeline to render the raw configs and store
the output in the
manifests directory. When you
configure Config Sync,
you'd configure it to sync from your
- Create cluster-scoped objects
- Create namespace-scoped objects
- Install Config Sync
- Configure syncing from multiple repositories
- Take the Creating policies for a multi-tenant cluster tutorial, which uses an unstructured repository.