Prerequisites
- A GitHub account — with permissions to create repositories and generate personal access tokens
- A Maverics Console account — with access to create or edit deployments
GitHub Setup
Create a Repository
Create a new GitHub repository (or use an existing one) for Maverics configuration storage. This repository will hold the signed config bundles published by the Console.
Generate a Fine-Grained Personal Access Token
Generate a fine-grained personal access token for the Console to write config bundles to the repository.
- In GitHub, click your profile photo, then click Settings
- In the left sidebar, click Developer settings
- Under Personal access tokens, click Fine-grained tokens
- Click Generate new token
- Enter a Token name (e.g., “Maverics Console”)
- Select the Resource owner (your user or organization)
- Set an Expiration date
- Under Repository access, select Only select repositories and choose your Maverics repository
- Under Permissions, expand Repository permissions and set Contents to Read and write
- Click Generate token and copy the value — paste this into the Console’s Token field
Storage Configuration
Configure these fields in the Console when creating or editing a deployment with the GitHub provider.| Field | Required | Description |
|---|---|---|
| Owner | Yes | Your GitHub organization name |
| Repository | Yes | The GitHub repository name |
| Token | Yes | A fine-grained personal access token with Contents read and write permission |
| Configuration File Path | No | The path within the repository where the bundle is stored |
The Orchestrator uses the corresponding config source type to retrieve bundles from the deployment provider. If the Console deploys to GitHub, the Orchestrator uses the GitHub config source to poll for updates.