What is configuration as code?

What is configuration as code?

Configuration as code (config as code) is an automated method of maintaining Compass component data in a Git repository. You can choose to declare component details in a YAML file that sits alongside the source code for the component itself. Learn more about how config as code works

Why should I sync a component?

With config as code, you can take an existing Compass component and move its source of truth to a YAML configuration file in your code repository. Once you connect the component with your repository, update the component's data by updating the YAML configuration file. Any updates to the YAML file on your repository’s default branch automatically sync back to Compass and reflect in Compass.

In this way, you can use the same version control practices for maintaining component data as you use for the rest of your codebase.

What tools can I use to manage synced components?

Compass currently supports config as code with Bitbucket Cloud, GitHub Cloud, and GitLab.com.

How does config as code work?

Here’s how config as code works:

• To set up config as code, first install a source code management app in Compass. Then connect a workspace/organization/project where your repositories are located.
  • More details on setting up apps for Bitbucket Cloud, GitHub Cloud, and GitLab.com.
• In your source repository, declare a component’s details in a YAML configuration file called compass.yaml or compass.yml. Each component has its own compass.yaml file. Learn more about the structure and contents of a compass.yaml file
• Set up config as code for your component by committing the compass.yaml file to the default branch (i.e. main or master usually) in your repository. Learn how to manage components with config-as-code
  • When you commit your changes to the default branch of your repository, the component connects to the repository from where you’ll manage it.
  • You can also manage multiple Compass components from the same repository. Place the compass.yaml files in separate subfolders anywhere in your repository structure. This is helpful if you have a monorepo.
• Once you set up config as code for a component, the compass.yaml file in your repository becomes the source of truth for all the component’s details. You now manage the component by making changes only in the compass.yaml file, not via the Compass UI or API.
  • When you commit the changes to your repository’s default branch, the changes automatically sync back to Compass and reflect in your component’s details.
  • You can update a component’s details by making changes in the compass.yaml file. Learn how to update a component managed via config as code
• At any time, you can disconnect a managed component from config as code by simply deleting the yaml file.

Benefits of config as code

• Manage your component right next to your source code without needing to navigate to the UI.
• Governance over who can update component catalog information.
• Version control your component metadata.
• Update your compass.yaml files with scripts or build jobs to help keep information fresh.