Skip to content

Commit e3e5674

Browse files
authored
Clarify secret requirements (azimuth-cloud#152)
* Clarify secret requirements For some secrets there are specific requirements. Let's include some notes in the passwords.yml * Clarify secret requirements in docs
1 parent 269605a commit e3e5674

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

docs/configuration/08-zenith.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ zenith_registrar_subdomain_token_signing_key: "<some secret key>"
1717
1818
!!! tip
1919
20-
This key should be a long, random string - at least 32 bytes (256 bits) is recommended.
20+
This key must be a long, random string - at least 32 bytes (256 bits) is required.
2121
A suitable key can be generated using `openssl rand -hex 32`.
2222

2323
!!! danger

environments/example/inventory/group_vars/all/secrets.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
# It should be encrypted if stored in version control
55
# https://stackhpc.github.io/azimuth-config/repository/secrets/
66
#####
7+
# Unless explicitly mentioned otherwise, a long, random string - at least 32 bytes (256 bits) is recommended.
8+
# A suitable key can be generated using the following command.
9+
# openssl rand -hex 32
710

811
# https://stackhpc.github.io/azimuth-config/configuration/05-secret-key/
912
# The secret key for signing Azimuth cookies
@@ -15,12 +18,14 @@ keycloak_admin_password: "<secure password>"
1518

1619
# https://stackhpc.github.io/azimuth-config/configuration/08-zenith/
1720
# The secret key for signing Zenith registrar tokens
21+
# This MUST be a minimum of 32 characters
1822
zenith_registrar_subdomain_token_signing_key: "<secure secret key>"
1923

2024
# https://stackhpc.github.io/azimuth-config/configuration/10-kubernetes-clusters/#harbor-registry
2125
# The password for the Harbor admin account
2226
harbor_admin_password: "<secure password>"
2327
# The secret key for Harbor
28+
# This MUST be exactly 16 alphanumeric characters
2429
harbor_secret_key: "<secure secret key>"
2530

2631
# https://stackhpc.github.io/azimuth-config/configuration/14-monitoring/#accessing-web-interfaces

0 commit comments

Comments
 (0)