centersl/portainer-docs
1
0
Fork 0
mirror of https://github.com/portainer/portainer-docs.git synced 2026-03-27 12:58:32 +07:00
Code Issues Packages Projects Releases Wiki Activity

GITBOOK-50: Add BE-only note to tunnel server address field

Browse Source
This commit is contained in:
James Carppe
2023-03-14 01:06:21 +00:00
committed by gitbook-bot
parent f25be16ff9
commit 71e294fbcd
31 changed files with 38 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
.gitbook/assets/2.12.2-stacks-edit-editor-webhook (1) (1).png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 65 KiB

BIN
.gitbook/assets/2.15-create_first_user (1) (1) (1).png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 152 KiB

BIN
.gitbook/assets/2.15-custom-templates (1) (1) (1).gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 431 KiB

BIN
.gitbook/assets/2.15-docker_api_more_settings (1) (1) (1).png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 104 KiB

BIN
.gitbook/assets/2.15-docker_services_list (1) (1) (1).png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 134 KiB

2
admin/environments/add/aci.md
View File

@@ -11,7 +11,7 @@ The following ACI features are not currently supported:
To add an ACI environment, click on **Environments** then click the **Add environment** button.
<figure><img src="../../../.gitbook/assets/2.16-environments-add.gif" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/2.16-environments-add (1).gif" alt=""><figcaption></figcaption></figure>
Select **ACI** as your environment type and click **Start Wizard**. Enter the **environment details** using the table below as a guide.

8
admin/environments/add/docker.md
View File

@@ -8,7 +8,7 @@ Before you begin, you will need to ensure that your Docker instance is configure
From the menu select **Environments** then click **Add environment**.
<figure><img src="../../../.gitbook/assets/2.16-environments-add.gif" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/2.16-environments-add (1).gif" alt=""><figcaption></figcaption></figure>
Next, select **Docker Standalone** as the environment type then click **Start Wizard**. Select the **API** option and your platform, then enter the environment details using the table below as a guide:
@@ -30,7 +30,7 @@ Portainer expects TLS certificates and keys to be in PEM format.
As an optional step you can expand the **More settings** section to add GPUs to your environment, and to categorize the environment by adding it to a [group](../groups.md) or [tagging](../tags.md) it for better searchability.
<figure><img src="../../../.gitbook/assets/2.15-docker_api_more_settings (2).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/2.15-docker_api_more_settings (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
When you're ready, click **Connect**. If you have other environments to configure click **Next** to proceed, otherwise click **Close** to return to the list of environments.
@@ -38,7 +38,7 @@ When you're ready, click **Connect**. If you have other environments to configur
From the menu select **Environments** then click **Add environment**.
<figure><img src="../../../.gitbook/assets/2.16-environments-add.gif" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/2.16-environments-add (1).gif" alt=""><figcaption></figcaption></figure>
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.
@@ -53,6 +53,6 @@ Once the Agent has been deployed, enter the environment details using the table
As an optional step you can expand the **More settings** section to add GPUs to your environment, and to categorize the environment by adding it to a [group](../groups.md) or [tagging](../tags.md) it for better searchability.
<figure><img src="../../../.gitbook/assets/2.15-docker_api_more_settings (2).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/2.15-docker_api_more_settings (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
When you're ready, click **Connect**. If you have other environments to configure click **Next** to proceed, otherwise click **Close** to return to the list of environments.

2
admin/environments/add/edge.md
View File

@@ -20,7 +20,7 @@ The Edge Agent communicates with the Portainer Server instance over port `8000`
To add an Edge Agent, click on **Environments** then **Add environment**.&#x20;
<figure><img src="../../../.gitbook/assets/2.16-environments-add (1).gif" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/2.16-environments-add.gif" alt=""><figcaption></figcaption></figure>
Select either Docker or Kubernetes depending on your environment type, then click **Start Wizard**. Then select the **Edge Agent** option. Enter the environment details **** using the table below as a guide.

2
admin/environments/add/kubernetes.md
View File

