API key update #1666
Merged
API key update #1666
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
✅ Deploy Preview for docs-spectrocloud ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
* 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 <karl@spectrocloud.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
ritawatson
approved these changes
Oct 17, 2023
docs/docs-content/user-management/authentication/api-key/api-key.md
Outdated
Show resolved
Hide resolved
docs/docs-content/user-management/authentication/api-key/api-key.md
Outdated
Show resolved
Hide resolved
docs/docs-content/user-management/authentication/api-key/create-api-key.md
Outdated
Show resolved
Hide resolved
docs/docs-content/user-management/authentication/authorization-token.md
Outdated
Show resolved
Hide resolved
docs/docs-content/user-management/authentication/authorization-token.md
Outdated
Show resolved
Hide resolved
docs/docs-content/user-management/authentication/authorization-token.md
Outdated
Show resolved
Hide resolved
docs/docs-content/user-management/authentication/authorization-token.md
Outdated
Show resolved
Hide resolved
docs/docs-content/user-management/authentication/authorization-token.md
Outdated
Show resolved
Hide resolved
docs/docs-content/user-management/authentication/api-key/delete-api-key.md
Outdated
Show resolved
Hide resolved
docs/docs-content/user-management/authentication/api-key/modify-api-key.md
Outdated
Show resolved
Hide resolved
docs/docs-content/user-management/authentication/api-key/modify-api-key.md
Outdated
Show resolved
Hide resolved
docs/docs-content/user-management/authentication/api-key/revoke-api-key.md
Outdated
Show resolved
Hide resolved
docs/docs-content/user-management/authentication/api-key/revoke-api-key.md
Outdated
Show resolved
Hide resolved
docs/docs-content/user-management/authentication/api-key/revoke-api-key.md
Outdated
Show resolved
Hide resolved
docs/docs-content/user-management/authentication/api-key/revoke-api-key.md
Outdated
Show resolved
Hide resolved
docs/docs-content/user-management/authentication/api-key/revoke-api-key.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com>
docs/docs-content/user-management/authentication/authorization-token.md
Outdated
Show resolved
Hide resolved
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| @@ -60,7 +59,7 @@ Some of the endpoints require a cluster ID. | |||
|
|
|||
| :::info | |||
|
|
|||
| If you do not provide the ProjectUid header, then the assumed scope is of the tenant. | |||
| If you do not provide the projectUid header, then the assumed scope is of the tenant. | |||
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'projectUid'?
| To refresh the authorization token, use the `v1/auth/refresh` endpoint with a GET request. | ||
|
|
||
|
|
||
| ## Aquire Authorization Token |
There was a problem hiding this comment.
🚫 [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. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'abriviated'?
| @@ -11,12 +11,12 @@ Palette offers you different types of services to help you model all the depende | |||
|
|
|||
| ## Container Deployment | |||
|
|
|||
| [Containers](https://www.docker.com/resources/what-container/) are methods of building, packaging, and deploying an application. A container includes the code, run-time, libraries, and all the dependencies required by a containerized workload. Containers are deployed to their target environment. For steps on how to deploy a container in Palette, refer to [Container Deployment](../container-deployment.md). | |||
| [Containers](https://www.docker.com/resources/what-container/) are methods of building, packaging, and deploying an application. A container includes the code, run-time, libraries, and all the dependencies required by a containerized workload. Containers are deployed to their target environment. For steps on how to deploy a container in Palette, refer to [Container Deployment](../../profiles/app-profiles/create-app-profiles/container-deployment.md). | |||
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[spectrocloud.ableism] Avoid using ableism terms. Use 'issue' instead of 'run'.
| @@ -58,7 +58,7 @@ charts: | |||
|
|
|||
| ## Usage | |||
|
|
|||
| To use the ngrok Ingress Controller pack, first create a new [add-on cluster profile](../cluster-profiles/create-add-on-profile.md), search for the **ngrok Ingress Controller** pack, and overwrite the default pack configuration with your API key and authentication token like the following example YAML content: | |||
| To use the ngrok Ingress Controller pack, first create a new [add-on cluster profile](../profiles/cluster-profiles/create-cluster-profiles/create-addon-profile/create-addon-profile.md), search for the **ngrok Ingress Controller** pack, and overwrite the default pack configuration with your API key and authentication token like the following example YAML content: | |||
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'ngrok'?
| |-----------|---------------------------| | ||
| | **Packs** | A pack is a collection of files and configurations that can be deployed to a cluster to add functionality or customize the cluster's behavior. We maintain a public pack registry that makes packs available to all tenants. Check out the [Packs List](../../integrations/integrations.mdx) reference to learn more about individual packs. | | ||
| | **Helm Charts** | Helm charts are a collection of Kubernetes resource files capable of deploying various services. We provide both a public and a private Helm registry. Additionally, your organization can add any public or private Helm registries to Palette to leverage charts from those registries. You can then attach customized charts to profiles. | | ||
| | **Manifests** | You can construct profile layers using manifests to provision Kubernetes resources that are unavailable in Palette or Helm Charts. Manifests also provide a pass-through mechanism to orchestrate Kubernetes resources in a cluster. For example, specific integrations may require the creation of secrets or Custom Resource Definitions (CRDs) to complete the installation. You can provision these additional resources by attaching a manifest file to a layer in a cluster profile. | |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'CRDs'?
|
|
||
| - [Create Cluster Profiles](../cluster-profiles/create-cluster-profiles/create-cluster-profiles.md) | ||
|
|
||
| - [Modify Cluster Profiles](../cluster-profiles/modify-cluster-profiles/modify-cluster-profiles.md) |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'modify' instead of 'Modify'.
|
|
||
| - Your Palette account role must have the `clusterProfile.update` permission to update a profile. Refer to the [Cluster Profile permissions](../../../user-management/palette-rbac/project-scope-roles-permissions.md#cluster-profile-admin) reference for more information about roles and permissions. | ||
|
|
||
| ## Modify Basic Profile Information |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'modify' instead of 'Modify'.
| - An existing app profile. | ||
|
|
||
|
|
||
| ## Modify Basic Profile Information |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'modify' instead of 'Modify'.
| tags: ["devx", "app mode", "pde", "app profiles"] | ||
| --- | ||
|
|
||
| Palette App Mode supports the use of containers, a standard unit of software that packages code and all its dependencies to run applications quickly and reliably from one computing environment to another. Containers contain all the required executables, binary codes, libraries, and configuration files. As a result, containers are lightweight and portable with less overhead. To add a container layer to a Palette Dev Engine app profile, follow the steps below. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[spectrocloud.ableism] Avoid using ableism terms. Use 'issue' instead of 'run'.
karl-cardenas-coding
added a commit
that referenced
this pull request
Oct 22, 2023
* feat: release of Palette 4.1 documentation * docs: updated edge docs PE-2801 (#1655) * 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 <117382432+ritawatson@users.noreply.github.com> * Optimised images with calibre/image-actions * Apply suggestions from code review --------- Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * docs: maas node tags PCP-1930 (#1656) * docs: maas node tags PCP-1930 * docs: feedback incorporated * ci: updated CI label * ci label update * API key update (#1666) * 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 <karl@spectrocloud.com> 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 <117382432+ritawatson@users.noreply.github.com> * Apply suggestions from code review --------- Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Distro virtual cluster (#1665) * 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> * 4 1 release notes (#1676) * 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 * docs: updated license list (#1681) * Included new CVE's (#1668) * 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 <karl@spectrocloud.com> Co-authored-by: Fayas <fayasmech@gmail.com> * docs: updated release notes * API docs - 4.1 (#1688) * Vertex platform (#1682) * docs: added supported platforms content PEM-3751 * docs: added docs links * save * chore: updated table * docs: update * docs: pack updates (#1689) * docs: pack updates * chore: updated packs * docs: feedback * chore: update gitleaks * docs: added content for PEM-3770 (#1690) * 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 <117382432+ritawatson@users.noreply.github.com> --------- Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com> * docs: documented non-fips packs in VerteX PEM-3652 * 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 <karl@spectrocloud.com> * docs: updated version URL * docs: updated airgap version --------- Co-authored-by: Rita Watson <117382432+ritawatson@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Alagu Jeeva M <alagujeeva22@gmail.com> Co-authored-by: Fayas <fayasmech@gmail.com> Co-authored-by: Prathab Kali <prathab@spectrocloud.com>
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 updates the user authentication documentation to address some recent changes.
Tenant Management API Key
User Authentication
Authorization Token
UI Auth
API Key Section
Review Changes
💻 Preview URL
🎫 PEM-3373
🎫 PEM-3441