Skip to content

Commit

Permalink
docs: Self hosted updates (#4987) (#5028)
Browse files Browse the repository at this point in the history
* docs: small self-hosted fixes

* docs: more updates

---------

Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>
(cherry picked from commit b20097e)

Co-authored-by: caroldelwing <carolina.delwing@spectrocloud.com>
  • Loading branch information
1 parent 9a013cf commit cff4702
Show file tree
Hide file tree
Showing 8 changed files with 30 additions and 38 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ prerequisite listed is required for a successful installation.

- An x86 Linux jumpbox or bastion host with connectivity to the target platform where you are installing Palette.

- 30 GB of disk space available for the airgap setup binary and temporary files. The uncompressed airgap content is
- 120 GB of disk space available for the airgap setup binary and temporary files. The uncompressed airgap content is
approximately 20 GB.

- An OCI registry such as [Harbor](https://goharbor.io/) or [AWS ECR](https://aws.amazon.com/ecr/) to store Palette
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,8 @@ The default container runtime for OVAs is [Podman](https://podman.io/), not Dock
3. Right-click on your cluster or resource group and select **Deploy OVF Template**.

4. In the **Deploy OVF Template** wizard, enter the following URL to import the Operating System (OS) and Kubernetes
distribution OVA required for the installation.
distribution OVA required for the installation. Contact your support representative to learn if the version of
Palette you are installing requires a new OS and Kubernetes OVA.

Consider the following example for reference.

Expand Down
27 changes: 12 additions & 15 deletions docs/docs-content/enterprise-version/upgrade/upgrade-k8s/airgap.md
Original file line number Diff line number Diff line change
Expand Up @@ -281,30 +281,27 @@ Palette upgrade.
```

11. In a code editor of your choice, open the **extras/cert-manager/values.yaml** file and replace the
`controllerImage`, `webhookImage`, and `amceResolverImage` image URLs with your OCI image registry URLs.
`cainjectorImage`,`controllerImage`, `webhookImage`, and `amceResolverImage` image URLs and with your OCI image
registry URL and the `/spectro-images/` namespace.

```yaml
```yaml {2-5}
image:
cainjectorImage: "gcr.io/spectro-images-public/release-fips/jetstack/cert-manager-cainjector:spectro-v1.11.0-20230427"
// highlight-start
controllerImage: "<your-oci-registry-url>/spectro-images-public/release-fips/jetstack/cert-manager-controller:spectro-v1.11.0-20230427"
webhookImage: "<your-oci-registry-url>/spectro-images-public/release-fips/jetstack/cert-manager-webhook:spectro-v1.11.0-20230808"
amceResolverImage: "<your-oci-registry-url>/spectro-images-public/release-fips/jetstack/cert-manager-acmesolver:spectro-v1.11.0-20230427"
// highlight-end
cainjectorImage: "<your-oci-registry-url>/spectro-images/gcr.io/spectro-images-public/release-fips/jetstack/cert-manager-cainjector:spectro-v1.11.0-20230427"
controllerImage: "<your-oci-registry-url>/spectro-images/gcr.io/spectro-images-public/release-fips/jetstack/cert-manager-controller:spectro-v1.11.0-20230427"
webhookImage: "<your-oci-registry-url>/spectro-images/gcr.io/spectro-images-public/release-fips/jetstack/cert-manager-webhook:spectro-v1.11.0-20230808"
amceResolverImage: "<your-oci-registry-url>/spectro-images/gcr.io/spectro-images-public/release-fips/jetstack/cert-manager-acmesolver:spectro-v1.11.0-20230427"
featureGates: "AdditionalCertificateOutputFormats=true"
```

Consider the following example for reference.

```yaml
```yaml {2-5}
image:
cainjectorImage: "gcr.io/spectro-images-public/release-fips/jetstack/cert-manager-cainjector:spectro-v1.11.0-20230427"
// highlight-start
controllerImage: "harbor.docs.spectro.dev/spectro-images-public/release-fips/jetstack/cert-manager-controller:spectro-v1.11.0-20230427"
webhookImage: "harbor.docs.spectro.dev/spectro-images-public/release-fips/jetstack/cert-manager-webhook:spectro-v1.11.0-20230808"
amceResolverImage: "harbor.docs.spectro.dev/spectro-images-public/release-fips/jetstack/cert-manager-acmesolver:spectro-v1.11.0-20230427"
// highlight-end
cainjectorImage: "harbor.docs.spectro.dev/spectro-images/gcr.io/spectro-images-public/release-fips/jetstack/cert-manager-cainjector:spectro-v1.11.0-20230427"
controllerImage: "harbor.docs.spectro.dev/spectro-images/gcr.io/spectro-images-public/release-fips/jetstack/cert-manager-controller:spectro-v1.11.0-20230427"
webhookImage: "harbor.docs.spectro.dev/spectro-images/gcr.io/spectro-images-public/release-fips/jetstack/cert-manager-webhook:spectro-v1.11.0-20230808"
amceResolverImage: "harbor.docs.spectro.dev/spectro-images/gcr.io/spectro-images-public/release-fips/jetstack/cert-manager-acmesolver:spectro-v1.11.0-20230427"
featureGates: "AdditionalCertificateOutputFormats=true"
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,6 @@ steps one through four. Otherwise, start at step five.
[Deploy an OVF or OVA Template](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-AFEDC48B-C96F-4088-9C1F-4F0A30E965DE.html)
guide for more information on deploying OVAs in vCenter.

:::tip

5. In your terminal, use the following command template to SSH into the Palette airgap support VM. Enter the path to
your private SSH key, your username, and the IP or domain of the airgap support VM. The default username is `ubuntu`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Each prerequisite is required for a successful installation.

- An x86 Linux jumpbox or bastion host with connectivity to the target platform where you are installing VerteX.

- 30 GB of disk space available for the airgap setup binary and temporary files. The airgap content uncompressed is
- 120 GB of disk space available for the airgap setup binary and temporary files. The airgap content uncompressed is
approximately 20 GB.

- An OCI registry such as [Harbor](https://goharbor.io/) or [AWS ECR](https://aws.amazon.com/ecr/) to store VerteX
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,8 @@ The default container runtime for OVAs is [Podman](https://podman.io/), not Dock
3. Right-click on your cluster or resource group and select **Deploy OVF Template**.

4. In the **Deploy OVF Template** wizard, enter the following URL to import the Operating System (OS) and Kubernetes
distribution OVA required for the installation.
distribution OVA required for the installation. Contact your support representative to learn if the version of
VerteX you are installing requires a new OS and Kubernetes OVA.

Consider the following example for reference.

Expand Down
27 changes: 12 additions & 15 deletions docs/docs-content/vertex/upgrade/upgrade-k8s/airgap.md
Original file line number Diff line number Diff line change
Expand Up @@ -283,30 +283,27 @@ Palette VerteX upgrade.
```

11. In a code editor of your choice, open the **extras/cert-manager/values.yaml** file and replace the
`controllerImage`, `webhookImage`, and `amceResolverImage` image URLs with your OCI image registry URLs.
`cainjectorImage`,`controllerImage`, `webhookImage`, and `amceResolverImage` image URLs and with your OCI image
registry URL and the `/spectro-images/` namespace.

```yaml
```yaml {2-5}
image:
cainjectorImage: "gcr.io/spectro-images-public/release-fips/jetstack/cert-manager-cainjector:spectro-v1.11.0-20230427"
// highlight-start
controllerImage: "<your-oci-registry-url>/spectro-images-public/release-fips/jetstack/cert-manager-controller:spectro-v1.11.0-20230427"
webhookImage: "<your-oci-registry-url>/spectro-images-public/release-fips/jetstack/cert-manager-webhook:spectro-v1.11.0-20230808"
amceResolverImage: "<your-oci-registry-url>/spectro-images-public/release-fips/jetstack/cert-manager-acmesolver:spectro-v1.11.0-20230427"
// highlight-end
cainjectorImage: "<your-oci-registry-url>/spectro-images/gcr.io/spectro-images-public/release-fips/jetstack/cert-manager-cainjector:spectro-v1.11.0-20230427"
controllerImage: "<your-oci-registry-url>/spectro-images/gcr.io/spectro-images-public/release-fips/jetstack/cert-manager-controller:spectro-v1.11.0-20230427"
webhookImage: "<your-oci-registry-url>/spectro-images/gcr.io/spectro-images-public/release-fips/jetstack/cert-manager-webhook:spectro-v1.11.0-20230808"
amceResolverImage: "<your-oci-registry-url>/spectro-images/gcr.io/spectro-images-public/release-fips/jetstack/cert-manager-acmesolver:spectro-v1.11.0-20230427"
featureGates: "AdditionalCertificateOutputFormats=true"
```

Consider the following example for reference.

```yaml
```yaml {2-5}
image:
cainjectorImage: "gcr.io/spectro-images-public/release-fips/jetstack/cert-manager-cainjector:spectro-v1.11.0-20230427"
// highlight-start
controllerImage: "harbor.docs.spectro.dev/spectro-images-public/release-fips/jetstack/cert-manager-controller:spectro-v1.11.0-20230427"
webhookImage: "harbor.docs.spectro.dev/spectro-images-public/release-fips/jetstack/cert-manager-webhook:spectro-v1.11.0-20230808"
amceResolverImage: "harbor.docs.spectro.dev/spectro-images-public/release-fips/jetstack/cert-manager-acmesolver:spectro-v1.11.0-20230427"
// highlight-end
cainjectorImage: "harbor.docs.spectro.dev/spectro-images/gcr.io/spectro-images-public/release-fips/jetstack/cert-manager-cainjector:spectro-v1.11.0-20230427"
controllerImage: "harbor.docs.spectro.dev/spectro-images/gcr.io/spectro-images-public/release-fips/jetstack/cert-manager-controller:spectro-v1.11.0-20230427"
webhookImage: "harbor.docs.spectro.dev/spectro-images/gcr.io/spectro-images-public/release-fips/jetstack/cert-manager-webhook:spectro-v1.11.0-20230808"
amceResolverImage: "harbor.docs.spectro.dev/spectro-images/gcr.io/spectro-images-public/release-fips/jetstack/cert-manager-acmesolver:spectro-v1.11.0-20230427"
featureGates: "AdditionalCertificateOutputFormats=true"
```
Expand Down
2 changes: 0 additions & 2 deletions docs/docs-content/vertex/upgrade/upgrade-vmware/airgap.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,6 @@ one through four. Otherwise, start at step five.
[Deploy an OVF or OVA Template](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-AFEDC48B-C96F-4088-9C1F-4F0A30E965DE.html)
guide for more information on deploying OVAs in vCenter.

:::tip

5. In your terminal, use the following command template to SSH into the Palette VerteX airgap support VM. Enter the path
to your private SSH key, your username, and the IP or domain of the airgap support VM. The default username is
`ubuntu`.
Expand Down

0 comments on commit cff4702

Please sign in to comment.