#3 add some documentation

cloudogu · Feb 9, 2021 · bf5f024 · bf5f024
1 parent 47a9d73
commit bf5f024
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/.smeagol.yml b/.smeagol.yml
diff --git a/docs/assets/default_template_ces_admin_permissions.png b/docs/assets/default_template_ces_admin_permissions.png
diff --git a/docs/permission_template.md b/docs/permission_template.md
@@ -0,0 +1,15 @@
+# Permission Template
+
+The permission template is a mechanism in sonar to setup project permissions. The default template will be changed
+during the dogu startup to ensure that the CES_ADMIN group has access to administer new created projects. The following
+permissions will be set (admin codeviewer issueadmin securityhotspotadmin scan user ) this setup can be verified
+(Administration -> Security -> Permisssion Templates). *see setup.json for further details*
+
+![default template overview][assets/default_template_ces_admin_permissions.png]
+
+Apart from project permissions there are some global permission, these permission will be set up during
+start up as well. Defined global permissions for the CES_ADMIN group will be (admin profileadmin gateadmin provisioning)
+
+The permissions for projects created without correct CES_ADMIN group permissions can be changed later using a specific etdkey.
+(set `amend_projects_with_ces_admin_permissions` to `all` -> restart sonar -> CES_ADMIN group will be added to all projects).
+The Implementation uses the sonar api endpoint `permissions/add_group`.