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.1 #1652

Merged
merged 25 commits into from
Oct 22, 2023
Merged

Palette 4.1 #1652

merged 25 commits into from
Oct 22, 2023

Conversation

karl-cardenas-coding
Copy link
Contributor

@karl-cardenas-coding karl-cardenas-coding commented Oct 10, 2023

Describe the Change

This PR contains all the Palette 4.1 documentation changes.

Review Changes

💻 Preview URL

🎫 Jira Ticket

@netlify
Copy link

netlify bot commented Oct 10, 2023

Deploy Preview for docs-spectrocloud canceled.

Name Link
🔨 Latest commit 130b41d
🔍 Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/6534bd3fb5c122000894e428

karl-cardenas-coding and others added 22 commits October 16, 2023 11:17
* docs:  updated edge docs PE-2801

* docs: updated the how-to with version 4.0.6

* Apply suggestions from code review

Co-authored-by: Rita Watson <[email protected]>

* Optimised images with calibre/image-actions

* Apply suggestions from code review

---------

Co-authored-by: Rita Watson <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
* docs: maas node tags PCP-1930

* docs: feedback incorporated

* ci: updated CI label

* ci label update
* ci: updated labels (#1661)

* docs: api-key changes

* Refactor/restructure cluster & app profiles sections (#1551)

* Add  index pgs, folders, json files post migration

* Added two index pages

* Added two more index pages

* Added a diagram

* Clarify two sentences.

* Applied new link format

* Added cluster profile-related docs

* Copied byoos files to this branch.

* Build out app profile folder

* Added diagram that removes "Core" label

* Copied cluster doc drafts from google doc

* Copied app profile drafts from google doc

* Added links in top-level cluster profile docs

* Refined wording, formatting, added links in 3 docs

* Updated clone cluster and app docs

* Updated versioning for cluster and app profiles

* Added diagram, refined import/export

* Refined steps in export/import

* Fixed one diagram, added a second diagram

* Added a diagram and refined import/export steps

* Refined byo-os docs, drafted delete howtos

* Add correct permissions for import/export

* Fix URLs and add meta descriptions

* Small fixes

* Refined cluster profiles, focus on cluster update

* Final changes to most cluster docs

* Fine tune app profiles, delete system profiles

* Tune app profiles docs

* Tune app profiles docs

* Edit Update Pack Version

* Touched up cluster profiles

* Touch up app profile docs

* Fix several links pointing to new docs

* Fix links, add missing section to add-on profile

* Add info on reusing same layer twice in profile

* Move cluster bkup and system profiles to deprecated

* Fix four more links pointing to these docs

* Add a heading

* Create two new folders: create, modify clusters

* Move BYOOS to top level, add icon, add content

* Add new doc for dup packs in profile, move byoos up

* Fix some  links due to restructure

* Fix three more links

* Fix last two links

* Add redirects, remove sys profile from glossary

* Restructure App Profiles

* Move docs from devx to App Profiles

* Minor fix

* Restructure App Profiles, tags

* Add sub-structure to Cluster Profiles for Add-ons

* Draft create add-on profs with helm and manifest

* Fix link

* Fix links after restructure

* Revised helm & manifest app profiles docs

* Draft Helm, manifest cluster profiles

* Draft container profile, add images

* Proof edits: infra, add-ons

* Move content to new page, rename file, small fixes

* Move services folder up one level in devx

* Fix links after moving Services up one layer

* Edit export/import, clone, delete, other edits

* Edit clone, delete, output vars app profiles docs

* Edit Create App Profiles docs

* Edit Modify App Profiles docs

* Revise enablement headings

* Review meta descs

* Move app profiles from pde folder to deprecated

* docs: removed deprecated content

* Fix links

* Fix Vale finds

* Optimised images with calibre/image-actions

* Input review comments

---------

Co-authored-by: Karl Cardenas <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* docs: refactored api documentation PEM-3441 PEM-3373

* Apply suggestions from code review

Co-authored-by: Rita Watson <[email protected]>

* Apply suggestions from code review

---------

Co-authored-by: Rita Watson <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
* ci: updated labels (#1661)

* docs: virtual clusters distro PPD-1357

* Optimised images with calibre/image-actions

* docs: vale feedback

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
* docs: 4-1 release notes DOC-891

* docs: added vertex notes

* chore: fixed broken link

* docs: more release notes

* docs: added content for PEM-3771

* docs: added packs

* docs: latest changes

* docs: ready for review DOC-891
* Included new CVE's

* Changes related to headings - Resolution/Patches

* docs: laguage toches

* docs: updated index table

* security advisory 4.1.0 updates based on review comments
- capture impact and impact versions
- update patches and workarounds
- and some formatting

* chore: minor langauge fixes

* chore: update layout

---------

Co-authored-by: Karl Cardenas <[email protected]>
Co-authored-by: Fayas <[email protected]>
* docs: added supported platforms content PEM-3751

* docs: added docs links

* save

* chore: updated table

* docs: update
* docs: pack updates

* chore: updated packs

* docs: feedback

* chore: update gitleaks
* docs: added content for PEM-3770

* docs: updated release notes known issues

* docs: updated tip

* Apply suggestions from code review

Co-authored-by: Rita Watson <[email protected]>

---------

Co-authored-by: Rita Watson <[email protected]>
* Add non-fips infra packs, add new screenshot

* Optimised images with calibre/image-actions

* Address most review comments

* Add sys-level regstry docs, vertex/palette

* Add tenant registry howto, final edits

* Add  revisions from review

* Minor fix

* Add tabs in add registry docs and more

* Change a word for consistency

* docs: added missing links

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Karl Cardenas <[email protected]>
@karl-cardenas-coding karl-cardenas-coding marked this pull request as ready for review October 22, 2023 05:24
@karl-cardenas-coding karl-cardenas-coding requested a review from a team as a code owner October 22, 2023 05:24
To refresh the authorization token, use the `v1/auth/refresh` endpoint with a GET request.


## Aquire Authorization Token
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 'Aquire'?

The response contains the authorization token. Use the new authorization token in the `Authorization` header to make API requests.


The following example shows how to refresh the authorization token using the refresh token. The refresh token is abriviated for brevity.
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 'abriviated'?


Palette API keys can be used to authenticate requests to the Palette REST API calls. You can use the API key to make REST API calls without providing your username and password. If you are a tenant admin, you can create API keys for yourself or other users.

Tenant administrators have additional permissions and capabilities to manage API keys. Tenant admins can create, edit, revoke, and delete API keys for any user within the tenant. Each of these actions is described in detail in the following resources. Refer to the [Tenant Admin API Key Management](../../../tenant-settings/api-key-management.md) section for more information.
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 'admin' instead of 'Admin'.


## Resources

- [Tenant Admin API Key Management](../../../tenant-settings/api-key-management.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 'admin' instead of 'Admin'.

KubeVirt offers other feature gates you may find useful and which you can enable using [Kubernetes feature gates](https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/). To enable more KubeVirt feature gates, you can modify the ``kubevirt.kubevirtResource.additonalFeatureGates`` parameter in the **Virtual Machine Orchestrator** manifest.

For more information on KubeVirt feature gates, refer to the [KubeVirt user guide](https://kubevirt.io/user-guide/operations/activating_feature_gates/).

## Kubevirt Plugins
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 'Kubevirt'?


## September 25, 2023 - CVE-2023-4863 Libwebp Programs Terminations - 8.8 CVSS

A heap buffer overflow in the library, `libwebp`, allows a remote attacker to perform an out of bounds memory write via a crafted HTML page. This vulerability is present with the combination of Google Chrome prior to versions 116.0.5845.187 with `libwebp` version 1.3.2. This is Chromium security severity that is marked as Critical.
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 🐶
[Google.DateFormat] Use 'July 31, 2016' format, not '16.0.5845'.


<br />

## September 01, 2023 - CVE-2023-22809 Sudo Vulnerability - 7.8 CVSS
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 'Sudo'?

| `kubeadmconfig.apiServer.extraArgs` | A list of additional apiServer flags you can set.|
| `kubeadmconfig.apiServer.extraVolumes` | A list of additional volumes to mount on the apiServer.|
| `kubeadmconfig.controllerManager.extraArgs` | A list of additional ControllerManager flags to set.|
| `kubeadmconfig.scheduler.extraArgs` | A list of additional Kube scheduler flags to set.|
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 'Kube'?

docs/docs-content/integrations/kubernetes.md Show resolved Hide resolved
docs/api-content/api-docs/2-samples.mdx Show resolved Hide resolved
| Edge RKE2 | 1.27.5 |
| Edge RKE2 | 1.26.2 |
| Edge RKE2 | 1.25.13|
| K3S| 1.27.5|
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 'k3s' instead of 'K3S'.

| Edge RKE2 | 1.26.2 |
| Edge RKE2 | 1.25.13|
| K3S| 1.27.5|
| K3S| 1.26.8|
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 'k3s' instead of 'K3S'.

| Edge RKE2 | 1.25.13|
| K3S| 1.27.5|
| K3S| 1.26.8|
| K3S| 1.25.13|
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 'k3s' instead of 'K3S'.

- Platform extensibility through custom integration packs.
- Grouping of clusters logically into Projects for governance and control.
- Rich set of enterprise features such as granular RBAC, Single Sign-on, detailed Audit logs, etc.
- ngrok published a documentation page where you can learn more about their ingress pack and how to use it. You can review their contribution by visiting the [ngrok](integrations/ngrok.md) documentation page.
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 'ngrok'?

- Platform extensibility through custom integration packs.
- Grouping of clusters logically into Projects for governance and control.
- Rich set of enterprise features such as granular RBAC, Single Sign-on, detailed Audit logs, etc.
- ngrok published a documentation page where you can learn more about their ingress pack and how to use it. You can review their contribution by visiting the [ngrok](integrations/ngrok.md) documentation page.
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 'ngrok'?

@karl-cardenas-coding karl-cardenas-coding merged commit e11218c into master Oct 22, 2023
@karl-cardenas-coding karl-cardenas-coding deleted the release-4-1 branch October 22, 2023 06:27
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.

4 participants