@@ -16,7 +16,7 @@ Helm charts for agent-only deployments will be available soon.
From the menu select **Environments** then click **Add environment**.
<figure><img src="../../../.gitbook/assets/2.16-environments-add.gif" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/2.16-environments-add (1).gif" alt=""><figcaption></figcaption></figure>
Select the **Kubernetes** option and click **Start Wizard**. Select the **Agent** option and choose the tab that matches your configuration (**Kubernetes via load balancer** or **Kubernetes via node port**). Copy the command, then run it on the control node of your Kubernetes cluster.

4
admin/environments/add/nomad.md
View File

@@ -4,7 +4,7 @@ Nomad support in Portainer is provided through the use of the [Portainer Edge Ag
To add a Nomad environment, click on **Environments** then click the **Add environment** button.
<figure><img src="../../../.gitbook/assets/2.16-environments-add (1).gif" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/2.16-environments-add.gif" alt=""><figcaption></figcaption></figure>
Select **Nomad** as your environment type and click **Start Wizard**. Enter the **environment details** using the table below as a guide.
@@ -13,7 +13,7 @@ Select **Nomad** as your environment type and click **Start Wizard**. Enter the
| Name | Enter a name for your environment. |
| Portainer server URL | Enter the URL and port of your Portainer Server instance as it will be seen from your Nomad environment. If using a FQDN, ensure that DNS is properly configured to provide this. |
<figure><img src="../../../.gitbook/assets/2.15-nomad_env (1).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/2.15-nomad_env.png" alt=""><figcaption></figcaption></figure>
As an optional step you can expand the **More settings** section and adjust the Poll frequency for the environment - this defines how often this Edge Agent will check the Portainer Server for new jobs. The default is every 5 seconds. You can also categorize the environment by adding it to a [group](../groups.md) or [tagging](../tags.md) it for better searchability.

4
admin/environments/add/swarm.md
View File

@@ -4,7 +4,7 @@
From the menu select **Environments** then click **Add environment**.
<figure><img src="../../../.gitbook/assets/2.16-environments-add.gif" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/2.16-environments-add (1).gif" alt=""><figcaption></figcaption></figure>
Next, select **Docker Swarm** as the environment type then click **Start Wizard**. Select the **Agent** option and your platform. Copy the command, then run it on the manager node of your Docker Swarm cluster.
@@ -53,6 +53,6 @@ Only do this **once** for your environment, regardless of how many nodes are in
As an optional step you can expand the **More settings** section and categorize the environment by adding it to a [group](../groups.md) or [tagging](../tags.md) it for better searchability.
<figure><img src="../../../.gitbook/assets/2.15-docker_api_more_settings (2).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/2.15-docker_api_more_settings (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
When you're ready, click **Connect**. If you have other environments to configure click **Next** to proceed, otherwise click **Close** to return to the list of environments.\

2
admin/users/password.md
View File

@@ -6,4 +6,4 @@ From the menu select **Users** then select the user whose password you want to r
Enter a new strong password, re-enter the password to confirm it then click **Update password**.
<figure><img src="../../.gitbook/assets/2.15-settings-users-changepw.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/2.15-settings-users-changepw (1).png" alt=""><figcaption></figcaption></figure>

2
start/agent/aci.md
View File

@@ -11,7 +11,7 @@ The following ACI features are not currently supported:
To add an ACI environment, click on **Environments** then click the **Add environment** button.
<figure><img src="../../.gitbook/assets/2.16-environments-add (1).gif" alt=""><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/2.16-environments-add.gif" alt=""><figcaption></figcaption></figure>
Select **ACI** as your environment type and click **Start Wizard**. Enter the **environment details** using the table below as a guide.

12
start/agent/edge.md
View File

@@ -22,15 +22,15 @@ In addition, our instructions assume your environment meets [our requirements](.
To add an Edge Agent, click on **Environments** then **Add environment**.&#x20;
<figure><img src="../../.gitbook/assets/2.16-environments-add (1).gif" alt=""><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/2.16-environments-add.gif" alt=""><figcaption></figcaption></figure>
Select either **Docker Standalone**, **Docker Swarm** or **Kubernetes** depending on your environment type, then click **Start Wizard**. Then select the **Edge Agent** option. Enter the environment details **** using the table below as a guide.
| Field | Overview |
| ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name | Enter a name for your environment. |
| Portainer API server URL | Enter the URL and port of your Portainer Server instance as it will be seen from your Edge environment. If using a FQDN, ensure that DNS is properly configured to provide this. |
| Portainer tunnel server address | <p>Enter the address and port of your Portainer Server instance's tunnel server as it will be seen from your Edge environment. If using a FQDN, ensure that DNS is properly configured to provide this.<br>In most cases, this will be the same address as the Portainer API server URL, but without the protocol and on port <code>8000</code>.</p> |
| Field | Overview |
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name | Enter a name for your environment. |
| Portainer API server URL | Enter the URL and port of your Portainer Server instance as it will be seen from your Edge environment. If using a FQDN, ensure that DNS is properly configured to provide this. |
| Portainer tunnel server address | <p>Enter the address and port of your Portainer Server instance's tunnel server as it will be seen from your Edge environment. If using a FQDN, ensure that DNS is properly configured to provide this.<br>In most cases, this will be the same address as the Portainer API server URL, but without the protocol and on port <code>8000</code>.<br>This field is only available in Portainer Business Edition.</p> |
<figure><img src="../../.gitbook/assets/2.17-install-agent-edge-nameurl.png" alt=""><figcaption></figcaption></figure>

2
start/agent/kaas/README.md
View File

@@ -8,7 +8,7 @@ This feature is only available in [Portainer Business Edition](https://www.porta
To get started, select **Environments** from the left hand menu then click **Add Environment**.
<figure><img src="../../../.gitbook/assets/2.16-environments-add (1).gif" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/2.16-environments-add.gif" alt=""><figcaption></figcaption></figure>
From the wizard select the **KaaS** option and click **Start Wizard**. Then, select your provider. We currently support the following providers:

2
start/agent/kaas/civo.md
View File

@@ -6,7 +6,7 @@ Select the **Civo** option from the list of providers. If you haven't already pr
You can find more details on [setting up access to your Civo account](../../../admin/settings/cloud/civo.md) in the [cloud credentials documentation](../../../admin/settings/cloud/).
{% endhint %}
<figure><img src="../../../.gitbook/assets/2.15-kaas-civo-creds (1).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/2.15-kaas-civo-creds.png" alt=""><figcaption></figcaption></figure>
Once you have added your credentials (or if you already had them set up) select your cluster options from the fields below.

2
start/agent/kubernetes/baremetal.md
View File

@@ -32,7 +32,7 @@ Helm charts for agent-only deployments will be available soon.
From the menu select **Environments** then click **Add environment**.
<figure><img src="../../../.gitbook/assets/2.16-environments-add (1).gif" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/2.16-environments-add.gif" alt=""><figcaption></figcaption></figure>
Select the **Kubernetes** option and click **Start Wizard**. Select the **Agent** option and choose the tab that matches your configuration (**Kubernetes via load balancer** or **Kubernetes via node port**). Copy the command, then run it on the control node of your Kubernetes cluster.

4
start/agent/nomad.md
View File

@@ -4,7 +4,7 @@ Nomad support in Portainer is provided through the use of the [Portainer Edge Ag
To add a Nomad environment, click on **Environments** then click the **Add environment** button.
<figure><img src="../../.gitbook/assets/2.16-environments-add (1).gif" alt=""><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/2.16-environments-add.gif" alt=""><figcaption></figcaption></figure>
Select **Nomad** as your environment type and click **Start Wizard**. Enter the **environment details** using the table below as a guide.
@@ -13,7 +13,7 @@ Select **Nomad** as your environment type and click **Start Wizard**. Enter the
| Name | Enter a name for your environment. |
| Portainer server URL | Enter the URL and port of your Portainer Server instance as it will be seen from your Nomad environment. If using a FQDN, ensure that DNS is properly configured to provide this. |
<figure><img src="../../.gitbook/assets/2.15-nomad_env (1).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/2.15-nomad_env.png" alt=""><figcaption></figcaption></figure>
As an optional step you can expand the **More settings** section and adjust the Poll frequency for the environment - this defines how often this Edge Agent will check the Portainer Server for new jobs. The default is every 5 seconds. You can also categorize the environment by adding it to a [group](../../admin/environments/groups.md) or [tagging](../../admin/environments/tags.md) it for better searchability.

2
start/agent/swarm/linux.md
View File

@@ -32,7 +32,7 @@ Only do this **once** for your environment, regardless of how many nodes are in
From the menu select **Environments** then click **Add environment**.
<figure><img src="../../../.gitbook/assets/2.16-environments-add (1).gif" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/2.16-environments-add.gif" alt=""><figcaption></figcaption></figure>
Next, select **Docker Swarm** as the environment type then click **Start Wizard**. Select the **Agent** option and the **Linux & Windows WSL** tab. Copy the command, then run it on the manager node of your Docker Swarm cluster.

2
start/agent/swarm/wcs.md
View File

@@ -29,7 +29,7 @@ Only do this **once** for your environment, regardless of how many nodes are in
From the menu select **Environments** then click **Add environment**.
<figure><img src="../../../.gitbook/assets/2.16-environments-add (1).gif" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/2.16-environments-add.gif" alt=""><figcaption></figcaption></figure>
Next, select **Docker Swarm** as the environment type then click **Start Wizard**. Select the **Agent** option and the **Windows WCS** tab. Copy the command, then run it on the manager node of your Docker Swarm cluster.

2
start/agent/swarm/wsl.md
View File

@@ -33,7 +33,7 @@ Only do this **once** for your environment, regardless of how many nodes are in
From the menu select **Environments** then click **Add environment**.
<figure><img src="../../../.gitbook/assets/2.16-environments-add (1).gif" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/2.16-environments-add.gif" alt=""><figcaption></figcaption></figure>
Next, select **Docker Swarm** as the environment type then click **Start Wizard**. Select the **Agent** option and the **Linux & Windows WSL** tab. Copy the command, then run it on the manager node of your Docker Swarm cluster.

2
user/docker/host/setup.md
View File

@@ -42,7 +42,7 @@ This setting allows you to specify a window within which [automatic updates](../
If this setting is enabled and an update is made to an application outside of this window, it will not be applied.
{% endhint %}
<figure><img src="../../../.gitbook/assets/2.15-docker_hosts_change_windows_settings (1).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/2.15-docker_hosts_change_windows_settings.png" alt=""><figcaption></figcaption></figure>
## Docker Security Settings

2
user/docker/images/pull.md
View File

@@ -12,7 +12,7 @@ This method lets you pull images from Docker Hub or from another registry that y
From the menu select **Images**. Select the registry to use then enter the name of the image. On a multi-node environment, select the node to deploy to.
<figure><img src="../../../.gitbook/assets/2.15-docker_images_pull_images.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/2.15-docker_images_pull_images (1).png" alt=""><figcaption></figcaption></figure>
When you're ready, click **Pull the image**.

2
user/docker/services/README.md
View File

@@ -6,7 +6,7 @@ The **Services** menu is only available to Docker Swarm endpoints.
A service consists of an image definition and container configuration as well as instructions on how those containers will be deployed across a Swarm cluster.
<figure><img src="../../../.gitbook/assets/2.15-docker_services_list (1).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/2.15-docker_services_list (1) (1).png" alt=""><figcaption></figcaption></figure>
When the [new image notification](../swarm/setup.md#other) feature is enabled, the circle next to the image name indicates whether the local image is up to date, with a green circle indicating it is up to date and a red circle indicating that there is a newer version of the image available at the remote registry. A grey circle indicates Portainer was unable to determine whether there is an update available for the image.

2
user/docker/services/configure.md
View File

@@ -14,7 +14,7 @@ In this section you can:
* View the [service logs](logs.md).
* Update, [roll back](rollback.md) or delete the service.
<figure><img src="../../../.gitbook/assets/2.15-docker_services_service_details (1).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/2.15-docker_services_service_details.png" alt=""><figcaption></figcaption></figure>
## Container specification configuration options

2
user/docker/stacks/add.md
View File

@@ -83,7 +83,7 @@ env_file:
Note the compose file is not changed when environment variables are used - this allows variables to be updated within Portainer without editing the compose file itself which would take it out of sync with your local copy. You will still see the `${MY_ENVIRONMENT_VARIABLE}` style entry in the compose file.
{% endhint %}
<figure><img src="../../../.gitbook/assets/2.15-docker_add_stack_upload_env_var.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/2.15-docker_add_stack_upload_env_var (1).png" alt=""><figcaption></figcaption></figure>
When you're ready click **Deploy the stack**.

2
user/docker/swarm/setup.md
View File

@@ -29,7 +29,7 @@ This setting allows you to specify a window within which [automatic updates](../
If this setting is enabled and an update is made to an application outside of this window, it will not be applied.
{% endhint %}
<figure><img src="../../../.gitbook/assets/2.15-docker_hosts_change_windows_settings (1).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/2.15-docker_hosts_change_windows_settings.png" alt=""><figcaption></figcaption></figure>
## Docker Security Settings

2
user/docker/templates/custom.md
View File

@@ -10,7 +10,7 @@ You can also [create a template from an existing deployed stack](../stacks/templ
To view a list of custom templates, from the menu select **App Templates** then select **Custom Templates**.
<figure><img src="../../../.gitbook/assets/2.15-custom-templates (1) (1).gif" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/2.15-custom-templates (1).gif" alt=""><figcaption></figcaption></figure>
## Creating a new custom template

2
user/kubernetes/applications/detach-volume.md
View File

@@ -2,7 +2,7 @@
From the menu select **Applications**, select the application then click **Edit this application**.
<figure><img src="../../../.gitbook/assets/2.15-k8s_kubernetes_applications_edit_app.gif" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/2.15-k8s_kubernetes_applications_edit_app (1).gif" alt=""><figcaption></figcaption></figure>
Scroll down to the **Persisting data** section and click the trash can icon to the right of the volume. Scroll down and click **Update application**. When the confirmation message appears, click **Update**.

2
user/kubernetes/applications/edit.md
View File

@@ -2,7 +2,7 @@
From the menu select **Applications**, select the application you want to edit, then click **Edit this application**.
<figure><img src="../../../.gitbook/assets/2.15-k8s_kubernetes_applications_edit_app (1).gif" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/2.15-k8s_kubernetes_applications_edit_app.gif" alt=""><figcaption></figcaption></figure>
Your editing options will depend on how the application was deployed initially.

4
user/kubernetes/namespaces/add.md
View File

@@ -6,10 +6,10 @@ From the menu select **Namespaces** then click **Add namespace with form**.
Namespaces can also be added [using a manifest](../applications/manifest.md) by clicking **Create from manifest**.
{% endhint %}
<figure><img src="../../../.gitbook/assets/2.15-k8s_kubernetes_namespaces_add_namespace (1).gif" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/2.15-k8s_kubernetes_namespaces_add_namespace.gif" alt=""><figcaption></figcaption></figure>
In the next screen, give the namespace a descriptive name. As an optional step you can assign a quota by toggling **Resource assignment** on, then setting resource limits like how much memory and CPU will be assigned.
<figure><img src="../../../.gitbook/assets/2.15-kubernetes_namespaces_create_namespace_resource_assignment.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/2.15-kubernetes_namespaces_create_namespace_resource_assignment (1).png" alt=""><figcaption></figcaption></figure>
When you're finished, click **Create namespace**.