Git Providers
In this brief guide, we will provide instructions on how to set up the integration between your Devportal and your Git provider. This integration will enable easy import of catalogs and efficient generation of projects. Follow the steps below:
1. Access your devportal Admin-UI, click on "Go to settings"and select “Git providers” in sidebar menu.
2. Fill in the data according to your choice of Git provider and then click "Save".
Below, we provide a table with descriptions of the fields you need to fill in.
- GitHub
- GitLab
- Azure DevOps
| Field | Description |
|---|---|
| Host | The "host" refers to the specific location you are targeting. The default host is github.com. |
| Token | Authentication token that GitHub uses in all interactions with this provider, both for the API and for direct operations. If not provided, anonymous access will be used. |
| Organization | Name of the organization on GitHub |
| Catalog path | Path to the “catalog-info.yaml” file |
| Branch | The branch you want to use |
| Repository | Repository you want to use |
| Frequency | Time in minutes for catalog update |
| Timeout | Time in minutes to automatically terminate after the update request. |
| Client id | Your Client ID that you generated on your GitHub account |
| Client secret | Your Client Secret that you generated on your GitHub account |
For the full integration and operation of the DevPortal with GitHub, you should create and configure your authentication application(GitHub Oauth) and add the host that has been provided to you in the EC2 console. To configure your GitHub Oauth integration, please follow this step-by-step guide
| Field | Description |
|---|---|
| Host | The host of the GitLab instance. The default host is set to ‘gitlab.com’. Please note, it’s important not to include ‘https://’ or ‘http://’ in your input. |
| Token | An authentication token as expected by GitLab. The token need at least api, read_repository and write_repository scopes. If this is not supplied, anonymous access will be used. |
| Client Id | Your GitLab clientId. |
| Client secret | The URL of the GitLab API. For self-hosted installations, it is commonly at https://host/api/v4. For Keycloak.com, this configuration is not needed as it can be inferred. |
| Api base url | The URL of the GitLab API. For self-hosted installations, it is commonly at https://host/api/v4. For gitlab.com, this configuration is not needed as it can be inferred. |
| Branch | The branch you want to use. |
| Group | Group and subgroup (if needed) to look for repositories. If not present the whole instance will be scanned. |
| File name | Catalog file path. |
| Frequency | Time in minutes for catalog update. |
| Timeout | Time in minutes to timeout after the refresh request. |
During this step, we will configure AzureDevops as the authenticator for the platform.
| Field | Description |
|---|---|
| Host | The host of the GitLab instance. The default host is set to ‘gitlab.com’. Please note, it’s important not to include ‘https://’ or ‘http://’ in your input. |
| Token | An authentication token as expected by GitLab. The token need at least api, read_repository and write_repository scopes. If this is not supplied, anonymous access will be used. |
| Api base url | The URL of the GitLab API. For self-hosted installations, it is commonly at https://host/api/v4 |
| Branch | The branch you want to use. |
| Group | Group and subgroup (if needed) to look for repositories. If not present the whole instance will be scanned. |
| File name | Catalog file path. |
| Frequency | Time in minutes for catalog update. |
| Timeout | Time in minutes to timeout after the refresh request. |
During this step, we will configure Keycloak as the authenticator for the platform.
3.After filling out the necessary information, click on “Preview” in the left-hand side menu.
4. On the preview page, you can view all the set information and redeploy the application to upload the new settings. To do this, simply click on "Apply and Re-deploy".
