Configuring a remote Git repository in Control Room - Configure a remote Git repository in the Control Room to version and store all bots and their dependencies. The remote Git repository backs up the bots and their dependencies, in addition to the local Automation 360 repository in the Control Room .

Automation 360

Configure a remote Git repository in the Control Room to version and store all bots and their dependencies. The remote Git repository backs up the bots and their dependencies, in addition to the local Automation 360 repository in the Control Room.

Before you begin

  • To configure a remote Git repository in the Control Room, ensure that you have the AAE_Admin role.
    Note: Automation 360 supports custom role creation by allowing all permissions to be non-default and editable. However, for releases before version v30, system-created roles such as AAE_Admin are mandatory. For more information, see System-created roles.
  • Based on your region, configure your network firewall to add outbound NAT gateway IP addresses to the allowed list.

    Control Room IP address list for external integrations

About this task

Review the following considerations before you configure a remote Git repository:
  • The Git repository must be configured to have write access only to the Control Room and not to any other Git client.
  • You cannot upload files greater than 100 MB to the Git repository.
  • Ensure that you integrate with an empty Git repository.
  • You should not check in any file manually into the Git repository from any other user, product, or application.
  • When you integrate with Git, the repository should not contain the ReadMe.md file.
  • Ensure your Git repository is private (internal). For security reasons, Automation 360 cannot connect to a public Git repository as all the bots and files are generally accessible in a public Git repository.

Procedure

  1. In the Control Room, navigate to Administration > Settings > Remote Git repository integration.
  2. Click Edit.
  3. Choose one of the following authentication methods and perform the corresponding steps to set up your Git configuration:
    Authentication methodSteps
    HTTPS Authentication
    1. Enter the HTTPS repository path, including the username in the following format:

      https://<username>@bitbucket.org/companyname/product.git

      Note: Obtain the repository address from your Git host.
    2. Enter the branch name.

      The changes are pushed to the branch selected. By default, the master branch is selected.

      Branch names can use lowercase characters and must not exceed 250 characters. Do not include spaces, tildes, colons, or ASCII control characters. Separate words with hyphens. For more information on branch naming, see Create a new Git branch.

    3. Enter your Git repository password or a generated Git token.
      Note:
      • Use the password or token generated for your repository connection. Tokens are more secure than passwords, so use tokens when possible.
      • For GitHub, use only personal access tokens (PATs). Both classic and fine-grained PATs are supported for remote Git integrations. For fine-grained personal access tokens, the supported token length depends on the Automation 360 version:
        • v.39: Fine-grained personal access tokens can contain up to 75 characters.
        • v.41 and later: Fine-grained personal access tokens can contain up to 255 characters.
      • For BitButcket, use only app passwords.
    4. Re-enter the password or Git token to confirm.
    SSH Authentication
    1. Enter the SSH repository path in the following format:

      https://git@bitbucket.org:companyname/product.git

      Note: Obtain the repository address from your Git host.
    2. Enter the branch name.

      The changes are pushed to the branch selected. By default, the master branch is selected.

      Branch names can use lowercase characters and must not exceed 250 characters. Do not include spaces, tildes, colons, or ASCII control characters. Separate words with hyphens. For more information on branch naming, see Create a new Git branch.

    3. Enter your SSH authentication private key.

      You must create the private and public key pair by using the RSA algorithm.

      Note: Ensure that the private key you enter in the Control Room includes both -----BEGIN RSA PRIVATE KEY----- and -----END RSA PRIVATE KEY-----.

      You must generate the public key and enter it in your Git server.

      See the following topics for steps on how to generate the public key depending on your server:
    4. Optional: Enter the passphrase.
  4. Optional: Select the Connect to Git via proxy check box.
    1. Enter the proxy host name or IP address.
    2. Enter the port number.
    3. Optional: Select the authentication check box and enter the user name and password.
  5. Click Connect and Save.
    The Control Room connects to the remote Git repository, and the following message is displayed: Git integration settings successfully saved. You can also check the audit log where the status for Set git settings is displayed as successful.
Note:
  • After you integrate a remote Git repository, a single check-in from the private workspace checks in all files in the public workspace to the remote Git repository.
  • The check-in operation might take longer if the Git folder in your public workspace contains many bot files, because a larger repository slows Git commits. As a best practice, delete unused bot files from your public workspace.
  • Delete lock files such as index.lock or master.lock from the Git repository. These files can block check-in and check-out operations.

You can connect to the same Git repository with a different username in the Control Room. For more information, see How to change the remote Git repository username in the control room (A-People login required).

Example

Watch the following video for an overview of the remote Git repository functionality:

New Git Repository functionality