EC Install Validate Flag #3176

karl-cardenas-coding · 2024-06-27T22:45:48Z

Describe the Change

This PR documents the new --validate flag to the Palette CLI's ec install command.

Changed Pages

💻 Add Preview URL for Page

Jira Tickets

🎫 PLT-1267

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.
Release content

github-actions · 2024-06-27T22:47:18Z

🤖 Netlify configured to enable preview build for branch: ec_install_validate . Subsequent commits will automatically trigger a Netlify build preview.

netlify · 2024-06-27T23:13:35Z

✅ Deploy Preview for docs-spectrocloud ready!

Name	Link
🔨 Latest commit	`7f2c5d1`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-spectrocloud/deploys/667ee1c46b59ee00087c0689
😎 Deploy Preview	https://deploy-preview-3176--docs-spectrocloud.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

github-actions · 2024-06-27T23:23:55Z

docs/docs-content/enterprise-version/install-palette/install-on-vmware/install.md

-If you are installing Palette in an airgap environment, ensure you complete all the airgap pre-install steps before
-proceeding with the installation. Refer to the
-[VMware vSphere Airgap Instructions](../install-on-vmware//airgap-install/vmware-vsphere-airgap-instructions.md) guide
+We recommend using the `--validate` flag with the `ec install` command to validate the installation. Check out the


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

github-actions · 2024-06-27T23:23:56Z

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

@@ -16,6 +16,14 @@ Palette VerteX will be deployed.

 ## Prerequisites

+:::tip
+
+We recommend using the `--validate` flag with the `ec install` command to validate the installation. Check out the


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

github-actions · 2024-06-27T23:23:56Z

docs/docs-content/automation/palette-cli/commands/ec.md

+- The required vSphere permissions and privileges are available for the provided user.
+- At least five IP addresses are available in the provided IP range.
+- Ensure vSphere tags for Kubernetes regions and zones are available.
+- The provided vSphere Datacenter is accessible and has the required compute resources available.


🚫 [vale] _{reported by reviewdog 🐶}
[Vale.Spelling] Did you really mean 'Datacenter'?

github-actions · 2024-06-27T23:23:56Z

docs/docs-content/automation/palette-cli/commands/ec.md

+Watching validation results, waiting for all to succeed
+Using kubeconfig from validator configuration file: /home/ubuntu/.palette/ec/ec-20240627215351/kind-cluster.kubeconfig
+
+Validation result for validator-plugin-vsphere-rules updated:


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

github-actions · 2024-06-27T23:23:56Z

docs/docs-content/automation/palette-cli/commands/ec.md

+
+Watching for updates to validation results for [validator-plugin-network-rules]...
+
+Validation result for validator-plugin-network-rules updated:


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

docs/docs-content/automation/palette-cli/commands/ec.md

ahmad-ibra · 2024-06-28T00:28:05Z

docs/docs-content/automation/palette-cli/commands/ec.md

+## Validate Environment
+
+You can use the `--validate` flag to scan the environment and conduct validation before the Enterprise Cluster is
+installed. The validation uses the open-source project [Validator](https://github.com/validator-labs/validator) to check


❤️ love the shoutout and link to the validator project

ahmad-ibra

LGTM! 🚀

addetz

Small comments.

addetz · 2024-06-28T15:48:29Z

docs/docs-content/automation/palette-cli/commands/ec.md

 | `-o`       | `--config-only`        | Generate configuration file only. This command will not proceed with installation.                                                                                                                                           | boolean |
 | `-v`       | `--custom-values-file` | Enterprise Cluster custom values.yaml configuration file (optional). Use this to customize the cluster profile of the Enterprise Cluster. Refer to the [custom value file](#custom-value-file) section for more information. | string  |
 | `-p`       | `--update-passwords`   | Update passwords only. Do not proceed with installation. The `--config-file` flag must also be provided.                                                                                                                     | string  |
+| `-t`       | `--update-tokens`      | Update authentication tokens only. Do not proceed with installation. The `--config-file` flag must be provided.                                                                                                              | boolean |
+| -          | `--validate`           | Scan the environment and conduct validation before the enterprise cluster is installed.                                                                                                                                      | boolean |


I think this means that there is no shorthand flag right? I wonder if we should leave this empty instead.

docs/docs-content/automation/palette-cli/commands/ec.md

addetz · 2024-06-28T15:59:07Z

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

@@ -16,6 +16,14 @@ Palette VerteX will be deployed.

 ## Prerequisites

+:::tip


Same suggestion as previous about removing this tip and making the mention further down a tip instead.

addetz · 2024-06-28T16:00:43Z

docs/docs-content/enterprise-version/install-palette/install-on-vmware/install.md

@@ -15,11 +15,10 @@ Refer to [Access Palette](../../enterprise-version.md#access-palette) for instru

 ## Prerequisites

-:::warning
+:::tip


I wonder if we should remove this and make the mention of the validate further down the page a tip instead, as the same info is now repeated.

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>

* fix: release patch * docs: PLT-1267 EC Install Validate Flag (#3176) * docs: PEM-5236 Updated Screenshots (#3182) * docs: PEM-5236 * chore: more tenant images updated * chore: more images * chore: more images * chore: more images * chore: fixed all SSO guides * chore: Fix a broken link (#3183) * Optimised images with calibre/image-actions * Optimised images with calibre/image-actions * Apply suggestions from code review Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com> --------- Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com> Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com> Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com> * docs: PCP-3015 (#3190) * docs: PCP-3015 * chore: removed br * docs: palette 4.4.a API docs (#3245) Co-authored-by: Karl Cardenas <karl@spectrocloud.com> * docs: add edge management api 44a (#3234) Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com> Co-authored-by: Karl Cardenas <karl@spectrocloud.com> * Steps for deleting the incorrectly created `kubernetes` LB and public IP (#3252) * chore: Fix markup and alignment in the Troubleshooting section * docs: Document the steps for deleting the incorrectly created LB * docs: Fix a typo * docs: Apply comments from the peer review * chore: Fix a typo that Vale caught * Document the `fullyPrivateAddressing` property and its limitations for Azure (#3258) * docs: Document the property for Azure * docs: Document the limitations for Azure * chore: Fix link format * docs: Small edits to the topic * docs: Implement peer review * docs: edge host grid view (#3286) * docs: document edge host grid view * docs: add png * docs: add webp * docs: add docs for grid view * Update edge-host-view.md * Optimised images with calibre/image-actions * docs: add page to index pages * minor edit * Apply suggestions from code review Co-authored-by: caroldelwing <carolina.delwing@spectrocloud.com> * docs: make format --------- Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com> Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com> Co-authored-by: caroldelwing <carolina.delwing@spectrocloud.com> * docs: update OSS licenses OPS-4804 (#3327) * docs: edge mgmt APIs exposed to connected clusters. (#3235) * docs: document list of apis unavailable to connected clusters * docs: add another endpoint * minor edit * Apply suggestions from code review Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com> --------- Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com> Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com> * docs: PEM-5064 (#3212) * docs: PEM-5064 * draft * docs: test * docs: added draft * chore: fix broken page issue * docs: added warning * Apply suggestions from code review Co-authored-by: caroldelwing <carolina.delwing@spectrocloud.com> * chore: fix prettier * chore: fixed partials --------- Co-authored-by: caroldelwing <carolina.delwing@spectrocloud.com> * docs: change screenshot for Edge filter (#3329) * docs: document edge host grid view * docs: add png * docs: add webp * docs: add docs for grid view * Update edge-host-view.md * Optimised images with calibre/image-actions * docs: add page to index pages * minor edit * Apply suggestions from code review Co-authored-by: caroldelwing <carolina.delwing@spectrocloud.com> * docs: make format * docs: crop screenshot * docs: change to webp * docs: rename image * Optimised images with calibre/image-actions * Optimised images with calibre/image-actions * docs: fix font awesome change --------- Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com> Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com> Co-authored-by: caroldelwing <carolina.delwing@spectrocloud.com> * docs: add parameter about preventing password change in local ui (#3243) * docs: add parameter for diabling pw change * docs: document password change through API * docs: delete dangling sentence * docs: minor edits * Update docs/docs-content/clusters/edge/local-ui/host-management/access-console.md Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com> * docs: make format * docs: fix font awesome * docs: cross linking * docs: add cross link * docs: add cloud config * docs: remove unrelated changes * docs: long form commands * docs: address review comments --------- Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com> Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com> * docs: Update prereqs for the `fullyPrivateAddressing` parameter (#3339) * docs: Update prereqs for the parameter * chore: Trigger build * docs: document new process for customizing local ui and custom links (#3205) * docs: address breaking change for local ui content * Update docs/docs-content/clusters/edge/local-ui/host-management/custom-link.md * docs: add font awesome * docs: minor edit * docs: remove breanking change from release notes * Apply suggestions from code review Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com> * docs: address review comments --------- Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com> Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com> * docs: DOC-1269 PLT-1298 Release Notes 4.4.a (#3320) * docs: DOC-1269 * docs: more notes * docs: more content * docs: added more content * docs: updated release notes * docs: update release notes * docs: vale feedback * docs: added VerteX section * docs: update edge section * docs: minor updates * docs: apply suggestions from code review Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com> * docs: updated release notes * doc: PLT-1298 --------- Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com> Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com> * docs: document signed content (#3251) * docs: draft for signed content * docs: fix broken link * docs: add crosslink * docs: add minor clarifications * Update docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/signed-content.md * docs: address review comments * docs: add note about signed content --------- Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com> * Document the steps for using custom CA (#3338) * docs: Document the steps for using custom CA * chore: Trigger build * Optimised images with calibre/image-actions * chore: Fix image format * docs: Add a note about HTTPS and TLS to the custom CA topic --------- Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com> * Convert the HTTPS/TLS admonition to a bullet (#3346) * docs: Convert admonitions to bullets in prerequisites * docs: Update wording * Document the step for removing kind images after EC and PCG installation (#3337) * docs: Document the step for removing kind * chore: Trigger build * docs: Add the guidance for PCG deployments * docs: PCP-3244 * docs: fixed date * docs: fixed broken url * docs: PCP-3141 (#3378) * docs: PCP-3141 * docs: added guides * chore: fix release note * docs: updated release notes * docs: vale feedback * docs: added tip about proxy and Palette support * docs: minor updates * Apply suggestions from code review Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com> * chore: fix prettier * chore: completed feedback suggestions --------- Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com> * docs: PEM-5375 (#3397) * docs: PEM-5375 * docs: vale feedback * docs: update release number * Update Palette CLI Binaries URLs (#3437) * docs: update palette cli binaries URL * docs: update spectro cli download URLs * docs: update spectro registry docker image * docs: rearrange Palette CLI rows so that the latest version comes first * docs: update self-hosted upgrade paths * docs: DOC-1312 (#3438) * docs: DOC-1312 * docs: azure update * Apply suggestions from code review Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com> --------- Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com> * docs: added spectro proxy --------- Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com> Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com> Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com> Co-authored-by: Ravikumar Kondepati <ravikum12@gmail.com> Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com> Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com> Co-authored-by: caroldelwing <carolina.delwing@spectrocloud.com>

* fix: release patch * docs: PLT-1267 EC Install Validate Flag (#3176) * docs: PEM-5236 Updated Screenshots (#3182) * docs: PEM-5236 * chore: more tenant images updated * chore: more images * chore: more images * chore: more images * chore: fixed all SSO guides * chore: Fix a broken link (#3183) * Optimised images with calibre/image-actions * Optimised images with calibre/image-actions * Apply suggestions from code review --------- * docs: PCP-3015 (#3190) * docs: PCP-3015 * chore: removed br * docs: palette 4.4.a API docs (#3245) * docs: add edge management api 44a (#3234) * Steps for deleting the incorrectly created `kubernetes` LB and public IP (#3252) * chore: Fix markup and alignment in the Troubleshooting section * docs: Document the steps for deleting the incorrectly created LB * docs: Fix a typo * docs: Apply comments from the peer review * chore: Fix a typo that Vale caught * Document the `fullyPrivateAddressing` property and its limitations for Azure (#3258) * docs: Document the property for Azure * docs: Document the limitations for Azure * chore: Fix link format * docs: Small edits to the topic * docs: Implement peer review * docs: edge host grid view (#3286) * docs: document edge host grid view * docs: add png * docs: add webp * docs: add docs for grid view * Update edge-host-view.md * Optimised images with calibre/image-actions * docs: add page to index pages * minor edit * Apply suggestions from code review * docs: make format --------- * docs: update OSS licenses OPS-4804 (#3327) * docs: edge mgmt APIs exposed to connected clusters. (#3235) * docs: document list of apis unavailable to connected clusters * docs: add another endpoint * minor edit * Apply suggestions from code review --------- * docs: PEM-5064 (#3212) * docs: PEM-5064 * draft * docs: test * docs: added draft * chore: fix broken page issue * docs: added warning * Apply suggestions from code review * chore: fix prettier * chore: fixed partials --------- * docs: change screenshot for Edge filter (#3329) * docs: document edge host grid view * docs: add png * docs: add webp * docs: add docs for grid view * Update edge-host-view.md * Optimised images with calibre/image-actions * docs: add page to index pages * minor edit * Apply suggestions from code review * docs: make format * docs: crop screenshot * docs: change to webp * docs: rename image * Optimised images with calibre/image-actions * Optimised images with calibre/image-actions * docs: fix font awesome change --------- * docs: add parameter about preventing password change in local ui (#3243) * docs: add parameter for diabling pw change * docs: document password change through API * docs: delete dangling sentence * docs: minor edits * Update docs/docs-content/clusters/edge/local-ui/host-management/access-console.md * docs: make format * docs: fix font awesome * docs: cross linking * docs: add cross link * docs: add cloud config * docs: remove unrelated changes * docs: long form commands * docs: address review comments --------- * docs: Update prereqs for the `fullyPrivateAddressing` parameter (#3339) * docs: Update prereqs for the parameter * chore: Trigger build * docs: document new process for customizing local ui and custom links (#3205) * docs: address breaking change for local ui content * Update docs/docs-content/clusters/edge/local-ui/host-management/custom-link.md * docs: add font awesome * docs: minor edit * docs: remove breanking change from release notes * Apply suggestions from code review * docs: address review comments --------- * docs: DOC-1269 PLT-1298 Release Notes 4.4.a (#3320) * docs: DOC-1269 * docs: more notes * docs: more content * docs: added more content * docs: updated release notes * docs: update release notes * docs: vale feedback * docs: added VerteX section * docs: update edge section * docs: minor updates * docs: apply suggestions from code review * docs: updated release notes * doc: PLT-1298 --------- * docs: document signed content (#3251) * docs: draft for signed content * docs: fix broken link * docs: add crosslink * docs: add minor clarifications * Update docs/docs-content/clusters/edge/edgeforge-workflow/palette-canvos/signed-content.md * docs: address review comments * docs: add note about signed content --------- * Document the steps for using custom CA (#3338) * docs: Document the steps for using custom CA * chore: Trigger build * Optimised images with calibre/image-actions * chore: Fix image format * docs: Add a note about HTTPS and TLS to the custom CA topic --------- * Convert the HTTPS/TLS admonition to a bullet (#3346) * docs: Convert admonitions to bullets in prerequisites * docs: Update wording * Document the step for removing kind images after EC and PCG installation (#3337) * docs: Document the step for removing kind * chore: Trigger build * docs: Add the guidance for PCG deployments * docs: PCP-3244 * docs: fixed date * docs: fixed broken url * docs: PCP-3141 (#3378) * docs: PCP-3141 * docs: added guides * chore: fix release note * docs: updated release notes * docs: vale feedback * docs: added tip about proxy and Palette support * docs: minor updates * Apply suggestions from code review * chore: fix prettier * chore: completed feedback suggestions --------- * docs: PEM-5375 (#3397) * docs: PEM-5375 * docs: vale feedback * docs: update release number * Update Palette CLI Binaries URLs (#3437) * docs: update palette cli binaries URL * docs: update spectro cli download URLs * docs: update spectro registry docker image * docs: rearrange Palette CLI rows so that the latest version comes first * docs: update self-hosted upgrade paths * docs: DOC-1312 (#3438) * docs: DOC-1312 * docs: azure update * Apply suggestions from code review --------- * docs: added spectro proxy --------- Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com> Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com> Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com> Co-authored-by: Ravikumar Kondepati <ravikum12@gmail.com> Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com> Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com> Co-authored-by: caroldelwing <carolina.delwing@spectrocloud.com>

yuliiiah and others added 3 commits June 16, 2024 07:29

feat: Splitting off a release branch for 4.5.x

49a14e4

Merge branch 'master' into release-4-5

5d7484a

docs: PLT-1267

9a308c3

karl-cardenas-coding added the 4.5 label Jun 27, 2024

chore: fix command flag note

a40021d

karl-cardenas-coding changed the base branch from release-4-5 to release-4-4-a June 27, 2024 22:53

karl-cardenas-coding added 4.4.a and removed 4.5 labels Jun 27, 2024

docs: added tip to help the reader

46d272d

karl-cardenas-coding marked this pull request as ready for review June 27, 2024 23:23

karl-cardenas-coding requested a review from a team as a code owner June 27, 2024 23:23

karl-cardenas-coding requested review from yuliiiah, addetz, lennessyy and ahmad-ibra June 27, 2024 23:23

github-actions bot reviewed Jun 27, 2024

View reviewed changes

ahmad-ibra reviewed Jun 28, 2024

View reviewed changes

ahmad-ibra approved these changes Jun 28, 2024

View reviewed changes

addetz approved these changes Jun 28, 2024

View reviewed changes

karl-cardenas-coding and others added 2 commits June 28, 2024 09:04

Apply suggestions from code review

c3cda35

Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>

chore: fixed prettier

7f2c5d1

karl-cardenas-coding merged commit e1c5430 into release-4-4-a Jun 28, 2024
9 checks passed

karl-cardenas-coding deleted the ec_install_validate branch June 28, 2024 16:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

EC Install Validate Flag #3176

EC Install Validate Flag #3176

karl-cardenas-coding commented Jun 27, 2024 •

edited

Loading

github-actions bot commented Jun 27, 2024

netlify bot commented Jun 27, 2024 •

edited

Loading

github-actions bot Jun 27, 2024

github-actions bot Jun 27, 2024

github-actions bot Jun 27, 2024

github-actions bot Jun 27, 2024

github-actions bot Jun 27, 2024

ahmad-ibra Jun 28, 2024 •

edited

Loading

ahmad-ibra left a comment

addetz left a comment

addetz Jun 28, 2024

addetz Jun 28, 2024

addetz Jun 28, 2024


		Watching for updates to validation results for [validator-plugin-network-rules]...

		Validation result for validator-plugin-network-rules updated:

		@@ -16,6 +16,14 @@ Palette VerteX will be deployed.

		## Prerequisites

		:::tip

EC Install Validate Flag #3176

EC Install Validate Flag #3176

Conversation

karl-cardenas-coding commented Jun 27, 2024 • edited Loading

Describe the Change

Changed Pages

Jira Tickets

Backports

github-actions bot commented Jun 27, 2024

netlify bot commented Jun 27, 2024 • edited Loading

✅ Deploy Preview for docs-spectrocloud ready!

github-actions bot Jun 27, 2024

Choose a reason for hiding this comment

github-actions bot Jun 27, 2024

Choose a reason for hiding this comment

github-actions bot Jun 27, 2024

Choose a reason for hiding this comment

github-actions bot Jun 27, 2024

Choose a reason for hiding this comment

github-actions bot Jun 27, 2024

Choose a reason for hiding this comment

ahmad-ibra Jun 28, 2024 • edited Loading

Choose a reason for hiding this comment

ahmad-ibra left a comment

Choose a reason for hiding this comment

addetz left a comment

Choose a reason for hiding this comment

addetz Jun 28, 2024

Choose a reason for hiding this comment

addetz Jun 28, 2024

Choose a reason for hiding this comment

addetz Jun 28, 2024

Choose a reason for hiding this comment

karl-cardenas-coding commented Jun 27, 2024 •

edited

Loading

netlify bot commented Jun 27, 2024 •

edited

Loading

ahmad-ibra Jun 28, 2024 •

edited

Loading