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

docs: share local UI login #4140

Merged
merged 13 commits into from
Oct 10, 2024
Merged

docs: share local UI login #4140

merged 13 commits into from
Oct 10, 2024

Conversation

lennessyy
Copy link
Contributor

@lennessyy lennessyy commented Oct 1, 2024

Describe the Change

This PR documents how to consume local UI's authentication cookie.

Changed Pages

💻 Share Local UI Auth

Jira Tickets

🎫 Jira Ticket

Backports

Can this PR be backported?

  • No.

@lennessyy lennessyy added the 4.5 label Oct 1, 2024
Copy link
Contributor

github-actions bot commented Oct 1, 2024

🤖 Netlify configured to enable preview build for branch: share-local-ui-login . Subsequent commits will automatically trigger a Netlify build preview.

Copy link

netlify bot commented Oct 2, 2024

Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit e23aee1
🔍 Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/670722c46df95c0008291368
😎 Deploy Preview https://deploy-preview-4140--docs-spectrocloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@lennessyy lennessyy marked this pull request as ready for review October 9, 2024 21:15
@lennessyy lennessyy requested a review from a team as a code owner October 9, 2024 21:15
}
```

The middleware verifies and the JWT. If it is valid, it decodes the JWT and return the user information contained in
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 'middleware'?

Copy link
Contributor

@karl-cardenas-coding karl-cardenas-coding left a comment

Choose a reason for hiding this comment

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

@lennessyy Solid start. I left some comments and suggestions that I think we'll help us provide a bit better UX.

Copy link
Contributor

Choose a reason for hiding this comment

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

@lennessyy Can we add the limitations Codrin shared in https://spectrocloud.atlassian.net/browse/PE-5057

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Which limitations are you specifically looking at? I added that the cookies don't have expiration dates, and that the tokens are issued per node

@lennessyy lennessyy merged commit 9d793d1 into release-4-5 Oct 10, 2024
10 checks passed
@lennessyy lennessyy deleted the share-local-ui-login branch October 10, 2024 18:07
lennessyy added a commit that referenced this pull request Oct 13, 2024
* feat: release 4.5

* docs: DOC-1410 (#4121)

* docs: PLT-1407 (#4112)

* docs: PEM-5698 OIDC userinfo (#4119)

* docs: PEM-5698

* docs: vale feedback

* docs: missing commit

* docs: PCP-3569 Microk8s and Backup Failures (#4138)

* docs: PCP-3568

* docs: PCP-3569

* docs: fixed heading

* docs: Apply suggestions from code review

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

* ci: auto-formatting prettier issues

---------

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

* docs: PEM-5472 (#4181)

* docs: PEM-5472

* docs: trigger build

* docs: added limiation

* docs: apply suggestions from code review

* docs: capitalization fix

* docs: palette API docs - 4.5 (#4219)

* docs: update API

* chore: fix API labeler

* docs: PEM-6014 (#4216)

* docs: PEM-6014

* docs: more changes

* docs: added tooltip infobox

* docs: vale feedback

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: Apply suggestions from code review

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

* ci: auto-formatting prettier issues

---------

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

* docs: add Edge api 4.5.0 (#4233)

* docs: add edge mgmt api 450

* ci: auto-formatting API changes

---------

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

* docs: add workaround for RKE2 Cilium known issue (#4217)

* docs: add workaround

* docs:git statusgit status

* docs: add troubleshooting steps

* docs: vale

* docs: link upstream issue

* docs: add crosslink

---------

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

* docs: add 4.5 palette oss licenses (#4251)

* docs: add 4.5 palette oss licenses

* docs: trigger netlify

* docs: disable webhook  (#4098)

* docs: start page

* docs: missing validate steps

* docs: add draft for webhook feature

* docs: add registry redirect instructions

* docs: copy edits

* docs: adjust verify steps

* docs: vale kubelet

* docs: address review comments

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

* chore: prettier

---------

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

* docs: share local UI login (#4140)

* docs: add title description

* docs: add some steps"

* docs: add content to page

* docs: add note about getting edge host ID

* docs: add prereqs

* docs: add env variable tip

* docs: small copy edit

* docs: fix broken links

* docs: vale comments

* Apply suggestions from code review

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

* ci: auto-formatting prettier issues

* docs: address review comments

---------

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

* docs: DOC-1408 DOC-1472 PCP-3520 PE-5257 (#4159)

* docs: DOC-1408

* docs: more content

* docs: save

* chore: update content

* docs: more content

* docs: more content

* docs: update

* docs: PPD-1472

* docs: more changes

* docs: PCP-3567

* docs: updated terraform version

* docs: updates

* docs: PE-5257

* docs: PE-5257

* save

* docs: updated release notes

* docs: ready for review

* docs: apply suggestions from code review

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

* ci: auto-formatting prettier issues

---------

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

* docs: agent mode / deployment modes (#4099)

* docs: start first page

* docs: add category.json

* docs: rough outline

* docs: add more disposition and place holder text

* docs: add more placeholders

* docs: brief descriptions

* docs: add diagrams

* docs: convert to webp

* docs: index page draft

* docs: add agent mode content

* docs: add agent mode info

* docs: Agent Mode installation guide (#4198)

* docs: add agent installation guide

* docs: remove config ref paragraph

* docs: add agent mgmt page

* docs: add new controller mode page and diagram

* docs: add limitations, tech preview banner, fix command

* docs: vale feedback

* Optimised images with calibre/image-actions

* Apply suggestions from code review

* Optimised images with calibre/image-actions

---------

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

* docs: add appliance mode info

* docs: fix broken link

* docs: remove image from index page

* docs: add diagrams

* docs: add link to github repo, review prereqs

* docs: add local ui theming guide

* docs: update BYOS pack

* Optimised images with calibre/image-actions

* Optimised images with calibre/image-actions

* docs: add deployment modes icon

* docs: review grammar

* docs: add instructions for airgap

* docs: fix broken tab, add main diagram

* docs: replace gif bc it was not looping

* docs: comment out airgap

* docs: minor copy edit

* docs: add supported k8s distros

* docs: remove CPU model restrictions

* docs: add airgap steps

* Apply suggestions from code review

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

* docs: address review comments

* docs: add local ui link

* docs: address vale comments

* docs: fix grouptab, replace download script command

* docs: modify version number

* docs: change docker to crane

* docs: add warning for docker

* docs: add flannel limitation

---------

Co-authored-by: Lenny Chen <[email protected]>
Co-authored-by: Carolina Delwing Rosa <[email protected]>
Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Karl Cardenas <[email protected]>

* chore: changes

* chore: added agent mode link

* chore: vale feedback

* docs: version.sh change (#4267)

* docs: version script

* docs: remove redundant changes

* docs: add robot.txt

* docs: rename robots.txt

---------

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

* chore: version update

* chore: version changes

* docs: updated URLs

* chore: fix docs

---------

Co-authored-by: caroldelwing <[email protected]>
Co-authored-by: karl-cardenas-coding <[email protected]>
Co-authored-by: Ravikumar Kondepati <[email protected]>
Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Lenny Chen <[email protected]>
Co-authored-by: Lenny Chen <[email protected]>
Co-authored-by: lennessyy <[email protected]>
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.

2 participants