docs: refactor for self-hosted Palette DOC-465 #1597
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
karl-cardenas-coding
added
documentation
✅ Deploy Preview for docs-spectrocloud ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
This comment was marked as duplicate.
This comment was marked as duplicate.
Sorry, something went wrong.
ritawatson
approved these changes
Sep 28, 2023
docs/docs-content/enterprise-version/system-management/tenant-management.md
Outdated
Show resolved
Hide resolved
docs/docs-content/enterprise-version/system-management/tenant-management.md
Outdated
Show resolved
Hide resolved
docs/docs-content/enterprise-version/system-management/tenant-management.md
Outdated
Show resolved
Hide resolved
docs/docs-content/enterprise-version/system-management/tenant-management.md
Outdated
Show resolved
Hide resolved
docs/docs-content/enterprise-version/system-management/tenant-management.md
Outdated
Show resolved
Hide resolved
docs/docs-content/enterprise-version/system-management/backup-restore.md
Outdated
Show resolved
Hide resolved
docs/docs-content/enterprise-version/system-management/backup-restore.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Rita Watson <[email protected]>
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 34.2%, saving 124.14 KB.
480 images did not require optimisation. |
This comment was marked as duplicate.
This comment was marked as duplicate.
Sorry, something went wrong.
| ### Validate | ||
|
|
||
|
|
||
| 1. Log in to the Palette system console. Refert to the [Access Palette](../enterprise-version.md#access-palette) section for instructions on how to access the Palette system console. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Refert'?
| ## Download Palette Installer | ||
|
|
||
| To request the Palette Self-hosted installer image, please contact our support team by sending an email to [email protected]. Kindly provide the following information in your email: | ||
| To set up a Palette account, contact our support team by sending an email to [email protected]. Include the following information in your email: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[spectrocloud.spectrocloud] Avoid using 'spectrocloud' outside of a URL format. Use 'Spectro Cloud' instead.
| | Storage views | View | | ||
| | Tasks | Create task<br />Update task | | ||
| | vApp | Import<br />View OVF environment<br />Configure vAPP application<br />Configure vApp instance | | ||
| | vSphere tagging | Assign or Unassign vSphere Tag<br />Create vSphere Tag<br />Delete vSphere Tag<br />Edit vSphere Tag | |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Unassign'?
|
|
||
| | **vSphere Object**| **Category** | **Privileges** | | ||
| |-------------------|----------------------|--------------------| | ||
| | Virtual Machines | Change Configuration | Acquire disk lease<br />Add existing disk<br />Add new disk<br />Add or remove device<br />Advanced configuration<br />Change CPU count<br />Change memory<br />Change settings<br />Change swapfile placement<br />Change resource<br />Change host USB device<br />Configure raw device<br />Configure managedBy<br />Display connection settings<br />Extend virtual disk<br />Modify device settings<br />Query fault tolerance compatibity<br />Query unowned files<br />Reload from path<br />Remove disk<br />Rename<br />Reset guest information<br />Set annotation<br />Toggle disk change tracking<br />Toggle fork parent<br />Upgrade VM compatibility| |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'swapfile'?
|
|
||
| ## Root-Level Role Privileges | ||
|
|
||
| Root-level role privileges are only applied to root objects and Data center objects. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'data center' instead of 'Data center'.
| | spectro-templates | Read only | | ||
| | Storage views | View | | ||
| | Tasks | Create task<br />Update task | | ||
| | vApp | Import<br />View OVF environment<br />Configure vAPP applications<br />Configure vApp instances | |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'vApp'?
| | spectro-templates | Read only | | ||
| | Storage views | View | | ||
| | Tasks | Create task<br />Update task | | ||
| | vApp | Import<br />View OVF environment<br />Configure vAPP applications<br />Configure vApp instances | |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'vApp'?
| | Storage views | View | | ||
| | Tasks | Create task<br />Update task | | ||
| | vApp | Import<br />View OVF environment<br />Configure vAPP applications<br />Configure vApp instances | | ||
| | vSphere tagging | Assign or Unassign vSphere Tag<br />Create vSphere Tag<br />Delete vSphere Tag<br />Edit vSphere Tag | |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Unassign'?
|
|
||
| | **vSphere Object**| **Category** | **Privileges** | | ||
| |-------------------|----------------------|--------------------| | ||
| | Virtual Machines | Change Configuration | Acquire disk lease<br />Add existing disk<br />Add new disk<br />Add or remove device<br />Advanced configuration<br />Change CPU count<br />Change memory<br />Change Settings<br />Change Swapfile placement<br />Change resource<br />Change host USB device<br />Configure Raw device<br />Configure managedBy<br />Display connection settings<br />Extend virtual disk<br />Modify device settings<br />Query fault tolerance compatibity<br />Query unowned files<br />Reload from path<br />Remove disk<br />Rename<br />Reset guest information<br />Set annotation<br />Toggle disk change tracking<br />Toggle fork parent<br />Upgrade VM compatibility| |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Swapfile'?
|
|
||
| If you do not clean up the tenant's resources, such as clusters and Private Cloud Gateways (PCGs), the tenant will remain in a **Deleting** state. You can use **Force Cleanup & Delete** to proceed with deletion without manually cleaning up tenant resources. | ||
| If you do not clean up the tenant's resources, such as clusters and Private Cloud Gateways (PCGs), the tenant will remain in a **Deleting** state. You can use **Force Cleanup & Delete** to proceed with deletion without manually cleaning up tenant resources. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'PCGs'?
|
|
||
| ::: | ||
| * A root-level role with access to higher-level vSphere objects. This role is referred to as the *spectro root role*. Check out the [Root-Level Role Privileges](#root-level-role-privileges) table for the list of privileges required for the root-level role. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'Spectro' instead of 'spectro'.
|
|
||
| As listed in the table, apply spectro role privileges to vSphere objects you intend to use for Palette installation. A separate table lists Spectro role privileges for VMs by category. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'Spectro' instead of 'spectro'.
| | **Storage views** | Configure service<br />View | | ||
| | **Tasks** | Create task<br />Update task | | ||
| | **vApp** | Import<br />View OVF environment<br />Configure vAPP applications<br />Configure vApp instances | | ||
| | **vSphere tagging** | Assign or unassign vSphere Tag<br />Create vSphere Tag<br />Delete vSphere Tag<br />Edit vSphere Tag | |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'unassign'?
| | **Storage views** | View | | ||
| | **Tasks** | Create task<br />Update task | | ||
| | **vApp** | Import<br />View OVF environment<br />Configure vAPP applications<br />Configure vApp instances | | ||
| | **vSphere tagging** | Assign or unassign vSphere Tag<br />Create vSphere Tag<br />Delete vSphere Tag<br />Edit vSphere Tag | |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'unassign'?
| <br /> | ||
| The zone tags you assign to your vSphere objects, such as a datacenter and clusters are applied to the Kubernetes nodes you deploy through VerteX into your vSphere environment. Kubernetes clusters deployed to other infrastructure providers, such as public cloud may have other native mechanisms for auto discovery of zones. | ||
|
|
||
| For example, assume a vCenter environment contains three compute clusters, cluster-1, cluster-2, and cluster-3. To support this environment you create the tag categories `k8s-region` and `k8s-zone`. The `k8s-region` is assigned to the datacenter, and the `k8s-zone` tag is assigned to the compute clusters. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Avoid] Avoid using 'datacenter'.
| <br /> | ||
| The zone tags you assign to your vSphere objects, such as a datacenter and clusters are applied to the Kubernetes nodes you deploy through VerteX into your vSphere environment. Kubernetes clusters deployed to other infrastructure providers, such as public cloud may have other native mechanisms for auto discovery of zones. | ||
|
|
||
| For example, assume a vCenter environment contains three compute clusters, cluster-1, cluster-2, and cluster-3. To support this environment you create the tag categories `k8s-region` and `k8s-zone`. The `k8s-region` is assigned to the datacenter, and the `k8s-zone` tag is assigned to the compute clusters. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'datacenter'?
vault-token-factory-spectrocloud bot
pushed a commit
that referenced
this pull request
Oct 5, 2023
* docs: refactor for self-hosted Palette DOC-465 * docs: updated palette content * docs: added VMware install docs * docs: image updates and deprecation * chore: gitleaks and FRPS clean-up * docs: refactor and condensed pages * docs: updated headings * chore: rebased * Apply suggestions from code review Co-authored-by: Rita Watson <[email protected]> * Optimised images with calibre/image-actions * docs: feedback incoporated * docs: minor language touchup * docs: touche dup the system requirements document * docs: fixed bold * docs: updated VerteX permissions page * docs: updated VerteX * chore: addresses DOC-886 * docs: feedback incorporated * docs: fixed a sentence * Apply suggestions from code review Co-authored-by: Rita Watson <[email protected]> * docs: updated vertex page * ci: reverted to the default runner --------- Co-authored-by: Rita Watson <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> (cherry picked from commit 6b4d07a)
💔 Some backports could not be created
Note: Successful backport PRs will be merged automatically after passing CI. Manual backportTo create the backport manually run: Questions ?Please refer to the Backport tool documentation and see the Github Action logs for details |
|
This PR #1646 adds the changes to the 3.4 version branch. |
karl-cardenas-coding
added a commit
that referenced
this pull request
Oct 5, 2023
…1645) * docs: refactor for self-hosted Palette DOC-465 (#1597) * docs: refactor for self-hosted Palette DOC-465 * docs: updated palette content * docs: added VMware install docs * docs: image updates and deprecation * chore: gitleaks and FRPS clean-up * docs: refactor and condensed pages * docs: updated headings * chore: rebased * Apply suggestions from code review Co-authored-by: Rita Watson <[email protected]> * Optimised images with calibre/image-actions * docs: feedback incoporated * docs: minor language touchup * docs: touche dup the system requirements document * docs: fixed bold * docs: updated VerteX permissions page * docs: updated VerteX * chore: addresses DOC-886 * docs: feedback incorporated * docs: fixed a sentence * Apply suggestions from code review Co-authored-by: Rita Watson <[email protected]> * docs: updated vertex page * ci: reverted to the default runner --------- Co-authored-by: Rita Watson <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> (cherry picked from commit 6b4d07a) * chore: gitleaks fix --------- Co-authored-by: Karl Cardenas <[email protected]>
Merged
Merged
2 tasks
This was referenced Apr 15, 2024
2 tasks
2 tasks
2 tasks
2 tasks
2 tasks
2 tasks
1 task
2 tasks
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe the Change
This PR refactors self-hosted Palette instructions to mirror the information architecture of Palette VerteX.
The following pages contain new content:
Review Changes
💻 Preview URL
🎫 DOC-465