Skip to content

Commit d138e3e

Browse files
maanymaany
committed
tools: env-generator, rename CA_BUNDLE to SERVER_CA_BUNDLE #259 
1 parent 32f27e0 commit d138e3e

File tree

4 files changed

+18
-19
lines changed

4 files changed

+18
-19
lines changed

‎tools/env-generator/.env.template

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ export RUCIO_WEBUI_RUCIO_AUTH_HOST="https://rucio-devmaany.cern.ch"
22
export RUCIO_WEBUI_RUCIO_HOST="https://rucio-devmaany.cern.ch"
33
export RUCIO_WEBUI_HOSTNAME="localhost:3000"
44
export RUCIO_WEBUI_ENABLE_SSL="false"
5-
# CA_BUNDLE is required if you are have enabled SSL. This CA bundle should verify the SSL certificate of the Rucio server.
6-
# export RUCIO_WEBUI_CA_BUNDLE="/path/to/ca-bundle.pem"
5+
# SERVER_CA_BUNDLE is required if you are have enabled SSL. This CA bundle should verify the SSL certificate of the Rucio server.
6+
# export RUCIO_WEBUI_SERVER_CA_BUNDLE="/path/to/ca-bundle.pem"
77
export RUCIO_WEBUI_PROJECT_URL="https://atlas.cern/"
88

99
export RUCIO_WEBUI_MULTIVO_ENABLED="true"

‎tools/env-generator/README.md

+14-15
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,21 @@ This tool is used to generate the `.env.production` or `.env` or `.env.developme
1010
cp .env.template .env.base
1111
```
1212

13-
2. Edit the `.env.base` file and add the required environment variables. All the variables **MUST** be prefixed with ` RUCIO*WEBUI*`` The variables should be added in the following format:
14-
`export RUCIO*WEBUI*<VARIABLE_NAME>=<VARIABLE_VALUE>`
13+
2. Edit the `.env.base` file and add the required environment variables. All the variables **MUST** be prefixed with ` RUCIO*WEBUI*`` The variables should be added in the following format: `export RUCIO*WEBUI*<VARIABLE_NAME>=<VARIABLE_VALUE>`
1514

