Skip to content

Commit

Permalink
docsL updates (#1544)
Browse files Browse the repository at this point in the history
* docs: helm updates for DOC-869

* docs: callout fixes

* docs: added KMS related content per feedback

* Apply suggestions from code review

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

---------

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>
(cherry picked from commit ea7e6ac)

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>
  • Loading branch information
github-actions[bot] and karl-cardenas-coding committed Sep 12, 2023
1 parent 94e332f commit 898c6ef
Show file tree
Hide file tree
Showing 5 changed files with 87 additions and 41 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,14 @@ Use the following steps to add an S3 bucket as the backup location using the STS
}
```

* If the S3 bucket is using a customer managed AWS Key Management Service (KMS) key for server-side encryption, ensure the Palette IAM role has the necessary permissions to access the KMS key. Otherwise, Palette will be unable to put objects in the S3 bucket, resulting in backup or restore failure. Check out the [Troubleshooting key access](https://docs.aws.amazon.com/kms/latest/developerguide/policy-evaluation.html) guide to learn more about common KMS issues.

:::tip

Use the IAM Policy Simulator to verify the IAM role has the necessary permissions to access a customer managed KMS key. Refer to the [Testing IAM policies with the IAM policy simulator](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html) guide to learn more.

:::

<br />


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,15 @@ The following sections provide detailed instructions. Select the environment whe
If you skip copying the secret access key, refer to the [Managing access keys for IAM users](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) guide to learn how to create a new access key.


* If the S3 bucket is using a customer managed AWS Key Management Service (KMS) key for server-side encryption, ensure the Palette IAM user has the necessary permissions to access the KMS key. Otherwise, Palette will be unable to put objects in the S3 bucket and result in backup or restore failure. Check out the [Troubleshooting key access](https://docs.aws.amazon.com/kms/latest/developerguide/policy-evaluation.html) guide to learn more about common KMS issues.

:::tip

Use the IAM Policy Simulator to verify the IAM role has the necessary permissions to access a customer managed KMS key. Refer to the [Testing IAM policies with the IAM policy simulator](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html) guide to learn more.

:::



### Add an AWS S3 Bucket

Expand Down
83 changes: 42 additions & 41 deletions docs/docs-content/enterprise-version/air-gap-repo.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,11 +223,11 @@ If you have any questions or concerns, please feel free to contact support@spect
--output airgap-k8s-v3.3.15.bin
```
:::info
:::tip
If you receive a certificate error, use the `-k` or `--insecure` flag.
:::
If you receive a certificate error, use the `-k` or `--insecure` flag.
:::
Assign the proper permissions and start the download script.
Expand Down Expand Up @@ -268,11 +268,12 @@ If you have any questions or concerns, please feel free to contact support@spect
--output airgap-k8s-v3.3.15.bin
```
:::info
If you receive a certificate error, use the `-k` or `--insecure` flag.
:::
:::tip
If you receive a certificate error, use the `-k` or `--insecure` flag.
:::
Assign the proper permissions and start the download script.
Expand Down Expand Up @@ -311,11 +312,11 @@ If you have any questions or concerns, please feel free to contact support@spect
--output airgap-edge-kubeadm.bin
```
:::info
:::tip
If you receive a certificate error, use the `-k` or `--insecure` flag.
:::
If you receive a certificate error, use the `-k` or `--insecure` flag.
:::
Assign the proper permissions and start the download script.
Expand Down Expand Up @@ -365,11 +366,11 @@ If you have any questions or concerns, please feel free to contact support@spect
--output airgap-edge-ubuntu22-k3s.bin
```
:::info
:::tip
If you receive a certificate error, use the `-k` or `--insecure` flag.
:::
If you receive a certificate error, use the `-k` or `--insecure` flag.
:::
Assign the proper permissions and start the download script.
Expand All @@ -394,11 +395,11 @@ If you have any questions or concerns, please feel free to contact support@spect
--output airgap-edge-ubuntu22-rke.bin
```
:::info
:::tip
If you receive a certificate error, use the `-k` or `--insecure` flag.
:::
If you receive a certificate error, use the `-k` or `--insecure` flag.
:::
Assign the proper permissions and start the download script.
Expand All @@ -421,11 +422,11 @@ If you have any questions or concerns, please feel free to contact support@spect
--output airgap-edge-ubuntu22-kubeadm.bin
```
:::info
:::tip
If you receive a certificate error, use the `-k` or `--insecure` flag.
If you receive a certificate error, use the `-k` or `--insecure` flag.
:::
:::
Assign the proper permissions and start the download script.
Expand All @@ -448,11 +449,11 @@ If you have any questions or concerns, please feel free to contact support@spect
--output airgap-edge-ubuntu20-k3s.bin
```
:::info
:::tip
If you receive a certificate error, use the `-k` or `--insecure` flag.
If you receive a certificate error, use the `-k` or `--insecure` flag.
:::
:::
Assign the proper permissions and start the download script.
Expand All @@ -475,11 +476,11 @@ If you have any questions or concerns, please feel free to contact support@spect
--output airgap-edge-ubuntu20-rke.bin
```
:::info
:::tip
If you receive a certificate error, use the `-k` or `--insecure` flag.
If you receive a certificate error, use the `-k` or `--insecure` flag.
:::
:::
Assign the proper permissions and start the download script.
Expand All @@ -503,11 +504,11 @@ If you have any questions or concerns, please feel free to contact support@spect
--output airgap-edge-ubuntu20-kubeadm.bin
```
:::info
:::tip
If you receive a certificate error, use the `-k` or `--insecure` flag.
If you receive a certificate error, use the `-k` or `--insecure` flag.
:::
:::
Assign the proper permissions and start the download script.
Expand All @@ -530,11 +531,11 @@ If you have any questions or concerns, please feel free to contact support@spect
--output airgap-edge-opensuse-k3s.bin
```
:::info
:::tip
If you receive a certificate error, use the `-k` or `--insecure` flag.
If you receive a certificate error, use the `-k` or `--insecure` flag.
:::
:::
Assign the proper permissions and start the download script.
Expand All @@ -557,11 +558,11 @@ If you have any questions or concerns, please feel free to contact support@spect
--output airgap-edge-opensuse-rke.bin
```
:::info
:::tip
If you receive a certificate error, use the `-k` or `--insecure` flag.
If you receive a certificate error, use the `-k` or `--insecure` flag.
:::
:::
Assign the proper permissions and start the download script.
Expand All @@ -584,11 +585,11 @@ If you have any questions or concerns, please feel free to contact support@spect
--output airgap-edge-opensuse-kubeadm.bin
```
:::info
:::tip
If you receive a certificate error, use the `-k` or `--insecure` flag.
If you receive a certificate error, use the `-k` or `--insecure` flag.
:::
:::
Assign the proper permissions and start the download script.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,20 @@ mongo:
Review the following parameters to configure Palette for your environment. The `config` section contains the following subsections:


#### Install Mode

You can install Palette in connected or air-gapped mode. The table lists the parameters to configure the installation mode.

| **Parameters** | **Description** | **Type** | **Default value** |
| --- | --- | --- | --- |
| `installMode` | Specifies the installation mode. Allowed values are `connected` or `airgap`. Set the value to `airgap` when installing in an air-gapped environment. | String | `connected` |

```yaml
config:
installationMode: "connected"
```

#### SSO

You can configure Palette to use Single Sign-On (SSO) for user authentication. Configure the SSO parameters to enable SSO for Palette. You can also configure different SSO providers for each tenant post-install, check out the [SAML & SSO Setup](/user-management/saml-sso) documentation for additional guidance.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,20 @@ mongo:
Review the following parameters to configure Palette VerteX for your environment. The `config` section contains the following subsections:


#### Install Mode

You can install Palette in connected or air-gapped mode. The table lists the parameters to configure the installation mode.

| **Parameters** | **Description** | **Type** | **Default value** |
| --- | --- | --- | --- |
| `installMode` | Specifies the installation mode. Allowed values are `connected` or `airgap`. Set the value to `airgap` when installing in an air-gapped environment. | String | `connected` |

```yaml
config:
installationMode: "connected"
```

### SSO

You can configure Palette VerteX to use Single Sign-On (SSO) for user authentication. Configure the SSO parameters to enable SSO for Palette VerteX. You can also configure different SSO providers for each tenant post-install, check out the [SAML & SSO Setup](/user-management/saml-sso) documentation for additional guidance.
Expand Down

0 comments on commit 898c6ef

Please sign in to comment.