From 3b1b49baeab3cb949dc6178ae39153b286de76d3 Mon Sep 17 00:00:00 2001 From: James Carppe Date: Mon, 28 Jul 2025 03:43:34 +0000 Subject: [PATCH] GITBOOK-24: Add clarity around HTTPS usage by standard Agent deployments --- admin/environments/add/docker/agent.md | 8 ++++---- admin/environments/add/kubernetes/agent.md | 8 ++++---- admin/environments/add/podman/agent.md | 8 ++++---- admin/environments/add/swarm/agent.md | 2 +- admin/settings/general.md | 2 +- 5 files changed, 14 insertions(+), 14 deletions(-) diff --git a/admin/environments/add/docker/agent.md b/admin/environments/add/docker/agent.md index 818356d0..2d73d0a0 100644 --- a/admin/environments/add/docker/agent.md +++ b/admin/environments/add/docker/agent.md @@ -45,10 +45,10 @@ The right side of the mount should remain as `/var/lib/docker/volumes`, as that Once the Agent has been deployed, enter the environment details using the table below as a guide: -| Field/Option | Overview | -| ------------------- | -------------------------------------------------------------------------------------------------------------------- | -| Name | Give the environment a descriptive name. | -| Environment address | Enter the DNS name or IP address to connect to the Portainer Agent along with the port (the default port is `9001`). | +| Field/Option | Overview | +| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Name | Give the environment a descriptive name. | +| Environment address | Enter the DNS name or IP address to connect to the Portainer Agent along with the port (the default port is `9001`). Do not provide a protocol - communication with the Agent by the Server is performed over HTTPS with certificates generated by the Agent on installation. |
diff --git a/admin/environments/add/kubernetes/agent.md b/admin/environments/add/kubernetes/agent.md index 1cf7a52e..088b46e0 100644 --- a/admin/environments/add/kubernetes/agent.md +++ b/admin/environments/add/kubernetes/agent.md @@ -65,10 +65,10 @@ Regardless of the method used, once the agent is running on the Kubernetes host, Only do this **once** for your environment, regardless of how many nodes are in the cluster. You do **not** need to add each node as an individual environment in Portainer. Adding just one node will allow Portainer to manage the entire cluster. {% endhint %} -| Field/Option | Overview | -| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Name | Give the environment a descriptive name. | -| Environment address | Define the IP address or name used to connect to the environment (the Kubernetes host) and specify the port if required (`30778` when using NodePort; `9001` when using Load Balancer). | +| Field/Option | Overview | +| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Name | Give the environment a descriptive name. | +| Environment address | Define the IP address or name used to connect to the environment (the Kubernetes host) and specify the port if required (`30778` when using NodePort; `9001` when using Load Balancer). Do not provide a protocol - communication with the Agent by the Server is performed over HTTPS with certificates generated by the Agent on installation. |
diff --git a/admin/environments/add/podman/agent.md b/admin/environments/add/podman/agent.md index fe09c474..6876b0ea 100644 --- a/admin/environments/add/podman/agent.md +++ b/admin/environments/add/podman/agent.md @@ -41,10 +41,10 @@ The right side of the mount should remain as `/var/lib/docker/volumes`, as that Once the Agent has been deployed, enter the environment details using the table below as a guide: -| Field/Option | Overview | -| ------------------- | -------------------------------------------------------------------------------------------------------------------- | -| Name | Give the environment a descriptive name. | -| Environment address | Enter the DNS name or IP address to connect to the Portainer Agent along with the port (the default port is `9001`). | +| Field/Option | Overview | +| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Name | Give the environment a descriptive name. | +| Environment address | Enter the DNS name or IP address to connect to the Portainer Agent along with the port (the default port is `9001`). Do not provide a protocol - communication with the Agent by the Server is performed over HTTPS with certificates generated by the Agent on installation. |
diff --git a/admin/environments/add/swarm/agent.md b/admin/environments/add/swarm/agent.md index 0314cab4..c3d49a5f 100644 --- a/admin/environments/add/swarm/agent.md +++ b/admin/environments/add/swarm/agent.md @@ -81,7 +81,7 @@ Once the agent is running on the Docker Swarm cluster, enter the environment det Only do this **once** for your environment, regardless of how many nodes are in the cluster. You do **not** need to add each node as an individual environment in Portainer. Adding just one node (we recommend the manager node) will allow Portainer to manage the entire cluster. {% endhint %} -
FieldOverview
NameGive the environment a descriptive name.
Environment addressEnter the IP or DNS name at which the Portainer Server instance can reach the environment along with the port (9001).
+
FieldOverview
NameGive the environment a descriptive name.
Environment addressEnter the IP or DNS name at which the Portainer Server instance can reach the environment along with the port (9001). Do not provide a protocol - communication with the Agent by the Server is performed over HTTPS with certificates generated by the Agent on installation.
diff --git a/admin/settings/general.md b/admin/settings/general.md index 4b4d002e..bedaeb89 100644 --- a/admin/settings/general.md +++ b/admin/settings/general.md @@ -104,7 +104,7 @@ Make sure that your HTTPS configuration is working correctly **before** enabling {% endhint %} {% hint style="warning" %} -Ensure that any Edge agents have been correctly configured for HTTPS communication before enabling this. +Ensure that any Edge agents have been correctly configured for HTTPS communication before enabling this. This setting does **not** affect Standard Agent deployments, as these use HTTPS certificates generated by the Agent on installation. {% endhint %}