Skip to content

Commit 23dbb33

Browse files
committed
wip
1 parent 0d4cf64 commit 23dbb33

File tree

7 files changed

+40
-45
lines changed

7 files changed

+40
-45
lines changed

docs/explanation/.pages

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
nav:
22
- nais.md
3+
- team.md
34
- what-is-naisdevice.md
4-
- nais-teams.md
5-
- workloads.md
5+
- workloads
66
- ...

docs/explanation/team.md

+10-38
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,22 @@
1-
# Team
1+
# NAIS team
22

33
Everything in NAIS is organized around the concept of a team.
4+
Nothing in NAIS is owned by an individual; the team as a whole owns the [workloads](./workloads.md) built by the team, as well as all provisioned resources. This is to ensure that everything can continue to operate even if someone leaves.
45

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+
A NAIS team doesn't necessarily map directly to the organizational team unit, and (usually) consists of purely technical personnel developing and operating on the same set of products or services. 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.
67

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.
8+
To [become a member](../how-to-guides/team.md) of a NAIS team, you need to have a Google account that is a member of your organization's Google Workspace.
109

1110
## The anatomy of a team
1211

13-
A team has two different roles, `owner` and `member`.
12+
A team has two different roles, `owner` and `member`.
1413
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`.
1514
You can be a member and owner of multiple teams.
1615

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-
16+
## What does a NAIS team provide?
4917

18+
When you [create a team](../how-to/create-team.md), the following will be provisioned for you:
5019

20+
- An isolated area for your team's workload and resources in each environment (e.g. dev and prod)
21+
- A GitHub team with the same name in your GitHub organization. The members of your NAIS team will be synchronized with the GitHub team.
22+
- Roles and permissions to access the workloads and resources in the team's area.

docs/explanation/what-is-naisdevice.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
TODO: Sanity check ChatGPT translation
22

3-
# What is naisdevice?
3+
# naisdevice
44

55
**naisdevice** is the mechanism that ensures the security of developers' laptops at NAV. It is a "platform-agnostic" solution that, in addition to securing laptops, aims to raise awareness about endpoint security and facilitate smoother access to runtime environments.
66

docs/explanation/workloads.md

-4
This file was deleted.

docs/explanation/workloads/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Workloads
2+
3+
NAIS offers several methods for running different types of workloads.
4+
5+
## NAIS application
6+
A [NAIS application](../reference/application-example.md) is a long-running service that is expected to be available at all times. Such as a web server, a REST API, or a message queue consumer.
7+
8+
## NAIS job
9+
A [NAIS job](../reference/job-example.md) is a short-lived process that is expected to complete within a certain time frame. Such as a batch job, a cron job, or a one-off task.
10+
11+
## NAIS CDN
12+
[NAIS CDN](../reference/frontend-example.md) offers a way to serve static content and single-page applications (SPA) with low latency and high availability.
+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Application
2+
A [NAIS application](../../reference/application-example.md) is a long-running service that is expected to be available at all times. Such as a web server, a REST API, or a message queue consumer.
3+
4+
- kontrakt mellom applikasjon og plattform
5+
- en eller fler kjørende instanser av en container-image
6+
- default isolert
7+
- kan eksponere tjenester via en eller flere ruter
8+
- hemmeligheter og konfigurasjon kan injiseres som environment-variabler
9+
- provisionering og tilknytning av ressurser som database, storage, BigQuery, etc.
10+
-
11+
12+
An application is represented by an [application manifest](../../reference/application-spec.md).
13+
The application manifest is the contract between the application and the platform, where you specify how the application should be run and what resources it needs.
14+
The platform uses the manifest to provision and configure the necessary resources specified in the manifest.
15+
File renamed without changes.

0 commit comments

Comments
 (0)