--- /dev/null
+== Getting started with Git and Gerrit\r
+\r
+Git is an opensource distributed version control system (dvcs) written in the C language and originally developed by Linus Torvalds and others to manage the Linux kernel. In Git, there is no central copy of the repository. After you have cloned the repository, you have a functioning copy of the source code with all the branches and tagged releases, in your local repository.\r
+\r
+Gerrit is an opensource web-based collaborative code review tool that integrates with Git. It was developed at Google by Shawn Pearce. Gerrit provides a framework for reviewing code commits before they are accepted into the code base. Changes can be uploaded to Gerrit by any user. However, the changes are not made a part of the project until a code review is completed. Gerrit is also a good collaboration tool for storing the conversations that occur around the code commits.\r
+\r
+The OpenDaylight source code is hosted in a repository in Git. Developers must use Gerrit to commit code to the OpenDaylight repository.\r
+\r
+NOTE: For more information on Git, see http://git-scm.com/. For more information on Gerrit, see https://code.google.com/p/gerrit/.\r
+\r
+=== Setting up a Gerrit account\r
+\r
+. Using a Google Chrome or Mozilla Firefox browser, go to https://git.opendaylight.org/gerrit\r
+\r
+The main page shows existing Gerrit requests. These are patches that have been pushed to the repository and not yet verified, reviewed, and merged.\r
+\r
+NOTE: If you already have an OpenDaylight account, you can click *Sign In* in the top right corner of the page and follow the instructions to enter the OpenDaylight page.\r
+\r
+.Signing in to OpenDaylight account\r
+\r
+image::Sign_in.jpg[Signing in to OpenDaylight account]\r
+\r
+[start=2]\r
+\r
+. If you do not have an existing OpenDaylight account, click *Account signup/management* on the top bar of the main Gerrit page.\r
+\r
+The *WS02 Identity Server* page is displayed.\r
+\r
+\r
+.Gerrit Account signup/management link\r
+\r
+image::Gerrit_setup.jpg[Account signup/management link]\r
+\r
+[start=3]\r
+\r
+. In the *WS02 Identity Server* page, click *Sign-up* in the left pane.\r
+\r
+There is also an option to authenticate your sign in with OpenID. This option is not described in this document.\r
+\r
+.Sign-up link for Gerrit account\r
+\r
+image::sign-up.jpg[Sign-up link for Gerrit account]\r
+\r
+[start=4]\r
+\r
+. Click on the *Sign-up with User Name/Password* image on the right pane to continue to the actual sign-up page.\r
+\r
+.Sign-up with User Name/Password Image\r
+\r
+image::signup_image.jpg[Sign-up with User Name / Password Image]\r
+\r
+[start=5]\r
+\r
+. Fill out the details in the account creation form and then click *Submit*.\r
+\r
+.Filling out the details\r
+\r
+image::form_details.jpg[Filling out the details]\r
+\r
+You now have an OpenDaylight account that can be used with Gerrit to pull the OpenDaylight code.\r
+\r
+=== Generating SSH keys for your system\r
+\r
+You must have SSH keys for your system to register with your Gerrit account. The method for generating SSH keys is different for different types of operating systems.\r
+\r
+The key you register with Gerrit must be identical to the one you will use later to pull or edit the code. For example, if you have a development VM which has a different UID login and keygen than that of your laptop, the SSH key you generate for the VM is different from the laptop. If you register the SSH key generated on your VM with Gerrit and do not reuse it on your laptop when using Git on the laptop, the pull fails.\r
+\r
+NOTE: For more information on SSH keys for Ubuntu, see https://help.ubuntu.com/community/SSH/OpenSSH/Keys. For generating SSH keys for Windows, see https://help.github.com/articles/generating-ssh-keys.\r
+\r
+For a system running Ubuntu operating system, follow the steps below:\r
+\r
+. Run the following command:\r
+\r
+[literal]\r
+\r
+mkdir ~/.ssh\r
+chmod 700 ~/.ssh\r
+ssh-keygen -t rsa\r
+\r
+[start=2]\r
+\r
+. You are prompted for a location to save the keys, and a passphrase for the keys.\r
+\r
+This passphrase protects your private key while it is stored on the hard drive. You must use the passphrase to use the keys every time you need to login to a key-based system.\r
+\r
+[literal]\r
+\r
+Generating public/private rsa key pair.\r
+Enter file in which to save the key (/home/b/.ssh/id_rsa):\r
+Enter passphrase (empty for no passphrase):\r
+Enter same passphrase again:\r
+Your identification has been saved in /home/b/.ssh/id_rsa.\r
+Your public key has been saved in /home/b/.ssh/id_rsa.pub.\r
+\r
+Your public key is now available as *.ssh/id_rsa.pub* in your home folder.\r
+\r
+=== Registering your SSH key with Gerrit\r
+\r
+. Using a Google Chrome or Mozilla Firefox browser, go to https://git.opendaylight.org/gerrit.\r
+\r
+[start=2]\r
+. Click *Sign In* to access the OpenDaylight repository.\r
+\r
+.Signin in to OpenDaylight repository\r
+\r
+image::Sign_in.jpg[Signin in to OpenDaylight repository]\r
+\r
+[start=3]\r
+. Click your name in the top right corner of the window and then click *Settings*.\r
+\r
+The *Settings* page is displayed.\r
+\r
+.Settings page for your Gerrit account\r
+\r
+image::Gerrit_settings.jpg[Settings page for your Gerrit account]\r
+\r
+[start=4]\r
+. Click *SSH Public Keys* under *Settings*.\r
+\r
+. Click *Add Key*.\r
+\r
+. In the *Add SSH Public Key* text box, paste the contents of your *id_rsa.pub* file and then click *Add*.\r
+\r
+.Adding your SSH key\r
+\r
+image::SSH_keys.jpg[Adding your SSH key]\r
+\r
+To verify your SSH key is working correctly, try using an SSH client to connect to Gerrit's SSHD port. \r
+\r
+[literal]\r
+\r
+$ ssh -p 29418 <sshusername>@git.opendaylight.org\r
+Enter passphrase for key '/home/cisco/.ssh/id_rsa': \r
+**** Welcome to Gerrit Code Review ****\r
+Hi <user>, you have successfully connected over SSH.\r
+Unfortunately, interactive shells are disabled.\r
+To clone a hosted Git repository, use: git clone ssh://<user>@git.opendaylight.org:29418/REPOSITORY_NAME.git\r
+Connection to git.opendaylight.org closed.\r
+\r
+You can now proceed to either Pulling, Hacking, and Pushing the Code from the CLI or Pulling, Hacking, and Pushing the Code from Eclipse depending on your implementation.\r
+\r
+\r
+\r
+\r
Code Review / docs.git / commitdiff
