1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) OPNFV, Intel Corporation and others.
.. OPNFV SAMPLEVNF Documentation design file.
====================================
Get started as a SampleVNF developer
===================================
.. _SampleVNF: https://wiki.opnfv.org/samplevnf
.. _Gerrit: https://www.gerritcodereview.com/
.. _JIRA: https://jira.opnfv.org
.. _Technical_Briefs: https://wiki.opnfv.org/display/SAM/Technical+Briefs+of+VNFs
Prerequisite knowledge
======================
Development/Contribution to SampleVNF requires knowledge of networking
technologies including knowledge of network protocols and hands-on experience
with relevant open-source software, such as Linux*, SDN, NFVI and the DPDK (if
VNF is based on DPDK libraries).
Developer needs debugging and benchmarking skills, as well as understanding of
NFVi infrastructure across multiple domains.
There are many ways to contribute to samplevnf.
* Develop new test cases in samplevnf
* Review code changes
* Develop/contribute to existing VNFs or new VNFs
* Write samplevnf documentation
Technical Briefs of exists in VNFs in Technical_Briefs_
Get Started
===========
Where can I find some help to start?
You can also directly contact us by mail with [SampleVNF] prefix in the title
at opnfv-tech-discuss@lists.opnfv.org or on the IRC chan #opnfv-samplevnf.
How TOs
-------
How can I contribute to SampleVNF?
If you are already a contributor of any OPNFV project, you can contribute to
samplevnf.
If you are totally new to OPNFV, you must first create your Linux Foundation
account, then contact us in order to declare you in the repository database.
We distinguish 2 levels of contributors:
The standard contributor can push patch and vote +1/0/-1 on any samplevnf patch
The committer can vote -2/-1/0/+1/+2 and merge.
SampleVNF committers are promoted by the samplevnf contributors.
Gerrit & JIRA
-------------
OPNFV uses Gerrit_ for web based code review and repository management for the
Git Version Control System. You can access OPNFV Gerrit from this link.
Please note that you need to have Linux Foundation ID in order to use OPNFV
Gerrit.
You can get one from this link.
OPNFV uses JIRA_ for issue management. An important principle of change
management is to have two-way traceability between issue management (i.e. JIRA_)and the code repository (via Gerrit).
In this way, individual commits can be traced to JIRA issues and we also know
which commits were used to resolve a JIRA issue.
If you want to contribute to samplevnf, you can pick a issue from SampleVNF's
JIRA dashboard or you can create you own issue and submit it to JIRA.
Submitting code to Gerrit
-------------------------
Installing and configuring Git and Git-Review is necessary in order to submit
code to Gerrit.
The Getting to the code page will provide you with some help for that.
Comitting the code with Git
Open a terminal window and set the project's directory to the working directory
using the cd command.
In this case "/home/opnfv/samplevnf" is the path to samplevnf project folder.
Replace this with the path of your own project.
::
cd /home/opnfv/samplevnf
Tell Git which files you would like to take into account for the next commit.
This is called 'staging' the files, by placing them into the staging area,
using the 'git add' command (or the synonym 'git stage' command).
::
git add samplevnf/samples/sample.yaml
...
Alternatively, you can choose to stage all files that have been modified
(that is the files you have worked on) since the last time you generated a
commit, by using the -a argument.
::
git add -a
Git won't let you push (upload) any code to Gerrit if you haven't pulled
the latest changes first.
So the next step is to pull (download) the latest changes made to the project
by other collaborators using the 'pull' command.
::
git pull
Now that you have the latest version of the project and you have staged the
files you wish to push, it is time to actually commit your work to your local
Git repository.
::
git commit --signoff -m "Title of change
Test of change that describes in high level what
was done. There is a lot of documentation in code
so you do not need to repeat it here.
JIRA: SAMPLEVNF-XXX"
The message that is required for the commit should follow a specific set of
rules. This practice allows to standardize the description messages attached
to the commits, and eventually navigate among the latter more easily.
Verify your patch locally before submitting
Once you finish a patch, you can submit it to Gerrit for code review.
A developer sends a new patch to Gerrit will trigger patch verify job on
Jenkins CI.
Pushing the code to Gerrit for review
Now that the code has been comitted into your local Git repository the
following step is to push it online to Gerrit for it to be reviewed. The
command we will use is 'git review'.
::
git review
This will automatically push your local commit into Gerrit.
Code review
You can add Samplevnf committers and contributors to review your codes.
Modifying the code under review in Gerrit
At the same time the code is being reviewed in Gerrit, you may need to edit it to
make some changes and then send it back for review. The following steps go
through the procedure.
Once you have modified/edited your code files under your IDE, you will have to
stage them.
The 'status' command is very helpful at this point as it provides an overview
of Git's current state.
::
git status
The output of the command provides us with the files that have been modified
after the latest commit.
You can now stage the files that have been modified as part of the Gerrit code
review edition/modification/improvement using git add command.
It is now time to commit the newly modified files, but the objective here is
not to create a new commit, we simply want to inject the new changes into the
previous commit.
You can achieve that with the '--amend' option on the 'commit' command:
::
git commit --amend
If the commit was successful, the 'status' command should not return the updated
files as about to be commited.
The final step consists in pushing the newly modified commit to Gerrit.
::
git review
References
[1]: http://artifacts.opnfv.org/samplevnf/docs/testing_user_userguide_vACL/index.html
|
