Merge pull request #2648 from project-sunbird/release-3.9.0

fix: add important comments (#2645)

private_repo/ansible/inventory/dev/Core/secrets.yml

@@ -91,17 +91,12 @@ core_vault_kibana_google_client_id:                      # You can use the same
 core_vault_kibana_google_client_secret:                  # You can use the same outh client secret that we used for portal
 
 vault_core_url_shortner_access_token: ""                 # Url shortner access token if you want to shorten urls like forgot password link etc using an external service like bit.ly
+
+### IMPORTANT! IMPORTANT! IMPORTANT! ###
+### NOTE: FOR A REAL ENVIRONMENT YOU MUST CHANGE THE BELOW VALUES TO SOMETHING VERY SECRET WHICH ONLY YOU WILL KNOW! DO NOT USE THE DEFAULTS FOR REAL ENVIRONMENTS! ###
 # ------------------------------------------------------------------------------------------------------------ #
-# Sensible defaults which you need not change - But if you would like to change, you are free to do so
-core_vault_enc_entry_password: password                              # encryption password for the enc service
-core_vault_enc_master_pass: password                                 # encryption password for the keys
-core_vault_kibana_cookie_secret: long-secret-to-calm-entropy-gods    # Cookie secret for kibana Oauth
-dp_play_http_secret_key: "long-secret-to-calm-entropy-gods"          # Random 32+ character string
-core_vault_graph_passport_key: "long-secret-to-calm-entropy-gods"    # Should be same as lp_vault_graph_passport_key from KP secrets.yml
-crypto_encryption_key: "long-secret-to-calm-entropy-gods" # any crypto key of 32 bit length, used by portal to encrypt and decrypt the userDetails for forgot password flow
-sunbird_api_auth_token_bot: "{{ core_vault_sunbird_api_auth_token }}"
+# Sensible defaults which you need not change if you are just trying Sunbird- You should change these to something unique for real environments and not use the defaults
 
-# Keycloak related vars
 core_vault_keycloak_api_management_user_password: admin
 core_vault_keystore_password: password                                                           # Password for encrypting data in cassandra
 core_vault_sunbird_sso_username: admin                                                           # Keycloak SSO username
@@ -123,9 +118,21 @@ core_vault_sunbird_keycloak_user_federation_provider_id: "8460f8f8-b6bc-11eb-852
 core_vault_proxy_prometheus_admin_creds: admin                                                   # Prometheus admin password
 core_vault_postgres_username: postgres                                                           # Postgres user name
 core_vault_grafana_editor_password: sunbird                                                      # Grafana editor user password
+
+
+# ------------------------------------------------------------------------------------------------------------ #
+# Sensible defaults which you need not change - But if you would like to change, you are free to do so
+
 core_vault_grafana_dashboards_git_repo_url_with_credentails: "https://github.com/project-sunbird/grafana-dashboards.git"
 # Changing the sessions secret value will invalidate all existing sessions.
 # In order to rotate the secret without invalidating sessions, provide an array of secrets,
 # with the new secret as first element of the array, and followed by previous secrets.
-sunbird_portal_session_secret: "long-secret-to-calm-entropy-gods"                                # Portal session secret
-nodebb_admin_password: MySecretPassword                                                          # Nodebb admin password
+sunbird_portal_session_secret: "long-secret-to-calm-entropy-gods"    # Portal session secret
+nodebb_admin_password: MySecretPassword                              # Nodebb admin password
+core_vault_enc_entry_password: password                              # encryption password for the enc service
+core_vault_enc_master_pass: password                                 # encryption password for the keys
+core_vault_kibana_cookie_secret: long-secret-to-calm-entropy-gods    # Cookie secret for kibana Oauth
+dp_play_http_secret_key: "long-secret-to-calm-entropy-gods"          # Random 32+ character string
+core_vault_graph_passport_key: "long-secret-to-calm-entropy-gods"    # Should be same as lp_vault_graph_passport_key from KP secrets.yml
+crypto_encryption_key: "long-secret-to-calm-entropy-gods" # any crypto key of 32 bit length, used by portal to encrypt and decrypt the userDetails for forgot password flow
+sunbird_api_auth_token_bot: "{{ core_vault_sunbird_api_auth_token }}"