From 7591be58ae4b44daf0d3ce71da49125e8c439b23 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Mon, 30 Oct 2023 09:34:44 -0700 Subject: [PATCH 1/2] docs: added guidance about nginx DOC-902 --- .../install-palette/install-on-kubernetes/install.md | 5 +++-- .../install-palette-vertex/install-on-kubernetes/install.md | 5 +++++ 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/install.md b/docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/install.md index 15fae5a7f8..2915d5647c 100644 --- a/docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/install.md +++ b/docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/install.md @@ -76,7 +76,7 @@ If you are installing an airgap Palette, ensure you complete all the airgap pre- - x509 SSL certificate authority file in base64 format. -- Ensure the OS and Kubernetes cluster you are installing Palette onto is FIPS-compliant. Otherwise, Palette and its operations will not be FIPS-compliant. +- An nginx controller will be installed by default. If you already have an nginx controller deployed in the cluster, you must set the `ingress.enabled` parameter to `false` in the **values.yaml** file. - A custom domain and the ability to update Domain Name System (DNS) records. You will need this to enable HTTPS encryption for Palette. @@ -182,7 +182,7 @@ The following instructions are written agnostic to the Kubernetes distribution y | `env.rootDomain` | The URL name or IP address you will use for the Palette installation. | string | | `ociPackRegistry` or `ociPackEcrRegistry` | The OCI registry credentials for Palette FIPS packs. These credentials are provided by our support team.| object | | `scar` | The Spectro Cloud Artifact Repository (SCAR) credentials for Palette FIPS images. These credentials are provided by our support team. | object | - + | `ingress.enabled`| Whether to install the nginx ingress controller. Set this to `false` if you already have an nginx controller deployed in the cluster. | boolean | Save the **values.yaml** file after you have populated the required parameters mentioned in the table. Expand the following sections to review an example of the **values.yaml** file with the required parameters highlighted. @@ -431,6 +431,7 @@ reach-system: | `ociImageRegistry.mirrorRegistries`| Replace the placeholder string with the respective values of your OCI registry repository that is hosting the images.| | `imageSwapConfig.isEKSCluster` | Set this value to `false` if you are NOT installing Palette on an EKS cluster. | boolean | | `scar` | Specify your HTTP file server values. If your HTTP file server requires credentials ensure the provided values are base64 encoded. Example of the string "admin" in base64 encoding - `YWRtaW4=`. | object | + | `ingress.enabled`| Whether to install the nginx ingress controller. Set this to `false` if you already have an nginx controller deployed in the cluster. | boolean | Save the **values.yaml** file after you have populated the required parameters mentioned in the table. Expand the following sections to review an example of the **values.yaml** file with the required parameters highlighted. diff --git a/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install.md b/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install.md index c2bd8ec01d..3f9d934bb0 100644 --- a/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install.md +++ b/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install.md @@ -79,6 +79,9 @@ If you are installing VerteX in an airgap environment, ensure you complete all t - Ensure the OS and Kubernetes cluster you are installing VerteX onto is FIPS-compliant. Otherwise, VerteX and its operations will not be FIPS-compliant. +- An nginx controller will be installed by default. If you already have an nginx controller deployed in the cluster, you must set the `ingress.enabled` parameter to `false` in the **values.yaml** file. + + - A custom domain and the ability to update Domain Name System (DNS) records. You will need this to enable HTTPS encryption for VerteX. @@ -182,6 +185,7 @@ The following instructions are written agnostic to the Kubernetes distribution y | `env.rootDomain` | The URL name or IP address you will use for the VerteX installation. | string | | `ociPackRegistry` or `ociPackEcrRegistry` | The OCI registry credentials for VerteX FIPS packs. These credentials are provided by our support team.| object | | `scar` | The Spectro Cloud Artifact Repository (SCAR) credentials for VerteX FIPS images. These credentials are provided by our support team. | object | + | `ingress.enabled`| Whether to install the nginx ingress controller. Set this to `false` if you already have an nginx controller deployed in the cluster. | boolean | Save the **values.yaml** file after you have populated the required parameters mentioned in the table. Expand the following sections to review an example of the **values.yaml** file with the required parameters highlighted. @@ -435,6 +439,7 @@ reach-system: | `ociImageRegistry.mirrorRegistries`| Replace the placeholder string with the respective values of your OCI registry repository that is hosting the images.| | `imageSwapConfig.isEKSCluster` | Set this value to `false` if you are NOT installing VerteX on an EKS cluster. | boolean | | `scar` | Specify your HTTP file server values. If your HTTP file server requires credentials ensure the provided values are base64 encoded. Example of the string "admin" in base64 encoding - `YWRtaW4=`. | object | + | `ingress.enabled`| Whether to install the nginx ingress controller. Set this to `false` if you already have an nginx controller deployed in the cluster. | boolean | Save the **values.yaml** file after you have populated the required parameters mentioned in the table. Expand the following sections to review an example of the **values.yaml** file with the required parameters highlighted. From 3b8765ccb06379c25102c45f156feabaedd96758 Mon Sep 17 00:00:00 2001 From: Karl Cardenas Date: Mon, 30 Oct 2023 09:43:09 -0700 Subject: [PATCH 2/2] docs: vale feedback --- .../install-palette/install-on-kubernetes/install.md | 7 +++---- .../install-on-kubernetes/install.md | 7 +++---- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/install.md b/docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/install.md index 2915d5647c..4339a3341e 100644 --- a/docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/install.md +++ b/docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/install.md @@ -76,7 +76,7 @@ If you are installing an airgap Palette, ensure you complete all the airgap pre- - x509 SSL certificate authority file in base64 format. -- An nginx controller will be installed by default. If you already have an nginx controller deployed in the cluster, you must set the `ingress.enabled` parameter to `false` in the **values.yaml** file. +- An Nginx controller will be installed by default. If you already have an Nginx controller deployed in the cluster, you must set the `ingress.enabled` parameter to `false` in the **values.yaml** file. - A custom domain and the ability to update Domain Name System (DNS) records. You will need this to enable HTTPS encryption for Palette. @@ -182,7 +182,7 @@ The following instructions are written agnostic to the Kubernetes distribution y | `env.rootDomain` | The URL name or IP address you will use for the Palette installation. | string | | `ociPackRegistry` or `ociPackEcrRegistry` | The OCI registry credentials for Palette FIPS packs. These credentials are provided by our support team.| object | | `scar` | The Spectro Cloud Artifact Repository (SCAR) credentials for Palette FIPS images. These credentials are provided by our support team. | object | - | `ingress.enabled`| Whether to install the nginx ingress controller. Set this to `false` if you already have an nginx controller deployed in the cluster. | boolean | + | `ingress.enabled`| Whether to install the Nginx ingress controller. Set this to `false` if you already have an Nginx controller deployed in the cluster. | boolean | Save the **values.yaml** file after you have populated the required parameters mentioned in the table. Expand the following sections to review an example of the **values.yaml** file with the required parameters highlighted. @@ -431,8 +431,7 @@ reach-system: | `ociImageRegistry.mirrorRegistries`| Replace the placeholder string with the respective values of your OCI registry repository that is hosting the images.| | `imageSwapConfig.isEKSCluster` | Set this value to `false` if you are NOT installing Palette on an EKS cluster. | boolean | | `scar` | Specify your HTTP file server values. If your HTTP file server requires credentials ensure the provided values are base64 encoded. Example of the string "admin" in base64 encoding - `YWRtaW4=`. | object | - | `ingress.enabled`| Whether to install the nginx ingress controller. Set this to `false` if you already have an nginx controller deployed in the cluster. | boolean | - + | `ingress.enabled`| Whether to install the Nginx ingress controller. Set this to `false` if you already have an Nginx controller deployed in the cluster. | boolean | Save the **values.yaml** file after you have populated the required parameters mentioned in the table. Expand the following sections to review an example of the **values.yaml** file with the required parameters highlighted. diff --git a/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install.md b/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install.md index 3f9d934bb0..2a53fc2658 100644 --- a/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install.md +++ b/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install.md @@ -79,7 +79,7 @@ If you are installing VerteX in an airgap environment, ensure you complete all t - Ensure the OS and Kubernetes cluster you are installing VerteX onto is FIPS-compliant. Otherwise, VerteX and its operations will not be FIPS-compliant. -- An nginx controller will be installed by default. If you already have an nginx controller deployed in the cluster, you must set the `ingress.enabled` parameter to `false` in the **values.yaml** file. +- An Nginx controller will be installed by default. If you already have an Nginx controller deployed in the cluster, you must set the `ingress.enabled` parameter to `false` in the **values.yaml** file. - A custom domain and the ability to update Domain Name System (DNS) records. You will need this to enable HTTPS encryption for VerteX. @@ -185,7 +185,7 @@ The following instructions are written agnostic to the Kubernetes distribution y | `env.rootDomain` | The URL name or IP address you will use for the VerteX installation. | string | | `ociPackRegistry` or `ociPackEcrRegistry` | The OCI registry credentials for VerteX FIPS packs. These credentials are provided by our support team.| object | | `scar` | The Spectro Cloud Artifact Repository (SCAR) credentials for VerteX FIPS images. These credentials are provided by our support team. | object | - | `ingress.enabled`| Whether to install the nginx ingress controller. Set this to `false` if you already have an nginx controller deployed in the cluster. | boolean | + | `ingress.enabled`| Whether to install the Nginx ingress controller. Set this to `false` if you already have an Nginx controller deployed in the cluster. | boolean | Save the **values.yaml** file after you have populated the required parameters mentioned in the table. Expand the following sections to review an example of the **values.yaml** file with the required parameters highlighted. @@ -439,8 +439,7 @@ reach-system: | `ociImageRegistry.mirrorRegistries`| Replace the placeholder string with the respective values of your OCI registry repository that is hosting the images.| | `imageSwapConfig.isEKSCluster` | Set this value to `false` if you are NOT installing VerteX on an EKS cluster. | boolean | | `scar` | Specify your HTTP file server values. If your HTTP file server requires credentials ensure the provided values are base64 encoded. Example of the string "admin" in base64 encoding - `YWRtaW4=`. | object | - | `ingress.enabled`| Whether to install the nginx ingress controller. Set this to `false` if you already have an nginx controller deployed in the cluster. | boolean | - + | `ingress.enabled`| Whether to install the Nginx ingress controller. Set this to `false` if you already have an Nginx controller deployed in the cluster. | boolean | Save the **values.yaml** file after you have populated the required parameters mentioned in the table. Expand the following sections to review an example of the **values.yaml** file with the required parameters highlighted.