Skip to content

Commit a2debd1

Browse files
authored
Add clarifying documentation for the OIDC configuration (#311)
* Add clarifying documentation for the OIDC configuration * Will's feedback * More feedback
1 parent 32f6891 commit a2debd1

File tree

1 file changed

+20
-10
lines changed

1 file changed

+20
-10
lines changed

getting-started/templates/systemlink-values.yaml

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -170,8 +170,17 @@ webserver:
170170
## Required - Secret name that holds client ID, client secret, and JWKs.
171171
##
172172
secretName: "oidc-secret"
173-
## Required - Include either issuer URL (for discovery) or the provider configuration as JSON wrapped in single quotes.
174-
##
173+
## Required - Specify the OIDC configuration using one of following approaches.
174+
## 1. Auto-discover: Set the issuer value as the provider URL. This value allows the service to
175+
## download a configuration from issuer-url/.well-known/openid-configuration as defined by
176+
## the OIDC specification.
177+
## 2. Manual: Set the issuer value to an empty string and remove the comment marks from the provider value.
178+
## You must also set the provider value to a single-quoted string that contains a full OIDC configuration.
179+
## This configuration must be in the JSON format as defined by the OIDC spec. For more information, refer to
180+
## https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationResponse.
181+
## 3. Auto-discover and manual override — Set the issuer value to the provider URL and remove the comment marks
182+
## from the provider value. You must set the provider value to a sparse OIDC configuration. The service will then
183+
## download the configuration from the provider and override with any settings from the provider configuration.
175184
issuer: "https://oidc.example.com/"
176185
# provider: '<provider-config-json>'
177186
## Optional - Claim to use for user ID.
@@ -408,20 +417,21 @@ alarmservice:
408417
queueLimit: 2
409418

410419
database:
411-
## The amount of time inactive alarms will be retained in the database ([d.]hh:mm[:ss] format).
420+
## Sets the amount of time that a database retains an inactive alarm.
421+
## This value uses the following format: [d.]hh:mm[:ss]
412422
##
413423
inactiveAlarmCleanupInterval: 30.00:00
414-
424+
415425
activeAlarmCleanup:
416-
## The amount of time active alarms will be retained in the database since they were
417-
## last updated ([d.]hh:mm[:ss] format).
426+
## Sets the amount of time that a database retains an active alarm after the latest update.
427+
## This value uses the following format: [d.]hh:mm[:ss]
418428
##
419429
interval: 90.00:00
420430
## Whether to limit active alarm cleanup to only affect active alarms whose most recent
421431
## transition has a CLEAR transition type.
422432
##
423433
onlyCleanUpClearAlarms: false
424-
434+
425435
## The total number of alarms the service supports creating, including
426436
## both active and inactive alarms. Must be greater than activeAlarmLimit.
427437
## The service will return an error if this limit is exceeded. Increasing
@@ -827,7 +837,7 @@ feedservice:
827837
##
828838
includeApiHostsInNoProxy: false
829839
## @param httpProxy.additionalNoProxy List of hosts that should not be proxied. Example: ["localserver1","localserver2"]
830-
## For example, we would need to set the host of the AWS Security Token Service if we use AWS_WEB_IDENTITY_TOKEN for the S3 auth type -> "sts.us-east-1.amazonaws.com"
840+
## For example, we would need to set the host of the AWS Security Token Service if we use AWS_WEB_IDENTITY_TOKEN for the S3 auth type -> "sts.us-east-1.amazonaws.com"
831841
additionalNoProxy: []
832842

833843
## FileIngestion configuration.
@@ -844,10 +854,10 @@ fileingestion:
844854
nginx.ingress.kubernetes.io/proxy-buffering: "off"
845855

846856
## Feature toggles.
847-
##
857+
##
848858
featureToggle:
849859
## <ATTENTION> - Verify that you have all the prerequisites before enabling this toggle.
850-
## More information can be found in the SystemLink User Manual.
860+
## For more information, refer to the SystemLink user manual.
851861
## <ATTENTION> - This is an early access feature and is not yet available for general use.
852862
searchFiles: false
853863

0 commit comments

Comments
 (0)