Skip to content

Commit

Permalink
feat: 4.3 Release Branch (#2131)
Browse files Browse the repository at this point in the history
* feat: release 4.3

* docs: add instructions for first boot tui (#2141)

* add instructions for first boot tui

* change page position

* remove QR code registration

* add cross reference

* add first boot condition

* Optimised images with calibre/image-actions

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <[email protected]>

* Update docs/docs-content/clusters/edge/site-deployment/site-installation/edge-host-registration.md

* make format

* add additional detail

* docs: add changes to tui

* add installer reference

---------

Co-authored-by: Lenny Chen <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Yuliia Horbenko <[email protected]>

* Update Nutanix Docs to capture changes in the cluster creation workflows (#2226)

* chore: Fix alignment in all Nutanix topics

* chore: Fix command template

* docs: Interim progress for the new Nutanix cluster creation UI

* docs: Finish describing fields for node pool configuration

* Apply suggestions from code review

Co-authored-by: caroldelwing <[email protected]>
Co-authored-by: Karl Cardenas <[email protected]>

* chore: Fix formatting

* docs: Change the optional field description

---------

Co-authored-by: caroldelwing <[email protected]>
Co-authored-by: Karl Cardenas <[email protected]>

* docs: add cluster update behavior (#2134)

* docs: airgap refactor DOC-1044 DOC-1043 DOC-973

* docs: updated diagram

* chore: more content

* docs: added more steps

* chore: save

* chore: save

* chore: merged master

* docs: more step

* save

* docs: updated airgap VMware step

* docs: DOC-1044 metalLB limitation

* docs: DOC-1043 Grafana issue

* docs: language cleanup

* docs: ready for ent refactpr

* docs: added OVAs

* docs: prep for palette airgap

* docs: save

* docs: final touches

* docs: vale feedback

* Optimised images with calibre/image-actions

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <[email protected]>

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <[email protected]>

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: feedback - manual

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: ready for merge

* chore: prettier fix

---------

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

* docs: add cluster update behavior

* chore: added missing refactor page (#2137)

* chore: added missing refactor page

* chore: vale feedback

* add repage behavior

* fix linking issue

* address vale comments

* Apply suggestions from code review

Co-authored-by: caroldelwing <[email protected]>
Co-authored-by: Karl Cardenas <[email protected]>

* incorporate feedback

* docs: change minimum disk size for Edge (#2132)

* change minimum disk size

* Update docs/docs-content/clusters/edge/architecture.md

---------

Co-authored-by: Lenny Chen <[email protected]>

* change li elements

* run prettier

* fix orphan

---------

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

* docs: PEM-4571 multi-account (#2296)

* docs: PEM-4571 multi-account

* docs: ready for review

* docs: fixed broken link

* Optimised images with calibre/image-actions

* docs: updated passwork reset link limitation

* docs: updated header

* Apply suggestions from code review

Co-authored-by: Lenny Chen <[email protected]>

* docs: PM feedback

---------

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

* docs: PEM-4571 Password Blocklist (#2304)

* docs: PEM-4571 multi-account

* docs: ready for review

* docs: fixed broken link

* Optimised images with calibre/image-actions

* docs: updated passwork reset link limitation

* docs: updated header

* docs: PEM-4299

* chore: pwd lenght

* docs: updated content

* docs: apply suggestions from code review

Co-authored-by: Lenny Chen <[email protected]>

* docs: added blocklist content to Palette

---------

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

* docs: PCP-2510 Konvoy (#2319)

* docs: PCP-2510

* docs: added folders

* docs: added more content

* docs: konvoy build steps

* docs: minor adjustment

* docs: added packs page

* docs: merged release-4-3

* docs: ready for review

* Apply suggestions from code review

Co-authored-by: Adelina Simion <[email protected]>

* Optimised images with calibre/image-actions

* docs: feedback

---------

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

* chore: document EMC API endpoints (#2340)

* chore: edge API WIP

* modify emc api

* modify base URL

* clean up script to generate edge API

* update emc swagger file

* Update docs/api-content/api-docs/1-introduction.md

Co-authored-by: Karl Cardenas <[email protected]>

* Update docs/api-content/api-docs/1-introduction.md

* docs: removed TP from H2 heading

* chore: adding tech previw callout

---------

Co-authored-by: Lenny Chen <[email protected]>
Co-authored-by: Lenny Chen <[email protected]>

* docs: document namespace-based image swap diabling (#2352)

* docs: add imageswap disabling documentation

* slight edits

* Vale comments

* nginx

* typo

* mode content out of tab

* Update docs/docs-content/integrations/harbor-edge.md

* address review comments

* fix typo

* add example

* Update docs/docs-content/integrations/harbor-edge.md

Co-authored-by: Karl Cardenas <[email protected]>

---------

Co-authored-by: Lenny Chen <[email protected]>
Co-authored-by: Karl Cardenas <[email protected]>

* docs: PCP-2494 custom MAAS Endpoint (#2363)

* docs: PCP-2494 content

* docs: vale feedback

* docs: vale feedback

* Apply suggestions from code review

Co-authored-by: Adelina Simion <[email protected]>

* docs: PCP-2494

---------

Co-authored-by: Adelina Simion <[email protected]>

* docs: PCP-2607 (#2369)

* docs: document edge management console (#2186)

* add instructions for first boot tui

* change page position

* remove QR code registration

* add cross reference

* add first boot condition

* add emc login functionality

* add draft on customizing ui

* add steps on creating local cluster

* modify build artifacts step

* docs: write about provider images

* add steps for building iso

* edit provider image

* docs: add upload content

* fix bad quotes

* fix broken link

* minor fixes

* add credential providing instructions

* fix tab item issue

* add instructions for exporting cluster definition

* add arg files instructions

* fix repeated word

* Optimised images with calibre/image-actions

* add info note on provider images page

* modify wording about user data

* add proxy configuration steps

* add new changes

* repeated word

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* small changes

* work on feedback

* Optimised images with calibre/image-actions

* Address feedback

* fix broken links

* fix broken links

* address comments

* address feedback

* address more comments

* address review comments

* add QR code registration back

* add note about proxy setting after reset

* add note about local registry

* Optimised images with calibre/image-actions

* docs: add note about duplicate profile layers

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

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

* fix tui acronym use

* docs: fix prereq

* update diagram

* Optimised images with calibre/image-actions

---------

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

* docs: 4.3 API Docs (#2376)

* 4.3 API Docs

* chore: fix prettier

---------

Co-authored-by: Karl Cardenas <[email protected]>

* Update the TechPreview component to also accept custom text (#2377) (#2379)

* chore: Update the TechPreview component to also accept custom text

* chore: Fix the linter warning and clean up CSS a bit

* docs:  PLT-1080 FIPS Validate Command (#2384)

* save

* docs: PLT-1080

* docs: add more content

* docs: updates

* docs: vale feedback

* Apply suggestions from code review

Co-authored-by: Adelina Simion <[email protected]>

* docs: feedback

---------

Co-authored-by: Adelina Simion <[email protected]>

* docs: add the command to bring up TUI before cluster deployment (#2387)

* docs: add tui day 2 instructions

* minor edits

* Update docs/docs-content/clusters/edge/site-deployment/initial-setup.md

Co-authored-by: caroldelwing <[email protected]>

---------

Co-authored-by: Lenny Chen <[email protected]>
Co-authored-by: caroldelwing <[email protected]>

* Cluster Profile Variables (#2343)

* docs: Prelim profile variables topic placement + fix alignment in the Profiles section

* docs: Profile variables draft

* docs: Implement Vale review

* Optimised images with calibre/image-actions

* docs: Implement SME review and edit the text a bit

* docs: Define profile variables in the glossary

* docs: Implement peer review

* Optimised images with calibre/image-actions

* docs: Update the structure

---------

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

* docs: DOC-1100 validator updates (#2388)

* docs: validator updates

* docs: update describe section

* docs: added example

* docs: added more context to the upgrade command

* docs: aDOC-1100 apply suggestions from code review

Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: prettier fix

---------

Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: replace EMC with local ui (#2392)

* replace EMC with local UI

* change filename to local-ui.md

* fix broken anchors

* fix broken link

* make local ui common noun

* common noun local ui

* fix typos

* change edge host API name

---------

Co-authored-by: Lenny Chen <[email protected]>

* Change EMC to local UI and fix all links (#2406)

* chore: Fix link formatting

* chore: Change EMC to local UI and fix all links

* Update cluster creation guides + Refactor Azure AKS (#2405)

* docs: Update the AWS EKS guide

* docs: Update the AWS IaaS guide

* docs: Update the Azure IaaS guide

* docs: Start updating the Azure AKS guide

* docs: Update the GCP IaaS guide

* docs: Update the GCP GKE guide

* docs: Update the TKE guide

* docs: Remove a note from the TKE guide

* docs: Continue  updating the Azure AKS guide

* docs: Continue  updating the Azure AKS guide

* docs: Finish updating the Azure AKS guide

* docs: Update the MAAS guide

* docs: Update the Nutanix guide

* chore: Fix a broken anchor

* chore: Implement the Vale feedback

* chore: Fix more broken anchors

* chore: Fix even more broken anchors

* docs: Implement peer review

* docs: address PE-4011 and PE-3874 (#2398)

* docs: address PE-4011

* docs: add PE-3874

* address review comments

---------

Co-authored-by: Lenny Chen <[email protected]>

* docs: add section for custom image registry options (#2386)

* docs: add content for custom image registries

* fix broken link

* docs: add prerequisites

* add corrections

* add redirects

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <[email protected]>

* address review comments

* docs: add instructions for using palette edge cli

* fix broken links

* add clarification

* docs: add clarifications

* Optimised images with calibre/image-actions

---------

Co-authored-by: Lenny Chen <[email protected]>
Co-authored-by: Yuliia Horbenko <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* docs: add rook ceph documentation (#2412)

* docs: add rook ceph documentation

* docs: small edit

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <[email protected]>

* prettier

---------

Co-authored-by: Lenny Chen <[email protected]>
Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: Update the PXK and PXK-E packs docs (#2423)

* docs: Update the PXK and PXK-E packs docs

* docs: Implement Vale feedback

* chore: Fix gitleaks

* docs: Update the K3s and RKE2 packs docs

* docs: DOC-1090 PCP-2590 PE-3943  4.3 Release Notes (#2342)

* docs: DOC-1090

* save

* docs: PCP-2590

* chore: branch switch

* docs: save

* docs: more content

* chore: save

* chore: added css property

* chore: added TechnicalPreviewReleaseNoteBadge component

* docs: ready to implement

* chore: updated README

* docs: new content

* docs: more content

* chore: added packs

* docs: added reference page

* docs: fixed vertex label

* docs: fixed broken link

* docs: update

* docs: updated packs

* chore: updated release notes

* docs: added new links

* docs: updated release notes with PCG update

* chore: vale feedback

* chore: fix jest

* modify private external registry bullet

* docs: Apply suggestions from code review

Co-authored-by: Lenny Chen <[email protected]>

* docs: feedback

---------

Co-authored-by: Lenny Chen <[email protected]>
Co-authored-by: Lenny Chen <[email protected]>

* docs: change edge harbor hardware requirements (#2413)

* docs: change edge harbor hardware requirements

* fix unfinished sentence

* clarify single node

* add fixes

---------

Co-authored-by: Lenny Chen <[email protected]>

* docs: PLT-1100 added docs for Palette EC install (#2428)

* docs: PLT-1100 added docs for Palette EC install

* docs: add VerteX steps

* chore: fixed gitleaks

* chore: gitleaks

* chore: revert eager load removal

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <[email protected]>

* chore: prettier fix

---------

Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: fix find/replace issue

* docs: merge master and DOC-1117

* docs: updated release notes

* Update download URLs (#2481)

* docs: Update download URLs

* docs: Edit a missed version reference

* docs: document how to generate FIPS-compliant Edge artifacts (#2462)

* docs: WIP fips images

* docs: fips first draft

* docs: fips-canvos

* docs: add fips instructions

* docs: fix tabs issue

* docs: copyedits

* fix vale issues

* docs: minor edits

* fix vale

* fix step numbering

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <[email protected]>

* make format

* clarify pxk-e

* punctuation

---------

Co-authored-by: Lenny Chen <[email protected]>
Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: update open source licenses list (#2485)

* docs: add update cluster section (#2482)

* docs: add update cluster section

* docs: apply suggestions from review

* Apply suggestions from code review

Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: add suggestions from pr review

---------

Co-authored-by: Yuliia Horbenko <[email protected]>

* docs: DOC-1127 (#2486)

* docs: DOC-1127

* Apply suggestions from code review

Co-authored-by: Adelina Simion <[email protected]>

* Apply suggestions from code review

Co-authored-by: Adelina Simion <[email protected]>

* chore: fix format issue

---------

Co-authored-by: Adelina Simion <[email protected]>

* docs: add note to change Longhorn images to reference harbor (#2497)

* docs: add requirement to change longhorn image base URL

* Update docs/docs-content/integrations/longhorn.md

* Update docs/docs-content/integrations/longhorn.md

* move procedure to usage

* fix syntax issue

---------

Co-authored-by: Lenny Chen <[email protected]>

* chore: update release notes date

* docs: add cluster upgrade note (#2588)

* docs: add cluster upgrade note

* edit for completeness

---------

Co-authored-by: Lenny Chen <[email protected]>

* docs: DOC-1133 (#2582)

* docs: DOC-1133

* chore: added steps

* docs: updated steps

* docs: vale feedback

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* Apply suggestions from code review

Co-authored-by: Adelina Simion <[email protected]>

* chore: prettier fix

* Apply suggestions from code review

---------

Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Adelina Simion <[email protected]>

* chore: updated PCG version

* docs: add security section (#2611)

* docs: add rook-ceph known issue (#2601)

* docs: add rook-ceph known issue

* docs: fix vale issues

* minor edit

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

* implement suggestions

* add meta description

---------

Co-authored-by: Lenny Chen <[email protected]>
Co-authored-by: Karl Cardenas <[email protected]>

* docs: add Arm64 known issue (#2614)

* docs: add arm64 limitation

* modify phrasing

---------

Co-authored-by: Lenny Chen <[email protected]>

* docs: clarify arm64 support (#2616)

* docs: clarify arm64 support

* fix typo

* Apply suggestions from code review

Co-authored-by: Karl Cardenas <[email protected]>

---------

Co-authored-by: Lenny Chen <[email protected]>
Co-authored-by: Karl Cardenas <[email protected]>

* save

* chore:  jest fix

* chore: revert fuse

* docs: PCP-2797  PLT-1127 updates to release notes (#2613)

* docs: updates to release notes

* docs: updated

* chore: update

* docs: PCP-2797

* docs: updated binaries list

* chore: updated release notes

* docs: cli updates

* docs:  PLT-1127

* chore: vale feedback

* chore: more vale feedback

* Apply suggestions from code review

Co-authored-by: Lenny Chen <[email protected]>

* chore: fix format

---------

Co-authored-by: Lenny Chen <[email protected]>

* docs: 4.3 security advisories (#2615)

* 4.3 security advisories

* docs: apply style guide

* docs: fix grammar

* chore: minor clarification

* chore: fix typo

---------

Co-authored-by: Carolina Delwing Rosa <[email protected]>
Co-authored-by: Karl Cardenas <[email protected]>

* docs: PE-4239

---------

Co-authored-by: Lenny Chen <[email protected]>
Co-authored-by: Lenny Chen <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Yuliia Horbenko <[email protected]>
Co-authored-by: caroldelwing <[email protected]>
Co-authored-by: Adelina Simion <[email protected]>
Co-authored-by: Prathab Kali <[email protected]>
Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Fayas Ahamed <[email protected]>
  • Loading branch information
10 people authored Apr 15, 2024
1 parent d2ec34e commit f4f1fbe
Show file tree
Hide file tree
Showing 157 changed files with 27,137 additions and 14,825 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ palette-docs.pdf

docs/api-content/api-docs/v1/*.mdx
docs/api-content/api-docs/v1/sidebar.*
docs/api-content/api-docs/edge-v1/*.mdx
docs/api-content/api-docs/edge-v1/sidebar.*

# Versions Content
versions.json
Expand Down
6 changes: 6 additions & 0 deletions .gitleaksignore
Original file line number Diff line number Diff line change
Expand Up @@ -103,3 +103,9 @@ fd60bdc4fdfe8b66925db07865cb530eab4978df:docs/docs-content/integrations/kubernet
511e735952ff4babb08c522a7febdd856740c3f9:docs/docs-content/vertex/system-management/reverse-proxy.md:private-key:141
511e735952ff4babb08c522a7febdd856740c3f9:docs/docs-content/vertex/system-management/reverse-proxy.md:private-key:167
511e735952ff4babb08c522a7febdd856740c3f9:docs/docs-content/vertex/system-management/reverse-proxy.md:private-key:239
9e62b4b635976b0ab93d4dddcf29d33365664091:docs/docs-content/integrations/kubernetes.md:generic-api-key:391
9e62b4b635976b0ab93d4dddcf29d33365664091:docs/docs-content/integrations/kubernetes.md:generic-api-key:759
9e62b4b635976b0ab93d4dddcf29d33365664091:docs/docs-content/integrations/kubernetes.md:generic-api-key:1125
e4040084011d4d7935a589959b96ebc5cfba7a94:docs/docs-content/integrations/kubernetes.md:generic-api-key:759
e4040084011d4d7935a589959b96ebc5cfba7a94:docs/docs-content/integrations/kubernetes.md:generic-api-key:1125
e4040084011d4d7935a589959b96ebc5cfba7a94:docs/docs-content/integrations/kubernetes.md:generic-api-key:391
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -500,6 +500,30 @@ To add a video, use the following syntax. Ensure you capitalize the letter "V":
<Video title="vsphere-pcg-creation" src="/cluster-creation-videos/vmware.mp4"></Video>
```
### Badges
The following badges are available for use:
> [!NOTE]
>
> All badges are globally available. No need to import them.
- Technical Preview Badge ![Technical Preview Badge](static/img/tech-preview-light.svg)
![Technical Preview Badge](static/img/tech-preview-dark.svg)
#### Technical Preview Badge
The technical preview badge is used to indicate that a feature is in technical preview. The badge is intended for
release notes in the context of a list. The following is an example of how to use the technical preview badge. The
component will automatically display the badge in the correct color based on the light theme (dark/light).
```markdown
- <TpBadge /> Cluster Profile variables, a new feature that allows you to define variables in a cluster profile. This
feature is in Tech Preview and is available only for Edge clusters. Profile variables allow you to define variable
types, apply validation, and more. Refer to the Cluster Profile Variables documentation to learn more about profile
variables.
```
### Simple Card Grid
This is a custom component that creates a grid of simple text cards with two columns, styled according to our color
Expand Down Expand Up @@ -744,3 +768,7 @@ make clean-versions
>
> The `docusaurus.config.js` file is updated by the [`update_docusaurus_config.js`](./docusaurus.config.js) script. DO
> NOT commit this file with the updated changes.
```
```
12 changes: 12 additions & 0 deletions apisidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ if (fs.existsSync(sidebarFilePath)) {
sidebarItems = require(sidebarFilePath);
}

let emcSidebarItems = [];
const sidebarEmcFilePath = "./docs/api-content/api-docs/edge-v1/sidebar.ts";
if (fs.existsSync(sidebarEmcFilePath)) {
emcSidebarItems = require(sidebarEmcFilePath);
}

module.exports = {
apiSidebar: [
{ type: "doc", id: "introduction", label: "Introduction" },
Expand All @@ -21,5 +27,11 @@ module.exports = {
link: { type: "generated-index", title: "Palette API V1" },
items: sidebarItems,
},
{
type: "category",
label: "Edge Host API V1",
link: { type: "generated-index", title: "Edge Host API V1" },
items: emcSidebarItems,
},
],
};
1 change: 1 addition & 0 deletions archiveVersions.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
"v4.1.x": "https://version-4-1.legacy.docs.spectrocloud.com",
"v4.0.x": "https://version-4-0.legacy.docs.spectrocloud.com",
"v3.4.x and prior": "https://version-3-4.legacy.docs.spectrocloud.com"
}
170 changes: 153 additions & 17 deletions docs/api-content/api-docs/1-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,32 +8,37 @@ sidebar_custom_props:
icon: "graph"
---

The API documentation section includes documentation for Palette API and Edge Host API. Edge Host API endpoints are Tech
Preview features and should not be used in production workloads.

## Palette API

Palette offers a range of capabilities you can access through the REST APIs. These REST APIs are designed in accordance
with open API standards, which ensure that the platform's features can be integrated with other applications and
systems. By utilizing these APIs, you can tap into the platform's capabilities through programmatic methods. Use the
APIs to build custom integrations and workflows that leverage the power of the Palette.

## Paths
### Paths

Every API's URI has the prefix of the version and the Palette resource, such as: `v1/spectroclusters/...`

## Authentication
### Authentication

Palette supports two types of API authentication methods that can be used to authenticate API requests:

- [Authorization Token](#authorization-token)

- [API Key](#api-key)

### Authorization Token
#### Authorization Token

You can acquire authorization tokens from Palette that have a 15-minute lifetime. The authorization token is passed as
part of the HTTP request header. You can use the authorization token to authenticate and authorize the request. The
header name is `Authorization`, and the token is the header value. Refer to the
[Authorization Token](/user-management/authentication/authorization-token) section to learn more about the authorization
token.

### API Key
#### API Key

You can use API keys to authenticate with the Palette API. API keys allow you to interact with Palette APIs without
requiring user credentials such as username and password. The API key must be present in each API request to
Expand All @@ -50,7 +55,7 @@ curl --location "https://api.spectrocloud.com/v1/spectroclusters/123456789?Proje

Refer to the [API Key](/user-management/authentication/api-key/) section to learn how to create and manage API keys.

## Requests
### Requests

All requests are in the `JSON` format. In general, the request payload has three sections: _metadata, spec and status_.

Expand All @@ -73,7 +78,7 @@ timestamp cannot be modified post-creation.
| PATCH | To add, modify, remove a specific attribute or sub-resource within a resource. |
| DELETE | To delete the resource. |

## Response Codes
### Response Codes

The API returns standard HTTP response codes:

Expand All @@ -88,42 +93,40 @@ The API returns standard HTTP response codes:
| 404 | The resource or the dependent resource is not found for the operation. |
| 500 | Operational error. For 500 error code, the server responds with an explicit error code and an error message. |

## Palette API Lifecycle
### Palette API Lifecycle

Palette APIs maintain backward compatibility until deprecation. The three API phases in the lifecycle are _Production_,
_Sunset_, and _Deprecated_. Spectro Cloud will inform users when APIs transition through this lifecycle.

### Production
#### Production

The Palette APIs are designed to work as intended and expected.

### Sunset
#### Sunset

As the API approaches deprecation because it is being replaced or will no longer be supported, a notice will be provided
in the documentation that outlines our intent and provides a cut-off date. Within three months of the deprecation date,
a notice will be shared that counts down to the end date and recommends the API to use instead.

### Deprecated
#### Deprecated

We indicate that an API is deprecated when it is no longer supported or recommended for use by including a tag to
indicate its state. The API documentation will remain available as a subsection of deprecated APIs.

<br />

:::info

The API lifecycle also applies to external-facing tools such as Terraform.

:::

## Versioning
### Versioning

The version information is included in the API URI, such as `v1alpha1` or `v1`. Future APIs will increment the version,
leaving the earlier version intact. The existing API request and response schema will be modified to add new attributes
or query parameters while maintaining backward compatibility with earlier schemas. Prior notice will be given before
advancing to the next version, and users will be advised to migrate to the new API.

## Scope
### Scope

Palette groups resources under either a Tenant or Project scope. When making API requests targeting resources belonging
to a project, the project scope should be specified. To specify the project scope, use the HTTP header key `ProjectUid`
Expand All @@ -145,7 +148,7 @@ If you do not provide the ProjectUid header, then the assumed scope is of the te

:::

## Pagination
### Pagination

API endpoints that return a list have a limit of 50 items per return payload. Pagination is necessary for this purpose.
The API response for the list includes the listMeta resource that contains the `continue` token. To perform pagination,
Expand Down Expand Up @@ -176,7 +179,7 @@ curl --location 'https://api.spectrocloud.com/v1/packs?continue=eyJvZmZzZXQiOjUw
--header 'apiKey: yourAPIKey'
```

## Rate Limits
### Rate Limits

The API rate limits are as follows:

Expand All @@ -194,7 +197,7 @@ The API rate limits are as follows:
- If too many requests are issued, you may receive an error with HTTP code `429` - `TooManyRequests.` We recommend
retrying the API call after a few moments.

## Endpoint Prefix Rate
### Endpoint Prefix Rate

| **Endpoint Prefix** | **Request Per Second** | **Burst Size** | **Max with Burst** |
| --------------------------------------------------------------------------------------- | ---------------------- | -------------- | ------------------ |
Expand Down Expand Up @@ -263,3 +266,136 @@ The API rate limits are as follows:
| /v1/clusterprofiles/validate/packs | 50 | 5 | 250 |
| /v1/clusterprofiles/:uid/validate/packs | 50 | 5 | 250 |
| /v1/spectroclusters/:uid/profiles | 50 | 5 | 250 |

## Edge Host API

An Edge host has its own set of API endpoints. These API endpoints are available on each Edge host instead of on a
Palette instance. You can use Edge Host API endpoints to programmatically perform tasks such as retrieve information
about Edge clusters, retrieve the list of available images on your Edge host, and create local clusters using embedded
cluster definitions.

:::preview

:::

### Authentication

Use the `POST /v1/users/default/login` endpoint to generate an authentication token with your OS username and password.
The following curl command is an example. Replace `edge-host-ip` with the IP of your Edge host and replace `os-username`
and `os-password` with your OS user credentials.

```shell
curl --location 'https://edge-host-ip:5080/v1/users/default/login' \
--header 'Content-Type: application/json' \
--data '{
"username": "os-username",
"password": "os-password"
}'
```

If your credentials are valid, you will receive a authorization token.

```hideClipboard
{
"Token": {
"Authorization": "******"
}
}
```

Include this token in the header of your subsequent requests to the Edge Host API to authenticate your requests. For
example, the following request retrieves information about the Edge host such as the processor architecture and the host
name.

```shell
curl --location 'https://10.10.135.182:5080/v1/edge-mgmt/edgehosts/current' \
--header 'Cookie: Authorization=*******'
```

```hideClipboard
{
"metadata": {
"creationTimestamp": "2024-02-29T20:31:42.204Z",
"id": "edge-bc4a38428b71300e371150263b651b8d",
"lastModifiedTimestamp": "0001-01-01T00:00:00.000Z",
"name": "edge-bc4a38428b71300e371150263b651b8d"
},
"spec": {
"connectionMode": "airgap",
"hardwareSpec": {
"archType": "amd64",
"cpu": {
"cores": 4
},
"disks": [
{
"controller": "SCSI",
"partitions": [
{
"fileSystemType": "ext4",
"freeSpace": 13,
"mountPoint": "/run/initramfs/cos-state",
"totalSpace": 24,
"usedSpace": 9
}
],
"size": 300,
"vendor": "VMware"
},
{
"controller": "SCSI",
"partitions": [],
"size": 4,
"vendor": "NECVMWar"
},
{
"controller": "SCSI",
"partitions": [],
"vendor": "NECVMWar"
}
],
"gpus": [],
"memory": {
"sizeInMB": 7930
},
"os": {
"family": "kairos-core-sles",
"version": "v2.4.3"
}
},
"networkInfo": [
{
"dns": [
"10.10.128.8"
],
"gateway": "10.10.128.1",
"ip": "10.10.135.182",
"isDefault": true,
"macAddr": "00:50:56:b8:9e:98",
"nicName": "ens160",
"subnet": "255.255.192.0"
}
]
},
"status": {
"agentVersion": "4.3.0-rc4",
"configurationStatus": "pending",
"dns": {
"nameservers": [
"10.10.128.8"
],
"options": [],
"searchDomains": [
"."
]
},
"hostName": "edge-bc4a38428b71300e371150263b651b8d",
"ntp": {
"fallbackNtpServers": [],
"ntpServers": []
},
"registrationStatus": "not applicable"
}
}
```
Loading

0 comments on commit f4f1fbe

Please sign in to comment.