Skip to content

Commit

Permalink
docs: adding more Helm context (#1231)
Browse files Browse the repository at this point in the history
* docs: adding more Helm context

* docs: updated helm language

* docs: updated language

* Apply suggestions from code review

Co-authored-by: Tyler Gillson <tyler.gillson@gmail.com>

* save

* save

* Update content/docs/12-enterprise-version/03-deploying-palette-with-helm.md

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

---------

Co-authored-by: Tyler Gillson <tyler.gillson@gmail.com>
Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>
  • Loading branch information
3 people committed Apr 7, 2023
1 parent 08b7113 commit 2fd755d
Showing 1 changed file with 47 additions and 26 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -108,22 +108,10 @@ Choose the installation steps for your target environment. The steps in the gene
kubectl get service ingress-nginx-controller --namespace nginx --output jsonpath='{.status.loadBalancer.ingress[0].hostname}'
```

You now have a self-hosted instance of Palette installed in a Kubernetes cluster.
You now have a self-hosted instance of Palette installed in a Kubernetes cluster. Make sure you retain the **values.yaml** file as you will need it for future upgrades.

<br />

<InfoBox>

To upgrade Palette with a new Helm release, or to modify the values used in the installation, use the following command.

<br />

```shell
helm upgrade palette /path/to/chart.tgz --file /path/to/values.yaml
```

</InfoBox>

</Tabs.TabPane>

<Tabs.TabPane tab="AWS EKS" key="aws-eks">
Expand Down Expand Up @@ -279,22 +267,10 @@ You now have a self-hosted instance of Palette installed in a Kubernetes cluster
kubectl get service ingress-nginx-controller --namespace nginx --output jsonpath='{.status.loadBalancer.ingress[0].hostname}'
```

You now have a self-hosted instance of Palette installed in a Kubernetes cluster.
You now have a self-hosted instance of Palette installed in a Kubernetes cluster. Make sure you retain the **values.yaml** file as you will need it for future upgrades.

<br />

<InfoBox>

To upgrade Palette with a new Helm release, or to modify the values used in the installation, use the following command.

<br />

```shell
helm upgrade palette /path/to/chart.tgz --file /path/to/values.yaml
```

</InfoBox>

</Tabs.TabPane>


Expand All @@ -320,6 +296,51 @@ If you notice that the pods in the `hubble-system` namespace are not initializin

</WarningBox>


# Upgrade Palette



To upgrade Palette with a new Helm release, use the following steps. <br /> <br />

1. Download the new version of the Helm Chart.



2. Extract the new **values.yaml** file from the Helm Chart with the following command:

<br />

```shell
tar xzvf /path/to/chart.tgz spectro-mgmt-plane/values.yaml
```


3. Compare the new **values.yaml** against the original **values.yaml** you used for the initial Palette installation. Address any new parameters added to the values file.




4. Issue the following command to upgrade Palette. Use the same **values.yaml** file you used for the Palette installation.

<br />

```shell
helm upgrade palette /path/to/chart.tgz --file /path/to/orginal_values.yaml
```


## Post-Install Configuration Values

The values you specified in the **values.yaml** file all fall under the parameter section `values.config` and are stored in the `configserver-cm` ConfigMap.

After the installation, if you need to change any configuration values under `values.config` in the **values.yaml** file, you must use the Palette API.
When you use the `helm upgrade` command, internal system configurations stored in the Kubernetes ConfigMap `configserver-cm` will display as updated, but Palette will not apply the new values. Palette only accepts changes to these configuration values if they are submitted via API.

If you find yourself in this scenario, contact our support team by emailing us at support@spectrocloud.com for additional guidance.



# Next Steps

Start exploring the Palette system dashboard so that you become familiar with the available actions you can take as an administrator. Check out the [System Console Dashboard](/enterprise-version/system-console-dashboard) resource to learn more.
Expand Down

0 comments on commit 2fd755d

Please sign in to comment.