Difference between revisions of "Custom Git Data Source Credential"

From Lingoport Wiki
Jump to: navigation, search
(Bitbucket / Custom Git)
(Bitbucket / Custom Git)
Line 9: Line 9:
   
 
* Within the Bitbucket repository, go to Repository Settings -> Access Tokens select Create Repository Access Token
 
* Within the Bitbucket repository, go to Repository Settings -> Access Tokens select Create Repository Access Token
[[File:BitbucketPATCreationForm.jpg|600px]]
+
[[File:BitbucketPATCreationForm.jpg|400px]]
  +
 
* Give the token a name that can be easily identified
 
* Give the token a name that can be easily identified
 
* Select the scopes of Read/Write/Delete
 
* Select the scopes of Read/Write/Delete
Line 16: Line 17:
 
There should be a new screen that appears showing the newly created PAT and the various ways to leverage it. Be sure to save the contents of this screen as everything but the email user.email section will no longer be visible once closed.
 
There should be a new screen that appears showing the newly created PAT and the various ways to leverage it. Be sure to save the contents of this screen as everything but the email user.email section will no longer be visible once closed.
   
  +
The sections that are of importance have been marked in red. These will be referenced later when filling out the configuration in Command Center. They are, from top to bottom:
[[File:BitbucketPATCreationDetails.jpg|600px]]
 
  +
* Repository access token
  +
* How to use this token with your Git Repository
  +
* The git config user.email
   
  +
[[File:BitbucketPATCreationDetails.jpg|400px]]
The Administrator can create the data source credentials by selecting the [[File:CreateIcon.jpg|30px]] ('''Create new credential''') button on the Manage Data Source Credentials page.
 
  +
  +
Now that the PAT has been created, it can be incorporated into Command Center as follows.
  +
  +
'''Create a new Data Source Credential'''
  +
* Open the Settings section (Gear Icon) from the Dashboard page
  +
* Select "Maintenance Mode" (Must be an Administrator to do this) to unlock the Data Source Credentials area
  +
* Select the Data Source Credentials
  +
* Selecti the [[File:CreateIcon.jpg|30px]] ('''Create new credential''') button on the Manage Data Source Credentials page.
   
 
'''Select the Custom Git card'''
 
'''Select the Custom Git card'''
Line 26: Line 38:
 
'''The Custom Git Connection Form will open'''
 
'''The Custom Git Connection Form will open'''
   
[[File:BitbucketUsername.jpg|600px]]
+
[[File:BitbucketGitCredentials.jpg|800px]]
   
 
'''Enter the details for the Custom Git Form'''
 
'''Enter the details for the Custom Git Form'''
 
* Enter a Username.
 
* Enter a Username.
** The username will be x-token-auth as provided by Bitbucket as part of the git clone URL provided by Bitbucket when the PAT was initially created.
+
** The username will be x-token-auth as provided by Bitbucket as part of the git clone URL when the PAT was initially created. This can be found in the "How to use this token with your Git Repository" when the PAT was created marked in red in the screenshot prior.
 
* Enter the Personal access token
 
* Enter the Personal access token
** The PAT is the Token itself as provided by Bitbucket in the first text box that was created by the Bitbucket service. Be sure not to add the username portion or the @<URL> portion to this.
+
** The PAT is the Token itself as provided by Bitbucket in the top text box marked in red in the screenshot prior marked as "Repository Access Token". This is the PAT itself.
* Enter the Commit author
+
* Enter the Commit author - You can put whatever you wish here
 
* Enter the Commit email
 
* Enter the Commit email
** If the Bitbucket provided user.email is input here, when commits occur from Command Center, they will show in Bitbucket with a commit author as token name provided when the PAT was created in Bitbucket
+
** If the Bitbucket provided user.email is input here, when commits occur from Command Center, they will show in Bitbucket with a commit author as token name provided when the PAT was created in Bitbucket. This is the "git config user.email" token marked in red in the screenshot prior.
* Enter the URL, for example, ''https://bitbucket.org/account/''
+
* Enter the Git server URL, for example, ''https://bitbucket.org/account/''
 
* '''Next'''
 
* '''Next'''
  +
[[File:BitbucketGitCredentials.jpg|600px]]
 
  +
[[File:BitbucketCredentialName.jpg|800px]]
   
 
'''Give the new credential a name'''
 
'''Give the new credential a name'''
Line 44: Line 57:
 
* Assign it to applicable managers
 
* Assign it to applicable managers
 
* '''Create'''
 
* '''Create'''
 
[[File:BitbucketCredentialName.jpg|600px]]
 
   
 
The system should return to the '''Manage Data Source Credentials''' page with "Credential created" note and the new credential should be listed.
 
The system should return to the '''Manage Data Source Credentials''' page with "Credential created" note and the new credential should be listed.
  +
  +
At this point, this credential can be added to a project in the same manner as any other source credential.

Revision as of 17:14, 7 January 2025

Bitbucket / Custom Git

[Administrator]

For special git repositories, such as Bitbucket, use Custom Git. It provides flexibility for special Git systems.

Bitbucket PAT Creation Notes

Bitbucket allows PATs to be created at the Project or the Repository level. In this description the PAT was created at the repository level

  • Within the Bitbucket repository, go to Repository Settings -> Access Tokens select Create Repository Access Token

BitbucketPATCreationForm.jpg

  • Give the token a name that can be easily identified
  • Select the scopes of Read/Write/Delete
  • Press Create

There should be a new screen that appears showing the newly created PAT and the various ways to leverage it. Be sure to save the contents of this screen as everything but the email user.email section will no longer be visible once closed.

The sections that are of importance have been marked in red. These will be referenced later when filling out the configuration in Command Center. They are, from top to bottom:

  • Repository access token
  • How to use this token with your Git Repository
  • The git config user.email

BitbucketPATCreationDetails.jpg

Now that the PAT has been created, it can be incorporated into Command Center as follows.

Create a new Data Source Credential

  • Open the Settings section (Gear Icon) from the Dashboard page
  • Select "Maintenance Mode" (Must be an Administrator to do this) to unlock the Data Source Credentials area
  • Select the Data Source Credentials
  • Selecti the CreateIcon.jpg (Create new credential) button on the Manage Data Source Credentials page.

Select the Custom Git card

BitbucketCard.jpg

The Custom Git Connection Form will open

BitbucketGitCredentials.jpg

Enter the details for the Custom Git Form

  • Enter a Username.
    • The username will be x-token-auth as provided by Bitbucket as part of the git clone URL when the PAT was initially created. This can be found in the "How to use this token with your Git Repository" when the PAT was created marked in red in the screenshot prior.
  • Enter the Personal access token
    • The PAT is the Token itself as provided by Bitbucket in the top text box marked in red in the screenshot prior marked as "Repository Access Token". This is the PAT itself.
  • Enter the Commit author - You can put whatever you wish here
  • Enter the Commit email
    • If the Bitbucket provided user.email is input here, when commits occur from Command Center, they will show in Bitbucket with a commit author as token name provided when the PAT was created in Bitbucket. This is the "git config user.email" token marked in red in the screenshot prior.
  • Enter the Git server URL, for example, https://bitbucket.org/account/
  • Next

BitbucketCredentialName.jpg

Give the new credential a name

  • The name should be something that is easily identified when applied from a project as the being the correct PAT
  • Assign it to applicable managers
  • Create

The system should return to the Manage Data Source Credentials page with "Credential created" note and the new credential should be listed.

At this point, this credential can be added to a project in the same manner as any other source credential.