Skip to content

Commit

Permalink
Doc changes
Browse files Browse the repository at this point in the history
  • Loading branch information
floeschau committed Sep 5, 2023
1 parent 25c296f commit 6565126
Showing 1 changed file with 23 additions and 3 deletions.
26 changes: 23 additions & 3 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,26 @@ kubespawner_override:
extra_resource_guarantees: {"nvidia.com/gpu": "1"}
```

## Environment variables

Environment variables can be defined by

* Providing a fixed global value, or
* Referencing a key in a config map (which must exist in the same Kubernetes namespace,
e.g. an individual user's namespace)

The two ways of defining environment variables work as follows (global and specific):

```yaml
pod_env_vars:
global: global_value
specific:
from_config_map:
name: config_map_name
key: config_map_key
```


## Volumes

A volume is defined with:
Expand All @@ -121,7 +141,7 @@ persist: true

**Note**: if the _PVC_ does not exist it is created.

If the `persist` boolean flag set to `false`, both the _PVC_ and _Volume_ are deleted.
If the `persist` boolean flag is set to `false`, both the _PVC_ and _Volume_ are deleted.

## ConfigMaps

Expand Down Expand Up @@ -151,7 +171,7 @@ content: -|

## Roles and role bindings

Roles and role bindings are defined as follows:
Roles and role bindings are defined as follows (following the model of the Kubernetes [RBAC authorisation](https://kubernetes.io/docs/reference/access-authn-authz/rbac/)):

```yaml
role_bindings:
Expand All @@ -172,4 +192,4 @@ role_bindings:
persist: false
```

If the persist boolean flag set to false, both the role and role binding are deleted.
If the `persist` boolean flag is set to `false`, both the _role_ and _role binding_ are deleted.

0 comments on commit 6565126

Please sign in to comment.