Skip to content

Commit a889827

Browse files
thokra-navthokra-nav
committed
NAIS -> Nais. Also prefix some Console references with Nais
1 parent d7bcfa7 commit a889827

File tree

120 files changed

+249
-255
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

120 files changed

+249
-255
lines changed

‎README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Welcome to the NAIS documentation
1+
# Welcome to the Nais documentation
22

3-
See the [NAIS handbook](https://handbook.nais.io/technical/write-the-doc/) for a more detailed explanation of the documentation structure and how to contribute.
3+
See the [Nais handbook](https://handbook.nais.io/technical/write-the-doc/) for a more detailed explanation of the documentation structure and how to contribute.
44

55
## Local development
66

‎docs/README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: NAIS Developer Documentation
2+
title: Nais Developer Documentation
33
hide:
44
- feedback
55
- footer
@@ -12,22 +12,22 @@ hide:
1212
}
1313
</style>
1414

15-
# :wave: **Welcome to the NAIS developer documentation!**
15+
# :wave: **Welcome to the Nais developer documentation!**
1616

17-
Here you'll find _explanations_[^1], _how-to guides_[^2], and _references_[^3] for all things NAIS.
17+
Here you'll find _explanations_[^1], _how-to guides_[^2], and _references_[^3] for all things Nais.
1818

19-
### :seedling: **New to NAIS?**
19+
### :seedling: **New to Nais?**
2020

2121
Start here to get an idea of the fundamentals.
2222

2323
<div class="grid cards" markdown>
2424

25-
- :ok_hand: [**What is NAIS?**](explanations/nais.md)
26-
- :student: [**Your first application; Hello NAIS**](tutorials/hello-nais.md)
25+
- :ok_hand: [**What is Nais?**](explanations/nais.md)
26+
- :student: [**Your first application; Hello Nais**](tutorials/hello-nais.md)
2727

2828
</div>
2929

30-
### :technologist: **Already familiar with NAIS?**
30+
### :technologist: **Already familiar with Nais?**
3131

3232
What can we help you with today?
3333

@@ -39,10 +39,10 @@ What can we help you with today?
3939
- :closed_lock_with_key: [**Auth your users and workloads**](auth/README.md)
4040
- :telescope: [**Gain insight into your workloads**](observability/README.md)
4141
- :wrench: [**Manage your workloads and services**](operate/README.md)
42-
- :heavy_plus_sign: [**Explore the rest of NAIS**](services/README.md)
42+
- :heavy_plus_sign: [**Explore the rest of Nais**](services/README.md)
4343

4444
</div>
4545

46-
[^1]: :bulb: [_explanations_](tags.md#explanation) present higher-level concepts. Most useful when you want to understand how NAIS works.
46+
[^1]: :bulb: [_explanations_](tags.md#explanation) present higher-level concepts. Most useful when you want to understand how Nais works.
4747
[^2]: :dart: [_how-to guides_](tags.md#how-to) help you achieve a specific goal. Most useful when you're trying to get something done.
4848
[^3]: :books: [_references_](tags.md#reference) contain technical descriptions and specifications. Most useful when you need to look up details about a specific feature.

‎docs/assets/resource-overview.svg

+2-2
Loading

‎docs/auth/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: Services and addons to support authentication and authorization in
77

88
{%- if tenant() == "nav" %}
99

10-
NAIS helps your applications [log in users](#logging-in-users), [validate inbound requests](#validating-inbound-requests) and [make authenticated outbound requests](#making-outbound-requests) using the following identity providers:
10+
Nais helps your applications [log in users](#logging-in-users), [validate inbound requests](#validating-inbound-requests) and [make authenticated outbound requests](#making-outbound-requests) using the following identity providers:
1111

1212
<div class="grid cards" markdown>
1313

@@ -102,7 +102,7 @@ The graph above can also be described as:
102102

103103
{%- else %}
104104

105-
NAIS provides the following services and addons to support authentication and authorization in your applications:
105+
Nais provides the following services and addons to support authentication and authorization in your applications:
106106

107107
: [**Login proxy**](explanations/README.md#login-proxy)
108108

‎docs/auth/entra-id/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ conditional: [tenant, nav]
99

1010
We use Entra ID as our internal identity provider for authenticating and authorizing both employees and applications.
1111

12-
NAIS provides support for declarative registration and configuration of Entra ID resources.
12+
Nais provides support for declarative registration and configuration of Entra ID resources.
1313
These cover these distinct use cases:
1414

1515
## Log in employees
1616

1717
If you have an employee-facing application that requires authentication, you will need to integrate with Entra ID.
18-
NAIS simplifies this by providing a [login proxy](../explanations/README.md#login-proxy) with endpoints to easily handle login, logout, and user sessions.
18+
Nais simplifies this by providing a [login proxy](../explanations/README.md#login-proxy) with endpoints to easily handle login, logout, and user sessions.
1919

2020
Your application is responsible for verifying that inbound requests have valid [tokens](../explanations/README.md#tokens).
2121

‎docs/auth/entra-id/explanations/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ You should generally **not** hard code or otherwise depend on the client ID of _
3030

3131
An Entra ID client has an associated name within a tenant.
3232

33-
All clients provisioned through NAIS will be registered in Entra ID using the following naming scheme:
33+
All clients provisioned through Nais will be registered in Entra ID using the following naming scheme:
3434

3535
```text
3636
<cluster>:<namespace>:<app-name>

‎docs/auth/entra-id/how-to/login.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ spec:
2626
2727
<<gcp_only("Login proxy")>>
2828
29-
See the [NAIS application reference](../../../workloads/application/reference/application-spec.md#azuresidecar) for the complete specifications with all possible options.
29+
See the [Nais application reference](../../../workloads/application/reference/application-spec.md#azuresidecar) for the complete specifications with all possible options.
3030
3131
### Grant access to users
3232

‎docs/auth/entra-id/reference/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ These variables are used to [:dart: secure your API](../how-to/secure.md):
252252

253253
## Spec
254254

255-
For all possible configuration options, see the [:books: NAIS application reference](../../../workloads/application/reference/application-spec.md#azure).
255+
For all possible configuration options, see the [:books: Nais application reference](../../../workloads/application/reference/application-spec.md#azure).
256256

257257
## Tenants
258258

‎docs/auth/explanations/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -595,7 +595,7 @@ verify the signature of your client assertions as proof of your client's identit
595595

596596
## Login proxy
597597

598-
NAIS offers an opt-in _login proxy_ (also known as _Wonderwall_) that simplifies the process of authenticating end-users in your application.
598+
Nais offers an opt-in _login proxy_ (also known as _Wonderwall_) that simplifies the process of authenticating end-users in your application.
599599

600600
<<gcp_only("Login proxy")>>
601601

@@ -759,7 +759,7 @@ See the [Texas reference](../reference/README.md#texas) for API specifications a
759759

760760
## Login proxy
761761

762-
NAIS offers an opt-in _login proxy_ (also known as [_Wonderwall_](https://github.com/nais/wonderwall)) that simplifies the process of authenticating end-users in your application.
762+
Nais offers an opt-in _login proxy_ (also known as [_Wonderwall_](https://github.com/nais/wonderwall)) that simplifies the process of authenticating end-users in your application.
763763

764764
When enabled, the proxy exposes [endpoints](../reference/README.md#endpoints) under your application's ingress.
765765

‎docs/auth/how-to/login.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ spec:
7676
enabled: true
7777
```
7878
79-
See the [NAIS application reference](../../workloads/application/reference/application-spec.md#login) for the complete specifications with all possible options.
79+
See the [Nais application reference](../../workloads/application/reference/application-spec.md#login) for the complete specifications with all possible options.
8080
8181
Now that your application is configured, you should handle inbound requests in your application code.
8282

‎docs/auth/idporten/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ conditional: [tenant, nav]
1010
[ID-porten](https://docs.digdir.no/docs/idporten/) is the standard authentication service used by Norwegian citizens to access public services.
1111

1212
If you have a citizen-facing application that requires authentication, you will need to integrate with ID-porten.
13-
NAIS simplifies this by providing a [login proxy](../explanations/README.md#login-proxy) with endpoints to easily handle login, logout, and user sessions.
13+
Nais simplifies this by providing a [login proxy](../explanations/README.md#login-proxy) with endpoints to easily handle login, logout, and user sessions.
1414

1515
Your application is responsible for verifying that inbound requests have valid [tokens](../explanations/README.md#tokens).
1616

‎docs/auth/idporten/how-to/login.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ spec:
2525
2626
<<gcp_only("Login proxy")>>
2727
28-
See the [NAIS application reference](../../../workloads/application/reference/application-spec.md#idportensidecar) for the complete specifications with all possible options.
28+
See the [Nais application reference](../../../workloads/application/reference/application-spec.md#idportensidecar) for the complete specifications with all possible options.
2929
3030
Now that your application is configured, you will need to handle inbound requests in your application code.
3131

‎docs/auth/idporten/reference/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ spec:
7575
7676
The default value is `idporten-loa-high`.
7777

78-
NAIS ensures that the user's authentication level matches or exceeds the level configured by the application.
78+
Nais ensures that the user's authentication level matches or exceeds the level configured by the application.
7979
If lower, the user is considered unauthenticated.
8080

8181
For runtime control of the value, set the query parameter `level` when redirecting the user to login:
@@ -86,4 +86,4 @@ https://<ingress>/oauth2/login?level=idporten-loa-high
8686

8787
## Spec
8888

89-
For all possible configuration options, see the [:books: NAIS application reference](../../../workloads/application/reference/application-spec.md#idporten).
89+
For all possible configuration options, see the [:books: Nais application reference](../../../workloads/application/reference/application-spec.md#idporten).

‎docs/auth/maskinporten/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ conditional: [tenant, nav]
99

1010
[Maskinporten](https://docs.digdir.no/maskinporten_overordnet.html) is a service provided by DigDir used to authorize access to APIs between organizations or businesses.
1111

12-
NAIS provides support for declarative registration and configuration of Maskinporten resources.
12+
Nais provides support for declarative registration and configuration of Maskinporten resources.
1313
These cover two distinct use cases:
1414

1515
## Consume an API

‎docs/auth/maskinporten/how-to/consume.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This how-to guides you through the steps required to consume an API secured with
99

1010
## Configure your application
1111

12-
Declare all the scopes that you want to consume in your application's NAIS manifest so that your application is granted access to them:
12+
Declare all the scopes that you want to consume in your application's Nais manifest so that your application is granted access to them:
1313

1414
```yaml hl_lines="5-7" title="nais.yaml"
1515
spec:

‎docs/auth/maskinporten/how-to/expose-fss-apps.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ conditional: [tenant, nav]
66

77
!!! warning "FSS apps only"
88

9-
KrakendD in NAIS is meant as an extra feature for teams using [Maskinporten](../README.md) to expose their APIs on-prem (FSS / Fagsystemsonen) to external consumers/partners.
10-
Applications that run in GCP should use the [Maskinporten](../README.md) functionality directly.
9+
KrakendD in Nais is meant as an extra feature for teams using [Maskinporten](../README.md) to expose their APIs on-prem (FSS / Fagsystemsonen) to external consumers/partners.
10+
Applications that run in GCP should use the [Maskinporten](../README.md) functionality directly.
1111

1212

1313
!!! info "Status: Beta"
@@ -22,7 +22,7 @@ conditional: [tenant, nav]
2222

2323
[KrakenD](https://www.krakend.io/) is an open-source API Gateway that sits in front of your Maskinporten APIs and provides a single point of entry for API clients.
2424

25-
## KrakenD in NAIS
25+
## KrakenD in Nais
2626

2727
Each team can get their own instance of KrakenD deployed in their namespace. The KrakenD instance will be configured to require JWT tokens, and API endpoints can be added
2828
in a declarative manner using the [ApiEndpoints custom resource](https://github.com/nais/krakend/blob/main/config/samples/apiendpoints_max.yaml)
@@ -33,7 +33,7 @@ The KrakenD instances and config for exposing APIs are managed by the [krakend-o
3333

3434
To get KrakenD installed in your namespace - the namespace must have a label `krakend.nais.io/enabled: "true"`.
3535

36-
If you do not have permissions to add this label, please contact the NAIS team and we will add it for you.
36+
If you do not have permissions to add this label, please contact the Nais team and we will add it for you.
3737
After beta testing, we will add more automation to this process.
3838

3939
When KrakenD is installed in your namespace you will get an ingress for your KrakenD instance at:
@@ -109,7 +109,6 @@ spec:
109109
!!! info "KrakenD requirements on paths, query params and headers"
110110
There are some strict requirements on specifying paths, query params and headers in KrakenD, see the [ApiEndpoints CRD](https://github.com/nais/krakend/blob/main/config/crd/bases/krakend.nais.io_apiendpoints.yaml) and corresponding [Krakend Doc](https://www.krakend.io/docs/endpoints/) for details.
111111
112-
113112
## Use cases
114113
115114
### Expose an API to external consumers from on-prem via GCP

‎docs/auth/maskinporten/how-to/secure.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This how-to guides you through the steps required to secure your API using [Mask
1515

1616
A _scope_ represents a permission that a given consumer has access to.
1717

18-
Declare all the scopes that you want to expose in your application's NAIS manifest:
18+
Declare all the scopes that you want to expose in your application's Nais manifest:
1919

2020
```yaml title="nais.yaml" hl_lines="5-15"
2121
spec:
@@ -37,7 +37,7 @@ spec:
3737
3838
See the [scope naming reference](../reference/README.md#scope-naming) for details on naming scopes.
3939
40-
See the [NAIS application reference](../../../workloads/application/reference/application-spec.md#maskinportenscopesexposes) for the complete specifications with all possible options.
40+
See the [Nais application reference](../../../workloads/application/reference/application-spec.md#maskinportenscopesexposes) for the complete specifications with all possible options.
4141
4242
## Grant access to consumers
4343

‎docs/auth/maskinporten/reference/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -115,4 +115,4 @@ scope := nav:helse/sykepenger/afp.read
115115

116116
## Spec
117117

118-
See the [:books: NAIS application reference](../../../workloads/application/reference/application-spec.md#maskinporten).
118+
See the [:books: Nais application reference](../../../workloads/application/reference/application-spec.md#maskinporten).

‎docs/auth/reference/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ See the respective identity provider pages for details on acquiring such tokens:
4343

4444
## Login proxy
4545

46-
Reference documentation for the [login proxy](../explanations/README.md#login-proxy) provided by NAIS.
46+
Reference documentation for the [login proxy](../explanations/README.md#login-proxy) provided by Nais.
4747
Supported identity providers:
4848

4949
- Entra ID for [logging in employees](../entra-id/how-to/login.md).
@@ -493,7 +493,7 @@ The following environment variables are available for your application to intera
493493

494494
## Login proxy
495495

496-
Reference documentation for the [login proxy](../explanations/README.md#login-proxy) provided by NAIS.
496+
Reference documentation for the [login proxy](../explanations/README.md#login-proxy) provided by Nais.
497497

498498
### Enforce login
499499

‎docs/auth/tokenx/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ conditional: [tenant, nav]
55

66
# TokenX
77

8-
TokenX is NAIS' own implementation of OAuth 2.0 Token Exchange.
8+
TokenX is Nais' own implementation of OAuth 2.0 Token Exchange.
99

1010
This allows internal applications to act on behalf of a citizen that originally authenticated with [ID-porten](../idporten/README.md),
1111
while maintaining the [zero trust](../../workloads/explanations/zero-trust.md) security model between applications throughout a request chain.
1212

13-
NAIS provides support for declarative registration and configuration of TokenX resources.
13+
Nais provides support for declarative registration and configuration of TokenX resources.
1414
These cover two distinct use cases:
1515

1616
## Consume an API

‎docs/auth/tokenx/reference/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,4 @@ These variables are used to [:dart: secure your API](../how-to/secure.md):
5757

5858
## Spec
5959

60-
See the [:books: NAIS application reference](../../../workloads/application/reference/application-spec.md#tokenx).
60+
See the [:books: Nais application reference](../../../workloads/application/reference/application-spec.md#tokenx).

‎docs/build/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ tags: [build, deploy, explanation, services]
66

77
To make your application available to others, you need to build and deploy it.
88

9-
NAIS attempts to make this as simple as possible by providing a set of composable [GitHub Actions](https://docs.github.com/en/actions).
9+
Nais attempts to make this as simple as possible by providing a set of composable [GitHub Actions](https://docs.github.com/en/actions).
1010

1111
Use these actions to compose your own build and deploy pipeline through [Github Actions workflows](https://docs.github.com/en/actions/using-workflows).
1212

‎docs/build/how-to/build-and-deploy.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ tags: [build, deploy, how-to]
44

55
# Build and deploy with Github Actions
66

7-
This how-to guide shows you how to build and deploy your application using [Github Actions](https://help.github.com/en/actions/automating-your-workflow-with-github-actions) and the NAIS deploy action.
7+
This how-to guide shows you how to build and deploy your application using [Github Actions](https://help.github.com/en/actions/automating-your-workflow-with-github-actions) and the Nais deploy action.
88

99
## Prerequisites
1010

11-
- You're part of a [NAIS team](../../operate/how-to/create-team.md)
12-
- A Github repository where the NAIS team has access
11+
- You're part of a [Nais team](../../operate/how-to/create-team.md)
12+
- A Github repository where the Nais team has access
1313
- The repository contains a valid [workload manifest](../../workloads/README.md)
1414

1515
## Authorize your Github repository for deployment
1616

17-
1. Open [NAIS Console](https://console.<<tenant()>>.cloud.nais.io) in your browser and select your team.
17+
1. Open [Nais Console](https://console.<<tenant()>>.cloud.nais.io) in your browser and select your team.
1818
2. Select the `Repositories` tab
1919
3. Input your repository (`organization/repository`) and press `Add`.
2020

@@ -45,7 +45,7 @@ This how-to guide shows you how to build and deploy your application using [Gith
4545
id: docker-build-push
4646
with:
4747
team: <MY-TEAM> # Replace
48-
- name: Deploy to NAIS
48+
- name: Deploy to Nais
4949
uses: nais/deploy/actions/deploy@v2
5050
env:
5151
CLUSTER: <MY-CLUSTER> # Replace (1)
@@ -65,6 +65,6 @@ When this file is pushed to the `main` branch, the workflow will be triggered an
6565

6666
The [nais/docker-build-push GitHub action](https://github.com/nais/docker-build-push) builds and pushes images to the _Google Artifact Registry_ (GAR).
6767

68-
This is a registry managed by NAIS and is the recommended way to store your container images for use in workloads on NAIS.
68+
This is a registry managed by Nais and is the recommended way to store your container images for use in workloads on Nais.
6969

7070
We keep images that are deployed, as well as the last 10 versions for each image regardless of age. Versions older than 90 days are automatically deleted.

‎docs/build/how-to/tracing.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This will allow you to measure the time it takes for your team to deliver new co
1313

1414
With these metrics you can also get a better view if changes to your pipeline affect the lead time for change.
1515

16-
NAIS automatically collects telemetry data from your pipeline when you use the
16+
Nais automatically collects telemetry data from your pipeline when you use the
1717
`docker-build-push` action to build your Docker image.
1818

1919
The following manual step is required on your part to visualize that data in Grafana;
@@ -29,7 +29,7 @@ you must export the `TELEMETRY` environment variable when you deploy.
2929
- name: Build and push Docker image
3030
uses: nais/docker-build-push@v0
3131
id: docker-build-push # make sure this ID matches the step id below
32-
- name: Deploy to NAIS
32+
- name: Deploy to Nais
3333
uses: nais/deploy/actions/deploy@v2
3434
env:
3535
TELEMETRY: ${{ steps.docker-build-push.outputs.telemetry }}

0 commit comments

Comments
 (0)