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

Palette 4.2 Release #1758

Merged
merged 60 commits into from
Jan 7, 2024
Merged

Palette 4.2 Release #1758

merged 60 commits into from
Jan 7, 2024

Conversation

karl-cardenas-coding
Copy link
Contributor

@karl-cardenas-coding karl-cardenas-coding commented Nov 7, 2023

Describe the Change

This PR contains all the documentation changes for the Palette 4.2 release.

Review Changes

💻 Preview URL

karl-cardenas-coding and others added 5 commits November 8, 2023 14:50
* docs: DOC-900

* docs: added prepres

* docs: added dubg tips table

* docs: more additions to debug table

* chore: rebuild

* docs: mentioned Helm Chart

* docs: vale feedback

* Apply suggestions from code review

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>

---------

Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>
@karl-cardenas-coding karl-cardenas-coding marked this pull request as ready for review November 15, 2023 17:16
@karl-cardenas-coding karl-cardenas-coding requested a review from a team as a code owner November 15, 2023 17:16
karl-cardenas-coding and others added 4 commits November 16, 2023 15:30
* docs: added maas PEM-3973

* ci: added missing variables
* docs: update Platform Settings page PEM-3979

This patch updates the Platform Settings page:
- Renames "Pause Platform Upgrades
- Introduces tabs for easier navigation
- Updates the page style to match the docs style guide

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>

* docs: fix capitalisation of admin PEM-3979

* docs: move info box to intro of cluster remediation

* docs: change info box to caution on auto remediation page PEM-3979

---------

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>
* add note about hostname validation

* docs: add character restrition for prefix

* docs: update prefix description

* docs: address review comments

* docs: change example

* Update docs/docs-content/clusters/edge/edge-configuration/installer-reference.md

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: Karl Cardenas <karl@spectrocloud.com>
lennessyy and others added 3 commits November 30, 2023 14:01
* docs: add step to configure nic for edge hosts

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: Karl Cardenas <karl@spectrocloud.com>

If certain network information is already available, the corresponding fields will be pre-populated.

11. (Optional) When you assign an Edge host to a node pool, if your Edge host has more than one NIC, you can optionally specify which Network Interface Controller (NIC) the Edge host will use to communicate with the cluster. When you select an Edge host, Palette displays a dropdown of all NICs present on the Edge host.
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 'NICs'?

