update values.yaml with notes about including port in api.host field (#…

…1122) Signed-off-by: Kent <[email protected]>
akuity · Nov 16, 2023 · db3a968 · db3a968
1 parent 29bff30
commit db3a968
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/charts/kargo/README.md b/charts/kargo/README.md
@@ -38,7 +38,7 @@ In the average case, these settings should be left alone.
 | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- |
 | `api.enabled`                      | Whether the API server is enabled.                                                                                                                                                                                                                                                                                                                                                                                                           | `true`               |
 | `api.replicas`                     | The number of API server pods.                                                                                                                                                                                                                                                                                                                                                                                                               | `1`                  |
-| `api.host`                         | The domain name where Kargo's API server will be accessible. This is used for (when applicable) generation of an Ingress resource, certificates, and the OpenID Connect issuer and callback URLs. Note: The protocol (http vs https) should not be specified and is automatically inferred from other configuration options.                                                                                                                 | `localhost`          |
+| `api.host`                         | The domain name where Kargo's API server will be accessible. When applicable, this is used for generation of an Ingress resource, certificates, and the OpenID Connect issuer and callback URLs. Note: The value in this field MAY include a port number and MUST NOT specify the protocol (http vs https), which is automatically inferred from other configuration options.                                                                | `localhost`          |
 | `api.logLevel`                     | The log level for the API server.                                                                                                                                                                                                                                                                                                                                                                                                            | `INFO`               |
 | `api.resources`                    | Resources limits and requests for the api containers.                                                                                                                                                                                                                                                                                                                                                                                        | `{}`                 |
 | `api.nodeSelector`                 | Node selector for api pods.                                                                                                                                                                                                                                                                                                                                                                                                                  | `{}`                 |

diff --git a/charts/kargo/values.yaml b/charts/kargo/values.yaml
@@ -42,7 +42,7 @@ api:
   enabled: true
   ## @param api.replicas The number of API server pods.
   replicas: 1
-  ## @param api.host The domain name where Kargo's API server will be accessible. This is used for (when applicable) generation of an Ingress resource, certificates, and the OpenID Connect issuer and callback URLs. Note: The protocol (http vs https) should not be specified and is automatically inferred from other configuration options.
+  ## @param api.host The domain name where Kargo's API server will be accessible. When applicable, this is used for generation of an Ingress resource, certificates, and the OpenID Connect issuer and callback URLs. Note: The value in this field MAY include a port number and MUST NOT specify the protocol (http vs https), which is automatically inferred from other configuration options.
   host: localhost
   ## @param api.logLevel The log level for the API server.
   logLevel: INFO