Setting Up SDC with GitLab Repositories

...

1. Select the GitLab icon on the upper left to return to the home page.

2. A list of your projects appears. Select the name of the project you want to add members
   /groups to.

   

3. Click on Settings and then Members from the left navigation menu.

   

4. You can add individual users or entire groups to the project.

   1. Select the Invite member tab to add members individually to the project.

      1. Start entering the project member’s name or email address into GitLab
         member or Email address to select from the autocomplete list.

      2. Select a role for the project member from the drop-down menu under Choose a role permission.

      3. Click Add to project.

         

   2. Select the Invite group tab to add an entire group to the project.

      1. Start entering the group’s name into Select a group to invite to select from
         the autocomplete list.

      2. Select a role to apply for the group from the drop-down menu under Max
         access level.

      3. Select Invite to grant the group access to the project repository.

...

🔑 Generate SSH Key

To set up Git integration, you need to have an SSH key on your SDC workstation. This key
authenticates your identification to GitLab so that you can push commits to the project
repository.

1. Your key authentication credentials are, by default, stored in a hidden folder named “.ssh.”
   You’ll need to ensure this folder exists in your home directory before creating your key.
   This can be done using Git Bash (for Windows), as below.
   
   a. Open the Git Bash application from the Windows search box:
   i. In the search box, type ‘Git Bash’ and hit enter.
   ii. Then, click on Git Bash App listed under the Best Match heading.
   

   Image RemovedImage Added

   
   
   b. The Git Bash terminal opens and should be active within your home directory.
   The title bar of the terminal window will display MINGW64/c/Users/<your-SDC-username>,
   where <your-SDC-username> is your actual SDC user credential.
   

   Image RemovedImage Added

   
   c. Use Git Bash to check if the .ssh folder already exists in your home directory:
   At the $ prompt, type the following command and then hit enter.

   Code Block
   ls-a

   This will list all objects in your home directory.
   

   Image RemovedImage Added

   
   
   d. Confirm whether you see the .ssh folder listed in the results:
   

   Image RemovedImage Added

   
   e. If not found, then create the .ssh folder:
   At the prompt, type the following and then hit enter.

   Code Block
   mkdir .ssh

   f. Confirm the .ssh folder is now created:
   At the prompt, type the following and then hit enter.

   Code Block
   ls -a

   
   

2. Next, use Git Bash to generate a new SSH key and store it in the .ssh folder.
   
   a. Generate the key pair:
   At the prompt, type the following command* and then hit enter

   Code Block
   ssh-keygen -t rsa -b 4096 -C "<your-SDC-username@dot.gov>"

   
   *NOTE: Be sure to replace <your-SDC-username@dot.gov> with your SDC email address,
   or other email address/ identifier of your choosing.
   
   b. It will output the following message: “Generating public/private rsa key pair.”
   
   c. It will then ask you where to save the file with the prompt “Enter file in which to save the key:”
   At the prompt, type the following and hit enter.

   Code Block
   C:\Users\<your-SDC-username>\.ssh\id_rsa

   
   d. It will also ask you to enter a passphrase with the following 2 prompts.
   • “Enter passphrase (empty for no passphrase):”
   • “Enter same passphrase again:”
   Hit the Enter key each time (no need to enter anything else) to accept the defaults.
   
   e. The following messages confirm the new SSH key is now stored in the .ssh folder.
   • “Your identification has been saved in C:\Users\<SDCusername>\.ssh\id_rsa.”
   • “Your public key has been saved in C:\Users\<SDCusername>\.ssh\id_rsa.pub.”
   
   NOTE:  Your SSH key pair is comprised of two files, which have been saved under the .ssh folder in your home directory ( C:/Users/<your-SDC-username>/.ssh/ ) .  
   The private identification is saved in the id_rsa file and the public part of the key is saved in the id_rsa.pub file.
   
   

...

cat ~/.ssh/id_rsa.pub | cliclip

This copies the content of id_rsa.pub to your clipboard.

...

c. In the Key field, paste your public SSH key.

...

d. The Title field will be automatically populated with the email/identifier that you provided in step##
<your_sdc_step 2a.
eg. your-sdc-username@dot.gov >.(see image below)

e. Click the Add key button.‘Add key’ button.

...

f. GitLab will return a summary of your new SSH Key.

...

5. To test whether your SSH key was added correctly, type the following command, in your Git Bash terminal,
and then hit enter:

...

a. The first time you connect to GitLab via SSH, you will be asked to verify the authenticity
of the GitLab host you are connecting to. Type “yes” to add the SDC internal GitLab to
the list of trusted hosts.

...

b. You should see the “Welcome to GitLab, @SDCusername!” message.
NOTE: Once added to the list of known hosts, you will not be asked to validate the
authenticity of SDC internal GitLab’s host again. Run the above command once more,
and you should only receive a “Welcome to GitLab, @SDCusername!” message.

c. If the Welcome message does not appear, rerun the last commandin ‘verbose’ ‘verbose'
mode by replacing -T with -vvvT. This will return more details that can be used to help debug the
error.

ssh -vvvT git@internalgit@gitlab.prod.sdc.dot.gov