@@ -142,14 +145,18 @@ To learn more, check out the resource from the etcd documentation titled [Why an
| DNS server | The IP address of the DNS server your cluster uses for domain resolution. |

If certain network information is already available, the corresponding fields will be pre-populated.


9. (Optional) When you assign an Edge host to a node pool, if your Edge host has more than one NIC, you can optionally specify which Network Interface Controller (NIC) the Edge host will use to communicate with the cluster. When you select an Edge host, Palette displays a dropdown of all NICs present on the Edge host.
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 'NICs'?

@@ -26,7 +26,7 @@ The Edge Installer is configured with a set of default values.
| Parameter | Default | Description |
| --- | --- | --- |
| `PaletteEndpoint`| `api.console.spectrocloud.com`| The Palette API endpoint. |
| `Prefix`| `edge`| The default prefix to apply to the unique identifier. |
| `Prefix`| `edge`| The prefix prepended to the edge device hostname to form the unique identifier. |
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 'prepended'?

| `name` | If you do not specify an Edge hostname, the system will generate one from the serial number of the device. If Stylus is unable to identify the serial number, it will generate a random ID instead. In cases where the hardware does not have a serial number, we suggest that you specify a value so there is minimal chance of duplication. Use the value `"$random"` to generate a random ID. You can also use the `DeviceUIDPaths` to read in a value from a system file. |
| `prefix` | The system assigns a prefix value to the device UID generated by the Edge Installer. By default, this value is set to `edge`. |
| `name` | Hostname of the Edge device. A hostname is composed of one label or a series of labels concatenated with dots. For example, `spectro-host` and `host.spectrocloud.com` are both valid host names. The entire hostname, including the delimiting dots, has a maximum of 253 ASCII characters. Each label may contain only the lower-case ASCII letters a through z, the digits 0 through 9, and the hyphen-minus character ('-'), and may contain no more than 63 characters. A hostname must start and end with alphanumeric characters. \
| `prefix` | A prefix prepended to the Edge device hostname to form the Edge device ID. Only alphanumeric characters and the hyphen-minus character are allowed. By default, this value is set to `edge`. |
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 'prepended'?

@karl-cardenas-coding karl-cardenas-coding removed the request for review from ritawatson January 3, 2024 17:44
* docs: adding azure gov PCP-810

* docs: updated Azure steps

* docs: added next steps
karl-cardenas-coding and others added 3 commits January 4, 2024 11:09
* document workarounds for cilium/flannel and calico

* change wording

* add troubleshooting section for edge overlay

* add troubleshooting steps

* add resources section

* vale comments

* fix indentation

* fix wording

* fix reference

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
* docs: release notes

* docs: added updated packs

* docs: updated release date

* docs: added pack's readme statement

* Apply suggestions from code review

Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>

* Apply suggestions from code review

---------

Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>
docs/docs-content/release-notes.md Show resolved Hide resolved
docs/docs-content/release-notes.md Outdated Show resolved Hide resolved
docs/docs-content/release-notes.md Outdated Show resolved Hide resolved
docs/docs-content/release-notes.md Outdated Show resolved Hide resolved
docs/docs-content/release-notes.md Show resolved Hide resolved
docs/docs-content/release-notes.md Show resolved Hide resolved
docs/docs-content/release-notes.md Show resolved Hide resolved
docs/docs-content/release-notes.md Show resolved Hide resolved
docs/docs-content/release-notes.md Show resolved Hide resolved
docs/docs-content/release-notes.md Show resolved Hide resolved
* docs: add note about local registry k8s change

* Update docs/docs-content/clusters/edge/networking/local-registry.md

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: Karl Cardenas <karl@spectrocloud.com>
karl-cardenas-coding and others added 5 commits January 5, 2024 09:42
* docs: PEM-4272

* Optimised images with calibre/image-actions

* docs: added Palette steps

* Optimised images with calibre/image-actions

* docs: removed max 2 limit

* Apply suggestions from code review

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

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Adelina Simion <43963729+addetz@users.noreply.github.com>
* docs: DOC-990

* docs: DOC-990 PE-3357

* docs: draft ready for review

* docs: updated statement

* save

* docs: removed and added new content

* docs: vale feedback

* docs: add known issue

* Apply suggestions from code review

Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>
* docs: open source license

* docs: updated values

* docs: final list
* Create Nutanix file structure

* Add steps to install PCG & add Nutanix cloud acct.

* Add content for create cluster, update profile docs

* Add Nutanix index pg & architecture doc and diagram

* Modify diagram metadata, add cloud acct doc, add tables

* Adjust sidebar placement

* chore: center images and round image corners

* Update register cloud

* Notes and updates based on eng. demo

* Remove a question to myself

* Add workflow

* Draft cluster creation, add varables that user provides values for

* Edits to pcg and add accnt, add workflow diagram

* Update cluster creation

* Move Register doc up in nav pane, edits to Create Cluster doc

* Add info block to profiles sections, and remove "custom".

* Add input from review comments

* Small updates to several files

* Add info to Register - some will move to PCG

* Add setup steps to PCG doc

* Add curl commands, edits to pcg

* Revise Register and infobox for profiles

* Revise workflow to be Nutanix-specific

* Minor changes

* Add next steps

* minor edit

* Optimised images with calibre/image-actions

* Modify label in diagram

* Optimised images with calibre/image-actions

* add diagram

* Optimised images with calibre/image-actions

* Incorporate review comments

* Apply more comments

* docs: addressed review suggestions and added Nutanix to Vale

* docs: fixed broken link

* Incorporate more changes

* docs: addressed suggestions

* Optimised images with calibre/image-actions

* Incorporate review comments

* Incorporate more changes

* Apply suggestions from code review

Co-authored-by: Romain Decker <deckerromain@gmail.com>

* Apply suggestions from code review

Co-authored-by: Romain Decker <deckerromain@gmail.com>

* Incorporated still more review comments

* docs: replace Nutanix architecture diagram

* Optimised images with calibre/image-actions

* Add proofing edits, add updated arch. diagram

* Optimised images with calibre/image-actions

* Fix variable description

* Apply  review comments

* Move Setup section for PCG

* docs: apply suggestions from code review

* docs: added cloud account keys API

* docs: update PCG sectiom, add NUTANIX_PORT

* docs: update arch diagram, add rotate-server-certificate:true

* docs: add new page for PCG cluster

* docs: add curl commands, add input from review

* docs: add sys admin to the glossary

* Optimised images with calibre/image-actions

* docs: fixed broken link

* docs: apply suggestions from code review

* docs: add nutanix-csi pack page

* docs: update arch diagram, review nutanix csi pack page

* Optimised images with calibre/image-actions

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Karl Cardenas <karl@spectrocloud.com>
Co-authored-by: Carolina Delwing Rosa <carolina.delwing@spectrocloud.com>
Co-authored-by: Romain Decker <deckerromain@gmail.com>
* add additional known issues

* address vale comments

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <karl@spectrocloud.com>

* add link to pxk-e

* add admonition for tech preview

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: Karl Cardenas <karl@spectrocloud.com>
Copy link
Contributor

@lennessyy lennessyy left a comment

Choose a reason for hiding this comment

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

🚀

* docs: DOC-993

* docs: known issues

* docs: added last set of known issues

* docs: PPD-1413 vc min resources for k8s

* docs: vale feedback

* docs: feedback from Sumit

* docs: sentence touch-up

* Apply suggestions from code review

Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>

* add known issue to longhorn

---------

Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>
Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
@spectrocloud spectrocloud deleted a comment from netlify bot Jan 6, 2024
@karl-cardenas-coding karl-cardenas-coding merged commit 06fa7c8 into master Jan 7, 2024
11 checks passed
@karl-cardenas-coding karl-cardenas-coding deleted the release-4-2 branch January 7, 2024 07:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants