Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Airgap helm update #2696

Merged
merged 20 commits into from
Apr 28, 2024
Merged

Airgap helm update #2696

merged 20 commits into from
Apr 28, 2024

Conversation

karl-cardenas-coding
Copy link
Contributor

@karl-cardenas-coding karl-cardenas-coding commented Apr 23, 2024

Describe the Change

This PR modifies the information architecture related to self-hosted Palette and VerteX install.

Changed Pages

💻 Preview URL for Page

Jira Tickets

🎫 DOC-1157

Backports

Can this PR be backported?

  • Yes. Remember to add the relevant backport labels to your PR.
  • No. Please leave a short comment below about why this PR cannot be backported.

Copy link

netlify bot commented Apr 23, 2024

Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit 2de0b94
🔍 Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/662e6c60f6478a0008e3bd79
😎 Deploy Preview https://deploy-preview-2696--docs-spectrocloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@karl-cardenas-coding karl-cardenas-coding added backport-version-4-0 Backport change to version 4.0 auto-backport Enable backport backport-version-4-1 Backport change to version 4.1 backport-version-4-2 Backport change to version 4.2 backport-version-4-3 Backport change to version 4.3 labels Apr 23, 2024
Copy link
Contributor

@yuliiiah yuliiiah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me ✨

@karl-cardenas-coding karl-cardenas-coding marked this pull request as ready for review April 28, 2024 14:26
@karl-cardenas-coding karl-cardenas-coding requested a review from a team as a code owner April 28, 2024 14:26
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

vale

docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/install.md|183 col 127| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/install.md|185 col 87| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/install.md|187 col 155| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/install.md|188 col 130| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/install.md|188 col 182| [Vale.Spelling] Did you really mean 'aurgap'?
docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/install.md|193 col 278| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/install.md|213 col 102| [spectrocloud.acronym] Use title case to define the acronym '(FQDN)'.
docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/install.md|226 col 9| [Vale.Spelling] Did you really mean 'Datacenter'?
docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/install.md|226 col 57| [Vale.Spelling] Did you really mean 'Datacenter'?
docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/install.md|232 col 186| [Vale.Terms] Use 'datastore' instead of 'Datastore'.
docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/install.md|259 col 127| [Vale.Spelling] Did you really mean 'cpu'?
docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/airgap-install/kubernetes-airgap-instructions.md|17 col 16| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/airgap-install/kubernetes-airgap-instructions.md|36 col 89| [Vale.Terms] Use 'we' instead of 'We'.
docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/airgap-install/kubernetes-airgap-instructions.md|48 col 68| [spectrocloud.colon] Use colons only to introduce lists, unless in code blocks or inline code.
docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/airgap-install/kubernetes-airgap-instructions.md|67 col 6| [Vale.Terms] Use 'ORAS' instead of 'Oras'.
docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/airgap-install/kubernetes-airgap-instructions.md|103 col 20| [Vale.Terms] Use 'ORAS' instead of 'oras'.
docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/airgap-install/kubernetes-airgap-instructions.md|270 col 42| [spectrocloud.longform] Avoid using the short form of commands. Replace the short form flag in 'zip -d' with the corresponding long form flag.
docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/airgap-install/kubernetes-airgap-instructions.md|277 col 6| [Vale.Terms] Use 'HTTP' instead of 'http'.
docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/airgap-install/kubernetes-airgap-instructions.md|285 col 5| [spectrocloud.longform] Avoid using the short form of commands. Replace the short form flag in 'python3 -m' with the corresponding long form flag.
docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/airgap-install/kubernetes-airgap-instructions.md|288 col 5| [Vale.Terms] Use 'we' instead of 'We'.
docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/airgap-install/install.md|32 col 74| [Vale.Terms] Use 'we' instead of 'We'.
docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/airgap-install/install.md|46 col 3| [Vale.Terms] Use 'we' instead of 'We'.
docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/airgap-install/install.md|49 col 7| [Vale.Spelling] Did you really mean 'CPUs'?
docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/airgap-install/install.md|66 col 44| [spectrocloud.colon] Use colons only to introduce lists, unless in code blocks or inline code.
docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/airgap-install/install.md|104 col 21| [spectrocloud.longform] Avoid using the short form of commands. Replace the short form flag in 'zip -d' with the corresponding long form flag.
docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/airgap-install/install.md|830 col 6| [spectrocloud.longform] Avoid using the short form of commands. Replace the short form flag in 'grep -E' with the corresponding long form flag.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/install-on-vmware.md|18 col 8| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/install-on-vmware.md|20 col 4| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-palette-vertex.md|20 col 4| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-palette-vertex.md|28 col 164| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/airgap-install.md|63 col 4| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/airgap-install.md|65 col 4| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/install.md|342 col 4| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/airgap/airgap.md|58 col 15| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/airgap/airgap.md|60 col 19| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install-on-kubernetes.md|24 col 136| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install-on-kubernetes.md|28 col 8| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install-on-kubernetes.md|30 col 4| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|23 col 17| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|40 col 3| [Vale.Terms] Use 'we' instead of 'We'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|43 col 7| [Vale.Spelling] Did you really mean 'CPUs'?
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|61 col 48| [spectrocloud.colon] Use colons only to introduce lists, unless in code blocks or inline code.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|78 col 67| [Vale.Terms] Use 'cloud' instead of 'Cloud'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|80 col 81| [Vale.Avoid] Avoid using 'Palette console'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|164 col 5| [Vale.Terms] Use 'cloud' instead of 'Cloud'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|164 col 23| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|197 col 7| [spectrocloud.colon] Use colons only to introduce lists, unless in code blocks or inline code.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|203 col 127| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|205 col 87| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|207 col 155| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|208 col 130| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|208 col 182| [Vale.Spelling] Did you really mean 'aurgap'?
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|213 col 278| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|235 col 102| [spectrocloud.acronym] Use title case to define the acronym '(FQDN)'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|248 col 61| [Vale.Spelling] Did you really mean 'Datacenter'?
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/kubernetes-airgap-instructions.md|108 col 13| [Vale.Terms] Use 'ORAS' instead of 'oras'.
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/kubernetes-airgap-instructions.md|177 col 11| [spectrocloud.colon] Use colons only to introduce lists, unless in code blocks or inline code.
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/kubernetes-airgap-instructions.md|206 col 11| [spectrocloud.colon] Use colons only to introduce lists, unless in code blocks or inline code.
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/airgap-install.md|64 col 4| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md|32 col 73| [Vale.Terms] Use 'we' instead of 'We'.
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md|46 col 3| [Vale.Terms] Use 'we' instead of 'We'.
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md|50 col 7| [Vale.Spelling] Did you really mean 'CPUs'?
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md|67 col 44| [spectrocloud.colon] Use colons only to introduce lists, unless in code blocks or inline code.
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md|104 col 21| [spectrocloud.longform] Avoid using the short form of commands. Replace the short form flag in 'zip -d' with the corresponding long form flag.
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md|229 col 5| [Vale.Repetition] 'VerteX' is repeated!
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md|840 col 6| [spectrocloud.longform] Avoid using the short form of commands. Replace the short form flag in 'grep -E' with the corresponding long form flag.

@@ -14,6 +14,8 @@ Refer to [Access Palette](../../enterprise-version.md#access-palette) for instru

## Resources

- [Install on VMware](install.md)
- [Non-Airgap Install on VMware](install.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'airgap' instead of 'Airgap'.

- [Install on VMware](install.md)
- [Non-Airgap Install on VMware](install.md)

- [Airgap Install](./airgap-install/airgap-install.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'airgap' instead of 'Airgap'.


- [Environment Setup](./vmware-vsphere-airgap-instructions.md)

- [Airgap Install Checklist](./checklist.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'airgap' instead of 'Airgap'.


- [Airgap Install Checklist](./checklist.md)

- [Airgap Install](./airgap-install.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'airgap' instead of 'Airgap'.

@@ -17,13 +17,15 @@ the following modes:
| VMware | Install Palette in VMware environment. | [Install on VMware](install-on-vmware/install.md) |
| Kubernetes | Install Palette using a Helm Chart in an existing Kubernetes cluster. | [Install on Kubernetes](install-on-kubernetes/install.md) |

## Airgap Installation
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'airgap' instead of 'Airgap'.


:::info

Self-hosted Palette installations provide a system Private Cloud Gateway (PCG) out-of-the-box and typically do not
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'cloud' instead of 'Cloud'.


Self-hosted Palette installations provide a system Private Cloud Gateway (PCG) out-of-the-box and typically do not
require a separate, user-installed PCG. However, you can create additional PCGs as needed to support provisioning into
remote data centers that do not have a direct incoming connection from the Palette console. To learn how to install a
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Avoid] Avoid using 'Palette console'.

:::info

If you are using the Palette CLI from inside an airgap support VM, the CLI will automatically detect the airgap
environment and prompt you to **Use local, air-gapped Spectro Cloud Artifact Repository (SCAR) configuration**. Type
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'cloud' instead of 'Cloud'.

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

vale

docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/airgap-install.md|63 col 4| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/airgap-install.md|65 col 4| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/install.md|342 col 4| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/airgap/airgap.md|58 col 15| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/airgap/airgap.md|60 col 19| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|23 col 17| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|40 col 3| [Vale.Terms] Use 'we' instead of 'We'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|43 col 7| [Vale.Spelling] Did you really mean 'CPUs'?
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|61 col 48| [spectrocloud.colon] Use colons only to introduce lists, unless in code blocks or inline code.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|78 col 67| [Vale.Terms] Use 'cloud' instead of 'Cloud'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|80 col 81| [Vale.Avoid] Avoid using 'Palette console'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|164 col 5| [Vale.Terms] Use 'cloud' instead of 'Cloud'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|164 col 23| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|197 col 7| [spectrocloud.colon] Use colons only to introduce lists, unless in code blocks or inline code.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|203 col 127| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|205 col 87| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|207 col 155| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|208 col 130| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|208 col 182| [Vale.Spelling] Did you really mean 'aurgap'?
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|213 col 278| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|235 col 102| [spectrocloud.acronym] Use title case to define the acronym '(FQDN)'.
docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/install.md|248 col 61| [Vale.Spelling] Did you really mean 'Datacenter'?
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install-on-kubernetes.md|24 col 136| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install-on-kubernetes.md|28 col 8| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install-on-kubernetes.md|30 col 4| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/kubernetes-airgap-instructions.md|108 col 13| [Vale.Terms] Use 'ORAS' instead of 'oras'.
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/kubernetes-airgap-instructions.md|177 col 11| [spectrocloud.colon] Use colons only to introduce lists, unless in code blocks or inline code.
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/kubernetes-airgap-instructions.md|206 col 11| [spectrocloud.colon] Use colons only to introduce lists, unless in code blocks or inline code.
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/airgap-install.md|64 col 4| [Vale.Terms] Use 'airgap' instead of 'Airgap'.
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md|32 col 73| [Vale.Terms] Use 'we' instead of 'We'.
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md|46 col 3| [Vale.Terms] Use 'we' instead of 'We'.
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md|50 col 7| [Vale.Spelling] Did you really mean 'CPUs'?
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md|67 col 44| [spectrocloud.colon] Use colons only to introduce lists, unless in code blocks or inline code.
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md|104 col 21| [spectrocloud.longform] Avoid using the short form of commands. Replace the short form flag in 'zip -d' with the corresponding long form flag.
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md|229 col 5| [Vale.Repetition] 'VerteX' is repeated!
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md|840 col 6| [spectrocloud.longform] Avoid using the short form of commands. Replace the short form flag in 'grep -E' with the corresponding long form flag.


| **Parameter** | **Description** |
| ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Registry Type** | Specify the type of registry. Allowed values are `OCI` or `OCI ECR`. Airgap users, select `OCI`. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'airgap' instead of 'Airgap'.

| ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Registry Type** | Specify the type of registry. Allowed values are `OCI` or `OCI ECR`. Airgap users, select `OCI`. |
| **Registry Name** | Enter the name of the registry. |
| **Registry Endpoint** | Enter the registry endpoint. Airgap users, provide the **Spectro Cloud Repository** URL or hostname shared by the airgap setup script. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'airgap' instead of 'Airgap'.

| **Registry Name** | Enter the name of the registry. |
| **Registry Endpoint** | Enter the registry endpoint. Airgap users, provide the **Spectro Cloud Repository** URL or hostname shared by the airgap setup script. |
| **Registry Base Path** | Enter the registry base path. |
| **Allow Insecure Connection** | Bypasses x509 verification. Type `n` to specify a certificate authority in the follow-up prompt. Airgap user, ensure you select `n`. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'airgap' instead of 'Airgap'.

| **Registry Endpoint** | Enter the registry endpoint. Airgap users, provide the **Spectro Cloud Repository** URL or hostname shared by the airgap setup script. |
| **Registry Base Path** | Enter the registry base path. |
| **Allow Insecure Connection** | Bypasses x509 verification. Type `n` to specify a certificate authority in the follow-up prompt. Airgap user, ensure you select `n`. |
| **Registry CA certificate filepath** | Specify the file path to the certificate authority. Use absolute paths. Airgap users, provide the filepath displayed by the aurgap setup script. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'airgap' instead of 'Airgap'.

| **Registry Endpoint** | Enter the registry endpoint. Airgap users, provide the **Spectro Cloud Repository** URL or hostname shared by the airgap setup script. |
| **Registry Base Path** | Enter the registry base path. |
| **Allow Insecure Connection** | Bypasses x509 verification. Type `n` to specify a certificate authority in the follow-up prompt. Airgap user, ensure you select `n`. |
| **Registry CA certificate filepath** | Specify the file path to the certificate authority. Use absolute paths. Airgap users, provide the filepath displayed by the aurgap setup script. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'aurgap'?


```shell
kubectl get pods --all-namespaces --output custom-columns="NAMESPACE:metadata.namespace,NAME:metadata.name,STATUS:status.phase" \
| grep -E '^(cp-system|hubble-system|ingress-nginx|jet-system|ui-system)\s'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[spectrocloud.longform] Avoid using the short form of commands. Replace the short form flag in 'grep -E' with the corresponding long form flag.

@@ -15,6 +15,8 @@ repository access.

## Resources

- [Install on VMware](install.md)
- [Non-Airgap Install on VMware](install.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'airgap' instead of 'Airgap'.

- [Install on VMware](install.md)
- [Non-Airgap Install on VMware](install.md)

- [Airgap Installation](./airgap-install/airgap-install.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'airgap' instead of 'Airgap'.

@@ -17,13 +17,15 @@ VerteX is available in the following modes:
| VMware | Install Palette VerteX in VMware environment. | [Install on VMware](./install-on-vmware/install.md) |
| Kubernetes | Install Palette VerteX using a Helm Chart in an existing Kubernetes cluster. | [Install on Kubernetes](./install-on-kubernetes/install.md) |

## Airgap Installation
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'airgap' instead of 'Airgap'.

| VMware | Install Palette VerteX in VMware environment using your own OCI registry server. |
| Kubernetes | Install Palette VerteX using a Helm Chart in an existing Kubernetes cluster with your own OCI registry server OR use AWS ECR. |
| Kubernetes | Install Palette VerteX using a Helm Chart in an existing Kubernetes cluster with your own OCI registry server OR use AWS ECR. | [Airgap Install](./install-on-kubernetes/airgap-install/airgap-install.md) |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'airgap' instead of 'Airgap'.

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

vale

docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md|46 col 3| [Vale.Terms] Use 'we' instead of 'We'.
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md|50 col 7| [Vale.Spelling] Did you really mean 'CPUs'?
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md|67 col 44| [spectrocloud.colon] Use colons only to introduce lists, unless in code blocks or inline code.
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md|104 col 21| [spectrocloud.longform] Avoid using the short form of commands. Replace the short form flag in 'zip -d' with the corresponding long form flag.
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md|229 col 5| [Vale.Repetition] 'VerteX' is repeated!
docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md|840 col 6| [spectrocloud.longform] Avoid using the short form of commands. Replace the short form flag in 'grep -E' with the corresponding long form flag.


- [Environment Setup](./vmware-vsphere-airgap-instructions.md)

- [Airgap Install Checklist](./checklist.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'airgap' instead of 'Airgap'.


- [Airgap Install Checklist](./checklist.md)

- [Airgap Install](./install.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'airgap' instead of 'Airgap'.

@@ -435,7 +339,7 @@ teams.

## Resources

- [Airgap Instructions](../airgap/vmware-vsphere-airgap-instructions.md)
- [Airgap Instructions](./airgap-install/vmware-vsphere-airgap-instructions.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'airgap' instead of 'Airgap'.

@@ -55,13 +55,11 @@ following diagram outlines the major pre-install steps for an airgap installatio

To get started with an airgap VerteX installation, check out the respective platform guide.

- [Kubernetes Airgap Instructions](kubernetes-airgap-instructions.md)
- [Kubernetes Airgap Instructions](../install-on-kubernetes/airgap-install/airgap-install.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'airgap' instead of 'Airgap'.


- [VMware vSphere Airgap Instructions](vmware-vsphere-airgap-instructions.md)
- [VMware vSphere Airgap Instructions](../install-on-vmware/airgap-install/airgap-install.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'airgap' instead of 'Airgap'.

For the public image repository, use the `docker` CLI instead of using `oras`. Replace the values below with your
environment configuration values.
Use `oras` to log in to your OCI registry. Replace the values below with your environment configuration values.
Check out the [oras login](https://oras.land/docs/commands/oras_login) documentation for information about
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'ORAS' instead of 'oras'.

@@ -175,7 +198,7 @@ OCI registry and restart the upload process.
export OCI_IMAGE_BASE=spectro-images
```

Example
Example:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[spectrocloud.colon] Use colons only to introduce lists, unless in code blocks or inline code.

```

Example
Example:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[spectrocloud.colon] Use colons only to introduce lists, unless in code blocks or inline code.


- [Install VerteX](./install.md)

- [Airgap Installation Checklist](checklist.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'airgap' instead of 'Airgap'.

- [Helm](https://helm.sh/docs/intro/install/) is installed and available.

- Access to the target Kubernetes cluster's kubeconfig file. You must be able to interact with the cluster using
`kubectl` commands and have sufficient permissions to install VerteX. We recommend using a role with `cluster-admin`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'we' instead of 'We'.

@karl-cardenas-coding karl-cardenas-coding enabled auto-merge (squash) April 28, 2024 15:42
@karl-cardenas-coding karl-cardenas-coding merged commit 55d2310 into master Apr 28, 2024
15 checks passed
@karl-cardenas-coding karl-cardenas-coding deleted the airgap-helm-update branch April 28, 2024 15:44
vault-token-factory-spectrocloud bot pushed a commit that referenced this pull request Apr 28, 2024
* chore: split airgap helm install pages

* docs: DOC-1157

* chore: save

* chore: updates

* docs: updated YAML examples

* chore: removed line numbers

* chore: update

* docs: moved k8s palette IA

* docs: moved vmware palette IA

* docs: Peer review

* chore: refactored Palette

* chore: k8s

* chore: refactor complete

* chore: touch-up

* docs: Final review and copy edits

* docs: Add the previous review and copy edits to VerteX

* docs: minor touc-ups

* docs: minor touc-ups

---------

Co-authored-by: yuliiiah <horbenko.yuliya@gmail.com>
(cherry picked from commit 55d2310)
@vault-token-factory-spectrocloud
Copy link
Contributor

💔 Some backports could not be created

Status Branch Result
version-4-0 Backport failed because of merge conflicts
version-4-1 Backport failed because of merge conflicts

You might need to backport the following PRs to version-4-1:
- docs: DOC-1118 Image Conversion to webp (#2439)
version-4-2 Backport failed because of merge conflicts

You might need to backport the following PRs to version-4-2:
- chore: added missing refactor page (#2137)
- replace caution with warning (#2039)
version-4-3

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

backport --pr 2696

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

karl-cardenas-coding added a commit that referenced this pull request Apr 28, 2024
* chore: split airgap helm install pages

* docs: DOC-1157

* chore: save

* chore: updates

* docs: updated YAML examples

* chore: removed line numbers

* chore: update

* docs: moved k8s palette IA

* docs: moved vmware palette IA

* docs: Peer review

* chore: refactored Palette

* chore: k8s

* chore: refactor complete

* chore: touch-up

* docs: Final review and copy edits

* docs: Add the previous review and copy edits to VerteX

* docs: minor touc-ups

* docs: minor touc-ups

---------

Co-authored-by: yuliiiah <horbenko.yuliya@gmail.com>
vault-token-factory-spectrocloud bot added a commit that referenced this pull request Apr 28, 2024
* chore: split airgap helm install pages

* docs: DOC-1157

* chore: save

* chore: updates

* docs: updated YAML examples

* chore: removed line numbers

* chore: update

* docs: moved k8s palette IA

* docs: moved vmware palette IA

* docs: Peer review

* chore: refactored Palette

* chore: k8s

* chore: refactor complete

* chore: touch-up

* docs: Final review and copy edits

* docs: Add the previous review and copy edits to VerteX

* docs: minor touc-ups

* docs: minor touc-ups

---------

Co-authored-by: yuliiiah <horbenko.yuliya@gmail.com>
(cherry picked from commit 55d2310)

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>
karl-cardenas-coding added a commit that referenced this pull request Apr 28, 2024
* chore: split airgap helm install pages

* docs: DOC-1157

* chore: save

* chore: updates

* docs: updated YAML examples

* chore: removed line numbers

* chore: update

* docs: moved k8s palette IA

* docs: moved vmware palette IA

* docs: Peer review

* chore: refactored Palette

* chore: k8s

* chore: refactor complete

* chore: touch-up

* docs: Final review and copy edits

* docs: Add the previous review and copy edits to VerteX

* docs: minor touc-ups

* docs: minor touc-ups

---------

Co-authored-by: yuliiiah <horbenko.yuliya@gmail.com>
karl-cardenas-coding added a commit that referenced this pull request Apr 28, 2024
* chore: split airgap helm install pages

* docs: DOC-1157

* chore: save

* chore: updates

* docs: updated YAML examples

* chore: removed line numbers

* chore: update

* docs: moved k8s palette IA

* docs: moved vmware palette IA

* docs: Peer review

* chore: refactored Palette

* chore: k8s

* chore: refactor complete

* chore: touch-up

* docs: Final review and copy edits

* docs: Add the previous review and copy edits to VerteX

* docs: minor touc-ups

* docs: minor touc-ups

---------

Co-authored-by: yuliiiah <horbenko.yuliya@gmail.com>
karl-cardenas-coding added a commit that referenced this pull request Apr 28, 2024
* chore: split airgap helm install pages

* docs: DOC-1157

* chore: save

* chore: updates

* docs: updated YAML examples

* chore: removed line numbers

* chore: update

* docs: moved k8s palette IA

* docs: moved vmware palette IA

* docs: Peer review

* chore: refactored Palette

* chore: k8s

* chore: refactor complete

* chore: touch-up

* docs: Final review and copy edits

* docs: Add the previous review and copy edits to VerteX

* docs: minor touc-ups

* docs: minor touc-ups

---------

Co-authored-by: yuliiiah <horbenko.yuliya@gmail.com>
karl-cardenas-coding added a commit that referenced this pull request Apr 28, 2024
* chore: split airgap helm install pages

* docs: DOC-1157

* chore: save

* chore: updates

* docs: updated YAML examples

* chore: removed line numbers

* chore: update

* docs: moved k8s palette IA

* docs: moved vmware palette IA

* docs: Peer review

* chore: refactored Palette

* chore: k8s

* chore: refactor complete

* chore: touch-up

* docs: Final review and copy edits

* docs: Add the previous review and copy edits to VerteX

* docs: minor touc-ups

* docs: minor touc-ups

---------

Co-authored-by: yuliiiah <horbenko.yuliya@gmail.com>
karl-cardenas-coding added a commit that referenced this pull request Apr 28, 2024
* chore: split airgap helm install pages

* docs: DOC-1157

* chore: save

* chore: updates

* docs: updated YAML examples

* chore: removed line numbers

* chore: update

* docs: moved k8s palette IA

* docs: moved vmware palette IA

* docs: Peer review

* chore: refactored Palette

* chore: k8s

* chore: refactor complete

* chore: touch-up

* docs: Final review and copy edits

* docs: Add the previous review and copy edits to VerteX

* docs: minor touc-ups

* docs: minor touc-ups

---------

Co-authored-by: yuliiiah <horbenko.yuliya@gmail.com>
@vault-token-factory-spectrocloud
Copy link
Contributor

🎉 This PR is included in version 4.3.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Enable backport backport-version-4-0 Backport change to version 4.0 backport-version-4-1 Backport change to version 4.1 backport-version-4-2 Backport change to version 4.2 backport-version-4-3 Backport change to version 4.3 released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants