Skip to content

Commit 7067c54

Browse files
author
Keyfactor
committed
Update generated docs
1 parent d922417 commit 7067c54

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,7 @@ For example, ClusterIssuer resources can be used to issue certificates for resou
251251
| ownerRoleName | The name of the security role assigned as the certificate owner. The security role must be assigned to the identity context of the issuer. If `ownerRoleId` and `ownerRoleName` are both specified, `ownerRoleId` will take precedence. This field is **required** if the enrollment pattern, certificate template, or system-wide setting requires it. |
252252
| scopes | (Optional) Required if using ambient credentials with Azure AKS. If using ambient credentials, these scopes will be put on the access token generated by the ambient credentials' token provider, if applicable. |
253253
| audience | (Optional) If using ambient credentials, this audience will be put on the access token generated by the ambient credentials' token provider, if applicable. Google's ambient credential token provider generates an OIDC ID Token. If this value is not provided, it will default to `command`. |
254+
| healthCheckIntervalSeconds | (Optional) Defines the health check interval, in seconds, for a healthy issuer. If ommitted, defaults to 60 seconds. If set to 0, it will disable the health check. If there is a failure when running the health check, it will retry in 10 seconds with an exponential backoff strategy. Value must not be negative. |
254255
255256
> If a different combination of hostname/certificate authority/certificate template is required, a new Issuer or ClusterIssuer resource must be created. Each resource instantiation represents a single configuration.
256257
@@ -282,6 +283,7 @@ For example, ClusterIssuer resources can be used to issue certificates for resou
282283
# ownerRoleName: "$OWNER_ROLE_NAME" # Uncomment if required
283284
# scopes: "openid email https://example.com/.default" # Uncomment if required
284285
# audience: "https://your-command-url.com" # Uncomment if desired
286+
# healthCheckIntervalSeconds: 60 # Uncomment if desired. Setting to 0 disables health check.
285287
EOF
286288
287289
kubectl -n default apply -f issuer.yaml
@@ -312,6 +314,7 @@ For example, ClusterIssuer resources can be used to issue certificates for resou
312314
# ownerRoleName: "$OWNER_ROLE_NAME" # Uncomment if required
313315
# scopes: "openid email https://example.com/.default" # Uncomment if required
314316
# audience: "https://your-command-url.com" # Uncomment if desired
317+
# healthCheckIntervalSeconds: 60 # Uncomment if desired. Setting to 0 disables health check.
315318
EOF
316319
317320
kubectl apply -f clusterissuer.yaml

0 commit comments

Comments
 (0)