Wiki source code of DevOps Portal for Users

Version 13.1 by DOaaS Operator on 2025/11/13 15:03

Show last authors
1 Welcome to the DevOps Portal. This guide will walk you through the initial steps to begin your first DevOps project seamlessly.
2
3 Below, you will find a series of actions required to get your project up and running:
4
5 {{toc/}}
6
7
8 = Invitation and activation{{id name="Invitation and activation"/}} =
9
10 To begin using our software solution, you must first receive an invitation email from an administrator who has created your account.
11
12 This email will enable you to activate your account.
13
14 Please see the example below:
15
16 [[image:1763042544636-589.png||data-xwiki-image-style-border="true"]]
17
18 Upon receiving an email containing an invitation link, you can activate your account by either clicking the link directly or copying and pasting it into a new browser window.
19
20 Once completed, you will be directed to a page on our platform confirming the successful activation of your account.
21
22 Please see the example below:
23
24 [[image:1763042597764-495.png||data-xwiki-image-style-border="true"]]
25
26 With your account now created and successfully activated, the next step is to set up your password.
27
28 Upon completing the activation process, the system will automatically send you an email containing a link to create your password.
29
30 Please see the example below:
31
32 [[image:1763042890784-731.png||data-xwiki-image-style-border="true"]]
33
34 Similar to the account activation process, you can create your password by either clicking the link provided in the email or by copying and pasting it into a new browser window.
35
36 Upon completion, you will be directed to a page on our platform prompting you to take further action.
37
38 Please click on the "**Click here to proceed**" link.
39
40 An example is provided below:
41
42 [[image:1763042933491-194.png||data-xwiki-image-style-border="true"]]
43
44
45 (% class="box infomessage" %)
46 (((
47 == Optional Two-Factor Authentication(2FA) configuration ==
48
49 At this stage of your account setup, it is possible that, based on your specific environment configuration, an additional level of authentication may be required.
50
51 If this is the case, the system will automatically prompt you to integrate this requirement into your setup.
52
53 To enable two-factor authentication, you will need a **smartphone **with an authenticator app installed such as **Google Authenticator** or **Microsoft Authenticator**.
54
55 After clicking "**Click here to proceed**" on the previous page, you will be directed to a screen resembling the one shown below:
56
57 [[image:Screenshot 2024-11-19 091818.png||alt="Second Factor Authentication setup" data-xwiki-image-style-border="true" class="img-thumbnail"]]
58
59 After scanning the QR code, enter the code generated by your authenticator application and create a custom identifier to easily remember which smartphone or account can generate the correct one-time code.
60
61 If you are unable to scan the QR code, click on the "**Unable to scan**" link for alternative instructions to obtain the one-time code from your authenticator application.
62
63 Once you follow the instructions provided and click the "**Submit**" button or press **Enter **on your keyboard, you will be directed to the password update page
64 )))
65
66 Whether or not you need to configure the second authentication factor, you will now be redirected to the password update page.
67
68 Here, you can select a new password that meets the required strength criteria.
69
70 Please enter your chosen password twice for confirmation.
71
72 After completing this step, click "**Submit**."
73
74 Below is an example screenshot for your reference:
75
76 [[image:1763043012921-785.png||data-xwiki-image-style-border="true"]]
77
78 Once your password update is **successful**, you will be taken to a confirmation page indicating the update's success and providing a link to the application's login page.
79
80 Below is an example screenshot for your reference:
81
82 [[image:1763043036241-364.png||data-xwiki-image-style-border="true"]]
83
84 With this last step, your account **setup is complete**, and you can now use it to access the application. **Well done**.
85
86
87 = Log in to DevOps Portal{{id name="Log in to DevOps Portal"/}} =
88
89 To access the application, begin by entering its URL into the address bar.
90
91 The application will then automatically direct you to the login screen.
92
93 Please refer to the example screenshot below:
94
95 [[image:Screenshot 2024-11-14 155426.png||alt="Page of Log-in" data-xwiki-image-style-border="true" class="img-thumbnail"]]
96
97 You can now access the application by entering your email and password and clicking the "**Log in"** button, or by pressing the Enter key on your keyboard.
98
99 Below is an example of how to complete the fields:
100
101 (% class="confluence-embedded-file-wrapper confluence-embedded-manual-size" %)[[image:Screenshot 2024-11-19 090916.png||alt="Login page filled" data-xwiki-image-style-border="true" class="img-thumbnail"]]
102
103
104 (% class="box infomessage" %)
105 (((
106 == Optional Two-Factor Authentication(2FA) Request ==
107
108 If you had to set up two-factor authentication (2FA) for each new login, you'll be asked to enter the one-time code generated by your authenticator application.
109
110 Once you've entered the code, click "**Submit**."
111
112 Below is an example screenshot:
113
114 [[image:Screenshot 2024-11-19 091946.png||alt="Second Factor Authentication requested" data-xwiki-image-style-border="true" class="img-thumbnail"]]
115 )))
116
117 With this last step, you have successfully **logged in** and you can now use the application. **Well done**.
118
119
120 = Forgotten Password{{id name="Forgotten Password"/}} =
121
122 To access the application, in case you have forgotten your password, start by loading the login screen in your browser.
123
124 On this page there is a link with the text "**Forgot Password?**" click on it to be redirected to the login recovery procedure.
125
126 Here is an example screenshot below:
127
128 [[image:Screenshot 2024-11-14 155426.png||alt="Page of Log-in" data-xwiki-image-style-border="true" class="img-thumbnail"]]
129
130 Once you click on the "**Forgot Password?**" link, you will be shown a new page where you just need to enter your email address and then click "**Submit**" or press enter on your keyboard.
131
132 This action will send your email a link with which you can change your password.
133
134 Here is an example screenshot below:
135
136 [[image:Screenshot 2024-11-19 092035.png||alt="Page of password reset" data-xwiki-image-style-border="true" class="img-thumbnail"]]
137
138
139 (% class="box infomessage" %)
140 (((
141 == Optional Two-Factor Authentication(2FA) Request ==
142
143 If you had to set up two-factor authentication (2FA) for each password change, you'll be asked to enter the one-time code generated by your authenticator application.
144
145 Once you've entered the code, click "**Submit**."
146
147 Below is an example screenshot:
148
149 [[image:Screenshot 2024-11-19 091946.png||alt="Second Factor Authentication requested" data-xwiki-image-style-border="true" class="img-thumbnail"]]
150 )))
151
152 You will then have to wait for the **password reset email** to arrive in your **inbox**.
153
154 Of course, it's always a good idea to check the **Spam **section of your inbox or **repeat the steps** if the email doesn't seem to be arriving, before contacting the support.
155
156 Here is a sample screenshot of the email below:
157
158 [[image:Screenshot 2024-11-19 092201.png||alt="Email of password reset" data-xwiki-image-style-border="true" class="img-thumbnail"]]
159
160 Once you click on the password reset link, your browser will open to a web page. On this webpage, you will be asked to choose a new password that meets the required security criteria.
161
162 Enter your chosen password twice to confirm.
163
164 After completing this step, click "**Submit**."
165
166 Here's a sample screenshot of the page below:
167
168 [[image:Screenshot 2024-11-19 092226.png||alt="Page of password change" data-xwiki-image-style-border="true" class="img-thumbnail"]]
169
170 With this last step, you have successfully **reset your password**, and you can now use the application. **Well done**.
171
172
173 = Change password{{id name="Change password"/}} =
174
175 If you wish to change your password, the first step is to log in to the portal using your credentials.
176
177 Once you are logged in, locate and click on the "**Account"** drop-down menu in the main menu.
178
179 Within the drop-down menu, you will find an option labeled "**Password**" click on this option to proceed with changing your password.
180
181 Below is an example screenshot:
182
183 [[image:Screenshot 2024-11-19 144030.png||alt="Triggering Change Password" data-xwiki-image-style-border="true" class="img-thumbnail"]]
184
185 Once you click on the "**Password**" link, you will be shown a new page.
186
187 On this page, your email address is placed in square brackets.
188
189 You just have to press the "**Request e-mail for new password**" button to send you the email to change your password.
190
191 Here is an example screenshot below:
192
193 [[image:Screenshot 2024-11-19 144045.png||alt="Password Reset image" data-xwiki-image-style-border="true" class="img-thumbnail"]]
194
195 You will then have to wait for the **password change email** to arrive in your **inbox**.
196
197 Of course, it's always a good idea to check the **Spam **section of your inbox or **repeat the steps** if the email doesn't seem to be arriving, before contacting the support.
198
199 Here is a sample screenshot of the email below:
200
201 [[image:Screenshot 2024-11-19 092201.png||alt="Email of password reset" data-xwiki-image-style-border="true" class="img-thumbnail"]]
202
203 Once you click on the password change link, your browser will open to a web page. On this webpage, you will be asked to choose a new password that meets the required security criteria.
204
205 Enter your chosen password twice to confirm.
206
207 After completing this step, click "**Submit**."
208
209 Here's a sample screenshot of the page below:
210
211 [[image:Screenshot 2024-11-19 092226.png||alt="Page of password reset" data-xwiki-image-style-border="true" class="img-thumbnail"]]
212
213 With this last step, you have successfully **changed your password**, and you can now use the application. **Well done**.
214
215
216 = Select Languages - Sprachen auswählen{{id name="Select Languages"/}} =
217
218 The DevOps portal is set to **English **by default, which applies to all web pages and sent emails within the system.
219
220 However, there is an option available on each page we created to change the settings and switch to **German (Deutsch)**.
221
222 Here is a sample screenshot below:
223
224 [[image:Screenshot 2024-11-21 152351.png||alt="change language" data-xwiki-image-style-border="true" class="img-thumbnail"]]
225
226 Within the DevOps portal, users have the option to change the language.
227
228 This can be done via the drop-down "**Language**" menu located in the top left corner.
229
230 Any changes made will be applied to the system's web and email pages.
231
232 [[image:Screenshot 2024-11-21 152713.png||alt="change language in the portal" data-xwiki-image-style-border="true" class="img-thumbnail"]]
233
234 With this **last step**, you are now aware of all the possibilities for the selected language. **Well done**.
235
236
237 Wenn das DevOps-Portal auf **Deutsch **eingestellt ist, gilt dies für alle Websites und E-Mails, die innerhalb des Systems versendet werden.
238
239 Auf jeder Seite, die wir erstellt haben, steht jedoch eine Option zur Verfügung, um die Einstellungen zu ändern und auf **Englisch(English)** zu wechseln.
240
241 Hier ist ein Beispiel-Screenshot unten:
242
243 [[image:Screenshot 2024-11-21 152426.png||alt="change language german" data-xwiki-image-style-border="true" class="img-thumbnail"]]
244
245 Innerhalb des DevOps-Portals haben Benutzer die Möglichkeit, die Sprache zu ändern.
246
247 Dies kann über das Dropdown-Menü "**Sprache**" in der oberen linken Ecke erfolgen.
248
249 Alle vorgenommenen Änderungen werden auf die Web- und E-Mail-Seiten des Systems angewendet.
250
251 [[image:Screenshot 2024-11-21 154936.png||alt="change language in the portal german" data-xwiki-image-style-border="true" class="img-thumbnail"]]
252
253 Mit diesem **letzten Schritt** sind Sie sich nun über alle Möglichkeiten für die ausgewählte Sprache im Klaren. **Gut gemacht**.
254
255
256 = The First Access =
257
258 After completing the logging in for the first time, you might find yourself facing a **completely blank page**, as shown in the example screenshot provided below:
259
260 [[image:Screenshot 2024-11-21 152652.png||alt="no projects" data-xwiki-image-style-border="true" class="img-thumbnail"]]
261
262 Please do not be **alarmed**. This situation typically indicates that you have not yet been assigned any projects, or there might be a configuration issue.
263
264 The application itself is **functioning correctly**. To address this matter, there are a few steps you can take.
265
266 If you have **contact **information for the **system administrator**, please reach out to them directly for assistance.
267
268 The administrator will be **able to assign** the necessary project or projects or rectify any configuration **problems**.
269
270 If you do not have direct contact with the administrator, you can easily identify them by navigating to the users page located in the main menu.
271
272 This will provide you with the information needed to reach out to the appropriate person **for support**.
273
274 Once everything has been configured correctly and any necessary project assignments have been made, the page **will no longer be empty**.
275
276 Instead, you will see **links to all the tools **and resources you have access to, enabling you to fully utilize the application.
277
278 Here is a sample screenshot below:
279
280 [[image:Screenshot 2024-11-22 135917.png||alt="nomal login" data-xwiki-image-style-border="true" class="img-thumbnail"]]
281
282 With this last step, you have successfully **made your first access**. **Well done**.
283
284
285 = The Projects Page =
286
287 In the main menu, one of the most important pages you will encounter is the **Projects page**.
288
289 This page provides a comprehensive overview of all the projects that have been assigned to you, along with a detailed view of their various features and attributes.
290
291 Key informantion available on this page include **Project key**, **Type**, **Status**, and **Project Role**.
292
293 To help you better understand, we have provided an example screenshot below:
294
295 [[image:Screenshot 2024-11-22 140014.png||alt="projects page" data-xwiki-image-style-border="true" class="img-thumbnail"]]
296
297 This page also allows you to **search **for projects that you have access to with the search bar under the **Projects **heading.
298
299 While with the **drop-down** menu on the left you can select a **portal user** to see if they have access to the projects you have access to.
300
301 It is important to note that the appearance of this screen may vary depending on your permission level.
302
303 If you have been granted a **higher level of permissions**, your view might look different from the example provided.
304
305 In such cases, you can simply **follow **this link: [[DevOps Portal for Admins>>doc:DevOps Portal for Admins.WebHome]] to access the relevant information.
306
307 For those who need more detailed information about the **individual tools**, we recommend referring to the **specialized pages** dedicated to it.
308
309 These pages offer **in-depth explanations** and **guidance **on how to effectively utilize each tool.
310
311 Here is a list of useful links that you may find helpful for further details:
312
313 * [[Jira>>doc:Jira.WebHome]]
314 * [[Confluence>>doc:Confluence.WebHome]]
315 * [[Bitbucket>>Bitbucket]]
316 * [[Jenkins>>doc:Jenkins.WebHome]]
317 * [[Sonarqube>>doc:SonarQube.WebHome]]
318 * [[Gitea>>doc:Gitea.WebHome]]
319 * [[Harbor>>doc:Harbor.WebHome]]
320 * [[Rancher 2>>doc:Rancher 2.WebHome]]
321
322 With this last step, you have successfully **analized your project page**. **Well done**.
323
324
325 = The Users Page =
326
327 In the main menu, another crucial page you will come across is the **Users **page.
328
329 This page is designed to provide you with a comprehensive overview of all the users who have been **created within the portal**.
330
331 Below, you will find an example screenshot:
332
333 [[image:Screenshot 2024-11-22 140413.png||alt="User page" data-xwiki-image-style-border="true" class="img-thumbnail"]]
334
335 The is a **search bar** located under the Users heading enables you to quickly find the **user you are looking** for by entering relevant keywords.
336
337 Additionally, on the **left side** of the page, you will find a **drop-down **menu that allows you to filter the projects to which you have access.
338
339 This feature helps you to streamline your search and view only the users associated with specific projects.
340
341 You can sort the table in both **ascending **and **descending **order by **simply clicking on the headers** of the columns you wish to sort.
342
343 Moreover, the Users page is equipped with easily accessible **contact **information for the **administrators**.
344
345 The information is presented in a clear and straightforward manner, **minimizing **any potential confusion or **delays in communication**.
346
347 With this last step, you have successfully **analized your user page**. **Well done**.