Configure the Git Integration to use self-managed GitLab (Beta)
Configure the Git integration for self-managed GitLab.
The Git Integration has beta support for a self-managed GitLab installation deployed on-premises or in the cloud. SnapLogic provides an app gateway, a secure transparent proxy, to route Git requests through your Groundplex to the GitLab server, providing an additional layer of security.
To enable use of self-managed GitLab for tracking SnapLogic assets, you need the following:
- A subscription for the SnapLogic Git Integration
- Administrative permission for the GitLab group
- SnapLogic Environment (Org) admin permission
Create application in GitLab
To enable GitLab to track SnapLogic assets, a GitLab administrator must create an application that configures connectivity:
- Log in to GitLab.
- Navigate to your Group.
- Select Settings.
- Click Applications.
- Click Add a new application.
- Enter a name.
- Specify these values:
- For Redirect URI, enter:
https://control-plane-name.snaplogic.com/api/1/rest/asset/app/oauthcallback
Wherecontrol-plane-name
is the control plane you are using. For example:- elastic
- uat
- emea
Important: This Redirect URI is the same as the Callback URL that you specify to configure the Git Integration in your SnapLogic environment/org. - Leave the Confidential box checked.
- For Scopes select the following:
- api
- read_api
- read_user
- write_repository
- Click Save application.
- Click the application to view it and copy the secret to use when configuring your SnapLogic Org.
- For Redirect URI, enter:
Configure the SnapLogic Environment
To finish the configuration, a SnapLogic Environment admin must configure Git Integration settings:
- Classic Manager
- Admin Manager
- Open the Classic Manager.
- From the left panel select Settings.
- Scroll down to Git Integration and click Configure Git.
- From the Git Integration Type dropdown list, select GitLab on-premises.
The configuration dialog opens:
- Enter the following values:
- App ID: The Application ID from the GitLab application.
- Client Secret: The Secret copied from the GitLab application.
- Gitlab URL: The app gateway URL in the format: org-location-environment-appname.control-plane-name.
- Auth URL: The URL for your GitLab server.
- Http proxy: The HTTP proxy.
- Https proxy: The HTTPS proxy.
- Authorized scopes:
api
read_api
read_user
write_repository
- Callback URL: The Redirect URI from the GitLab
application,
https://control-plane-name.snaplogic.com/api/1/rest/asset/app/oauthcallback
.Where control-plane-name is the control plane you are using. For example:- elastic
- uat
- emea
Important: This Callback URL is the same as the Redirect URI that you specified in the GitLab application.
- Click Save.
- Open Admin Manager.
- From the left navigation panel under System Configurations select Git Integration.
- From the Git integration type dropdown list, select GitLab on-premises. The configuration page opens:
- Enter the following values:
- App ID: The Application ID from the GitLab application.
- Client secret: The secret copied from the GitLab application.
- Gitlab URL: The app gateway URL in the format:
org-location-environment-appname.control-plane-name:port-number.
For example, with an environment named
test
and a Groundplex with an Environment value ofdev
, the gateway URL would be as follows:https://test-sidekick-dev-gitlab.appgateway.prod.snaplogic.io:8095
- Auth URL: The URL for your GitLab server.
- Http proxy: The HTTP proxy.
- Https proxy: The HTTPS proxy.
- Authorized scopes:
api
read_api
read_user
write_repository
- Callback URL: The Redirect URI from the GitLab
application,
https://control-plane-name.snaplogic.com/api/1/rest/asset/app/oauthcallback
.Where control-plane-name is the control plane you are using. For example:- elastic
- uat
- emea
Important: This Callback URL is the same as the Redirect URI that you specified in the GitLab application.
- Click Save.
Configure the Groundplex
Configure the Groundplex to connect to the app gateway in Classic Manager or Admin Manager.
- Classic Manager
- Admin Manager
From Classic Manager:
- Select the Project associated with the Groundplex.
- Search for the Groundplex.
- Click it to open the Update Snaplex dialog.
- Click the Node Properties tab.
- In the Global Properties section, click
to add the gateway key-value pair:
- Enter the appropriate values for the app gateway:
- Key:
jcc.app.gateway.gitlab
- Value:
https://
org-location-environment-appname.controlplanename:port where:- org: The environment name.
- location: The location of your Groundplex. Always
sidekick
. - environment: The value in the Environment field in your Groundplex Snaplex Settings tab.
- appname: gitlab.
- controlplanename: The control plane that hosts your environment and
the app gateway port number:
- Production:
appgateway.prod.snaplogic.io:8095
- UAT:
appgateway.uat.snaplogic.io:8095
- EMEA:
appgateway.emea.snaplogic.io:8095
- Production:
-
For example, with an environment named
test
and a Groundplex with an Environment value ofdev
, the gateway URL for self-managed GitLab would be as follows:https://test-sidekick-dev-gitlab.appgateway.prod.snaplogic.io:8095
- Key:
From Admin Manager:
- In the left pane, click Snaplexes.
- Click the Groundplex to open the Update Snaplex page.
- Click the Node properties tab.
- In the Global properties section, click + Add new global property to add the gateway key-value pair:
- Enter the appropriate values for the app gateway:
- Key:
jcc.app.gateway.gitlab
- Value:
https://
org-location-environment-appname.controlplanename:port where:- org: The environment (Org) name without hyphens (-). For example:
myenterprise-snap-test
should be passed asmyenterprisesnaptest
. - location: Location of your groundplex. Always
sidekick
. - environment: The value in the Environment field in your Groundplex Snaplex Settings tab.
- appname: gitlab.
- controlplanename: The control plane that hosts your environment and
the app gateway port number:
- Production:
appgateway.prod.snaplogic.io:8095
- UAT:
appgateway.uat.snaplogic.io:8095
- EMEA:
appgateway.emea.snaplogic.io:8095
- Production:
For example, with an environment named
test
and a Groundplex with an Environment value ofdev
, the gateway URL for self-managed GitLab would be as follows:https://test-sidekick-dev-gitlab.appgateway.prod.snaplogic.io:8095
- org: The environment (Org) name without hyphens (-). For example:
- Key: