Skip to content

Commit

Permalink
Update fleet content
Browse files Browse the repository at this point in the history
  • Loading branch information
npentrel committed Dec 4, 2024
1 parent 628d171 commit 72a7c22
Show file tree
Hide file tree
Showing 13 changed files with 769 additions and 791 deletions.
93 changes: 0 additions & 93 deletions docs/dev/tools/how-tos/_index.md

This file was deleted.

93 changes: 0 additions & 93 deletions docs/dev/tools/how-tos/configure-teleop-workspace.md

This file was deleted.

34 changes: 25 additions & 9 deletions docs/manage/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,41 @@ open_on_desktop: true
overview: true
---

You can use Viam's cloud-based fleet management tools to monitor and manage access to your fleet of {{< glossary_tooltip term_id="smart-machine" text="smart machines" >}}.
Use these tools as you create and scale a new fleet of smart machines, or integrate Viam to manage and add functionality like data management to your existing fleet.

For example, you might have 30 robots in one warehouse and 500 in another.
You can monitor and teleoperate all of the robots from one online dashboard, and grant permission to other users to do the same.
You can grant users different levels of access to individual machines or to groups of machines.

---

Viam fleet management allows you to organize, manage, and control any number of machines alone or in collaboration with others.
You can manage and control your fleet of {{< glossary_tooltip term_id="machine" text="smart machines" >}} from the [Viam app](https://app.viam.com), using the [CLI](/cli/), or using the [fleet management API](/appendix/apis/fleet/).


{{< how-to-expand "Deploy software to machines" "4" "BEGINNER-FRIENDLY" >}}
{{< cards >}}
{{% card link="/how-tos/configure/" noimage="true" %}}
{{% card link="/how-tos/one-to-many/" noimage="true" %}}
{{% card link="/how-tos/provision-setup/" noimage="true" %}}
{{% card link="/how-tos/provision/" noimage="true" %}}
{{% card link="/manage/deploy/provision/" noimage="true" %}}
{{% card link="/manage/deploy/one-to-many/" noimage="true" %}}
{{% card link="/manage/deploy/ota/" noimage="true" %}}
{{% card link="/manage/deploy/setup/" noimage="true" %}}
{{% card link="/manage/deploy/update/" noimage="true" %}}
{{< /cards >}}
{{< /how-to-expand >}}

{{< how-to-expand "Manage a large fleet of machines" "2" "INTERMEDIATE" >}}
{{< cards >}}
{{% card link="/how-tos/manage-fleet/" noimage="true" %}}
{{% card link="/how-tos/deploy-packages/" noimage="true" %}}
{{% card link="/manage/manage/organize/" noimage="true" %}}
{{% card link="/manage/manage/access/" noimage="true" %}}
{{< /cards >}}
{{< /how-to-expand >}}

{{< how-to-expand "Troubleshooting" "2" "INTERMEDIATE" >}}
{{< how-to-expand "Monitor & Troubleshooting" "4" "INTERMEDIATE" >}}
{{< cards >}}
{{% card link="/how-tos/manage-fleet/" noimage="true" %}}
{{% card link="/how-tos/deploy-packages/" noimage="true" %}}
{{% card link="/manage/troubleshoot/monitor/" noimage="true" %}}
{{% card link="/manage/troubleshoot/teleoperate/" noimage="true" %}}
{{% card link="/manage/troubleshoot/alert/" noimage="true" %}}
{{% card link="/manage/troubleshoot/troubleshoot/" noimage="true" %}}
{{< /cards >}}
{{< /how-to-expand >}}
2 changes: 1 addition & 1 deletion docs/manage/deploy/ota.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
linkTitle: "Deploy packages"
title: "Deploy packages to machines (OTA)"
title: "Deploy software packages to machines (OTA)"
weight: 10
layout: "docs"
type: "docs"
Expand Down
12 changes: 0 additions & 12 deletions docs/manage/manage/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,3 @@ empty_node: true
open_on_desktop: true
header_only: true
---

You can use Viam's cloud-based fleet management tools to monitor and manage access to your fleet of {{< glossary_tooltip term_id="smart-machine" text="smart machines" >}}.
Use these tools as you create and scale a new fleet of smart machines, or integrate Viam to manage and add functionality like data management to your existing fleet.

For example, you might have 30 robots in one warehouse and 500 in another.
You can monitor and teleoperate all of the robots from one online dashboard, and grant permission to other users to do the same.
You can grant users different levels of access to individual machines or to groups of machines.

---

Viam fleet management allows you to organize, manage, and control any number of machines alone or in collaboration with others.
You can manage and control your fleet of {{< glossary_tooltip term_id="machine" text="smart machines" >}} from the [Viam app](https://app.viam.com), using the [CLI](/cli/), or using the [fleet management API](/appendix/apis/fleet/).
15 changes: 11 additions & 4 deletions docs/manage/manage/access.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ weight: 20
layout: "docs"
type: "docs"
no_list: true
description: "TODO"
description: "To collaborate with others on your machines, you can grant users permissions for individual machines or entire locations."
---

To collaborate with others on your machines, you can grant individual collaborators or entire organizations granular permissions for individual machines or entire locations.
You can use the [Viam app](https://app.viam.com) or the [Viam mobile app](/fleet/control/#control-interface-in-the-viam-mobile-app) to grant or revoke organization owner or operator access to users on the go.
To collaborate with others on your machines, you can grant users permissions for individual machines or entire locations.
You can use the [Viam app](https://app.viam.com) or the [Viam mobile app](/fleet/control/#control-interface-in-the-viam-mobile-app) to grant or revoke organization owner or operator access to users or API keys.

## Grant access

Expand Down Expand Up @@ -95,7 +95,14 @@ You can also remove the user by clicking on **Remove user**.

You can remove any organization except the primary owner from the shared list by clicking the **X** to the right of the location in the shared list.

## Simultaneous configuration changes
## Rotate an API key

If you ever need to rotate an API key, click on the **Generate Key** button on the organization setting page to generate a new key.

Viam supports flexible key rotation with up to two keys in use at one time.
After generating a new secret key, update all references to the key in your code as soon as possible and then remove the old key.

## Collaborate safely

When you or your collaborators change the configuration of a machine or a group of machines in the Viam app, `viam-server` automatically synchronizes the configuration and updates the running resources within 15 seconds.
This means everyone who has access can change a fleet's [configuration](machines/#configure), even while your machines are running.
Expand Down
8 changes: 5 additions & 3 deletions docs/manage/manage/organize.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ weight: 10
layout: "docs"
type: "docs"
no_list: true
description: "TODO"
description: "Organize and manage access to your fleet by grouping machines into organizations and locations."
aliases:
- /fleet/account/
- /cloud/account/
Expand All @@ -26,6 +26,8 @@ You cannot move machines to other locations once created.
{{<imgproc src="/fleet/fleet.svg" class="fill aligncenter" resize="800x" style="width: 600px" declaredimensions=true alt="Two locations within an organization">}}
</p>

## Create organizations and locations

{{< table >}}
{{% tablestep link="/cloud/organizations/" %}}
**1. Create organizations**
Expand Down Expand Up @@ -67,6 +69,6 @@ You can nest locations up to three levels deep.
{{% /tablestep %}}
{{< /table >}}

{{< alert title="Tip" color="tip" >}}
## Example

If you'd like to look at an example, see [Monitor Air Quality with a Fleet of Sensors](/tutorials/control/air-quality-fleet/#example).
{{< /alert >}}
16 changes: 6 additions & 10 deletions docs/manage/reference/agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,9 @@ Your machine must have `curl` available in order to install `viam-agent`.
2. Navigate to the **CONFIGURE** tab and find your machine's card.
An alert will be present directing you to **Set up your machine part**:

![Machine setup alert in a newly created machine](/installation/setup-part.png)
<p>
{{<imgproc src="/installation/setup-part.png" resize="800x" declaredimensions=true alt="Machine setup alert in a newly created machine" class="imgzoom aligncenter">}}
</p>

Click **View setup instructions** to open the setup instructions.
Then navigate to the machine part's setup and follow the instructions to install `viam server` with `viam-agent`.
Expand Down Expand Up @@ -81,7 +83,9 @@ For information on managing the service, see [Manage `viam-agent`](/installation
Navigate to the **CONFIGURE** tab of your machine's page in the [Viam app](https://app.viam.com).
Click the **+** icon next to your machine part in the left-hand menu and select **Agent**.

{{< imgproc src="/configure/agent.png" alt="Configuration of viam-agent" resize="1200x" style="width=600x" >}}
<p>
{{< imgproc src="/configure/agent.png" alt="Configuration of viam-agent" resize="1200x" style="width:600px" class="imgzoom aligncenter">}}
</p>

Edit and fill in the attributes as applicable.

Expand Down Expand Up @@ -338,11 +342,3 @@ You can find these messages on the [**LOGS** tab](/cloud/machines/#logs) of your
If your machine is offline, log messages are queued and are sent to the Viam app once your machine reconnects to the internet.

These log messages include when `viam-server` is stopped and started, the status of agent subsystems, and any errors or warnings encountered during operation.

## Next Steps

To see how to provision machines using `viam-agent`, see:

{{< cards >}}
{{% card link="/fleet/provision/" %}}
{{< /cards >}}
4 changes: 0 additions & 4 deletions docs/manage/reference/processes.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,6 @@ To run a program or control code when your machine is online, configure a _{{< g
The process is managed by `viam-server`.
You can configure processes to run once upon startup or indefinitely.

{{< alert title="In this page" color="note" >}}
{{% toc %}}
{{< /alert >}}

## Configure a process

Navigate to the **CONFIGURE** tab of your machine's page in the [Viam app](https://app.viam.com).
Expand Down
Loading

0 comments on commit 72a7c22

Please sign in to comment.