Skip to content
Snippets Groups Projects
Select Git revision
  • renovate-kubernetes-client-node-1.x
  • renovate-kubernetes-client-node-0.x
  • renovate-nodemon-3.x-lockfile
  • main default protected
  • swarm-platform-2965
  • renovate-express-4.x-lockfile
  • aatemnke2-PLATFORM-2768
  • aatemnke-PLATFORM-2768
  • renovate-prom-client-15.x
  • renovate-pretty-quick-4.x
  • renovate-prettier-3.x
  • renovate-major-jest-monorepo
  • renovate-husky-9.x
  • renovate-major-gitbeaker-monorepo
  • renovate-pretty-quick-3.x-lockfile
  • renovate-prettier-2.x-lockfile
  • aatemnke-main-patch-98396
  • aatemnke-main-patch-12446
  • markhw-platform-1840
  • revert-0176c3bc
20 results
Compare History
Michael Irwin's avatar
Add e2e tests to the syncer
Michael Irwin authored
2bf80dc9
Name Last commit Last update
e2e
examples
src
test
.gitignore
Dockerfile
LICENSE
README.md
docker-compose.yml
package.json
yarn.lock
README.md

Flux GitLab Syncer

This project creates a small app that watches for changes in Flux v2 resources and syncs them to GitLab. This helps facilitate additional automation and reduce the amount of manual configuration to get GitOps up and running. Specifically, it watches the following:

  • GitRepository objects to add/remove the SSH keys to referenced git repos
  • Receiver objects to add/remove the configured webhook URLs to the repos

Note that this component currently watches only these resources within a single namespace, as this was built to run in a multi-tenant platform and automate the setup of the tenant repos.

Configuration

The following environment variables can be used to configure the syncer.

Name Required? Description Default Value
GITLAB_PRIVATE_KEY_FILE Yes File path to a file containing the API key/access token used to authenticate with the GitLab API server. Note this token needs full API access to add/remove keys and webhooks -
WEBHOOK_BASE_URL Yes The base URL to prepend to the URLs created by the Receiver objects. This should be the URL that resolves to the webhook receiver. Example: https://webhook-receiver.example.com -
NAMESPACE Yes The namespace to watch for resources -
DEPLOY_KEY_IDENTIFIER No The name given to the Deploy Key in GitLab flux-gitlab-key-syncer
GITLAB_HOST No The host of the GitLab server https://code.vt.edu
PORT No The port to run the HTTP server on 8080

Deployment Example

You can use the following instructions to deploy the syncer.

  1. Set an environment variable for the namespace you want to deploy everything into. This is used to support copy/paste of the following commands.

    export NAMESPACE=platform-flux-tenant-config

  2. In GitLab, create an access token. We recommend creating a bot account that can be added to all of the repos/groups and using a personal access token for this bot. Hopefully, GitLab will add support for group-level access tokens. Store this token in a file named gitlab-token.

  3. Create a Kubernetes secret containing the access token.

    kubectl create secret generic gitlab-api-token --from-file=token=./gitlab-token

  4. Deploy the syncer! Note that the configured WEBHOOK_BASE_URL points to https://webhook-receiver.example.com, which obviously isn't going to work for you.

    kubectl apply -f ./examples -n $NAMESPACE

  5. After a moment, check the logs for the deployed pod. You should see some startup info letting you know how it's configured.

     kubectl logs flux-gitlab-syncer-d9fd798d-gd9ms
[INFO]  2021-06-25T16:44:56.143Z Configured GitLab client to use https://code.vt.edu with token Ww****
[INFO]  2021-06-25T16:44:56.162Z Configuring WebhookSyncer to use base URL of https://webhook-receiver.example.com
[INFO]  2021-06-25T16:44:26.180Z Web server listening on port 8080