Skip to content

Commit 1294ccb

Browse files
committed
docs: update readme
1 parent 5db9538 commit 1294ccb

File tree

2 files changed

+15
-5
lines changed

2 files changed

+15
-5
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
This repository defines the organizational structure, team membership, and project ownership for ScottyLabs.
44
It serves as the source of truth for our GitHub organization's governance model,
5-
formalizing permission as code.
5+
formalizing permission as code. The specific permissions granted to contributors
6+
and each team are detailed in [synchronizer/README.md](__meta/synchronizer/README.md).
67

78
## Repository Structure
89

__meta/synchronizer/README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ The groups and oidc clients created by Keycloak synchronization are used for aut
5454
and integrate with Hashicorp Vault. However, they are not directly visible to you,
5555
so you can skip this section if you only want to know about the permissions you can directly use.
5656

57+
### Team Synchronization
58+
5759
- Create the Keycloak oidc clients if they do not exist. The team can opt out
5860
by setting the `create-oidc-clients` field to `false` in the team file.
5961

@@ -80,25 +82,30 @@ by setting the `create-oidc-clients` field to `false` in the team file.
8082
will be added to this group.
8183

8284
- A dev group will also be created with the suffix "-devs".
85+
- The team contributors who are not maintainers will be added to this group.
8386

8487
- An external admin group will be created with the suffix "-ext-admins" if the
8588
`ext-admins` field is present in the team file.
89+
- The external admins will be added to this group.
8690

8791
- An applicant group will be created with the suffix "-applicants" if the
8892
`applicants` field is present in the team file.
93+
- The applicants will be added to this group.
8994

9095
- Any unlisted members will be removed from the Keycloak groups unless the
9196
team opts out by setting the `remove-unlisted` field to `false` in the team file.
9297

9398
## Hashicorp Vault
9499

100+
### Team Synchronization
101+
95102
- Hashicorp groups, policies, and aliases will be created to integrate with Keycloak groups.
96103

97-
- Admin groups can read and edit all secrets.
104+
- Admin groups can read and edit all secrets in the team's folder.
98105

99-
- Dev groups can read the secrets in the `local` folder.
106+
- Dev groups can read the secrets in the `local` folder in the team's folder.
100107

101-
- Applicants group can read the secrets in the `applicants` folder.
108+
- Applicants group can read the secrets in the `applicants` folder in the team's folder.
102109

103110
- If the team did not opt out of secrets population by setting the `secrets-population-layout`
104111
field to `none` in the team file, the secrets will be populated in the following layout:
@@ -116,6 +123,8 @@ by setting the `create-oidc-clients` field to `false` in the team file.
116123

117124
## Slack
118125

126+
### Team Synchronization
127+
119128
- Invite team members to the corresponding Slack channels listed in the team file.
120129

121130
- The Slack Governance App needs to be added to every **private** Slack channel in
@@ -129,7 +138,7 @@ by setting the `create-oidc-clients` field to `false` in the team file.
129138
## Google Drive
130139

131140
- See [Google Drive Wiki page](https://github.com/ScottyLabs/wiki/wiki/Resources#google-drive)
132-
on how to use the ScottyLabs Google Drive.
141+
on what to use ScottyLabs Google Drive for.
133142

134143
- All contributors will be added as a contributor to the ScottyLabs Google Drive.
135144

0 commit comments

Comments
 (0)