blob: c95f12f2da0ebc7fa0d3e914b170410ef2baac89 [file] [log] [blame]
Joey Armstrong56334fc2023-01-15 22:53:19 -05001.. _my-reference-label:
2.. _gerrit-user-account:
3
4Getting Started
5###############
6
7- Register with ONF
8- gerrit user account
9- github user account
10
11Register with ONF
12=================
13
14Begin by registering with OpenNetworkingFoundation, this will create a
15user account for you to access resources: gerrit, jenkins, wiki, etc.
16
17- https://opennetworking.org/register/
18
19
20Gerrit user account
21===================
22
23Next navigate to gerrit.opencord.org, login and configure your user account
24^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
25
26- `Gerrit Login <https://gerrit.opencord.org/login/%2Fq%2Fstatus%3Aopen%2B-is%3Awip>`_
27
28- `User Settings <https://gerrit.opencord.org/settings/>`_
29 - Verify full name and display name fields are populated.
30 - Verify your email address is correct.
31
32- Generate and deploy an ssh key to interact with the repository:
33 - `Public SSH key <https://gerrit.opencord.org/settings>`_ (#SSHKeys)
34
35- Verify your ssh access
36
37.. sourcecode:: shell
38
39 # Generate a new ssh key
40 $ cd .ssh
41 $ ssh-keygen -t ed25519 -f id_gerrit -C 'tux@opennetworking.org'
42
43 # Connect passing -T, -p(ort), -i(dentity)
Joey Armstrongb8a1e052023-08-07 09:32:53 -040044 $ ssh -T -p 29418 -i ~/.ssh/id_gerrit 'tux@opennetworking.org@gerrit.opencord.org'
Joey Armstrong56334fc2023-01-15 22:53:19 -050045
46 $ ssh-add ~/.ssh/id_gerrit
Joey Armstrongb8a1e052023-08-07 09:32:53 -040047 $ ssh -T -p 29418 'tux@opennetworking.org@gerrit.opencord.org'
Joey Armstrong56334fc2023-01-15 22:53:19 -050048
49
50
51Github user account
52===================
53
54Enable two-factor authentication
55^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
56- https://github.com/settings/security
57
58Generate and upload a public ssh key to interact with the repository:
59"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
60- https://github.com/settings/keys
61
62
63
64Git config settings
65===================
66
67.. sourcecode:: shell
68
69 ## Config required by git:
70 $ git config --global user.name 'Tux Penguin'
71 $ git config --global user.email 'tux@opennetworking.org'
72
73 ## Config required by gerrit:
74 $ git config --global gitreview.username 'tux@opennetworking.org'
75
76 ## Convenience:
77 $ git config --global alias.br branch
78 $ git config --global alias.ci commit
79 $ git config --global alias.co checkout
80 $ git config --global alias.st status
81
82 ## Optional configs:
83 $ git config --global color.ui auto
84 $ git config --global pater.diff false