Set up and configure GitLab for Edge Delivery Services

To publish content from Experience Manager Guides to Edge Delivery Services (EDS) using GitLab, you connect a GitLab repository to your EDS site through Cloud Manager’s Bring Your Own Git (BYOG) capability. This article lists the steps in sequence. For details on each step, follow the linked documentation.

How it works

Prerequisites

Configure GitLab for Edge Delivery Services

To configure GitLab for use with Edge Delivery Services, perform the following steps in the specified sequence to ensure proper setup and integration.

1. Create the EDS site using GitHub

Create a GitHub repository from the AEM Guides boilerplate and install the AEM Code Sync app on it. Save the generated Live URL (https://<branch>--<github-repo>--<github-username>.aem.live) for later.

For steps, view Create a GitHub repository for EDS and Connect GitHub to Adobe via AEM Code Sync.

2. Create the GitLab repository

Create a separate GitLab repository (for example, my-eds-gitlab) from the same AEM Guides boilerplate. Experience Manager Guides publishes the generated output to this repository. EDS expects a main branch.

To create the repository, either create a blank project and push the contents of aem-guides-boilerplate to it, or import the boilerplate into a new project. For steps, view Create a project and Import your project from GitHub to GitLab in the GitLab documentation.

3. Configure the mountpoint URL

In the GitHub repository, update fstab.yaml so the content source points to the GitLab repository, and commit the change to main.

https://<worker URL>/gitlab/<git acc domain>/<git username>/<git repo>/main/docs

4. Create GitLab access tokens

Create the access token(s) required for:

5. Add the GitLab repository to Cloud Manager

In Cloud Manager, go to Repositories > Add Repository, select Private Repository, and validate ownership using the access token. Wait until the repository status is Ready. The BYOG option is available only after at least one external repository is Ready.

For steps, view Add external repositories in Cloud Manager.

6. Generate a Cloud Manager API key

Create an API integration in Adobe Developer Console (Cloud Manager API, OAuth Server-to-Server) and copy the Client ID (API Key).

For steps, view Creating an API integration project.

7. Configure the GitLab webhook

In Cloud Manager, select Config Webhook for the repository and copy the Webhook URL and Secret. Append the API key to the URL (<webhook URL>&api-key=<CLIENT_ID>). In GitLab, go to Settings > Webhooks, add the URL and secret, select the main branch, and enable Push events.

For details, view Configure your external repository in Cloud Manager.

8. Add the EDS site to Cloud Manager

In Cloud Manager, go to Edge Delivery > Add Edge Delivery Site and enter the Live URL saved in step 1. Complete the ownership validation.

For steps, view Add an Edge Delivery site.

9. Connect the repository using Bring Your Own Git

On the EDS site in Cloud Manager, select Bring Your Own Git (BYOG), choose the GitLab repository, and confirm. Copy and securely store the generated secret. It is shown only once, and a new secret is generated if you reconfigure the site.

For details, view Configure your Edge Delivery site in Cloud Manager.

10. Configure the EDS site to use Cloud Manager

Set the EDS site’s code source to the Cloud Manager repository, using the Program ID (/program/<PROGRAM_ID>/) and Repository ID (/repo/<REPO_ID>/) from the webhook URL. Then create a secret named exactly cm-byog with the secret from step 9.

For the Admin API calls, view Configure your AEM site to use Cloud Manager.

11. Sync and verify

In Cloud Manager, select Sync Code from the site’s menu and choose the main branch. Then open https://main--<site>--<org>.aem.page to verify the site.

For details, view Trigger your first sync and Verify your AEM site.

12. Publish from Experience Manager Guides

Create an EDS publish profile with Git account type set to GitLab, using the project access token from step 4. Then select this profile in an EDS output preset and generate the output. The output is committed to the docs folder of the GitLab repository.

For steps, view Create the EDS publish profile and Create an Output preset for EDS and generate output.

Troubleshooting

For more details, view Troubleshooting in Bring Your Own Git.