16-
| Variable Name | Full Name | Description | Example | Default |
17-
| --------------- | --------------------------- | ------------------------------------------------------------------------------------------ | ------------------------------ | ------- |
18-
| RUCIO_HOST | RUCIO_WEBUI_RUCIO_HOST | URL for the Rucio Server | https://rucio-lb-prod.cern.ch | |
19-
| RUCIO_AUTH_HOST | RUCIO_WEBUI_RUCIO_AUTH_HOST | URL for the Rucio authentication server | https://rucio-auth-host.ch:443 | |
20-
| HOSTNAME | RUCIO_WEBUI_HOSTNAME | Public HOSTNAME at which Rucio WebUI will be accessible. It may include port number. | rucio-ui.cern.ch | |
21-
| ENABLE_SSL | RUCIO_WEBUI_ENABLE_SSL | Enable or Disable TLS Termination (true or false) | true | false |
22-
| CA_BUNDLE | RUCIO_WEBUI_CA_BUNDLE | Path to the CA bundle file that can verify Rucio Server certificate. If ENABLE_SSL is set. | /path/to/ca-bundle.pem | |
23-
| PROJECT_URL | RUCIO_WEBUI_PROJECT_URL | Public URL for your project | https://atlas.cern.ch | |
24-
| VO_DEFAULT | RUCIO_WEBUI_VO_DEFAULT | Short name for the default VO used for authentication | def | def |
25-
| VO_LIST | RUCIO_WEBUI_VO_LIST | CSV string containing the list of supported VOs | def, atl, cms | def |
26-
| MULTIVO_ENABLED | RUCIO_WEBUI_MULTIVO_ENABLED | Whether to enable multi-VO config (true or false) | true | |
27-
| OIDC_ENABLED | RUCIO_WEBUI_OIDC_ENABLED | Enable or Disable OIDC Authentication (true or false) | true | |
28-
| OIDC_PROVIDERS | RUCIO_WEBUI_OIDC_PROVIDERS | CSV string containing names of OIDC Providers | cern, indigo | |
15+
| Variable Name | Full Name | Description | Example | Default |
16+
| ---------------- | ---------------------------- | ------------------------------------------------------------------------------------------ | ------------------------------ | ------- |
17+
| RUCIO_HOST | RUCIO_WEBUI_RUCIO_HOST | URL for the Rucio Server | https://rucio-lb-prod.cern.ch | |
18+
| RUCIO_AUTH_HOST | RUCIO_WEBUI_RUCIO_AUTH_HOST | URL for the Rucio authentication server | https://rucio-auth-host.ch:443 | |
19+
| HOSTNAME | RUCIO_WEBUI_HOSTNAME | Public HOSTNAME at which Rucio WebUI will be accessible. It may include port number. | rucio-ui.cern.ch | |
20+
| ENABLE_SSL | RUCIO_WEBUI_ENABLE_SSL | Enable or Disable TLS Termination (true or false) | true | false |
21+
| SERVER_CA_BUNDLE | RUCIO_WEBUI_SERVER_CA_BUNDLE | Path to the CA bundle file that can verify Rucio Server certificate. If ENABLE_SSL is set. | /path/to/ca-bundle.pem | |
22+
| PROJECT_URL | RUCIO_WEBUI_PROJECT_URL | Public URL for your project | https://atlas.cern.ch | |
23+
| VO_DEFAULT | RUCIO_WEBUI_VO_DEFAULT | Short name for the default VO used for authentication | def | def |
24+
| VO_LIST | RUCIO_WEBUI_VO_LIST | CSV string containing the list of supported VOs | def, atl, cms | def |
25+
| MULTIVO_ENABLED | RUCIO_WEBUI_MULTIVO_ENABLED | Whether to enable multi-VO config (true or false) | true | |
26+
| OIDC_ENABLED | RUCIO_WEBUI_OIDC_ENABLED | Enable or Disable OIDC Authentication (true or false) | true | |
27+
| OIDC_PROVIDERS | RUCIO_WEBUI_OIDC_PROVIDERS | CSV string containing names of OIDC Providers | cern, indigo | |
2928

3029
For each `VO` specified in the `VO_LIST` variable, the additional variables need to be specified. The variables should be added in the following format:
3130
`export RUCIO_WEBUI_VO_<VO_SHORT_NAME>_<VARIABLE_NAME>=<VARIABLE_VALUE>`. An example for the default VO is shown below:

‎tools/env-generator/src/api/base.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ export class WebUIEnvTemplateCompiler {
135135

136136
// check if NODE_TLS_REJECT_UNAUTHORIZED is set to 1, then NODE_EXTRA_TLS_CERTS should be set
137137
if(env['NODE_TLS_REJECT_UNAUTHORIZED'] === '1') {
138-
requiredVariables.push('CA_BUNDLE')
138+
requiredVariables.push('SERVER_CA_BUNDLE')
139139
}
140140

141141
// check if all required variables are set

‎tools/env-generator/src/templates/.env.liquid

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ SESSION_COOKIE_NAME={{ context.SESSION_COOKIE_NAME }}
1414
[fetch]
1515
NODE_TLS_REJECT_UNAUTHORIZED={{ context.NODE_TLS_REJECT_UNAUTHORIZED }}
1616
{% if enable_ssl == 'true' %}
17-
NODE_EXTRA_TLS_CERTS={{ context.CA_BUNDLE }}
17+
NODE_EXTRA_TLS_CERTS={{ context.SERVER_CA_BUNDLE }}
1818
{% endif %}
1919

2020
[gateway]

0 commit comments

Comments
 (0)