ConfigSync deployment
ConfigSync is disabled by default because it requires preparation of a GitHub repository.
This topic provides an overview of the deployment process.
Repo organization explains what you’ll find in the repository when ConfigSync is enabled.
1. Prepare a GitHub repository
Theconfig-sync service uses a GitHub repository to store the configuration files.
See Set up a GitHub repo for ConfigSync to learn how to prepare a repository for use with ConfigSync.
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.2. Enable ConfigSync
To enable ConfigSync, you need to update your Helm chart configuration. See Enable ConfigSync for instructions.Enable ConfigSync
Enable ConfigSync
To enable ConfigSync, add the Next, you can configure the ConfigSync mode to select Publisher mode, Subscriber mode, or Pub/Sub mode.For additional options, see the ConfigSync configuration reference.
config-sync values to your Helm chart configuration, similar to the example below:3. Configure the synchronization mode
You can select Publisher, Subscriber, or PubSub mode. See Configure the ConfigSync mode for instructions.Configure the ConfigSync mode
Configure the ConfigSync mode
ConfigSync can operate in different modes:
- Publisher mode: Monitors Fusion for changes and pushes them to a Git repository.
- Subscriber mode: Polls a Git repository for changes and applies them to Fusion.
- Pub/Sub mode: Combines the features of both Publisher and Subscriber modes.
sync configuration in the fusion-config-sync section of the Helm chart configuration, as shown below.-
Publisher mode:
-
Subscriber mode:
-
PubSub mode: