docs: agent mode / deployment modes #4099
Merged
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
|
🤖 Netlify configured to enable preview build for branch: agent-mode . Subsequent commits will automatically trigger a Netlify build preview. |
✅ Deploy Preview for docs-spectrocloud ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
* 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]>
…into agent-mode
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
docs/docs-content/deployment-modes/agent-mode/manage-agent/localui-theming.md
Outdated
Show resolved
Hide resolved
docs/docs-content/deployment-modes/agent-mode/manage-agent/localui-theming.md
Outdated
Show resolved
Hide resolved
docs/docs-content/deployment-modes/agent-mode/manage-agent/localui-theming.md
Outdated
Show resolved
Hide resolved
docs/docs-content/deployment-modes/agent-mode/manage-agent/localui-theming.md
Show resolved
Hide resolved
docs/docs-content/deployment-modes/agent-mode/manage-agent/localui-theming.md
Outdated
Show resolved
Hide resolved
karl-cardenas-coding
requested changes
Oct 10, 2024
docs/docs-content/deployment-modes/agent-mode/install-agent-host.md
Outdated
Show resolved
Hide resolved
| export USERDATA=./user-data | ||
| ``` | ||
|
|
||
| 4. Download the Palette agent installation script. Access the [Agent Mode](https://github.com/spectrocloud/agent-mode) |
There was a problem hiding this comment.
We may be able to use this URL https://github.com/spectrocloud/agent-mode/releases/latest/download/palette-agent-install.sh and get away from versions all together.
Follow the Slack thread for more details 🧵
| tags: ["edge"] | ||
| --- | ||
|
|
||
| Palette offers the option to customize the Local UI web interface. You can change the color of the sidebar as well as |
There was a problem hiding this comment.
Maybe I'm missing something but outside of an EdgeForge context. How does a host become a localUI host? It's as simple as the host coming up, registering with Palette and accessing port 5080?
There was a problem hiding this comment.
Yes. Local UI is enabled by default. Whether you register with Palette or not, as long as you didn't disable it in your user data, it's going to be available at port 5080.
Co-authored-by: Karl Cardenas <[email protected]>
docs/docs-content/deployment-modes/agent-mode/install-agent-host.md
Outdated
Show resolved
Hide resolved
docs/docs-content/deployment-modes/agent-mode/install-agent-host.md
Outdated
Show resolved
Hide resolved
docs/docs-content/deployment-modes/agent-mode/install-agent-host.md
Outdated
Show resolved
Hide resolved
docs/docs-content/deployment-modes/agent-mode/manage-agent/manage-agent.md
Show resolved
Hide resolved
karl-cardenas-coding
approved these changes
Oct 11, 2024
|
|
||
| The diagram below illustrates the agent mode cluster provisioning workflow. | ||
|
|
||
|  |
There was a problem hiding this comment.
This is great @lennessyy
lennessyy
added
backport-version-4-5
nianyush
reviewed
Oct 11, 2024
docs/docs-content/deployment-modes/agent-mode/install-agent-host.md
Outdated
Show resolved
Hide resolved
| - [conntrack](https://conntrack-tools.netfilter.org/downloads.html). This requirement is specific for clusters that | ||
| use PXKE as the Kubernetes layer. | ||
| - (Airgap only) [Docker](https://www.docker.com/) is installed and available. | ||
| - (Airgap only) [Palette Edge CLI](../../spectro-downloads.md#palette-edge-cli) is installed and available. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'airgap' instead of 'Airgap'.
| - [Rsync](https://github.com/RsyncProject/rsync) | ||
| - [conntrack](https://conntrack-tools.netfilter.org/downloads.html). This requirement is specific for clusters that | ||
| use PXKE as the Kubernetes layer. | ||
| - (Airgap only) [Crane](https://github.com/google/go-containerregistry/blob/main/cmd/crane/README.md) is installed and |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'airgap' instead of 'Airgap'.
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
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 documents deployment mods and procedure to deploy a cluster in agent mode
Changed Pages
💻 Deployment Modes
Jira Tickets
🎫 DOC-1398
Backports
Can this PR be backported?