GitHub Container Registry (GHCR) Connection

Kapstan streamlines the process of integrating with the GitHub Container Registry (GHCR). By setting up a connection using a token, Kapstan can seamlessly deploy applications using container images from your organization or personal GitHub account. To achieve this integration, users must generate a GitHub token and establish a connection in Kapstan using that token.

info

What is a token?

A token is a unique alphanumeric string that authorizes and authenticates an application or user to access specific resources or perform certain actions in another application. In this context, the GitHub token provides Kapstan with permissions to access container images and other resources in the GitHub Container Registry.

Creating a Token in GitHub

1. Log in to your GitHub account.
2. Navigate to Settings > Developer settings.
3. Click on Personal access tokens. You can reach by clicking here as well.
4. Click on Generate new token (classic).
5. Select the read:packages permissions for the token, ensuring you include permissions related to container registry management.
6. Generate the token and make sure to copy it immediately, as you won't be able to see it again for security reasons.

Steps to Create a GHCR Connection in Kapstan

1. Navigate to connections page.
2. Click the "+" icon in the top-right corner and then click on "Container registry".
3. Select "GitHub Container Registry" from the presented container registries.
4. Complete the creation process by providing the required values in the form.

• Connection name: Enter an identifiable name for your connection.
• Username: Enter your GitHub "Username".
• Token: In this field, please paste the token you generated from GitHub.
• Namespace: Specify the desired "Namespace" associated with your GitHub repositories. Read more here

5. Click "Confirm" to finalize the connection setup.

Verify Connection

Once you established the connection with Kapstan, you will be directed to the Connections page. You can check the status of the connection by checking the status column.