Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
simu committed Dec 17, 2024
1 parent e6f1548 commit 7f902e3
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions gitlab/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,14 +56,30 @@ spec:
masked: true
```

### External cluster catalog
### External cluster catalog via SSH

If the cluster catalog is not hosted on the same GitLab instance as the tenant repo, you can specify an SSH key which has access to the cluster catalog and the relevant known hosts entry via CI/CD variables on the tenant repo:
If the cluster catalog is hosted externally and can be cloned via SSH, you can specify an SSH key which has access to the cluster catalog and the relevant known hosts entry via CI/CD variables on the tenant repo:

1. Create a CI/CD variable named `SSH_PRIVATE_KEY` containing the SSH private key.
1. Create a CI/CD varaible named `SSH_KNOWN_HOSTS` containing the know hosts entry.
1. (optional) Create a CI/CD variable named `SSH_CONFIG` containing any required SSH configuration.

### External cluster catalog via HTTPS

If the cluster catalog is hosted externally and must be cloned via HTTPS, you can configure HTTPS credentials via CI/CD variables on the tenant repo:

1. Create a CI/CD variable named `ACCESS_USER_CLUSTERNAME` where `CLUSTERNAME` is the Project Syn ID of the cluster.
Set this variable's value to the username used to access the catalog repo.
1. Create a CI/CD variable named `ACCESS_TOKEN_CLUSTERNAME` where `CLUSTERNAME` is the Project Syn ID of the cluster.
Set this variable's value to the password or token used to access the catalog repo.

> [!NOTE]
> To make this work, the Project Syn cluster must be configured to provide its `catalogURL` with a `https://` prefix.
> [!TIP]
> The variable `ACCESS_USER_CLUSTERNAME` is optional.
> If it's not provided, the CI pipeline will fallback to username `token`.
### Test new pipeline generation image

The image used to generate the compile and deploy pipelines can be adjusted by setting the following variables.
Expand Down

0 comments on commit 7f902e3

Please sign in to comment.