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.

Sign up for GitHub

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

Jump to bottom

docs: Agent Mode installation guide #4198

Merged
merged 10 commits into from
Oct 7, 2024
Merged

docs: Agent Mode installation guide #4198

merged 10 commits into from
Oct 7, 2024

Conversation

caroldelwing
Copy link
Contributor

@caroldelwing caroldelwing commented Oct 4, 2024 •
edited by jira bot
Loading

Describe the Change

This PR documents the Palette agent installation steps and controller mode.

Changed Pages

💻 Install Palette Agent
💻 Manage Palette Agent
💻 Controller Mode

Note: the new version of the BYOS pack and the link to download the script will be updated once they are available for use.

Jira Tickets

🎫 DOC-1404
🎫 DOC-1402
🎫 DOC-1405

Backports

Can this PR be backported?

  • Yes. Remember to add the relevant backport labels to your PR.
  • No. _Please leave a short comment below about why this PR cannot be backported._The PR will be merged into the agent-mode branch.

@netlify Netlify
Copy link

netlify bot commented Oct 4, 2024 •
edited
Loading

✅ Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit 911a1aa
🔍 Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/670470e9318fc50008172ba9
😎 Deploy Preview https://deploy-preview-4198--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.

@caroldelwing caroldelwing marked this pull request as ready for review October 7, 2024 20:36
@caroldelwing caroldelwing requested a review from a team as a code owner October 7, 2024 20:36
@caroldelwing caroldelwing requested review from karl-cardenas-coding, addetz and lennessyy and removed request for a team October 7, 2024 20:36
github-actions[bot]
github-actions bot reviewed Oct 7, 2024
View reviewed changes
@vault-token-factory-spectrocloud
Copy link
Contributor

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 81.2%, saving 1.40 MB.

Filename Before After Improvement Visual comparison
static/assets/docs/images/deployment-modes_agent-mode_byos-pack.webp 460.55 KB 113.67 KB -75.3% View diff
static/assets/docs/images/deployment-modes_agent-mode.webp 195.49 KB 38.30 KB -80.4% View diff
static/assets/docs/images/deployment-modes_appliance-mode.webp 213.34 KB 42.68 KB -80.0% View diff
static/assets/docs/images/deployment-modes_controller-diagram.webp 895.69 KB 137.10 KB -84.7% View diff

726 images did not require optimisation.

@vault-token-factory-spectrocloud
Copy link
Contributor

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 2.2%, saving 7.35 KB.

Filename Before After Improvement Visual comparison
static/assets/docs/images/deployment-modes_agent-mode_byos-pack.webp 113.67 KB 111.01 KB -2.3% View diff
static/assets/docs/images/deployment-modes_agent-mode.webp 38.30 KB 37.68 KB -1.6% View diff
static/assets/docs/images/deployment-modes_appliance-mode.webp 42.68 KB 41.92 KB -1.8% View diff
static/assets/docs/images/deployment-modes_controller-diagram.webp 137.10 KB 133.79 KB -2.4% View diff

726 images did not require optimisation.

@lennessyy lennessyy merged commit be069f9 into agent-mode Oct 7, 2024
16 checks passed
@lennessyy lennessyy deleted the agent-mode-install branch October 7, 2024 23:52
lennessyy added a commit that referenced this pull request Oct 11, 2024
@lennessyy @caroldelwing
@vault-token-factory-spectrocloud @karl-cardenas-coding
docs: agent mode / deployment modes (#4099)
ced20b0 
* 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 <55669665+lennessyy@users.noreply.github.com>

* 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 <29551334+karl-cardenas-coding@users.noreply.github.com>

* 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 <lenny.chen@spectrocloud.com>
Co-authored-by: Carolina Delwing Rosa <carolina.delwing@spectrocloud.com>
Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>
lennessyy added a commit that referenced this pull request Oct 13, 2024
@karl-cardenas-coding @caroldelwing
@ravi-k8 @vault-token-factory-spectrocloud @lennessyy
feat: release 4.5 (#4028)
959de22 
* 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 <carolina.delwing@spectrocloud.com>

* ci: auto-formatting prettier issues

---------

Co-authored-by: caroldelwing <carolina.delwing@spectrocloud.com>
Co-authored-by: karl-cardenas-coding <karl-cardenas-coding@users.noreply.github.com>

* 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 <carolina.delwing@spectrocloud.com>

* 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 <carolina.delwing@spectrocloud.com>
Co-authored-by: karl-cardenas-coding <karl-cardenas-coding@users.noreply.github.com>

* docs: add Edge api 4.5.0 (#4233)

* docs: add edge mgmt api 450

* ci: auto-formatting API changes

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: Karl Cardenas <karl@spectrocloud.com>
Co-authored-by: karl-cardenas-coding <karl-cardenas-coding@users.noreply.github.com>

* 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 <lenny.chen@spectrocloud.com>

* 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 <lenny.chen@spectrocloud.com>
Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>
Co-authored-by: Karl Cardenas <karl@spectrocloud.com>

* 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 <29551334+karl-cardenas-coding@users.noreply.github.com>

* ci: auto-formatting prettier issues

* docs: address review comments

---------

Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>
Co-authored-by: lennessyy <lennessyy@users.noreply.github.com>

* 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 <carolina.delwing@spectrocloud.com>

* ci: auto-formatting prettier issues

---------

Co-authored-by: caroldelwing <carolina.delwing@spectrocloud.com>
Co-authored-by: karl-cardenas-coding <karl-cardenas-coding@users.noreply.github.com>

* 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 <55669665+lennessyy@users.noreply.github.com>

* 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 <29551334+karl-cardenas-coding@users.noreply.github.com>

* 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 <lenny.chen@spectrocloud.com>
Co-authored-by: Carolina Delwing Rosa <carolina.delwing@spectrocloud.com>
Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>

* 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 <lenny.chen@spectrocloud.com>

* chore: version update

* chore: version changes

* docs: updated URLs

* chore: fix docs

---------

Co-authored-by: caroldelwing <carolina.delwing@spectrocloud.com>
Co-authored-by: karl-cardenas-coding <karl-cardenas-coding@users.noreply.github.com>
Co-authored-by: Ravikumar Kondepati <ravikum12@gmail.com>
Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com>
Co-authored-by: Lenny Chen <55669665+lennessyy@users.noreply.github.com>
Co-authored-by: Lenny Chen <lenny.chen@spectrocloud.com>
Co-authored-by: lennessyy <lennessyy@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments

@lennessyy lennessyy lennessyy approved these changes

@karl-cardenas-coding karl-cardenas-coding Awaiting requested review from karl-cardenas-coding karl-cardenas-coding was automatically assigned from spectrocloud/docs-education

@addetz addetz Awaiting requested review from addetz addetz was automatically assigned from spectrocloud/docs-education

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@caroldelwing @lennessyy