Skip to content

Commit c892a5c

Browse files
docs: Fix paths and code examples for k8s non-airgap Vertex installation (#9364) (#9391)
* Fix paths and code examples * ci: auto-formatting prettier issues * Minor fix * Fix identations --------- (cherry picked from commit 1d9fb8c) Co-authored-by: svetlana-efimova <[email protected]> Co-authored-by: svetlana-efimova <[email protected]>
1 parent c79eab7 commit c892a5c

File tree

1 file changed

+60
-42
lines changed
  • docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes

1 file changed

+60
-42
lines changed

docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install.md

Lines changed: 60 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -113,13 +113,13 @@ your environment. Reach out to our support team if you need assistance.
113113
our support. Unzip the file to a directory named **vertex-install**.
114114

115115
```shell
116-
unzip release-*.zip -d vertex-install
116+
unzip charts.zip -d vertex-install
117117
```
118118

119-
2. Navigate to the release folder inside the **vertex-install** directory.
119+
2. Navigate to the **vertex-install** directory.
120120

121121
```shell
122-
cd vertex-install/charts/release-*
122+
cd vertex-install
123123
```
124124

125125
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.
137137
NAMESPACE: default
138138
STATUS: deployed
139139
REVISION: 1
140+
DESCRIPTION: Install complete
140141
TEST SUITE: None
141142
```
142143

143-
4. Open the **values.yaml** in the **spectro-mgmt-plane** folder with a text editor of your choice. The **values.yaml**
144-
contains the default values for the VerteX installation parameters. However, you must populate the following
145-
parameters before installing VerteX. You can learn more about the parameters in the **values.yaml** file in the
146-
[Helm Configuration Reference](vertex-helm-ref.md) page.
144+
4. Open the **values.yaml** in the **vertex/spectro-mgmt-plane** folder with a text editor of your choice. The
145+
**values.yaml** contains the default values for the VerteX installation parameters. However, you must populate the
146+
following parameters before installing VerteX. You can learn more about the parameters in the **values.yaml** file
147+
in the [Helm Configuration Reference](vertex-helm-ref.md) page.
147148

148149
| **Parameter** | **Description** | **Type** |
149150
| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
150151
| `env.rootDomain` | The URL name or IP address you will use for the VerteX installation. | string |
151152
| `ociPackRegistry` or `ociPackEcrRegistry` | The OCI registry credentials for VerteX FIPS packs. These credentials are provided by our support team. | object |
152153
| `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 |
153-
| `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 |
154+
| `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 |
154155

155156
:::info
156157

@@ -201,6 +202,7 @@ your environment. Reach out to our support team if you need assistance.
201202
202203
config:
203204
installationMode: "connected" #values can be connected or airgap.
205+
isPaletteBaseCluster: false
204206
205207
# SSO SAML Configuration (Optional for self-hosted type)
206208
sso:
@@ -288,8 +290,8 @@ your environment. Reach out to our support team if you need assistance.
288290
# Replace <PLACE_HOLDER_FOR_ENDPOINT> with your actual registry endpoint and <DOCKER_IO_ENDPOINT>, <GCR_IO_ENDPOINT>, <GHCR_IO_ENDPOINT>, <K8S_IO_ENDPOINT>, <REGISTRY_K8S_IO_ENDPOINT>, and <QUAY_IO_ENDPOINT> with the specific endpoint details for each registry.
289291
290292
imageSwapImages:
291-
imageSwapInitImage: "us-docker.pkg.dev/palette-images-fips/palette/thewebroot/imageswap-init:v1.5.3-spectro-4.5.1"
292-
imageSwapImage: "us-docker.pkg.dev/palette-images-fips/palette/thewebroot/imageswap:v1.5.3-spectro-4.5.1"
293+
imageSwapInitImage: "us-docker.pkg.dev/palette-images-fips/third-party/thewebroot/imageswap-init:v1.5.3-spectro-4.8.a-v2"
294+
imageSwapImage: "us-docker.pkg.dev/palette-images-fips/third-party/thewebroot/imageswap:v1.5.3-spectro-4.8.a-v2"
293295
294296
imageSwapConfig:
295297
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.
313315
serverCrtBase64: ""
314316
serverKeyBase64: ""
315317
insecureSkipVerify: false
316-
318+
tunnel:
319+
preferredServer:
320+
endpoint: ""
321+
servers:
322+
- endpoint: ""
317323
ingress:
324+
msgbroker:
325+
proxyBodySize: "15m" # Default proxy body size for msgbroker ingress
318326
# When enabled nginx ingress controller would be installed
319327
enabled: true
320328
@@ -336,6 +344,7 @@ your environment. Reach out to our support team if you need assistance.
336344
# service.beta.kubernetes.io/aws-load-balancer-backend-protocol: tcp
337345
# service.beta.kubernetes.io/aws-load-balancer-ssl-cert: <ACM_ARN>
338346
# service.beta.kubernetes.io/aws-load-balancer-ssl-ports: "https"
347+
# service.beta.kubernetes.io/aws-load-balancer-proxy-protocol: '*'
339348
340349
# Azure example
341350
# 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.
408417
cpuLimit: "2000m"
409418
memoryLimit: "4Gi"
410419
pvcSize: "20Gi"
411-
storageClass: "" # leave empty to use the default storage class
420+
storageClass: "" # leave empty to use the default storage class
412421
413422
config:
414423
installationMode: "connected" #values can be connected or airgap.
424+
isPaletteBaseCluster: false
415425
416426
# SSO SAML Configuration (Optional for self-hosted type)
417427
sso:
@@ -448,13 +458,13 @@ your environment. Reach out to our support team if you need assistance.
448458
cluster:
449459
stableEndpointAccess: false
450460
451-
# registry:
452-
# endpoint: "" #<Contact Spectro Cloud Sales for More info>
453-
# name: "" #<Contact Spectro Cloud Sales for More info>
454-
# password: "" #<Contact Spectro Cloud Sales for More info>
455-
# username: "" #<Contact Spectro Cloud Sales for More info>
456-
# insecureSkipVerify: false
457-
# caCert: ""
461+
# registry:
462+
# endpoint: "" #<Contact Spectro Cloud Sales for More info>
463+
# name: "" #<Contact Spectro Cloud Sales for More info>
464+
# password: "" #<Contact Spectro Cloud Sales for More info>
465+
# username: "" #<Contact Spectro Cloud Sales for More info>
466+
# insecureSkipVerify: false
467+
# caCert: ""
458468
459469
ociPackRegistry:
460470
endpoint: "example.harbor.org" #<Contact Spectro Cloud Sales for More info>
@@ -465,15 +475,15 @@ your environment. Reach out to our support team if you need assistance.
465475
insecureSkipVerify: false
466476
caCert: ""
467477
468-
# ociPackEcrRegistry:
469-
# endpoint: "" #<Contact Spectro Cloud Sales for More info>
470-
# name: "" #<Contact Spectro Cloud Sales for More info>
471-
# accessKey: "" #<Contact Spectro Cloud Sales for More info>
472-
# secretKey: "" #<Contact Spectro Cloud Sales for More info>
473-
# baseContentPath: "" #<Contact Spectro Cloud Sales for More info>
474-
# isPrivate: true
475-
# insecureSkipVerify: false
476-
# caCert: ""
478+
# ociPackEcrRegistry:
479+
# endpoint: "" #<Contact Spectro Cloud Sales for More info>
480+
# name: "" #<Contact Spectro Cloud Sales for More info>
481+
# accessKey: "" #<Contact Spectro Cloud Sales for More info>
482+
# secretKey: "" #<Contact Spectro Cloud Sales for More info>
483+
# baseContentPath: "" #<Contact Spectro Cloud Sales for More info>
484+
# isPrivate: true
485+
# insecureSkipVerify: false
486+
# caCert: ""
477487
478488
ociImageRegistry:
479489
endpoint: "example.harbor.org" #<Contact Spectro Cloud Sales for More info>
@@ -485,22 +495,22 @@ your environment. Reach out to our support team if you need assistance.
485495
caCert: ""
486496
mirrorRegistries: "" # See instructions below.
487497
488-
# Instruction for mirrorRegistries.
489-
# ----------------------------------
490-
# Please provide the registry endpoint for the following registries, separated by double colons (::):
491-
# docker.io
492-
# gcr.io
493-
# ghcr.io
494-
# k8s.gcr.io
495-
# registry.k8s.io
496-
# quay.io
497-
# For each registry, follow this example format:
498-
# docker.io::<PLACE_HOLDER_FOR_ENDPOINT>/v2/<DOCKER_IO_ENDPOINT>,gcr.io::<PLACE_HOLDER_FOR_ENDPOINT>/v2/<GCR_IO_ENDPOINT>,ghcr.io::<PLACE_HOLDER_FOR_ENDPOINT>/v2/<GHCR_IO_ENDPOINT>,k8s.gcr.io::<PLACE_HOLDER_FOR_ENDPOINT>/v2/<K8S_IO_ENDPOINT>,registry.k8s.io::<PLACE_HOLDER_FOR_ENDPOINT>/v2/<REGISTRY_K8S_IO_ENDPOINT>,quay.io::<PLACE_HOLDER_FOR_ENDPOINT>/v2/<QUAY_IO_ENDPOINT>,us-docker.pkg.dev::<PLACE_HOLDER_FOR_ENDPOINT>/v2/<US_DOCKER_ENDPOINT>
499-
# Replace <PLACE_HOLDER_FOR_ENDPOINT> with your actual registry endpoint and <DOCKER_IO_ENDPOINT>, <GCR_IO_ENDPOINT>, <GHCR_IO_ENDPOINT>, <K8S_IO_ENDPOINT>, <REGISTRY_K8S_IO_ENDPOINT>, and <QUAY_IO_ENDPOINT> with the specific endpoint details for each registry.
498+
# Instruction for mirrorRegistries.
499+
# ----------------------------------
500+
# Please provide the registry endpoint for the following registries, separated by double colons (::):
501+
# docker.io
502+
# gcr.io
503+
# ghcr.io
504+
# k8s.gcr.io
505+
# registry.k8s.io
506+
# quay.io
507+
# For each registry, follow this example format:
508+
# docker.io::<PLACE_HOLDER_FOR_ENDPOINT>/v2/<DOCKER_IO_ENDPOINT>,gcr.io::<PLACE_HOLDER_FOR_ENDPOINT>/v2/<GCR_IO_ENDPOINT>,ghcr.io::<PLACE_HOLDER_FOR_ENDPOINT>/v2/<GHCR_IO_ENDPOINT>,k8s.gcr.io::<PLACE_HOLDER_FOR_ENDPOINT>/v2/<K8S_IO_ENDPOINT>,registry.k8s.io::<PLACE_HOLDER_FOR_ENDPOINT>/v2/<REGISTRY_K8S_IO_ENDPOINT>,quay.io::<PLACE_HOLDER_FOR_ENDPOINT>/v2/<QUAY_IO_ENDPOINT>,us-docker.pkg.dev::<PLACE_HOLDER_FOR_ENDPOINT>/v2/<US_DOCKER_ENDPOINT>
509+
# Replace <PLACE_HOLDER_FOR_ENDPOINT> with your actual registry endpoint and <DOCKER_IO_ENDPOINT>, <GCR_IO_ENDPOINT>, <GHCR_IO_ENDPOINT>, <K8S_IO_ENDPOINT>, <REGISTRY_K8S_IO_ENDPOINT>, and <QUAY_IO_ENDPOINT> with the specific endpoint details for each registry.
500510
501511
imageSwapImages:
502-
imageSwapInitImage: "us-docker.pkg.dev/palette-images-fips/palette/thewebroot/imageswap-init:v1.5.3-spectro-4.5.1"
503-
imageSwapImage: "us-docker.pkg.dev/palette-images-fips/palette/thewebroot/imageswap:v1.5.3-spectro-4.5.1"
512+
imageSwapInitImage: "us-docker.pkg.dev/palette-images-fips/third-party/thewebroot/imageswap-init:v1.5.3-spectro-4.8.a-v2"
513+
imageSwapImage: "us-docker.pkg.dev/palette-images-fips/third-party/thewebroot/imageswap:v1.5.3-spectro-4.8.a-v2"
504514
505515
imageSwapConfig:
506516
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.
525535
serverKeyBase64: ""
526536
insecureSkipVerify: false
527537
538+
tunnel:
539+
preferredServer:
540+
endpoint: ""
541+
servers:
542+
- endpoint: ""
528543
ingress:
544+
msgbroker:
545+
proxyBodySize: "15m" # Default proxy body size for msgbroker ingress
529546
# When enabled nginx ingress controller would be installed
530547
enabled: true
531548
@@ -547,6 +564,7 @@ your environment. Reach out to our support team if you need assistance.
547564
# service.beta.kubernetes.io/aws-load-balancer-backend-protocol: tcp
548565
# service.beta.kubernetes.io/aws-load-balancer-ssl-cert: <ACM_ARN>
549566
# service.beta.kubernetes.io/aws-load-balancer-ssl-ports: "https"
567+
# service.beta.kubernetes.io/aws-load-balancer-proxy-protocol: '*'
550568
551569
# Azure example
552570
# service.beta.kubernetes.io/azure-load-balancer-internal: "true"

0 commit comments

Comments
 (0)