Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for realm provisioning #5223

Merged
merged 2 commits into from
Nov 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ In order to successfully run Nexus Delta there is a minimum set of configuration

The configuration flag `akka.http.server.parsing.max-content-length` can be used to control the maximum payload size allowed for Nexus Delta resources. This value applies to all posted resources except for files.

### Postgres configuration
## Postgres configuration

@link:[The `database` section](https://github.com/BlueBrain/nexus/blob/$git.branch$/delta/app/src/main/resources/app.conf#L23){ open=new } of the configuration defines the postgres specific configuration. As Nexus Delta uses three separate pools ('read', 'write', 'streaming'), it is recommended to set the host, port, database name, username, and password via the `app.defaults.database` field, as it will apply to all pools. It is however possible to accommodate more advanced setups by configuring each pool separately by changing its respective `app.database.{read|write|streaming}` fields.

Expand Down Expand Up @@ -55,6 +55,43 @@ Nexus Delta uses a service account to perform automatic tasks under the hood. Ex

@link:[The `service-account` section](https://github.com/BlueBrain/nexus/blob/$git.branch$/delta/app/src/main/resources/app.conf#L427){ open=new } of the configuration defines the service account configuration.

## Realm provisioning

Realm provisioning allows to create one or several realm at startup.

It is useful to start a new deployment with having to call the @ref:[realm API](../../../delta/api/realms-api.md) to create those.

Exemple:
```hocon
realms {
#...

# To provision realms at startup
# Only the name and the OpenId config url are mandatory
provisioning {
enabled = true
realms {
my-realm = {
name = "My realm name"
open-id-config = "https://.../path/.well-known/openid-configuration"
logo = "https://bbp.epfl.ch/path/favicon.png"
accepted-audiences = ["audience1", "audience2"]
}
}
}
}
```

@@@ note { .warning }

Realm provisioning will only create realms.
If a realm with the same identifier exists it will not be updated.

@@@

@link:[The `realms.provisioning` section](https://github.com/BlueBrain/nexus/blob/$git.branch$/delta/app/src/main/resources/app.conf){ open=new } of the configuration defines the service account configuration.


## Automatic project provisioning

Automatic project provisioning allows to create a dedicated project for users the first time they connect to Delta that is to
Expand Down
14 changes: 10 additions & 4 deletions docs/src/main/paradox/docs/releases/v1.11-release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,25 @@ For the detailed list of updates in this release, see the @link:[list of address
This feature allows to reduce the pressure on the primary store by changing the way indexing routines for views (but also graph-analytics)
behaves when they have processed all available data.

More @ref:[here](../delta/api/views/index.md#passivation)
@ref:[More here](../delta/api/views/index.md#passivation)

### Conditional requests

Nexus now supports conditional requests
Nexus now supports conditional requests.

More @ref[here](../delta/api/conditional-requests.md)
@ref[More here](../delta/api/conditional-requests.md)

### Realm provisioning

Nexus now allows to provision realms at start up so as to simplify automated deployments.

@ref[More here](../getting-started/running-nexus/configuration/index.md#realm-provisioning)

### Remote storage server

The remote storage server part has been removed.

The client is deprecated and remains with @link:[the remote storage in 1.10](https://hub.docker.com/r/bluebrain/nexus-storage/tags).
The client is deprecated and remains compatible with @link:[the remote storage in 1.10](https://hub.docker.com/r/bluebrain/nexus-storage/tags).

## Nexus Fusion

Expand Down