Skip to content

Commit eebbc20

Browse files
committed
wip
1 parent 4f2e948 commit eebbc20

File tree

7 files changed

+60
-180
lines changed

7 files changed

+60
-180
lines changed

docs/explanation/nais-teams.md

Lines changed: 0 additions & 169 deletions
This file was deleted.

docs/explanation/observability/logging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Enheter i Nav som skal ha tilgang: <four digit department code>. E.g (2990 - IT-
115115

116116
### 2 Connect the AD group to your team in Kibana
117117

118-
The logs your apps produces are linked with your [nais-team](../nais-teams.md).
118+
The logs your apps produces are linked with your [nais-team](../team.md).
119119
Administrators of Kibana will create a role for your team with read rights to those logs.
120120
Whoever is in the AD-group (created in step 1) will get the Kibana role, and can thus read all logs produced by apps belonging to the nais-team.
121121

docs/explanation/team.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Team
2+
3+
Everything in NAIS is organized around the concept of a team.
4+
5+
A team is a group of people, typically working on the same set of products or services, and sharing the same set of responsibilities.
6+
7+
The team owns the workloads built by the team, as well as all provisioned resources. Nothing is owned by an individual, but by the team as a whole. This is to ensure that the team can continue to operate even if a member leaves the team.
8+
9+
A team doesn't necessarily map directly to the organizational team unit, and usually consists of technical people involved in the actual development and operations. The reason for this is that being member of a NAIS team will grant you access to all the workloads and provisioned resources that the team owns. To reduce the attack surface, it's a good idea to limit access to the people that actually need it.
10+
11+
## The anatomy of a team
12+
13+
A team has two different roles, `owner` and `member`.
14+
A team has at least one `owner`, and can have multiple `members`. The `owners` have permission to add and remove `members`, as well changing the roles of the `members`.
15+
You can be a member and owner of multiple teams.
16+
17+
## What does NAIS provide a team?
18+
19+
When you [create a team](../how-to/create-team.md), NAIS will ensure you have the following:
20+
21+
- A isolated area for your team's workload, in each environment (e.g. dev and prod)
22+
- A GitHub team with the same name, in your GitHub organization. The members of your NAIS team will be synchronized with the GitHub team.
23+
24+
25+
TODO:
26+
- Requirement: google user
27+
28+
29+
30+
31+
32+
33+
34+
35+
36+
37+
38+
39+
40+
41+
42+
43+
44+
45+
46+
47+
48+
49+
50+

docs/how-to-guides/create-team.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,18 @@
22

33
This how-to guide shows you how to create a NAIS team.
44

5-
!!! note
6-
Creating a team comes with quite a bit of overhead so this excersise should only be completeted if you are not part of a relevant team and just want find your bearings and get started.
7-
8-
## Prerequisites
5+
## 0. Prerequisites
96
- [naisdevice installed](./naisdevice/install-naisdevice.md)
107
- A GitHub Account with access to your org. (eg. navikt)
118
- A Slack channel that can receive alerts concerning your apps and workloads
129

13-
### 1. Create your team
10+
## 1. Create your team
1411

15-
1. Open [NAIS Teams](https://console.<<tenant()>>.cloud.nais.io/) in your browser and autenticate with your credentials.
12+
1. Open [Console](https://console.<<tenant()>>.cloud.nais.io/) in your browser, and autenticate.
1613
2. Click on "Create"
1714
3. Choose a team name, add a description of the team and the Slack channel that is mentioned in the prerequisites.
1815
4. Click "Create"
1916

20-
Your team will now be created and the needed resources on which to run your workloads.
17+
Your team will now be created, and you will be the owner.
18+
19+
Read more about what resources are created for your team [here](../explanation/team.md).

docs/how-to-guides/workload-crud-operations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This guide shows you how to perform CRUD-operations on your workload.
44

55
## 0. Prerequisites
66
- [Command-line access to the cluster](./command-line-access.md)
7-
- [Member of a NAIS team](../explanation/nais-teams.md)
7+
- [Member of a NAIS team](../explanation/team.md)
88
- [Workload spec](../explanation/workloads.md)
99

1010
=== "Application"

docs/tutorial/hello-nais/hello-nais-1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This tutorial will take you through the process of getting a simple node applica
66

77
- You have a GitHub account connected to your GitHub organization (e.g. `navikt`)
88
- [naisdevice installed](../../how-to-guides/naisdevice/install-naisdevice.md)
9-
- [Member of a NAIS team](../../explanation/nais-teams.md)
9+
- [Member of a NAIS team](../../explanation/team.md)
1010
- [GitHub CLI installed](https://cli.github.com/)
1111

1212
???+ note "Conventions"

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@
114114
# - Tracing: explanation/observability/tracing.md
115115
# - Alerts: explanation/observability/alerts.md
116116
# - Logs: explanation/observability/logs.md
117-
# - NAIS Teams: explanation/nais-teams.md
117+
# - NAIS Teams: explanation/team.md
118118
# - Kafka: explanation/kafka.md
119119
# - Persistent Volume Storage: explanation/persistent-volume-storage.md
120120
# - Database:

0 commit comments

Comments
 (0)