From de2808d165d4550c7d68ea640e9858bc5aff0c6a Mon Sep 17 00:00:00 2001 From: "vault-token-factory-spectrocloud[bot]" <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com> Date: Sat, 21 Dec 2024 00:40:44 +0000 Subject: [PATCH] docs: DOC-1531 (#5121) (#5151) * Initial commit for PVC data allocation requirement for external DBs * docs: update to the install guides * docs: clarify csi req --------- Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com> Co-authored-by: Karl Cardenas (cherry picked from commit 56647804e8e6cfb8f01f262096e13631677f5797) Co-authored-by: Amanda Churi Filanowski --- .../install-on-kubernetes/airgap-install/install.md | 9 ++++----- .../install-palette/install-on-kubernetes/install.md | 9 ++++----- .../install-on-kubernetes/airgap-install/install.md | 9 ++++----- .../install-on-kubernetes/install.md | 9 ++++----- 4 files changed, 16 insertions(+), 20 deletions(-) diff --git a/docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/airgap-install/install.md b/docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/airgap-install/install.md index 2fce2f8fc5..d425a0fd71 100644 --- a/docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/airgap-install/install.md +++ b/docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/airgap-install/install.md @@ -42,10 +42,10 @@ Complete the [Environment Setup](./kubernetes-airgap-instructions.md) steps befo configuration to be installed as part of the installation process. If Cert Manager is already installed, you must uninstall it before installing Palette. -- The Kubernetes cluster must have a Container Storage Interface (CSI) installed and configured. Palette requires a CSI - to store persistent data. You may install any CSI that is compatible with your Kubernetes cluster. +- Palette requires a Container Storage Interface (CSI) to create Persistest Volume, which is used to store persistent + data. You may install any CSI that is compatible with your Kubernetes cluster. -- If you are using MongoDB Atlas, or a self-hosted MongoDB instance, ensure the MongoDB database has a user named +- If you are using a _self-hosted MongoDB_ instance, such as MongoDB Atlas, ensure the MongoDB database has a user named `hubble` with the permission `readWriteAnyDatabase`. Refer to the [Add a Database User](https://www.mongodb.com/docs/guides/atlas/db-user/) guide for guidance on how to create a database user in Atlas. @@ -57,8 +57,7 @@ Complete the [Environment Setup](./kubernetes-airgap-instructions.md) steps befo - 16 GB Memory per node. - - 100 GB Disk Space per node. - - A Container Storage Interface (CSI) for persistent data. + - 110 GB Disk Space per node. - A minimum of three worker nodes or three untainted control plane nodes. 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 0364d73b58..97f654086c 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 @@ -31,10 +31,10 @@ You can use the Palette Helm Chart to install Palette in a multi-node Kubernetes configuration to be installed as part of the installation process. If Cert Manager is already installed, you must uninstall it before installing Palette. -- The Kubernetes cluster must have a Container Storage Interface (CSI) installed and configured. Palette requires a CSI - to store persistent data. You may install any CSI that is compatible with your Kubernetes cluster. +- Palette requires a Container Storage Interface (CSI) to create Persistest Volume, which is used to store persistent + data. You may install any CSI that is compatible with your Kubernetes cluster. -- If you are using MongoDB Atlas, or a self-hosted MongoDB instance, ensure the MongoDB database has a user named +- If you are using a _self-hosted MongoDB_ instance, such as MongoDB Atlas, ensure the MongoDB database has a user named `hubble` with the permission `readWriteAnyDatabase`. Refer to the [Add a Database User](https://www.mongodb.com/docs/guides/atlas/db-user/) guide for guidance on how to create a database user in Atlas. @@ -46,8 +46,7 @@ You can use the Palette Helm Chart to install Palette in a multi-node Kubernetes - 16 GB Memory per node. - - 100 GB Disk Space per node. - - A Container Storage Interface (CSI) for persistent data. + - 110 GB Disk Space per node. - A minimum of three worker nodes or three untainted control plane nodes. diff --git a/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md b/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md index a0a56906aa..b8735983da 100644 --- a/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md +++ b/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md @@ -42,10 +42,10 @@ Complete the [Environment Setup](./kubernetes-airgap-instructions.md) steps befo configuration to be installed as part of the installation process. If Cert Manager is already installed, you must uninstall it before installing VerteX. -- The Kubernetes cluster must have a Container Storage Interface (CSI) installed and configured. VerteX requires a CSI - to store persistent data. You may install any CSI that is compatible with your Kubernetes cluster. +- Palette requires a Container Storage Interface (CSI) to create Persistest Volume, which is used to store persistent + data. You may install any CSI that is compatible with your Kubernetes cluster. -- If you are using MongoDB Atlas, or a self-hosted MongoDB instance ,ensure the MongoDB database has a user named +- If you are using a _self-hosted MongoDB_ instance, such as MongoDB Atlas, ensure the MongoDB database has a user named `hubble` with the permission `readWriteAnyDatabase`. Refer to the [Add a Database User](https://www.mongodb.com/docs/guides/atlas/db-user/) guide for guidance on how to create a database user in Atlas. @@ -58,8 +58,7 @@ Complete the [Environment Setup](./kubernetes-airgap-instructions.md) steps befo - 16 GB Memory per node. - - 100 GB Disk Space per node. - - A Container Storage Interface (CSI) for persistent data. + - 110 GB Disk Space per node. - A minimum of three worker nodes or three untainted control plane nodes. 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 c3aac32825..339c35fa6d 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 @@ -36,10 +36,10 @@ has the necessary network connectivity for VerteX to operate successfully. configuration to be installed as part of the installation process. If Cert Manager is already installed, you must uninstall it before installing VerteX. -- The Kubernetes cluster must have a Container Storage Interface (CSI) installed and configured. VerteX requires a CSI - to store persistent data. You may install any CSI that is compatible with your Kubernetes cluster. +- Palette requires a Container Storage Interface (CSI) to create Persistest Volume, which is used to store persistent + data. You may install any CSI that is compatible with your Kubernetes cluster. -- If you are using MongoDB Atlas, or a self-hosted MongoDB instance, ensure the MongoDB database has a user named +- If you are using a _self-hosted MongoDB_ instance, such as MongoDB Atlas, ensure the MongoDB database has a user named `hubble` with the permission `readWriteAnyDatabase`. Refer to the [Add a Database User](https://www.mongodb.com/docs/guides/atlas/db-user/) guide for guidance on how to create a database user in Atlas. @@ -51,8 +51,7 @@ has the necessary network connectivity for VerteX to operate successfully. - 16 GB Memory per node. - - 100 GB Disk Space per node. - - A Container Storage Interface (CSI) for persistent data. + - 110 GB Disk Space per node. - A minimum of three worker nodes or three untainted control plane nodes.