Set up a GitHub repo for ConfigSync
Set up a GitHub repo for ConfigSync
ConfigSync uses a GitHub repository to store the configuration files.
The repository should be created independently and shared with the ConfigSync service via the Helm chart values.
This document describes the process of setting up a GitHub repository for Fusion config files.To encode the private key to base64 you can use the following command:To encode the private key to base64 you can use the following command:
Create a new repository
Create a new repository in the github organization where the ConfigSync should store the config files.Create a deploy key
Create a deploy key for the new repository. The deploy key should have write access to the repository. See the GitHub documentation for instructions.Add the deploy key and repository information to the ConfigSync values
Option 1: Add the deploy key in the Helm chart
Option 2: Add the deploy key as an external secret
Alternatively, you can store the deploy key as an external secret and reference it in the ConfigSync values.Create a secret with the deploy key:
Update the ConfigSync values to reference the secret with the deploy key:
Additional configuration
github.* settings control the remote GitHub repo, branch, and path within the repo.Update the ConfigSync deployment
Update the ConfigSync deployment with the new values.Branch and Path
If you need to share the same GitHub repo for different clusters or environments, you can use thecfg.github.branch setting to specify the branch in the GitHub repo where the config files are stored.
Additionally (or alternatively) ConfigSync supports a cfg.github.path (referred to as root in the future)
setting to specify the path in the GitHub repo where the config files are stored.
By default, ConfigSync stores the config files in the root of the GitHub repo.
Apps and Object Types
Under theroot directory, there is a directory for each app, such as app1, app2.
Under each app directory, there are directories for each object type, such as query-pipelines, blobs, etc.
System Objects
ConfigSync uses_lw_system as the app name for system objects.
This directory is always present in the repo and contains system objects like users, roles, solr configs, etc.
Reserved Files
Additionally, ConfigSync has set of reserved files in theroot directory:
.lock- A lock file to prevent concurrent updates.gitattributes- Used to list LFS files.gitignore- Used to ignore files that should not be stored in the repo
ImportantThese files should not be modified or deleted.
Example repo structure
ConfigSync uses the Fusion links API to determine app association for
Fusion objects. However, it does not track links in GitHub as it uses
the directory structure to maintain app association for an object.