github.md 1.1 KB

GitHub

External Secrets Operator integrates with GitHub to sync Kubernetes secrets with GitHub Actions secrets.

Configuring Github provider

The GitHub API requires to install the ESO app to your GitHub organisation in order to use the Github provider features.

Configuring the secret store

Verify that github provider is listed in the Kind=SecretStore. The properties appID, installationID, organization are required to register the provider. In addition, authentication has to be provided.

Optionally, to target repository and environment secrets, the fields repository and environment need also to be added.

{% include 'github-secret-store.yaml' %}

NOTE: In case of a ClusterSecretStore, Be sure to provide namespace in accessToken with the namespace where the secret resides.

Pushing to an external secret

To sync a Kubernetes secret with an external GitHub secret we need to create a PushSecret, this means a Kind=PushSecret is needed.

{% include 'github-push-secret.yaml' %}