Skip to content

Commit 2d054ab

Browse files
committed
document the elasticsearch config option
1 parent 1774e6b commit 2d054ab

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/software/uenv/configure.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ Notes on the syntax:
3737
| --- | ----------- | -------- | ------ |
3838
| [`color`][ref-uenv-configure-options-color] | Use color output | automatically chosen according to environment | `true`, `false` |
3939
| [`repo`][ref-uenv-configure-options-repo] | The default repo location for downloaded uenv images | `$SCRATCH/.uenv-images` | An absolute path |
40+
| [`elasticsearch`][ref-uenv-configure-options-elastic] | Elastic logging API end point | - | http://log.cscs.ch:31311/logs |
4041

4142
[](){#ref-uenv-configure-options-color}
4243
#### `color`
@@ -58,3 +59,17 @@ The repo is selected according to the following process:
5859
* if the `--repo` CLI argument is given, use that setting
5960
* else if `repo` is set in the config file, use that setting
6061
* else use the default value of `$SCRATCH/.uenv-images`
62+
63+
Note that the default location is system-specific, and may not match the actual `SCRATCH` environment variable.
64+
65+
[](){#ref-uenv-configure-options-elastic}
66+
#### `elasticsearch`
67+
68+
!!! warning "do not modify"
69+
This option is set in the system configuration file, normally installed at `/etc/uenv/config`.
70+
This file is used to set system-wide defaults, and can only be modified by system engineers.
71+
72+
The location of the elastic logging service used to log uenv usage in SLURM jobs.
73+
This value has to be set to the specific API end point of the CSCS elastic service, otherwise no logging will be performed.
74+
75+
CSCS uses this information to understand which uenv usage, in order to improve the quality of the uenv service.

0 commit comments

Comments
 (0)