-
Notifications
You must be signed in to change notification settings - Fork 45
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-2046: Update install and agent docs #3243
Merged
Merged
Changes from 7 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
16aa33f
Update install and agent docs
npentrel 2e13244
Update docs/configure/agent.md
npentrel efa532d
Apply suggestions from code review
npentrel 6f0400d
Apply suggestions from code review
npentrel 9c26636
Updates
npentrel 2a716a9
Apply suggestions from code review
npentrel f43b84f
Update docs/installation/_index.md
npentrel 172293d
Update the agent provisioning config attributes
npentrel 356faf5
Update docs/fleet/provision.md
npentrel File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
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
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
--- | ||
title: "Manage viam-agent" | ||
linkTitle: "Manage viam-agent" | ||
weight: 80 | ||
no_list: true | ||
type: docs | ||
draft: false | ||
images: ["/installation/thumbnails/manage.png"] | ||
imageAlt: "Manage viam-agent" | ||
description: "Control and troubleshoot viam-agent." | ||
--- | ||
|
||
[`viam-agent`](/configure/agent/) is installed as a `systemd` service named `viam-agent`. | ||
|
||
- To start `viam-agent`: | ||
|
||
```sh {class="command-line" data-prompt="$"} | ||
sudo systemctl start viam-agent | ||
``` | ||
|
||
- To stop `viam-agent`: | ||
|
||
{{< alert title="Alert" color="note" >}} | ||
When you stop `viam-agent`, the agent will stop `viam-server` as well. | ||
{{< /alert >}} | ||
|
||
```sh {class="command-line" data-prompt="$"} | ||
sudo systemctl stop viam-agent | ||
``` | ||
|
||
- To restart `viam-agent`: | ||
|
||
{{< alert title="Alert" color="note" >}} | ||
When you restart `viam-agent`, the agent will restart `viam-server` as well. | ||
{{< /alert >}} | ||
|
||
```sh {class="command-line" data-prompt="$"} | ||
sudo systemctl restart viam-agent | ||
``` | ||
|
||
- To completely uninstall `viam-agent` and `viam-server`, run the following command: | ||
|
||
```sh {class="command-line" data-prompt="$"} | ||
sudo /bin/sh -c "$(curl -fsSL https://storage.googleapis.com/packages.viam.com/apps/viam-agent/uninstall.sh)" | ||
``` | ||
|
||
This command uninstalls `viam-agent`, `viam-server`, the machine configuration file (<file>/etc/viam.json</file>), and the provisioning configuration file (<file>/etc/viam-provisioning.json</file>). | ||
|
||
## Troubleshooting | ||
|
||
You can find assistance in the [Troubleshooting section](/appendix/troubleshooting/). |
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
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
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should probably also include the enable and disable commands (similar to what's on the viam-server version of this page) The commands are almost the same, "viam-server" just becomes "viam-agent" in each.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Still think this would be good to add, especially as this is now linked from the alert about "Automatic Startup"