chore: update docs

Signed-off-by: Matthew H. Irby <[email protected]>

Author: irby

api/v1alpha1/issuer_types.go

@@ -46,7 +46,7 @@ type IssuerSpec struct {
 	// +kubebuilder:default:=KeyfactorAPI
 	APIPath string `json:"apiPath,omitempty"`
 
-	// The number of seconds between successful health checks. 60 seconds (1 minute) by default
+	// The number of seconds between successful health checks. 60 seconds (1 minute) by default. Setting to 0 will disable the health check.
 	// +kubebuilder:default:=60
 	HealthCheckIntervalSeconds *int `json:"healthCheckIntervalSeconds,omitempty"`
 

config/crd/bases/command-issuer.keyfactor.com_clusterissuers.yaml

@@ -105,7 +105,8 @@ spec:
               healthCheckIntervalSeconds:
                 default: 60
                 description: The number of seconds between successful health checks.
-                  60 seconds (1 minute) by default
+                  60 seconds (1 minute) by default. Setting to 0 will disable the
+                  health check.
                 type: integer
               hostname:
                 description: Hostname is the hostname of a Keyfactor Command instance.

config/crd/bases/command-issuer.keyfactor.com_issuers.yaml

@@ -105,7 +105,8 @@ spec:
               healthCheckIntervalSeconds:
                 default: 60
                 description: The number of seconds between successful health checks.
-                  60 seconds (1 minute) by default
+                  60 seconds (1 minute) by default. Setting to 0 will disable the
+                  health check.
                 type: integer
               hostname:
                 description: Hostname is the hostname of a Keyfactor Command instance.

deploy/charts/command-cert-manager-issuer/templates/crds/clusterissuers.yaml

@@ -82,7 +82,8 @@ spec:
               healthCheckIntervalSeconds:
                 default: 60
                 description: The number of seconds between successful health checks.
-                  60 seconds (1 minute) by default
+                  60 seconds (1 minute) by default. Setting to 0 will disable the
+                  health check.
                 type: integer
               ownerRoleId:
                 description: |-

deploy/charts/command-cert-manager-issuer/templates/crds/issuers.yaml

@@ -82,7 +82,8 @@ spec:
               healthCheckIntervalSeconds:
                 default: 60
                 description: The number of seconds between successful health checks.
-                  60 seconds (1 minute) by default
+                  60 seconds (1 minute) by default. Setting to 0 will disable the
+                  health check.
                 type: integer
               ownerRoleId:
                 description: |-

docsource/content.md

@@ -219,6 +219,7 @@ For example, ClusterIssuer resources can be used to issue certificates for resou
     | 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. |
     | 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.   |
      | 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`.  |
+     | 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. |
 
     > 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.
 
@@ -250,6 +251,7 @@ For example, ClusterIssuer resources can be used to issue certificates for resou
           # ownerRoleName: "$OWNER_ROLE_NAME" # Uncomment if required
           # scopes: "openid email https://example.com/.default" # Uncomment if required
           # audience: "https://your-command-url.com" # Uncomment if desired
+          # healthCheckIntervalSeconds: 60 # Uncomment if desired. Setting to 0 disables health check.
         EOF
 
         kubectl -n default apply -f issuer.yaml
@@ -280,6 +282,7 @@ For example, ClusterIssuer resources can be used to issue certificates for resou
           # ownerRoleName: "$OWNER_ROLE_NAME" # Uncomment if required
           # scopes: "openid email https://example.com/.default" # Uncomment if required
           # audience: "https://your-command-url.com" # Uncomment if desired
+          # healthCheckIntervalSeconds: 60 # Uncomment if desired. Setting to 0 disables health check.
         EOF
 
         kubectl apply -f clusterissuer.yaml