Skip to content

Commit cc86a96

Browse files
committed
Update fleet content (#3729)
1 parent 52099de commit cc86a96

File tree

13 files changed

+769
-791
lines changed

13 files changed

+769
-791
lines changed

docs/dev/tools/how-tos/_index.md

-93
This file was deleted.

docs/dev/tools/how-tos/configure-teleop-workspace.md

-93
This file was deleted.

docs/manage/_index.md

+25-9
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,41 @@ open_on_desktop: true
99
overview: true
1010
---
1111

12+
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" >}}.
13+
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.
14+
15+
For example, you might have 30 robots in one warehouse and 500 in another.
16+
You can monitor and teleoperate all of the robots from one online dashboard, and grant permission to other users to do the same.
17+
You can grant users different levels of access to individual machines or to groups of machines.
18+
19+
---
20+
21+
Viam fleet management allows you to organize, manage, and control any number of machines alone or in collaboration with others.
22+
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/).
23+
24+
1225
{{< how-to-expand "Deploy software to machines" "4" "BEGINNER-FRIENDLY" >}}
1326
{{< cards >}}
14-
{{% card link="/how-tos/configure/" noimage="true" %}}
15-
{{% card link="/how-tos/one-to-many/" noimage="true" %}}
16-
{{% card link="/how-tos/provision-setup/" noimage="true" %}}
17-
{{% card link="/how-tos/provision/" noimage="true" %}}
27+
{{% card link="/manage/deploy/provision/" noimage="true" %}}
28+
{{% card link="/manage/deploy/one-to-many/" noimage="true" %}}
29+
{{% card link="/manage/deploy/ota/" noimage="true" %}}
30+
{{% card link="/manage/deploy/setup/" noimage="true" %}}
31+
{{% card link="/manage/deploy/update/" noimage="true" %}}
1832
{{< /cards >}}
1933
{{< /how-to-expand >}}
2034

2135
{{< how-to-expand "Manage a large fleet of machines" "2" "INTERMEDIATE" >}}
2236
{{< cards >}}
23-
{{% card link="/how-tos/manage-fleet/" noimage="true" %}}
24-
{{% card link="/how-tos/deploy-packages/" noimage="true" %}}
37+
{{% card link="/manage/manage/organize/" noimage="true" %}}
38+
{{% card link="/manage/manage/access/" noimage="true" %}}
2539
{{< /cards >}}
2640
{{< /how-to-expand >}}
2741

28-
{{< how-to-expand "Troubleshooting" "2" "INTERMEDIATE" >}}
42+
{{< how-to-expand "Monitor & Troubleshooting" "4" "INTERMEDIATE" >}}
2943
{{< cards >}}
30-
{{% card link="/how-tos/manage-fleet/" noimage="true" %}}
31-
{{% card link="/how-tos/deploy-packages/" noimage="true" %}}
44+
{{% card link="/manage/troubleshoot/monitor/" noimage="true" %}}
45+
{{% card link="/manage/troubleshoot/teleoperate/" noimage="true" %}}
46+
{{% card link="/manage/troubleshoot/alert/" noimage="true" %}}
47+
{{% card link="/manage/troubleshoot/troubleshoot/" noimage="true" %}}
3248
{{< /cards >}}
3349
{{< /how-to-expand >}}

docs/manage/deploy/ota.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
linkTitle: "Deploy packages"
3-
title: "Deploy packages to machines (OTA)"
3+
title: "Deploy software packages to machines (OTA)"
44
weight: 10
55
layout: "docs"
66
type: "docs"

docs/manage/manage/_index.md

-12
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,3 @@ empty_node: true
88
open_on_desktop: true
99
header_only: true
1010
---
11-
12-
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" >}}.
13-
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.
14-
15-
For example, you might have 30 robots in one warehouse and 500 in another.
16-
You can monitor and teleoperate all of the robots from one online dashboard, and grant permission to other users to do the same.
17-
You can grant users different levels of access to individual machines or to groups of machines.
18-
19-
---
20-
21-
Viam fleet management allows you to organize, manage, and control any number of machines alone or in collaboration with others.
22-
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/).

docs/manage/manage/access.md

+11-4
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ weight: 20
55
layout: "docs"
66
type: "docs"
77
no_list: true
8-
description: "TODO"
8+
description: "To collaborate with others on your machines, you can grant users permissions for individual machines or entire locations."
99
---
1010

11-
To collaborate with others on your machines, you can grant individual collaborators or entire organizations granular permissions for individual machines or entire locations.
12-
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.
11+
To collaborate with others on your machines, you can grant users permissions for individual machines or entire locations.
12+
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.
1313

1414
## Grant access
1515

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

9696
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.
9797

98-
## Simultaneous configuration changes
98+
## Rotate an API key
99+
100+
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.
101+
102+
Viam supports flexible key rotation with up to two keys in use at one time.
103+
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.
104+
105+
## Collaborate safely
99106

100107
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.
101108
This means everyone who has access can change a fleet's [configuration](machines/#configure), even while your machines are running.

docs/manage/manage/organize.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ weight: 10
55
layout: "docs"
66
type: "docs"
77
no_list: true
8-
description: "TODO"
8+
description: "Organize and manage access to your fleet by grouping machines into organizations and locations."
99
aliases:
1010
- /fleet/account/
1111
- /cloud/account/
@@ -26,6 +26,8 @@ You cannot move machines to other locations once created.
2626
{{<imgproc src="/fleet/fleet.svg" class="fill aligncenter" resize="800x" style="width: 600px" declaredimensions=true alt="Two locations within an organization">}}
2727
</p>
2828

29+
## Create organizations and locations
30+
2931
{{< table >}}
3032
{{% tablestep link="/cloud/organizations/" %}}
3133
**1. Create organizations**
@@ -67,6 +69,6 @@ You can nest locations up to three levels deep.
6769
{{% /tablestep %}}
6870
{{< /table >}}
6971

70-
{{< alert title="Tip" color="tip" >}}
72+
## Example
73+
7174
If you'd like to look at an example, see [Monitor Air Quality with a Fleet of Sensors](/tutorials/control/air-quality-fleet/#example).
72-
{{< /alert >}}

docs/manage/reference/agent.md

+6-10
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,9 @@ Your machine must have `curl` available in order to install `viam-agent`.
4545
2. Navigate to the **CONFIGURE** tab and find your machine's card.
4646
An alert will be present directing you to **Set up your machine part**:
4747

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

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

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

8690
Edit and fill in the attributes as applicable.
8791

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

345349
These log messages include when `viam-server` is stopped and started, the status of agent subsystems, and any errors or warnings encountered during operation.
346-
347-
## Next Steps
348-
349-
To see how to provision machines using `viam-agent`, see:
350-
351-
{{< cards >}}
352-
{{% card link="/fleet/provision/" %}}
353-
{{< /cards >}}

docs/manage/reference/processes.md

-4
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,6 @@ To run a program or control code when your machine is online, configure a _{{< g
1515
The process is managed by `viam-server`.
1616
You can configure processes to run once upon startup or indefinitely.
1717

18-
{{< alert title="In this page" color="note" >}}
19-
{{% toc %}}
20-
{{< /alert >}}
21-
2218
## Configure a process
2319

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

0 commit comments

Comments
 (0)