1.3. Cloning a Repository

It is possible to clone a repository either in Business Central or using the REST API calls. The kie-config-cli tool cannot be used to clone arbitrary repositories - run git clone or one of the following options instead.

Cloning a Repository in Business Central

Important

Note that only users with the admin role can clone repositories.

Procedure 1.3. Using Business Central to Clone a Repository

  1. In Business Central, go to Authoring → Administration.
  2. On the perspective menu, choose Repositories → Clone repository.
  3. The Clone Repository pop-up window is displayed.
    A screenshot of the Clone Repository dialog window.

    Figure 1.3. Clone Repository Dialog Window

  4. In the Clone Repository dialog window, enter the repository details:
    1. Enter the Repository Name to be used as the repository identifier in the Asset repository and select the Organizational Unit it should be added to.
    2. Enter the URL of the Git repository:
      • for a local repository, use file:///PATH_TO_REPOSITORY/REPOSITORY_NAME;
      • for a remote or preexisting repository, use https://github.com/USERNAME/REPOSITORY_NAME.git or git://HOST_NAME/REPOSITORY_NAME.

        Important

        It is important to use the HTTPS or Git protocol instead of a SCP-style SSH URL. Business Central does not support the basic SSH URL and fails with Invalid URL format.

      Note

      The file protocol is only supported for READ operations. WRITE operations are not supported.
    3. If applicable, enter the User Name and Password of your Git account to be used for authentication.
  5. Click Clone.
  6. A confirmation prompt with the notification that the repository was created successfully is displayed. After clicking Ok, the repository is being indexed. Some workbench features may be unavailable until indexing has completed.
The cloned repository can be viewed either in the File Explorer or Project Explorer.

Cloning a Repository Using the REST API

To clone a repository, issue the POST REST API call. This call creates or clones (according to the value of the requestType parameter) the repository defined by the JSON entity.
Input parameter is a RepositoryRequest instance. Returns a CreateOrCloneRepositoryRequest instance.

Example 1.3. Cloning a Repository Using the Curl Utility

Example JSON entity containing details of a repository to be cloned: 
{
	"name"                   : "clonedRepository",
	"description"            :  null,
	"userName"               :  null,
	"password"               :  null,
	"requestType"            : "clone",
	"gitURL"                 : "git://localhost:9418/example-repository",
	"organizationalUnitName" : "helloWorldUnit"
}
Execute the following command: 
curl -X POST 'localhost:8080/business-central/rest/repositories/' -u USERNAME:PASSWORD -H 'Accept: application/json' -H 'Content-Type: application/json' -d '{"name":"clonedRepository","description":null,"username":null,"password":null,"requestType":"clone","gitURL":"git://localhost:9418/example-repository","organizationalUnitName":"helloWorldUnit"}'
For further information, refer to the Red Hat JBoss BPM Suite Development Guide, section Repository Calls.