Setup and Learn GIT¶

What is it?¶

Git is a free and open source distributed version control system that the OpenStack community uses to manage changes to source code.

Installation¶

brew install git

sudo apt install git

sudo yum install git

sudo dnf install git

sudo zypper in git

Configure Git¶

Once you have Git installed you need to configure it. Open your terminal application and issue the following commands putting in your first/last name and email address. This is how your contributions will be identified:

git config --global user.name "Firstname Lastname"
git config --global user.email "your_email@youremail.com"

What is it?¶

Git review is tool maintained by the OpenStack community. It adds an additional sub-command to git like so:

git review

When you have changes in an OpenStack project repository, you can use this sub-command to have the changes posted to Gerrit so that they can be reviewed.

Installation¶

pip install git-review

pip install --install-option '--install-data=/usr/local' git-review

brew install git-review

sudo apt install git-review

sudo yum install git-review

sudo dnf install git-review

sudo zypper in python-git-review

Configuration¶

Git review assumes the user you’re running it as is the same as your Gerrit username. If it’s not, you can tell it by setting this git config setting:

git config --global gitreview.username <username>

If you don’t know what your Gerrit username is, you can check the Gerrit settings.

What are they?¶

In order to push things to Gerrit we need to have a way to identify ourselves. We will do this using ssh keys which allows us to have our machine we’re pushing a change from to perform a challenge-response authentication with the Gerrit server.

SSH keys are always generated in pairs:

• Private key - Only known to you and it should be safely guarded.
• Public key - Can be shared freely with any SSH server you wish to connect to.

In summary, we will be generating these keys, and providing the Gerrit server with your public key. With your system holding the private key, it will have no problem replying to Gerrit during the challenge-response authentication.

Check For Existing Keys¶

Open your terminal program and type:

ls -la ~/.ssh

Typically public key filenames will look like:

• id_dsa.pub
• id_ecdsa.pub
• id_ed25519.pub
• id_rsa.pub

If you don’t see .pub extension file, you need to generate keys.

Generate SSH Keys¶

Assuming you weren’t able to find keys in your ~/.ssh directory, you can generate a new ssh key using the provided email as a label by going into your terminal program and typing:

ssh-keygen -t rsa -b 4096 -C "your_email@example.com"

When you’re prompted to “Enter a file in which to save the key” press Enter. This accepts the default location:

Enter a file in which to save the key (/Users/you/.ssh/id_rsa): [Press enter]

At the prompt, type a secure a passphrase, you may enter one or press Enter to have no passphrase:

Enter passphrase (empty for no passphrase): [Type a passphrase]
Enter same passphrase again: [Type passphrase again]

Copy Public Key¶

cat ~/.ssh/id_rsa.pub

Import Public Key Into Gerrit¶

1. Go to Gerrit’s SSH Public Keys settings.
2. Click the ‘Add Key’ button.
3. Paste the public key into the Add SSH Public Key text box and click Add.