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 f4abd813a4..169104357b 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 @@ -113,13 +113,13 @@ your environment. Reach out to our support team if you need assistance. our support. Unzip the file to a directory named **vertex-install**. ```shell - unzip release-*.zip -d vertex-install + unzip charts.zip -d vertex-install ``` -2. Navigate to the release folder inside the **vertex-install** directory. +2. Navigate to the **vertex-install** directory. ```shell - cd vertex-install/charts/release-* + cd vertex-install ``` 3. Install Cert Manager using the following command. Replace the actual file name of the Cert Manager Helm Chart with @@ -137,20 +137,21 @@ your environment. Reach out to our support team if you need assistance. NAMESPACE: default STATUS: deployed REVISION: 1 + DESCRIPTION: Install complete TEST SUITE: None ``` -4. Open the **values.yaml** in the **spectro-mgmt-plane** folder with a text editor of your choice. The **values.yaml** - contains the default values for the VerteX installation parameters. However, you must populate the following - parameters before installing VerteX. You can learn more about the parameters in the **values.yaml** file in the - [Helm Configuration Reference](vertex-helm-ref.md) page. +4. Open the **values.yaml** in the **vertex/spectro-mgmt-plane** folder with a text editor of your choice. The + **values.yaml** contains the default values for the VerteX installation parameters. However, you must populate the + following parameters before installing VerteX. You can learn more about the parameters in the **values.yaml** file + in the [Helm Configuration Reference](vertex-helm-ref.md) page. | **Parameter** | **Description** | **Type** | | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | `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 | | `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 | - | `reach-system` | Set `reach-system.enabled` to `true` and configure the `reach-system.proxySettings` parameters to configure VerteX to use a network proxy in your environment | object | + | `reachSystem` | Set `reach-system.enabled` to `true` and configure the `reach-system.proxySettings` parameters to configure VerteX to use a network proxy in your environment | object | :::info @@ -201,6 +202,7 @@ your environment. Reach out to our support team if you need assistance. config: installationMode: "connected" #values can be connected or airgap. + isPaletteBaseCluster: false # SSO SAML Configuration (Optional for self-hosted type) sso: @@ -288,8 +290,8 @@ your environment. Reach out to our support team if you need assistance. # Replace with your actual registry endpoint and , , , , , and with the specific endpoint details for each registry. imageSwapImages: - imageSwapInitImage: "us-docker.pkg.dev/palette-images-fips/palette/thewebroot/imageswap-init:v1.5.3-spectro-4.5.1" - imageSwapImage: "us-docker.pkg.dev/palette-images-fips/palette/thewebroot/imageswap:v1.5.3-spectro-4.5.1" + imageSwapInitImage: "us-docker.pkg.dev/palette-images-fips/third-party/thewebroot/imageswap-init:v1.5.3-spectro-4.8.a-v2" + imageSwapImage: "us-docker.pkg.dev/palette-images-fips/third-party/thewebroot/imageswap:v1.5.3-spectro-4.8.a-v2" imageSwapConfig: isEKSCluster: true #If the Cluster you are trying to install is EKS cluster set value to true else set to false @@ -313,8 +315,14 @@ your environment. Reach out to our support team if you need assistance. serverCrtBase64: "" serverKeyBase64: "" insecureSkipVerify: false - + tunnel: + preferredServer: + endpoint: "" + servers: + - endpoint: "" ingress: + msgbroker: + proxyBodySize: "15m" # Default proxy body size for msgbroker ingress # When enabled nginx ingress controller would be installed enabled: true @@ -336,6 +344,7 @@ your environment. Reach out to our support team if you need assistance. # service.beta.kubernetes.io/aws-load-balancer-backend-protocol: tcp # service.beta.kubernetes.io/aws-load-balancer-ssl-cert: # service.beta.kubernetes.io/aws-load-balancer-ssl-ports: "https" + # service.beta.kubernetes.io/aws-load-balancer-proxy-protocol: '*' # Azure example # service.beta.kubernetes.io/azure-load-balancer-internal: "true" @@ -408,10 +417,11 @@ your environment. Reach out to our support team if you need assistance. cpuLimit: "2000m" memoryLimit: "4Gi" pvcSize: "20Gi" - storageClass: "" # leave empty to use the default storage class + storageClass: "" # leave empty to use the default storage class config: installationMode: "connected" #values can be connected or airgap. + isPaletteBaseCluster: false # SSO SAML Configuration (Optional for self-hosted type) sso: @@ -448,13 +458,13 @@ your environment. Reach out to our support team if you need assistance. cluster: stableEndpointAccess: false - # registry: - # endpoint: "" # - # name: "" # - # password: "" # - # username: "" # - # insecureSkipVerify: false - # caCert: "" + # registry: + # endpoint: "" # + # name: "" # + # password: "" # + # username: "" # + # insecureSkipVerify: false + # caCert: "" ociPackRegistry: endpoint: "example.harbor.org" # @@ -465,15 +475,15 @@ your environment. Reach out to our support team if you need assistance. insecureSkipVerify: false caCert: "" - # ociPackEcrRegistry: - # endpoint: "" # - # name: "" # - # accessKey: "" # - # secretKey: "" # - # baseContentPath: "" # - # isPrivate: true - # insecureSkipVerify: false - # caCert: "" + # ociPackEcrRegistry: + # endpoint: "" # + # name: "" # + # accessKey: "" # + # secretKey: "" # + # baseContentPath: "" # + # isPrivate: true + # insecureSkipVerify: false + # caCert: "" ociImageRegistry: endpoint: "example.harbor.org" # @@ -485,22 +495,22 @@ your environment. Reach out to our support team if you need assistance. caCert: "" mirrorRegistries: "" # See instructions below. - # Instruction for mirrorRegistries. - # ---------------------------------- - # Please provide the registry endpoint for the following registries, separated by double colons (::): - # docker.io - # gcr.io - # ghcr.io - # k8s.gcr.io - # registry.k8s.io - # quay.io - # For each registry, follow this example format: - # docker.io::/v2/,gcr.io::/v2/,ghcr.io::/v2/,k8s.gcr.io::/v2/,registry.k8s.io::/v2/,quay.io::/v2/,us-docker.pkg.dev::/v2/ - # Replace with your actual registry endpoint and , , , , , and with the specific endpoint details for each registry. + # Instruction for mirrorRegistries. + # ---------------------------------- + # Please provide the registry endpoint for the following registries, separated by double colons (::): + # docker.io + # gcr.io + # ghcr.io + # k8s.gcr.io + # registry.k8s.io + # quay.io + # For each registry, follow this example format: + # docker.io::/v2/,gcr.io::/v2/,ghcr.io::/v2/,k8s.gcr.io::/v2/,registry.k8s.io::/v2/,quay.io::/v2/,us-docker.pkg.dev::/v2/ + # Replace with your actual registry endpoint and , , , , , and with the specific endpoint details for each registry. imageSwapImages: - imageSwapInitImage: "us-docker.pkg.dev/palette-images-fips/palette/thewebroot/imageswap-init:v1.5.3-spectro-4.5.1" - imageSwapImage: "us-docker.pkg.dev/palette-images-fips/palette/thewebroot/imageswap:v1.5.3-spectro-4.5.1" + imageSwapInitImage: "us-docker.pkg.dev/palette-images-fips/third-party/thewebroot/imageswap-init:v1.5.3-spectro-4.8.a-v2" + imageSwapImage: "us-docker.pkg.dev/palette-images-fips/third-party/thewebroot/imageswap:v1.5.3-spectro-4.8.a-v2" imageSwapConfig: isEKSCluster: true #If the Cluster you are trying to install is EKS cluster set value to true else set to false @@ -525,7 +535,14 @@ your environment. Reach out to our support team if you need assistance. serverKeyBase64: "" insecureSkipVerify: false + tunnel: + preferredServer: + endpoint: "" + servers: + - endpoint: "" ingress: + msgbroker: + proxyBodySize: "15m" # Default proxy body size for msgbroker ingress # When enabled nginx ingress controller would be installed enabled: true @@ -547,6 +564,7 @@ your environment. Reach out to our support team if you need assistance. # service.beta.kubernetes.io/aws-load-balancer-backend-protocol: tcp # service.beta.kubernetes.io/aws-load-balancer-ssl-cert: # service.beta.kubernetes.io/aws-load-balancer-ssl-ports: "https" + # service.beta.kubernetes.io/aws-load-balancer-proxy-protocol: '*' # Azure example # service.beta.kubernetes.io/azure-load-balancer-internal: "true"