From 3f61f5540dd9437759ea2de6b38f805ebd05468e Mon Sep 17 00:00:00 2001 From: James Carppe Date: Mon, 11 Sep 2023 04:37:10 +0000 Subject: [PATCH] GITBOOK-35: Add note re host management features to Agent install instructions --- admin/environments/add/docker/agent.md | 8 ++++++++ admin/environments/add/swarm/agent.md | 8 ++++++++ 2 files changed, 16 insertions(+) diff --git a/admin/environments/add/docker/agent.md b/admin/environments/add/docker/agent.md index d63bd980..d51297b9 100644 --- a/admin/environments/add/docker/agent.md +++ b/admin/environments/add/docker/agent.md @@ -23,6 +23,14 @@ From the menu select **Environments** then click **Add environment**. Next, select **Docker Standalone** as the environment type then click **Start Wizard**. Select the **Agent** option, then your environment type. Copy the command for your environment type and run it on your Docker Standalone instance. For example, if you are deploying on a Linux machine or a Windows machine with WSL installed, use the **Linux & Windows WSL** command. If you are deploying on a Windows machine with WCS, use the **Windows WCS** command. +{% hint style="info" %} +If you want to use the [host management features](../../../../user/docker/host/setup.md#enable-host-management-features) of the Portainer Agent, you should add the necessary volume mount to the command that Portainer provides: + +``` +-v /:/host +``` +{% endhint %} + Once the Agent has been deployed, enter the environment details using the table below as a guide: | Field/Option | Overview | diff --git a/admin/environments/add/swarm/agent.md b/admin/environments/add/swarm/agent.md index f2296b32..b684f466 100644 --- a/admin/environments/add/swarm/agent.md +++ b/admin/environments/add/swarm/agent.md @@ -33,6 +33,14 @@ Next, select **Docker Swarm** as the environment type then click **Start Wizard* You must run the command on the Docker Swarm cluster before entering the environment details. {% endhint %} +{% hint style="info" %} +If you want to use the [host management features](../../../../user/docker/swarm/setup.md#host-and-filesystem) of the Portainer Agent, you should add the necessary volume mount to the command that Portainer provides: + +``` +--mount type=bind,src=//,dst=/host +``` +{% endhint %} +
The deployment command will return something similar to this: