Helm Chart Install Reference #1241
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,261 @@ | ||
| --- | ||
| title: "Helm Chart Install Reference" | ||
| metaTitle: "Helm Chart Install References" | ||
| metaDescription: "Reference page for Pallete Helm chart self-installation values.yaml file parameters." | ||
rahulhazra97 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| icon: "" | ||
| hideToC: False | ||
| fullWidth: False | ||
| --- | ||
|
|
||
| # Helm Chart Install Reference | ||
|
|
||
| You can use the Palette Helm Chart to install Palette in a multi-node Kubernetes cluster in your production environment. The Helm chart allows you to customize values in the values.yaml file. This reference guide lists and describes parameters available in the values.yaml file from the Helm Chart for your installation. To learn how to install Palette using the Helm Chart, refer to [Helm Chart Mode](/deploying-palette-with-helm). | ||
|
|
||
| # Required Parameters | ||
|
|
||
| The following parameters are required: | ||
rahulhazra97 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
|
There was a problem hiding this comment. Let's add a break here for space between the intro sentence and the list. It's up to you, but if we mention the values.yaml file here, it doesn't have to repeat in each introductory sentence. I've offered wording for each table introduction. There was a problem hiding this comment. Hi Rita, Thanks for this. I added the break. It looks cleaner now. |
||
| - **env.rootDomain**- Used to configure the domain for the Palette installation. You should create a CNAME DNS record separately, and it should be a wildcard to account for Organization prefixes. Review the [Environment parameters](#environment) to learn more. | ||
|
|
||
rahulhazra97 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - **natsUrl**- The URL format specifies configuring the NATS servers to the IP address and port. Review the [Network Address Translation (NATS) parameters](#network-address-translationnats) to learn more. | ||
|
|
||
rahulhazra97 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| - **Registry and Palette Artifact Repository**- Refer to the [Registry and Palette Artifact Repository parameters](#registry-and-palette-artifact-repositorypar) used to specify the Docker registry where the chart images are stored and the **Palette Artifact Repository (PAR)**, respectively. | ||
|
|
||
| # MongoDB | ||
|
|
||
|
There was a problem hiding this comment. For this list, I suggest
There was a problem hiding this comment. Yep. I did it exactly how you asked it here, it seems concise enough. |
||
| Palette uses MongoDB as its database and supports two modes of deployment: | ||
| 1. MongoDB deployed and active inside the cluster. | ||
| 2. MongoDB hosted on a Saas platform such as Atlas. | ||
|
There was a problem hiding this comment. 🚫 [vale] reported by reviewdog 🐶
rahulhazra97 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| The table lists parameters in the values.yaml file that are used to configure a MongoDB deployment. | ||
|
|
||
| | **Parameters** | **Default value** | **Type** | **Description** | **Required/Optional** | | ||
karl-cardenas-coding marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| | --- | --- | --- | --- | --- | | ||
| | `internal` | `N/A` | Boolean | Specifies the MongoDB deployment either in-cluster or using Mongo Atlas. | Required | | ||
| | `databaseUrl` | `mongo-0.mongo,mongo-1.mongo,mongo-2.mongo` | String | Url for MongoDB. Change if using Mongo Atlas.| Required| | ||
|
There was a problem hiding this comment. 🚫 [vale] reported by reviewdog 🐶
rahulhazra97 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| | `databasePassword` | `""` | String | The base64 encoded MongoDB password. | Optional | | ||
| | `replicas` | `3` | Integer | Specifies the number of MongoDB replicas to start.| Required | | ||
| | `cpu.limit` | `2000m` | String | Specifies the CPU limit for each MongoDB replica.| Optional | | ||
| | `memorylimit` | `4Gi` | String |Specifies the memory limit for each MongoDB replica.| Optional | | ||
| | `pvcSize` | `20Gi` | String | Specifies the persistent volume claim (PVC) size for each MongoDB replica.|Optional | | ||
| | `storageClass` | `""` | String | Storage class for the PVC. Leave empty to use the default storage class. |Optional | | ||
rahulhazra97 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
|
|
||
| ```yaml | ||
| mongo: | ||
| databaseUrl: "mongo-0.mongo,mongo-1.mongo,mongo-2.mongo" | ||
| replicas: 3 | ||
| cpuLimit: "2000m" | ||
| memoryLimit: "4Gi" | ||
| pvcSize: "20Gi" | ||
| storageClass: "" | ||
| ``` | ||
|
|
||
| # Config | ||
|
There was a problem hiding this comment. 🚫 [vale] reported by reviewdog 🐶 |
||
|
|
||
| The configuration file contains the following sections: | ||
rahulhazra97 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## SSO | ||
|
|
||
| The following table outlines the different values.yaml parameters for configuring **SSO SAML** authentication in Palette. | ||
|
|
||
| | **Parameters** | **Default value** | **Type** | **Description** | **Required/Optional** | | ||
| | --- | --- | --- | --- | --- | | ||
| | `saml.enabled` | `false` | Boolean | Specifies whether to enable **SSO SAML** configuration by setting it to true. | Optional| | ||
| | `saml.acsUrlRoot` | `myfirstpalette.spectrocloud.com` | String | Root URL of the Assertion Consumer Service (ACS).| Optional| | ||
| | `saml.acsUrlScheme` | `https` | String | URL scheme of the ACS (e.g., http or https). | Optional | | ||
|
There was a problem hiding this comment. 🚫 [vale] reported by reviewdog 🐶 |
||
| | `saml.audienceUrl` | `https://www.spectrocloud.com` | String | URL of the intended audience for the SAML response.| Optional| | ||
| | `saml.entityID` | `https://www.spectrocloud.com` | String | Entity ID of the Service Provider.| Optional | | ||
| | `saml.apiVersion` | `v1` | String |**SSO SAML** API version to use.| Optional | | ||
|
|
||
| ```yaml | ||
| config: | ||
| sso: | ||
| saml: | ||
| enabled: false | ||
| acsUrlRoot: "myfirstpalette.spectrocloud.com" | ||
| acsUrlScheme: "https" | ||
| audienceUrl: "https://www.spectrocloud.com" | ||
| entityId: "https://www.spectrocloud.com" | ||
| apiVersion: "v1" | ||
| ``` | ||
|
|
||
|
|
||
| The following table provides a reference for the available values.yaml parameters for configuring email settings in Palette's self-hosted mode. | ||
|
|
||
| | **Parameters** | **Default value** | **Type** | **Description** | **Required/Optional** | | ||
| | --- | --- | --- | --- | --- | | ||
| | `enabled` | `false` | Boolean | Specifies whether to enable email configuration. | Optional| | ||
| | `emailID ` | `""` | String | Email address for sending mail.| Optional| | ||
| | `smtpServer` | `smtp.gmail.com` | String | Simple Mail Transfer Protocol (SMTP) server used for sending mail. | Optional | | ||
|
There was a problem hiding this comment. 🚫 [vale] reported by reviewdog 🐶 There was a problem hiding this comment. 🚫 [vale] reported by reviewdog 🐶 |
||
| | `smtpPort` | `587` | Integer | SMTP port used for sending mail.| Optional| | ||
| | `insecureSkipVerifyTIs` | `true` | Boolean | Specifies whether to skip Transport Layer Security (TLS) verification for the SMTP connection.| Optional | | ||
| | `fromEmailID` | `noreply@spectrocloud.com` | String |Email address used from From address.| Optional | | ||
rahulhazra97 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| | `password` | `""` | String |Base64-encoded SMTP password when sending emails.| Optional | | ||
rahulhazra97 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ```yaml | ||
| config: | ||
| email: | ||
| enabled: false | ||
| emailId: "<username>@spectrocloud.com" | ||
| smtpServer: "smtp.gmail.com" | ||
| smtpPort: 587 | ||
| insecureSkipVerifyTls: true | ||
| fromEmailId: "noreply@spectrocloud.com" | ||
| password: "YmFzZTY0X2VtYWlsX3Bhc3N3b3Jk" | ||
| ``` | ||
|
|
||
| ## Environment | ||
|
|
||
| The following table outlines environment variables needed for deployment as defined in the values.yaml file. | ||
|
|
||
| | **Parameters** | **Default value** | **Type** | **Description** | **Required/Optional** | | ||
| | --- | --- | --- | --- | --- | | ||
| | `env.rootDomain` | `""` | String | Specifies the default DNS record mapped to the ingress-nginx-controller load balancer. It is mandatory if false; otherwise, leave it empty. | Required| | ||
|
There was a problem hiding this comment. 🚫 [vale] reported by reviewdog 🐶 |
||
| | `env.installerMode` | `self-hosted` | String | Specifies the installer mode. Do not modify the value.| Required| | ||
| | `env.installerCloud` | `""` | String | Specifies cloud provider. It shoudl be left empty. | Optional | | ||
|
There was a problem hiding this comment. 🚫 [vale] reported by reviewdog 🐶
rahulhazra97 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ```yaml | ||
| config: | ||
| env: | ||
| rootDomain: "" | ||
| installerMode: "self-hosted" | ||
| installerCloud: "" | ||
| ``` | ||
|
|
||
| ## Cluster | ||
|
|
||
| Cluster parameters are used to specify the Kubernetes cluster configuration. | ||
rahulhazra97 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
|
|
||
| | **Parameters** | **Default value** | **Type** | **Description** | **Required/Optional** | | ||
| | --- | --- | --- | --- | --- | | ||
| | `stableEndpointAccess` | `false` | Boolean | Specifies whether EKS cluster is deployed in private network access through a stable private endpoint, if true, through a public endpoint. | Optional| | ||
|
|
||
| ```yaml | ||
| config: | ||
| cluster: | ||
| stableEndpointAccess: false | ||
| ``` | ||
|
|
||
| ## Registry and Palette Artifact Repository (PAR) | ||
|
|
||
| **Registry and Palette Artifact Repository** are required parameters in the values.yaml for installing Palette using Helm Chart. | ||
|
|
||
| | **Parameters** | **Type** | **Description** | **Required/Optional** | | ||
| | ----------------- | ------ | -------------------------------------------------------- | ------------------ | | ||
| | `registry.endpoint` | String | The endpoint URL for the registry. | Required | | ||
| | `registry.name` | String | The name of the registry. | Required | | ||
| | `registry.password` | String | The password for the registry. | Required | | ||
| | `registry.username` | String | The username for the registry. | Required | | ||
| | `scar.endpoint` | String | The endpoint URL of the **Palette Artifact Repository (PAR)**. | Required | | ||
| | `scar.username` | String | The username for the **PAR**. | Required | | ||
| | `scar.password` | String | The password for the **PAR**. | Required | | ||
|
|
||
| ```yaml | ||
| config: | ||
| registry: | ||
| endpoint: "<Contact Spectro Cloud Sales for More info>" | ||
| name: "<Contact Spectro Cloud Sales for More info>" | ||
| password: "<Contact Spectro Cloud Sales for More info>" | ||
| username: "<Contact Spectro Cloud Sales for More info>" | ||
|
|
||
| scar: | ||
| endpoint: "<Contact Spectro Cloud Sales for More info>" | ||
| username: "<Contact Spectro Cloud Sales for More info>" | ||
| password: "<Contact Spectro Cloud Sales for More info>" | ||
| ``` | ||
|
|
||
| Please contact the Spectro Cloud support team at [support@spectrocloud.com](support@spectrocloud.com) to receive the required values and credentials for **Palette Artifact Repository (PAR**). | ||
|
|
||
| # Network Address Translation (NATS) | ||
|
|
||
| When using Palette, **Network Address Translation (NATS)** is used for communication between the tenant and management clusters. The internal flag determines whether **NATS** uses a new load balancer or the existing ingress service. To learn about the NATS cluster configuration map properties, refer to [NATS clustering configuration.](https://docs.nats.io/running-a-nats-service/configuration/clustering/cluster_config) | ||
|
|
||
| | **Parameters ** | **Default Value** | **Type ** | **Description** | **Required/Optional** | | ||
| | ------------ | ------------- | ------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------ | | ||
| | `internal` | `true` | Boolean | Specifies if NATS shares the ingress load balancer or uses hostNetwork if true; otherwise, with a cloud load balancer. | Optional | | ||
|
There was a problem hiding this comment. 🚫 [vale] reported by reviewdog 🐶
rahulhazra97 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| | `natsUrl` | `""` | String | Comma-separated list of <dns_name:port> mappings for nats load balancer service. Mandatory if `nats.internal` is false. | Required | | ||
|
There was a problem hiding this comment. 🚫 [vale] reported by reviewdog 🐶
rahulhazra97 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| | `annotations`| `{}` | Map | A map of key-value pairs that specify the load balancer annotations for NATS. These annotations vary depending on the cloud provider. | Optional | | ||
| | `routes` | `[]` | List | List of server URLs for clustering (excluding self-routes) that can include authentication via token or username/password in the URL. | Optional | | ||
| | `natsStaticIP`| `""` | String | Static IP for the NATS load balancer service. If empty, a dynamic IP will be generated. | Optional | | ||
|
|
||
| ```yaml | ||
| nats: | ||
| internal: true | ||
| natsUrl: "" | ||
| annotations: {} | ||
| routes: [] | ||
| natsStaticIP: "" | ||
| ``` | ||
|
|
||
| # Ingress | ||
|
|
||
| The **Ingress** block in the YAML configuration file is used for configuring the **NGINX Ingress** Controller, which provides an external HTTP load balancer for **Kubernetes** services. | ||
|
|
||
| | **Parameters** | **Default Value** | **Type** | **Description** | **Required/Optional** | | ||
| |--------------------------------|---------------|---------|---------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| | ||
| | `Internal` | `false` | Boolean |Specify whether to use a cloud load balancer or host network. | Required | | ||
| | `certificate` | `""` | String | Default SSL certificate for NGINX Ingress Controller. If left blank, the NGINX ingress controller will generate a self-signed cert. | Optional | | ||
|
There was a problem hiding this comment. 🚫 [vale] reported by reviewdog 🐶 |
||
| | `key` | `""` | String | Default SSL key for the NGINX Ingress Controller. | Optional | | ||
|
There was a problem hiding this comment. 🚫 [vale] reported by reviewdog 🐶 |
||
| | `annotations` | `{}` | Map | A map of key-value pairs that specify the load balancer annotations for Ingress. | Optional | | ||
rahulhazra97 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| | `ingressStaticIP` | `""` | String | Static IP for the Ingress load balancer service. If empty, a dynamic IP will be generated. | Optional | | ||
| | `terminateHTTPSAtLoadBalancer` | `false` | Boolean | Specify whether to terminate HTTPS at the load balancer. | Optional | | ||
|
|
||
| ```yaml | ||
| ingress: | ||
| ingress: | ||
| internal: false | ||
| certificate: "" | ||
| key: "" | ||
| annotations: {} | ||
| ingressStaticIP: "" | ||
| terminateHTTPSAtLoadBalancer: false | ||
| ``` | ||
|
|
||
| # Spectro Proxy | ||
|
|
||
| **Spectro Proxy** is a section of the configuration file for the Spectro server-side proxy. | ||
|
|
||
| | **Parameters** | **Default Value** | **Type** | **Description** | **Required/Optional** | | ||
| |---------------------|------------------------------|---------|---------------------------------------------------------------|--------------------| | ||
| | `enabled` | `false` | Boolean | Specifies whether Spectro proxy is enabled or not | Optional | | ||
| | `frpHostURL` | `proxy.sample.spectrocloud.com` | String | The URL of the Spectro proxy host. | Optional | | ||
| | `server.crt` | | String | Specifies the certificate file for the Spectro proxy server. | Optional | | ||
| | `server.key` | | String | Specifies the private key file for the Spectro proxy server. | Optional | | ||
| | `ca` | | String | Specifies the certificate authority (CA) for the Spectro proxy server. | Optional | | ||
| | `ca.crt` | | String | Specifies the CA certificate file for the Spectro proxy server. | Optional | | ||
|
|
||
| ```yaml | ||
| frps: | ||
| frps: | ||
| enabled: false | ||
| frpHostURL: proxy.sample.spectrocloud.com | ||
| server: | ||
| crt: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURqekNDQW5lZ0F3SUJBZ0lVZTVMdXBBZGljd0Z1SFJpWWMyWEgzNTFEUzJJd0RRWUpLb1pJaHZjTkFRRUwKQlFBd0tERW1NQ1FHQTFVRUF3d2RjSEp2ZUhrdWMyRnRjR3hsTG5Od1pXTjBjbTlqYkc5MVpDNWpiMjB3SGhjTgpNakl4TURFME1UTXlOREV5V2hjTk1qY3hNREV6TVRNeU5ERXlXakI3TVFzd0NRWURWUVFHRXdKVlV6RUxNQWtHCkExVUVDQk1DUTBFeEV6QVJCZ05WQkFjVENsTmhiblJoUTJ4aGNtRXhGVEFUQmdOVkJBb1RERk53WldOMGNtOUQKYkc5MVpERUxNQWtHQTFVRUN4TUNTVlF4SmpBa0JnTlZCQU1USFhCeWIzaDVMbk5oYlhCc1pTNXpjR1ZqZEhKdgpZMnh2ZFdRdVkyOXRNSUlCSWpBTkJna3Foa2 | ||
| ``` | ||
|
|
||
| # UI System | ||
|
|
||
| This is a User Interface (UI) system configuration file and specifies a setting for a UI called **nocUI**. Palette's **NOC UI** enables easy location monitoring of multi-location clusters through an intuitive UI. | ||
|
There was a problem hiding this comment. 🚫 [vale] reported by reviewdog 🐶 |
||
|
|
||
| | **Parameters ** | **Default Value** | **Type** | **Description** | **Required/Optional** | | ||
| |---------------------|---------------|---------|------------------------------------------------------|--------------------| | ||
| | `enabled` | `false` | Boolean | Specifies if UI is enabled or not | Optional | | ||
| | `mapBoxAccessToken` | `""` | String | Access token for MapBox API. | Optional | | ||
rahulhazra97 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| | `mapBoxStyledLayerID`| `""` | String | ID for MapBox style layer. | Optional | | ||
rahulhazra97 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ```yaml | ||
| ui-system: | ||
| ui: | ||
| nocUI: | ||
| enable: false | ||
| mapBoxAccessToken: "" | ||
| mapBoxStyledLayerID: "" | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The default values column is inconsistent. Some start as capitalized, others use code tickets. We can't have all these inconsistencies. Also, some of the default values with
""have double quotes that are curved. This comes from a copy and paste action. Let's fix these double quotes to look correct.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed it.