Skip to Content
Last modified by DOaaS Operator on 2025/11/20 11:41
Show last authors
1 The DevOps portal is used to manage DevOps-as-a-Service, which is a set of tools that aid in the delivery, development, and management of applications throughout the systems development life cycle, as coordinated by an organization that uses DevOps practices.
2
3 (% style="color:#003366" %)__Table of contents:__
4
5 {{toc/}}
6
7 = Creating user accounts =
8
9 After a successful login you can continue with onboarding your colleges. In the top menu, click **Users**, then click **Create User** button:
10
11 [[image:1763562495483-386.png||data-xwiki-image-style-border="true"]]
12 Please fill in the required fields with the user's Name and Email address (where the activation email will be sent), and select the Organization (or use the default).
13
14 The Organization can be the default organization, or you can create a different organization. Find more information in the [[Creating organizations>>||anchor="HCreatingOrganizations"]] and [[Modify Organizations>>||anchor="HModifyOrganizations"]] sections.
15
16 The Portal Role (in this example, it will be USER) can be either Admin (with permission to manage the portal) or User (without permission to change users, organizations, etc.). By default, all user accounts are created as User.
17
18 The Tools section lets you choose which tool(s) the user should have access to.
19
20 Click **Save** to send the invitation email to the user. Please refer to [[DevOps Portal for Users>>doc:DevOps Portal for Users.WebHome]] for further information regarding the activation process and password change.
21
22 [[image:1763562615324-864.png||height="535" width="973"]]
23
24 The new user's status will be **CREATED **until the profile has been activated. Activation can either be done by the user her-/himself (by following the received link) or by an admin user via **More ... → Activate**. The latter option will prompt the admin to manually set the user's password
25
26 (% class="box warningmessage" %)
27 (((
28 ⚠ **Note**
29 Manual activation is not recommended since it bypasses email verification so use with caution!
30 )))
31
32
33 [[image:1763562797201-420.png||data-xwiki-image-style-border="true" height="236" width="150"]]
34
35 [[image:1763562956443-820.png||data-xwiki-image-style-border="true" height="200" width="988"]]
36
37
38
39 If needed, a user can be invited again by selecting the **Reinvite** option. This can be used if the user missed the activation deadline mentioned in the email, without locking the user's account.
40
41 [[image:1763562797201-420.png||data-xwiki-image-style-border="true" height="236" width="150"]]
42
43 After receiving the email, the user's status will be CREATED. Once the activation is successful, the status will change to ACTIVE.
44
45 If an email address was entered incorrectly, the user will need to be deleted and recreated. Email addresses cannot be changed for existing users.
46
47
48 = Modifying user accounts =
49
50 A user account can be modified by clicking his / her last name. However, **it's not possible to change a user's e-mail address**.
51
52 [[image:1763562956443-820.png||data-xwiki-image-style-border="true" height="142" width="701"]]
53
54 To **change the user's email address**, the user must be **//deleted//** first. It can then be recreated with the new email address.
55
56 Under the Users menu, the **Lock/Unlock** function is available in the **More...** dropdown menu. This function is used to suspend a user account (which is a necessary step before deleting a profile). The status can be changed to locked or unlocked here.
57
58 Please keep in mind that a locked user can still receive notification emails.
59
60 [[image:1763563098133-556.png||data-xwiki-image-style-border="true" height="348" width="953"]]
61
62 In order to **delete** a user, he / she **must be locked first** and must remain in locked status for a certain period of time. Since deletion is not reversible, It is suggested to //only lock// users rather than deleting the user profile.
63
64 The **Delete** option will present a confirmation.
65
66 An attempt to delete a locked user without being in locked state long enough will result in an error message: "This user has not yet spent enough time in Locked status to be deleted."
67
68 In case of a re-invited user, it is also possible to let the admin do the activation process instead of the user. To do so, click **Activate**. The user can still change the password later with the reset password option. Please refer to the [[Forgotten Passwords>>doc:DevOps Portal for Users.WebHome||anchor="HForgottenPassword" shape="rect" class="createlink"]] section of the DevOps Portal for Users page for details regarding forgotten passwords.
69
70 {{warning}}
71 ⚠ **Note**
72 A user can have 3 statuses in the Self-service Portal: **CREATED**, **ACTIVE** and **LOCKED**. In case there is a //question mark// or an //exclamation mark// shown in brackets right after the status name, there might be some synchronization issue. For more information about user statuses and troubleshooting, please have a look at the [[User statuses in DevOps Portal>>doc:DevOps Portal for Admins.User statuses in DevOps Portal.WebHome]] page.
73 {{/warning}}
74
75
76 = {{id name="creating_tech_users"/}}Creating Technical Users =
77
78 For automation tasks, technical users can be created. The technical user is bound to **one tool**. To create a technical user, access the **Technical Users **menu and click the **Create Technical User **button.
79
80 [[image:1763563209345-647.png||data-xwiki-image-style-border="true"]]
81
82
83 When creating a technical user, it is necessary to choose a **username** and to **select the tool**. It is recommended to choose a username that refers to the exact task or tool. The password is already pre-generated to be as secure as possible, but it can be manually changed (though not recommended).
84
85 //The description is optional for creating a technical user.//
86
87 [[image:1763563267797-731.png||height="202" width="36"]]
88
89 [[image:1763563315208-492.png||height="297" width="704"]]
90
91 = Modifying Technical User accounts =
92
93
94 [[image:attach:image-2023-4-25_16-41-23.png||data-xwiki-image-style-border="true" width="1000"]]
95
96 To view the details of a technical user, click its username. Tick the Edit Details box to make modifications to that user.
97
98 [[image:attach:image-2023-4-26_10-15-29.png||thumbnail="true" width="250"]]
99
100 It's also possible to change the tech user's password here. There is a minimum length required for passwords.
101
102 [[image:1763563537660-474.png||data-xwiki-image-style-border="true" height="395" width="632"]]
103
104 If you would like to change the username or the selected tool you have to **Delete** the user and recreate it again. The **Delete** option will present a confirmation.
105
106
107 = {{id name="manageorganizations"/}}Creating Organizations =
108
109 Per default, a user account is assigned to one organization (here in the example the default organization is //Manoni//). To add more organizations to a user account, click **Organizations **in the top menu and add a new organization by clicking **Create Organization**:
110
111 [[image:1763563645298-625.png||data-xwiki-image-style-border="true" height="253" width="912"]]
112
113 In the following example we create the fictional company //Wayne Corp//.
114
115 [[image:1763563688872-353.png||data-xwiki-image-style-border="true" height="161" width="634"]]
116
117
118
119 After providing a name for your organization, click **Save** to create the new organization.
120
121 [[image:1763563735395-115.png||data-xwiki-image-style-border="true" height="219" width="1000"]]
122
123
124 More organizations can be added by repeating these steps.
125
126
127 = Modify Organizations =
128
129 To modify an organization's profile, click the** organization name** (Wayne Corp in the example).
130
131 [[image:1763563735395-115.png||data-xwiki-image-style-border="true" height="219" width="1000"]]
132
133
134 The **Edit an Organization page** will load and you can change the organization's name by replacing the name with the new one (so it is not necessary to delete an organization just because of the wrong name or a typo). As with the users edit page, the **Edit Details checkbox needs to be ticked **for editing to be enabled.
135
136 [[image:1763563793297-134.png||height="166" width="476"]]
137
138 There is an option to **Delete** an organization, but keep in mind, that deleting an organization is not reversible. An organization cannot be deleted if at least one user is still assigned to the organization. The deletion process can be accessed from the Actions - More button. A confirmation will appear.
139
140 [[image:1763563828637-290.png||data-xwiki-image-style-border="true" height="206" width="837"]]
141
142 The default organization is tied to the DevOps-as-a-Service instance and can never be renamed or deleted.
143
144
145 = Creating Projects =
146
147 In order to use the provided tools of DevOps services, first you have to create a project. Just Click on **Projects **in the top menu.
148
149 [[image:1763636823143-571.png||data-xwiki-image-style-border="true" height="240" width="932"]]
150
151 The list of projects will be loaded. If there isn't any project in the list, then one can be created easily:
152
153 To add a new project click **Create Project**:
154
155 [[image:1763636880688-469.png||data-xwiki-image-style-border="true"]]
156
157
158 Fill-in the following field:
159
160 **Project Key:** This identifier cannot be changed later and is used to identify the project in all tools. Letters and numbers are supported, but no special characters are allowed and it cannot start with a number. The portal will automatically display the Project Key in uppercase, but in some tools, it will appear in lowercase.
161
162 **Name:** This is the name of the project. Spaces are supported.
163
164 **Type:** The default value is PRIVATE, which means that members of the project will need to have a role assigned to gain access to the project.
165
166 **Tools:** These are the available tools that can be used in the toolchain by default.
167
168 **Description:** This is an optional field for a description of the project.
169
170 [[image:1763636983986-204.png||data-xwiki-image-style-border="true" height="799" width="1492"]]
171
172
173
174
175 Click **Save** to create the project. The list of projects will be reloaded and should contain the new project. If you would like to add more projects then repeat the previous step.
176
177 In the following example WI1 project has been added.
178 [[image:1763637077465-799.png||data-xwiki-image-style-border="true" height="195" width="1216"]]
179
180
181
182
183 = {{id name="managingprojects"/}}Managing Projects =
184
185 To see or update the settings of a project, click the **Project Key** (WI1 in the example). Click **More ...** to open the actions menu.
186
187 [[image:1763637112506-519.png||data-xwiki-image-style-border="true" height="245" width="1326"]]
188
189 When nobody works on a project anymore, the project can be //archived// by using **Retire.** A retired project cannot be accessed anymore, because all roles of the project will be removed from the associated tools. If you would like to use this project again you can **Reactivate **it. The project will then be {{code language="none"}}Active{{/code}} and usable again, but user roles have to be restored manually if necessary.
190
191 Retiring a project does not delete the project's data, it makes it inaccessible only.
192
193 If you would like to permanently remove a (retired) project, select **Delete** in the Actions menu (but keep in mind that a deleted project cannot be activated again, so it is suggested to just retire a project rather than deleting it).
194
195 {{error title="⚠ **Warning**"}}
196 (% style="color:#993300" %)Deleting a project is irreversible and project data will be lost!
197 {{/error}}
198
199
200 [[image:attach:image-2023-4-26_15-2-3.png||data-xwiki-image-style-border="true" height="400"]]
201
202
203 //**A project can only be deleted after having spent some time in the Retired status.**//
204
205 A **confirmation** is needed where you can type the project's name that you would like to delete and click on **Delete** button.
206
207 [[image:1763637196906-235.png||data-xwiki-image-style-border="true" height="216" width="731"]]
208
209 = {{id name="assignusertoproject"/}}Assign a user to a project =
210
211 If you would like to add a user to a project Click **Users** in the top menu, then select the user from the list:
212
213 [[image:1763638038942-493.png||data-xwiki-image-style-border="true"]]
214
215
216
217 Select the **Project** and the **New Role** - one of **ADMIN, MASTER, DEVELOPER, VIEWER** (depending on the desired rights). After that, click **Assign**:
218
219 [[image:1763638080575-732.png||data-xwiki-image-style-border="true"]]
220
221
222
223
224 Each user who is a member of a project has to be in //exactly one// Project Role. Therefore it is not possible to have multiple roles in a project.
225
226 If you want to **Delete** a User from a project, simply select the **"-"** from the New Role dropdown menu.
227
228 Different roles have different sets of permissions. Possible roles are:
229
230 (% class="wrapped" %)
231 |=(((
232 Admin
233 )))|(((
234 (% class="content-wrapper" %)
235 (((
236 Full access, even to potentially dangerous operations like Project Lifecycle Transitions. Can administer Project Members and Roles.
237 )))
238 )))
239 |=(((
240 Master
241 )))|(((
242 Limited full access to avoid accidental data loss or other irreversible changes.
243 )))
244 |=(((
245 Developer
246 )))|(((
247 Read-write access to contribute to the Project
248 )))
249 |=(((
250 Viewer
251 )))|(((
252 Read-only access to all not security-relevant data in the Project
253 )))
254
255 Please refer to [[Users and roles>>doc:DevOps Portal for Admins.Users and roles.WebHome]] for a detailed description of users and roles in the tools.
256
257 = Viewing and Modifying the role of a user in a project =
258
259 If you would like to see the settings of a Project Member click **Manage Roles** in the **More... **dropdown menu.
260
261 [[image:1763638170755-115.png||data-xwiki-image-style-border="true"]]
262
263
264 [[image:1763638232453-344.png||data-xwiki-image-style-border="true"]]
265
266
267 In order to **modify** the roles of a project member, repeat the steps of [[Assign a user to a project>>||anchor="assignusertoproject"]] and select the new roles.
268
269
270 = Administration menu of the DevOps Portal =
271
272 In the Administration menu you can have special options to choose from, most of these features are for troubleshooting and monitoring.
273
274 [[image:1763638275724-863.png||data-xwiki-image-style-border="true"]]
275
276
277
278 == Usage Terms ==
279
280 With the "Usage Terms" option you can create and upload your own terms and condition documents about the usage of your own DevOps-as-a-Service toolchain. It is basically an option to provide any document to accept by the users (e.g. documents related to data protection regulations).
281
282 As an administrator, you can upload a document by selecting this option and clicking **Create new Terms**.
283
284 [[image:1763638312427-187.png||data-xwiki-image-style-border="true"]]
285
286
287
288 Choose the preferred language, then click **Select file**, browse the selected file from your local drive and click Open.
289
290 [[image:1763638353445-421.png]]
291
292
293
294 The uploaded document is shown, you can check the content by clicking **Open**, remove the document by clicking **Delete**//,// or you can also **Cancel** the whole operation. If you would like to use the selected document, click **Save**.
295
296 (% class="confluence-embedded-file-wrapper confluence-embedded-manual-size" %)[[image:attach:image2021-2-22_13-47-46.png||data-xwiki-image-style-border="true" queryparams="effects=drop-shadow" height="229" width="610"]]
297
298 The selected document will be listed in the documents table and you will be logged out - to re-login and to accept the uploaded document.
299
300 [[image:1763638667545-652.png||data-xwiki-image-style-border="true"]]
301
302 After uploading a new terms and conditions document, every existing user has to accept it. Otherwise they are not allowed to login to the DevOps portal.
303
304 When new users are invited to the portal, they will receive the uploaded file as an attachment in the invitation mail (so they will be able to read it before following the activation URL).
305
306 //Every user (including administrators) have to accept// the uploaded document only one time, however if you upload another document then both documents have to be accepted by the users.
307
308 To remove an uploaded document, click **Delete**. If you would like to check the content of the uploaded document, click **View**.
309
310 //If you decide not to upload a document at all (or you delete all the existing uploaded documents) the invitation process and the login of users will not depend on the acceptance of any document, since nothing is to be accepted.//
311
312 == Synchronization ==
313
314 All actions related to users or projects must be synchronized with the LDAP server prior to becoming effective. All pending (i.e. unfinished) synchronizations are listed at the **Pending synchronizations** page. Successful and finished synchronizations won't be listed.
315
316 This information is mainly provided for troubleshooting, in case of errors during the synchronization with the LDAP server.
317
318 [[image:1763638748911-205.png]]
319
320 == Licenses ==
321
322 The Licenses page provides information about the number of Active and Available Users as well as the package's User Limit.
323
324 [[image:1763638850327-770.png||data-xwiki-image-style-border="true"]]
325
326
327 == Audits ==
328
329 Provides the audit log to check all past activities related to the Portal for up to 90 days.
330
331 [[image:1763638883919-918.png||data-xwiki-image-style-border="true"]]
332
333
© 2018-2025 T-Systems International GmbH