Connecting to a remote repository automatically

By default, all decision automations that are created on the Decision Intelligence Client Managed Software platform are not connected to a remote repository. However, you can configure the platform to automatically create a remote repository and connect new decision automations to it.

Before you begin

Note: You must have the Administer platform for decision services permission to access the administration page. This permission is associated with the Decision Designer Platform Administrator predefined role. For more information, see Manage user permissions.
  • If the automatic connection is configured, a decision automation is connected to a remote repository automatically when a user creates it. This applies to all users.
  • When the automatic connection fails, the decision automation is still created but it is not connected to a remote repository.
  • When the automatic connection fails, you can still connect to another remote repository manually. For more information, see Connecting to a remote repository manually.
Restriction: You can configure one Git provider only. This Git provider is used for all users.

Procedure

  1. Go to the administration page in Decision Designer by adding /admin-platform at the end of the URL of Decision Designer in your browser: 
    https://<decision_designer_url>/admin-platform
  2. Open the Git provider configuration tab.
  3. To add a Git provider configuration, click New.
  4. From the Git provider pull-down menu, select a Git provider.
    You can select one of the following providers:
    • GitHub
    • GitLab
    • Gitea
    • Bitbucket
    • Azure Repos
    • AWS CodeCommit
  5. Complete the required fields for the Git provider you selected.
    Table 1.
    Field Mandatory or optional Description
    Service URL Mandatory

    The URL for your Git provider API.

    The current default paths for the supported Git providers:
    • GitHub: For https://github.com, the URL for the provider API is https://api.github.com.

      This path is automatically set in the UI.

    • GitLab: https://gitlab.com/api/v4
    • Gitea: https://my-server.com/api/v1
    • Bitbucket: https://my-server.com/api/2.0
    • Azure Repos: The path is provided in the UI.
    • AWS CodeCommit: https://git-codecommit.<region>.amazonaws.com/v1/repos/
    Tip: You might need to use a different URL and path for specific cases; for example:
    • If you are using your own instance of GitHub; that is, if you are not using https://github.com, the URL for the provider API is https://my-server.com/api/v3.
    • For https://bitbucket.org, the URL for the provider API is https://api.bitbucket.org/2.0

    The https protocol must be used.

    Certificates must be properly recognized by the Git service pods.
    Git provider name Mandatory

    A unique name of your Git provider.

    A Git provider name cannot contain the following characters:
    • Unicode control characters or surrogate characters
    • Any of the following characters:
      • / : \ ~ & % ; @ ' " ? < > | # $ * } { , + = [ ]
      • characters starting with an underscore ( _ )
      • characters starting or ending with a period (.)
    Repository details

    What you need to select or enter in this field varies depending on the Git provider you selected.

    Not required for AWS CodeCommit.
    • Project name: Your project name. This field is available and mandatory only for Azure Repos.
    • Organization name: Your organization name.
      Note: For GitLab, the organization name must be the full path of the namespace that you want to use. This namespace can be a personal namespace, a group or subgroup namespace. For more information, see the GitLab documentation External link opens a new window or tab.
      Git provider Mandatory or optional
      GitHub Optional
      GitLab Optional
      Gitea Optional
      Bitbucket Mandatory
      Azure Repos Mandatory
      AWS CodeCommit The field is not available if you selected this Git provider.
    • Visibility of the Git repository: Select Public or Private. The default is Private.
    Git provider API

    What you need to select or enter in this field varies depending on the Git provider you selected.

    The type and values of credentials to access the Git provider API.

    Git provider Description
    GitHub
    1. Select Credentials or Access token in Authentication type.
    2. Enter username and password for Credentials or enter access token for Access token.

    To obtain the access token or application password, go to the following location: Settings > Developer Settings > Personal Access Tokens
    Gitea
    1. Select Credentials or Access token in Authentication type.
    2. Enter username and password for Credentials or enter access token for Access token.

    To obtain the access token or application password, go to the following location: Settings > Applications > Manage Access Tokens
    GitLab

    Enter an access token.

    To obtain the access token or application password, go to the following location: Preferences > Access Tokens > Personal Access Tokens
    AzureRepos

    Enter an access token.

    To obtain the access token or application password, go to the following location: User settings > Personal Access Tokens
    Bitbucket

    Enter the username and password.

    To obtain the access token or application password, go to the following location: Personal settings > App passwords
    AWS CodeCommit

    Enter the username and password.

    1. Go to Identity and Access Management (IAM): https://<region>.console.aws.amazon.com/iamv2/home?region=<region>#/home.
    2. Go to Access Management > Users, and select your user.
    3. Verify that you have the AWSCodeCommitFullAccess permission. If you don't have it, add one.
    4. Go to Security credentials > Create access key, and select Application running outside AWS.
    5. When the access key is created, use the access key as username, and the secret access key as password.
    Git credentials Mandatory

    The type and values of credentials to access the Git repositories.

    Use one of them:
    • Username and password (usually personal access token)
    • SSH key
    For AWS CodeCommit:
    1. Go to Identity and Access Management (IAM): https://<region>.console.aws.amazon.com/iamv2/home?region=<region>#/home
    2. Do one of the following steps:
      • Go to Access Management > Security credentials > SSH public keys for AWS CodeCommit, and upload the SSH public key.
      • Go to HTTPS Git credentials for AWS CodeCommit, and generate credentials.
  6. Click Save.