Portainer
/
portainer-docs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

GitBook: [#1155] Moved Upgrading Portainer to Getting Started section to improve visibility

ce-2.6
James Carppe 2021-10-19 02:20:01 +00:00 committed by gitbook-bot
parent 98d16f65ce
commit 823cc4d40d
No known key found for this signature in database
GPG Key ID: 07D2180C7B12D0FF
33 changed files with 237 additions and 231 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -3,12 +3,12 @@
Welcome to Portainer's official documentation site. Ours is an open source project and all community contributions are welcome and encouraged. If you're thinking about contributing to Portainer documentation, first read our [contribution guidelines](contribute/contribute.md). Welcome to Portainer's official documentation site. Ours is an open source project and all community contributions are welcome and encouraged. If you're thinking about contributing to Portainer documentation, first read our [contribution guidelines](contribute/contribute.md).
{% hint style="info" %} {% hint style="info" %}
You're currently reading the documentation for **Portainer Community Edition \(CE\)** version **2.6**. If you want to view the documentation for a different version, you can choose the version from the selector in the top left. You're currently reading the documentation for **Portainer Community Edition (CE)** version **2.6**. If you want to view the documentation for a different version, you can choose the version from the selector in the top left.
{% endhint %} {% endhint %}
## About Portainer ## About Portainer
Portainer Community Edition \(CE\) is our foundation. With over half a million regular users, CE is a powerful, open source toolset that allows you to easily build and manage containers in Docker, Docker Swarm, Kubernetes and Azure ACI. Portainer Community Edition (CE) is our foundation. With over half a million regular users, CE is a powerful, open source toolset that allows you to easily build and manage containers in Docker, Docker Swarm, Kubernetes, and Azure ACI.
Portainer hides the complexity of managing containers behind an easy-to-use UI. By removing the need to use the CLI, write YAML or understand manifests, Portainer makes deploying apps and troubleshooting problems so easy that anyone can do it. Portainer hides the complexity of managing containers behind an easy-to-use UI. By removing the need to use the CLI, write YAML or understand manifests, Portainer makes deploying apps and troubleshooting problems so easy that anyone can do it.
@ -16,7 +16,7 @@ Our team is here to help you on your journey. Engage with them any time through
## Documentation ## Documentation
We're working hard to ensure that our documentation keeps up with our ever-growing Portainer community. If you have a question or a task, we encourage you to start with the documentation \(right here!\). If you can't find what you're looking for, please visit one of our support channels. We're working hard to ensure that our documentation keeps up with our ever-growing Portainer community. If you have a question or a task, we encourage you to start with the documentation (right here!). If you can't find what you're looking for, please visit one of our support channels.
{% hint style="info" %} {% hint style="info" %}
As an open source product we rely on users in our community to support one another by asking questions, engaging in discussions and sharing knowledge. Together with the documentation found on this site and our [YouTube channel](https://www.youtube.com/channel/UC7diMJcrULjDseq5yhSUZgg), we cover a lot of ground but there may be gaps. As an open source product we rely on users in our community to support one another by asking questions, engaging in discussions and sharing knowledge. Together with the documentation found on this site and our [YouTube channel](https://www.youtube.com/channel/UC7diMJcrULjDseq5yhSUZgg), we cover a lot of ground but there may be gaps.
@ -24,12 +24,11 @@ As an open source product we rely on users in our community to support one anoth
## Community and support channels ## Community and support channels
* **Ask questions** either in [GitHub Issues](https://github.com/portainer/portainer/issues) or the [community Slack channel](https://portainer.slack.com/join/shared_invite/enQtNDk3ODQ5MjI2MjI4LTcwNGYxMWQ5OGViYWZkNDY2ZjY4YTMwMTgzYmU4YmNiOTU0MDcxYmJjNTIyYmQ0MTM5Y2QwNTg3NzNkMTk5MDg#/). Other platforms exist \(Reddit, Discord, Stack Overflow\) but we are less active in those spaces. * **Ask questions **either in [GitHub Issues](https://github.com/portainer/portainer/issues) or the [community Slack channel](https://portainer.slack.com/join/shared\_invite/enQtNDk3ODQ5MjI2MjI4LTcwNGYxMWQ5OGViYWZkNDY2ZjY4YTMwMTgzYmU4YmNiOTU0MDcxYmJjNTIyYmQ0MTM5Y2QwNTg3NzNkMTk5MDg#/). Other platforms exist (Reddit, Discord, Stack Overflow) but we are less active in those spaces.
* **Log bugs** in [GitHub Issues](https://github.com/portainer/portainer/issues) so they can be properly managed. * **Log bugs** in [GitHub Issues](https://github.com/portainer/portainer/issues) so they can be properly managed.
* **Flag vulnerabilities** by emailing [security@portainer.io](mailto:security@portainer.io) so we can deal with them immediately. * **Flag vulnerabilities** by emailing [security@portainer.io](mailto:security@portainer.io) so we can deal with them immediately.
* **Flag documentation issues** via our [GitHub documentation channel](https://github.com/portainer/portainer-docs/issues) \(or start [contributing](contribute/contribute.md) and make our documentation better!\). * **Flag documentation issues** via our [GitHub documentation channel](https://github.com/portainer/portainer-docs/issues) (or start [contributing](contribute/contribute.md) and make our documentation better!).
{% hint style="info" %} {% hint style="info" %}
We do not provide community support over email. We do not provide community support over email.
{% endhint %} {% endhint %}

31
SUMMARY.md
View File

@ -3,7 +3,7 @@
* [Welcome](README.md) * [Welcome](README.md)
* [Release Notes](release-notes.md) * [Release Notes](release-notes.md)
## Getting Started <a id="start"></a> ## Getting Started <a href="start" id="start"></a>
* [Introduction](start/intro.md) * [Introduction](start/intro.md)
* [Portainer architecture](start/architecture.md) * [Portainer architecture](start/architecture.md)
@ -36,8 +36,16 @@
* [Install Portainer Agent with Kubernetes on WSL / Docker Desktop](start/install/agent/kubernetes/wsl.md) * [Install Portainer Agent with Kubernetes on WSL / Docker Desktop](start/install/agent/kubernetes/wsl.md)
* [Azure ACI](start/install/agent/aci.md) * [Azure ACI](start/install/agent/aci.md)
* [Edge Agent](start/install/agent/edge.md) * [Edge Agent](start/install/agent/edge.md)
* [Upgrading Portainer](start/upgrade/README.md)
* [Upgrading on Docker](start/upgrade/docker.md)
* [Upgrading on Docker Swarm](start/upgrade/swarm.md)
* [Upgrading on Kubernetes](start/upgrade/kubernetes.md)
* [Switching from CE to Portainer Business](start/upgrade/tobe/README.md)
* [Docker Standalone](start/upgrade/tobe/docker.md)
* [Docker Swarm](start/upgrade/tobe/swarm.md)
* [Kubernetes](start/upgrade/tobe/kubernetes.md)
## Using Portainer <a id="user"></a> ## Using Portainer <a href="user" id="user"></a>
* [Docker/Swarm](user/docker/README.md) * [Docker/Swarm](user/docker/README.md)
* [Dashboard](user/docker/dashboard.md) * [Dashboard](user/docker/dashboard.md)
@ -125,7 +133,7 @@
* [Edge Stacks](user/edge/stacks.md) * [Edge Stacks](user/edge/stacks.md)
* [Edge Jobs](user/edge/jobs.md) * [Edge Jobs](user/edge/jobs.md)
## Administering Portainer <a id="admin"></a> ## Administering Portainer <a href="admin" id="admin"></a>
* [Users](admin/users/README.md) * [Users](admin/users/README.md)
* [Teams](admin/users/teams/README.md) * [Teams](admin/users/teams/README.md)
@ -159,16 +167,8 @@
* [Authentication](admin/settings/authentication/README.md) * [Authentication](admin/settings/authentication/README.md)
* [Authenticate via LDAP](admin/settings/authentication/ldap.md) * [Authenticate via LDAP](admin/settings/authentication/ldap.md)
* [Authenticate via OAuth](admin/settings/authentication/oauth.md) * [Authenticate via OAuth](admin/settings/authentication/oauth.md)
* [Upgrading Portainer](admin/upgrade/README.md)
* [Upgrading on Docker](admin/upgrade/docker.md)
* [Upgrading on Docker Swarm](admin/upgrade/swarm.md)
* [Upgrading on Kubernetes](admin/upgrade/kubernetes.md)
* [Switching from CE to Portainer Business](admin/upgrade/tobe/README.md)
* [Docker Standalone](admin/upgrade/tobe/docker.md)
* [Docker Swarm](admin/upgrade/tobe/swarm.md)
* [Kubernetes](admin/upgrade/tobe/kubernetes.md)
## Frequently Asked Questions <a id="faq"></a> ## Frequently Asked Questions <a href="faq" id="faq"></a>
* [Portainer Concepts](faq/concepts/README.md) * [Portainer Concepts](faq/concepts/README.md)
* [What is Portainer's architecture?](faq/concepts/what-is-portainers-architecture.md) * [What is Portainer's architecture?](faq/concepts/what-is-portainers-architecture.md)
@ -203,7 +203,7 @@
* [How do you decide which bugs and features to work on first?](faq/contributing/how-do-you-decide-which-bugs-and-features-to-work-on-first.md) * [How do you decide which bugs and features to work on first?](faq/contributing/how-do-you-decide-which-bugs-and-features-to-work-on-first.md)
* [How do I log a support ticket?](faq/contributing/how-do-i-log-a-support-ticket.md) * [How do I log a support ticket?](faq/contributing/how-do-i-log-a-support-ticket.md)
## Advanced Topics <a id="advanced"></a> ## Advanced Topics <a href="advanced" id="advanced"></a>
* [CLI configuration options](advanced/cli.md) * [CLI configuration options](advanced/cli.md)
* [App templates](advanced/app-templates/README.md) * [App templates](advanced/app-templates/README.md)
@ -228,13 +228,12 @@
## Get More Help ## Get More Help
* [YouTube](https://www.youtube.com/channel/UC7diMJcrULjDseq5yhSUZgg/videos) * [YouTube](https://www.youtube.com/channel/UC7diMJcrULjDseq5yhSUZgg/videos)
* [Slack](https://join.slack.com/t/portainer/shared_invite/zt-txh3ljab-52QHTyjCqbe5RibC2lcjKA) * [Slack](https://join.slack.com/t/portainer/shared\_invite/zt-txh3ljab-52QHTyjCqbe5RibC2lcjKA)
* [Discord](https://discord.com/invite/j8fVken) * [Discord](https://discord.com/invite/j8fVken)
## Contribute to Portainer <a id="contribute"></a> ## Contribute to Portainer <a href="contribute" id="contribute"></a>
* [Contribute](contribute/contribute.md) * [Contribute](contribute/contribute.md)
* [Build instructions](contribute/build/README.md) * [Build instructions](contribute/build/README.md)
* [Set up a macOS build environment](contribute/build/mac.md) * [Set up a macOS build environment](contribute/build/mac.md)
* [Set up a Linux build environment](contribute/build/linux.md) * [Set up a Linux build environment](contribute/build/linux.md)

3
admin/endpoints/access-groups.md
View File

@ -6,9 +6,8 @@ Endpoints can be [grouped](groups.md) for organizational purposes. If an endpoin
If you manually assign a user to an endpoint, and they are already assigned to it via a group, they will be tagged with `override` on the **Manage access** page, indicating that their individual access will override that of the group for this one endpoint. You can then modify their access in this special case. If you manually assign a user to an endpoint, and they are already assigned to it via a group, they will be tagged with `override` on the **Manage access** page, indicating that their individual access will override that of the group for this one endpoint. You can then modify their access in this special case.
{% endhint %} {% endhint %}
From the menu select **Endpoints** then select **Groups**. Locate the endpoint group you want to give users access to then select **Manage access** at the end of the row. From the menu select **Endpoints** then select** Groups**. Locate the endpoint group you want to give users access to then select **Manage access** at the end of the row.
![](../../.gitbook/assets/endpoints-access-groups-1.gif) ![](../../.gitbook/assets/endpoints-access-groups-1.gif)
Next, select the users or teams you want to add using the dropdown. Once all have been selected, click **Create access**. Next, select the users or teams you want to add using the dropdown. Once all have been selected, click **Create access**.

53
admin/endpoints/add/docker.md
View File

@ -14,13 +14,13 @@ From the menu select **Endpoints** then click **Add endpoint**.
Next, select **Docker** as the **environment type** then enter the environment details using the table below as a guide: Next, select **Docker** as the **environment type** then enter the environment details using the table below as a guide:
| Field/Option | Overview | | Field/Option | Overview |
| :--- | :--- | | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
| Name | Give the endpoint a descriptive name. | | Name | Give the endpoint a descriptive name. |
| Connect via socket | Leave this option toggled off. | | Connect via socket | Leave this option toggled off. |
| Endpoint URL | Enter the DNS name or IP address to connect to the Docker host along with the port. When connecting without TLS, the default port is `2375`. | | Endpoint URL | Enter the DNS name or IP address to connect to the Docker host along with the port. When connecting without TLS, the default port is `2375`. |
| Public IP | Enter the URL or IP address where exposed containers will be reachable. This is an optional field \(defaults to the endpoint URL\). | | Public IP | Enter the URL or IP address where exposed containers will be reachable. This is an optional field (defaults to the endpoint URL). |
| TLS | Leave this option toggled off. | | TLS | Leave this option toggled off. |
![](../../../.gitbook/assets/endpoints-add-docker-2.png) ![](../../../.gitbook/assets/endpoints-add-docker-2.png)
@ -40,22 +40,22 @@ From the menu select **Endpoints** then click **Add endpoint**.
From the **Environment type** section select **Docker**, then enter the environment details using the table below as a guide: From the **Environment type** section select **Docker**, then enter the environment details using the table below as a guide:
| Field/Option | Overview | | Field/Option | Overview |
| :--- | :--- | | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
| Name | Give the endpoint a descriptive name. | | Name | Give the endpoint a descriptive name. |
| Connect via socket | Leave this option toggled off. | | Connect via socket | Leave this option toggled off. |
| Endpoint URL | Enter the DNS name or IP address to connect to the Docker host along with the port. When connecting with TLS, the default port is `2376`. | | Endpoint URL | Enter the DNS name or IP address to connect to the Docker host along with the port. When connecting with TLS, the default port is `2376`. |
| Public IP | Enter the URL or IP address where exposed containers will be reachable. This is an optional field \(defaults to the endpoint URL\). | | Public IP | Enter the URL or IP address where exposed containers will be reachable. This is an optional field (defaults to the endpoint URL). |
| TLS | Toggle this option on then select the TLS mode. | | TLS | Toggle this option on then select the TLS mode. |
![](../../../.gitbook/assets/endpoints-add-docker-3.png) ![](../../../.gitbook/assets/endpoints-add-docker-3.png)
| Field/Option | Overview | | Field/Option | Overview |
| :--- | :--- | | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| TLS mode | Select the mode that best fits your configuration. In most cases, this will be the default **TLS with server and client verification** option. The next options change, depending on what you select here. | | TLS mode | Select the mode that best fits your configuration. In most cases, this will be the default **TLS with server and client verification** option. The next options change, depending on what you select here. |
| TLS CA certificate | Select your CA certificate. | | TLS CA certificate | Select your CA certificate. |
| TLS certificate | Select your certificate. | | TLS certificate | Select your certificate. |
| TLS key | Select the key that matches the certificate. | | TLS key | Select the key that matches the certificate. |
![](../../../.gitbook/assets/endpoints-add-docker-4.png) ![](../../../.gitbook/assets/endpoints-add-docker-4.png)
@ -71,7 +71,7 @@ When you're ready click **Add endpoint**.
## Method 2: Connecting via the Portainer Agent ## Method 2: Connecting via the Portainer Agent
First, install the Portainer Agent on your Docker Standalone instance using our [platform-specific instructions](). When this is done, you will be able to add the endpoint to Portainer. First, install the Portainer Agent on your Docker Standalone instance using our [platform-specific instructions](broken-reference). When this is done, you will be able to add the endpoint to Portainer.
From the menu select **Endpoints** then click **Add endpoint**. From the menu select **Endpoints** then click **Add endpoint**.
@ -79,11 +79,11 @@ From the menu select **Endpoints** then click **Add endpoint**.
From the **Environment type** section, select **Agent**. Since we have already installed the agent you can ignore the sample commands in the **Information** section. Enter the environment details, using the table below as a guide: From the **Environment type** section, select **Agent**. Since we have already installed the agent you can ignore the sample commands in the **Information** section. Enter the environment details, using the table below as a guide:
| Field/Option | Overview | | Field/Option | Overview |
| :--- | :--- | | ------------ | --------------------------------------------------------------------------------------------------------------------------------- |
| Name | Give the endpoint a descriptive name. | | Name | Give the endpoint a descriptive name. |
| Endpoint URL | Enter the DNS name or IP address to connect to the Portainer Agent along with the port \(the default port is `9001`\). | | Endpoint URL | Enter the DNS name or IP address to connect to the Portainer Agent along with the port (the default port is `9001`). |
| Public IP | Enter the URL or IP address where exposed containers will be reachable. This is an optional field \(defaults to the endpoint URL\). | | Public IP | Enter the URL or IP address where exposed containers will be reachable. This is an optional field (defaults to the endpoint URL). |
![](../../../.gitbook/assets/install-agent-swarm-linux-3.png) ![](../../../.gitbook/assets/install-agent-swarm-linux-3.png)
@ -92,4 +92,3 @@ In the **Metadata** section, as an optional step you can categorize the endpoint
![](../../../.gitbook/assets/install-agent-swarm-linux-4.png) ![](../../../.gitbook/assets/install-agent-swarm-linux-4.png)
When you're ready, click **Add endpoint**. When you're ready, click **Add endpoint**.

20
admin/endpoints/add/swarm.md
View File

@ -16,20 +16,20 @@ You must run the command on the Docker Swarm cluster before entering the environ
The deployment command will return something similar to this: The deployment command will return something similar to this:
```text ```
Creating network portainer-agent_portainer_agent Creating network portainer-agent_portainer_agent
Creating service portainer-agent_agent Creating service portainer-agent_agent
``` ```
To validate the agent is running, run the following command: To validate the agent is running, run the following command:
```text ```
docker service ls docker service ls
``` ```
The result of which should look something like this: The result of which should look something like this:
```text ```
ID NAME MODE REPLICAS IMAGE PORTS ID NAME MODE REPLICAS IMAGE PORTS
tshb6ee2710s portainer-agent_agent global 1/1 portainer/agent:latest tshb6ee2710s portainer-agent_agent global 1/1 portainer/agent:latest
``` ```
@ -38,11 +38,11 @@ tshb6ee2710s portainer-agent_agent global 1/1
Once the agent is running on the Docker Swarm cluster, enter the environment details, using the table below as a guide: Once the agent is running on the Docker Swarm cluster, enter the environment details, using the table below as a guide:
| Field | Overview | | Field | Overview |
| :--- | :--- | | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name | Give the endpoint a descriptive name. This is a required field. | | Name | Give the endpoint a descriptive name. This is a required field. |
| Endpoint URL | Enter the IP or DNS name at which the Portainer Server instance can reach the endpoint along with the port \(`9001`\) if required. This is a required field. | | Endpoint URL | Enter the IP or DNS name at which the Portainer Server instance can reach the endpoint along with the port (`9001`) if required. This is a required field. |
| Public IP | URL or IP address where exposed containers will be reachable. This is an optional field and will default to the endpoint URL. You can change it later if you need to. | | Public IP | URL or IP address where exposed containers will be reachable. This is an optional field and will default to the endpoint URL. You can change it later if you need to. |
![](../../../.gitbook/assets/install-agent-swarm-linux-3.png) ![](../../../.gitbook/assets/install-agent-swarm-linux-3.png)
@ -50,6 +50,4 @@ In the **Metadata** section, as an optional step you can categorize the endpoint
![](../../../.gitbook/assets/install-agent-swarm-linux-4.png) ![](../../../.gitbook/assets/install-agent-swarm-linux-4.png)
When you're ready click **Add endpoint**. When you're ready click **Add endpoint**.\

19
admin/registries/add/README.md
View File

@ -1,18 +1,25 @@
# Add a new registry # Add a new registry
From the menu select **Registries** then click **Add registry**. From the menu select **Registries **then click **Add registry**.
![](../../../.gitbook/assets/registries-add-1.gif) ![](../../../.gitbook/assets/registries-add-1.gif)
From the **Registry provider** section select the type of registry you want to add. Portainer provides configuration support for a number of popular registry providers: From the **Registry provider** section select the type of registry you want to add. Portainer provides configuration support for a number of popular registry providers:
{% page-ref page="quay.md" %} {% content-ref url="quay.md" %}
[quay.md](quay.md)
{% endcontent-ref %}
{% page-ref page="azure.md" %} {% content-ref url="azure.md" %}
[azure.md](azure.md)
{% endcontent-ref %}
{% page-ref page="gitlab.md" %} {% content-ref url="gitlab.md" %}
[gitlab.md](gitlab.md)
{% endcontent-ref %}
You can also add your own custom registry: You can also add your own custom registry:
{% page-ref page="custom.md" %} {% content-ref url="custom.md" %}
[custom.md](custom.md)
{% endcontent-ref %}

22
admin/upgrade/README.md
View File

@ -1,22 +0,0 @@
# Upgrading Portainer
Portainer releases contain new features and bug fixes so it's important to keep your installation up to date. We have [tested and validated](../../start/requirements-and-prerequisites.md#validated-configurations) all Portainer CE version upgrades from 1.24.0 up to the latest release.
While it's possible that an untested unvalidated upgrade path might work, we recommend that all upgrade paths are tested and validated on a non-critical system before applying them to your production systems.
{% hint style="info" %}
We added a [backup and restore feature](../settings/#backup-portainer) to Portainer CE 2.5 and strongly recommend that you take a backup of your Portainer instance before upgrading.
{% endhint %}
To upgrade Portainer, choose your platform then follow the instructions:
{% page-ref page="docker.md" %}
{% page-ref page="swarm.md" %}
{% page-ref page="kubernetes.md" %}
If you want to upgrade from CE to Business Edition, we have instructions for that too:
{% page-ref page="tobe/" %}

3
admin/users/password.md
View File

@ -1,10 +1,9 @@
# Reset a user's password # Reset a user's password
From the menu select **Users** then select the user whose password you want to reset. From the menu select **Users **then select the user whose password you want to reset.
![](../../.gitbook/assets/users-promote-1.gif) ![](../../.gitbook/assets/users-promote-1.gif)
Enter a new strong password, re-enter the password to confirm it then click **Update password**. Enter a new strong password, re-enter the password to confirm it then click **Update password**.
![](../../.gitbook/assets/users-password-2.png) ![](../../.gitbook/assets/users-password-2.png)

3
admin/users/promote.md
View File

@ -1,10 +1,9 @@
# Turn a user into an administrator # Turn a user into an administrator
From the menu select **Users** then select the user you want to promote to administrator. From the menu select **Users **then select the user you want to promote to administrator.
![](../../.gitbook/assets/users-promote-1.gif) ![](../../.gitbook/assets/users-promote-1.gif)
Toggle **Administrator** on then click **Save**. Toggle **Administrator** on then click **Save**.
![](../../.gitbook/assets/users-promote-2.png) ![](../../.gitbook/assets/users-promote-2.png)

61
advanced/helm-chart-configuration-options.md
View File

@ -2,34 +2,33 @@
The following table lists the configurable parameters of the Portainer Helm chart and their default values. Find the values file under `deploy/helm/portainer/values.yaml`. The following table lists the configurable parameters of the Portainer Helm chart and their default values. Find the values file under `deploy/helm/portainer/values.yaml`.
| Parameter | Description | Default | | Parameter | Description | Default |
| :--- | :--- | :--- | | ---------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------- |
| `replicaCount` | Number of Portainer service replicas \(always set to 1\). | `1` | | `replicaCount` | Number of Portainer service replicas (always set to 1). | `1` |
| `image.repository` | Portainer Docker Hub repository. | `portainer/portainer-ce` | | `image.repository` | Portainer Docker Hub repository. | `portainer/portainer-ce` |
| `image.tag` | Tag for the Portainer image. | `latest` | | `image.tag` | Tag for the Portainer image. | `latest` |
| `image.pullPolicy` | Portainer image-pulling policy. | `IfNotPresent` | | `image.pullPolicy` | Portainer image-pulling policy. | `IfNotPresent` |
| `imagePullSecrets` | If the Portainer image needs to be in a private repository. | `nil` | | `imagePullSecrets` | If the Portainer image needs to be in a private repository. | `nil` |
| `nodeSelector` | Used to apply a nodeSelector to the deployment. | `{}` | | `nodeSelector` | Used to apply a nodeSelector to the deployment. | `{}` |
| `serviceAccount.annotations` | Annotations to add to the service account. | `null` | | `serviceAccount.annotations` | Annotations to add to the service account. | `null` |
| `serviceAccount.name` | The name of the service account to use. | `portainer-sa-clusteradmin` | | `serviceAccount.name` | The name of the service account to use. | `portainer-sa-clusteradmin` |
| `service.type` | Service type for the main Portainer Service. Valid values: `ClusterIP`, `NodePort`, `LoadBalancer`. | `LoadBalancer` | | `service.type` | Service type for the main Portainer Service. Valid values: `ClusterIP`, `NodePort`, `LoadBalancer`. | `LoadBalancer` |
| `service.httpPort` | HTTP port for accessing the Portainer web interface. | `9000` | | `service.httpPort` | HTTP port for accessing the Portainer web interface. | `9000` |
| `service.httpNodePort` | Static NodePort for accessing the Portainer web interface. Specify only if the type is `NodePort`. | `30777` | | `service.httpNodePort` | Static NodePort for accessing the Portainer web interface. Specify only if the type is `NodePort`. | `30777` |
| `service.edgePort` | TCP port for accessing Portainer Edge. | `8000` | | `service.edgePort` | TCP port for accessing Portainer Edge. | `8000` |
| `service.edgeNodePort` | Static NodePort for accessing Portainer Edge. Specify only if the type is `NodePort`. | `30776` | | `service.edgeNodePort` | Static NodePort for accessing Portainer Edge. Specify only if the type is `NodePort`. | `30776` |
| `service.annotations` | Annotations to add to the service. | `{}` | | `service.annotations` | Annotations to add to the service. | `{}` |
| `ingress.enabled` | Creates an ingress for Portainer. | `false` | | `ingress.enabled` | Creates an ingress for Portainer. | `false` |
| `ingress.annotations` | Annotations to add to the ingress. For example: `kubernetes.io/ingress.class: nginx` | `{}` | | `ingress.annotations` | <p>Annotations to add to the ingress. For example:<br><code>kubernetes.io/ingress.class: nginx</code></p> | `{}` |
| `ingress.hosts.host` | URL for Portainer Web. For example, `portainer.example.io`. | `nil` | | `ingress.hosts.host` | URL for Portainer Web. For example, `portainer.example.io`. | `nil` |
| `ingress.hosts.paths.path` | Path for the Portainer web interface. | `/` | | `ingress.hosts.paths.path` | Path for the Portainer web interface. | `/` |
| `ingress.hosts.paths.port` | Port for the Portainer web interface. | `9000` | | `ingress.hosts.paths.port` | Port for the Portainer web interface. | `9000` |
| `ingress.tls` | TLS support on ingress. Must create a secret with TLS certificates in advance. | `[]` | | `ingress.tls` | TLS support on ingress. Must create a secret with TLS certificates in advance. | `[]` |
| `resources` | Portainer resource requests and limits. | `{}` | | `resources` | Portainer resource requests and limits. | `{}` |
| `persistence.enabled` | Whether or not to enable data persistence. | `true` | | `persistence.enabled` | Whether or not to enable data persistence. | `true` |
| `persistence.existingClaim` | Name of an existing PVC to use for data persistence. | `nil` | | `persistence.existingClaim` | Name of an existing PVC to use for data persistence. | `nil` |
| `persistence.size` | Size of the PVC used for persistence. | `10Gi` | | `persistence.size` | Size of the PVC used for persistence. | `10Gi` |
| `persistence.annotations` | Annotations to apply to PVC used for persistence. | `{}` | | `persistence.annotations` | Annotations to apply to PVC used for persistence. | `{}` |
| `persistence.storageClass` | StorageClass to apply to PVC used for persistence. | `default` | | `persistence.storageClass` | StorageClass to apply to PVC used for persistence. | `default` |
| `persistence.accessMode` | AccessMode for persistence. | `ReadWriteOnce` | | `persistence.accessMode` | AccessMode for persistence. | `ReadWriteOnce` |
| `persistence.selector` | Selector for persistence. | `nil` | | `persistence.selector` | Selector for persistence. | `nil` |

3
faq/installing/how-do-i-enter-my-portainer-business-license-into-portainer-ce.md
View File

@ -1,4 +1,3 @@
# How do I enter my Portainer Business license into Portainer CE? # How do I enter my Portainer Business license into Portainer CE?
Due to the differences between Portainer features and versions, we don't provide a way to enter a Portainer Business license directly into Portainer CE. Instead, [switch images from CE to BE](../../admin/upgrade/tobe/) then enter your trial license to get all the functionality of BE. You should experience no data loss when switching the images over. Due to the differences between Portainer features and versions, we don't provide a way to enter a Portainer Business license directly into Portainer CE. Instead, [switch images from CE to BE](../../start/upgrade/tobe/) then enter your trial license to get all the functionality of BE. You should experience no data loss when switching the images over.

5
faq/upgrading/after-an-update-why-doesnt-my-version-number-match-the-latest-version.md
View File

@ -2,7 +2,6 @@
This is common after updating Portainer versions, and is usually caused by a cached page in your browser. This is common after updating Portainer versions, and is usually caused by a cached page in your browser.
**Step 1 - Find out if caching is the problem:** Load Portainer in private/incognito mode. If it works then it means that your browser has cached the page. **Step 1 - Find out if caching is the problem: **Load Portainer in private/incognito mode. If it works then it means that your browser has cached the page.
**Step 2 - Fix it:** Clear your cache through the browser settings. If that doesn't work, check that the latest Portainer version installed successfully. If that doesn't work, [log a bug report](https://github.com/portainer/portainer/issues/new?assignees=&labels=bug%2Fneed-confirmation%2C+kind%2Fbug&template=Bug_report.md&title=).
**Step 2 - Fix it: **Clear your cache through the browser settings. If that doesn't work, check that the latest Portainer version installed successfully. If that doesn't work, [log a bug report](https://github.com/portainer/portainer/issues/new?assignees=\&labels=bug%2Fneed-confirmation%2C+kind%2Fbug\&template=Bug\_report.md\&title=).

4
faq/upgrading/can-i-upgrade-portainer-ce-to-portainer-business.md
View File

@ -1,6 +1,4 @@
# Can I upgrade Portainer CE to Portainer Business? # Can I upgrade Portainer CE to Portainer Business?
Yes, you can! The upgrade process will carry your existing configuration over to Portainer Business. See our [platform-specific upgrade instructions](../../admin/upgrade/tobe/) for more information. Yes, you can! The upgrade process will carry your existing configuration over to Portainer Business. See our [platform-specific upgrade instructions](../../start/upgrade/tobe/) for more information.

3
faq/upgrading/how-do-i-upgrade-portainer-ce-to-the-latest-version.md
View File

@ -1,4 +1,3 @@
# How do I upgrade Portainer CE to the latest version? # How do I upgrade Portainer CE to the latest version?
We recommend keeping your Portainer installation up to date to ensure that you have the latest features and bug fixes. The upgrade process changes depending on the environment and platform you're using. See [Upgrading Portainer](../../admin/upgrade/) for information about the supported platforms. We recommend keeping your Portainer installation up to date to ensure that you have the latest features and bug fixes. The upgrade process changes depending on the environment and platform you're using. See [Upgrading Portainer](../../start/upgrade/) for information about the supported platforms.

18
start/install/agent/README.md
View File

@ -2,11 +2,23 @@
If you want to add another endpoint to your existing Portainer installation, first select the environment of the endpoint you would like to add: If you want to add another endpoint to your existing Portainer installation, first select the environment of the endpoint you would like to add:
{% page-ref page="swarm/" %} {% content-ref url="broken-reference" %}
[Broken link](broken-reference)
{% endcontent-ref %}
{% page-ref page="aci.md" %} {% content-ref url="swarm/" %}
[swarm](swarm/)
{% endcontent-ref %}
{% page-ref page="edge.md" %} {% content-ref url="broken-reference" %}
[Broken link](broken-reference)
{% endcontent-ref %}
{% content-ref url="aci.md" %}
[aci.md](aci.md)
{% endcontent-ref %}
{% content-ref url="edge.md" %}
[edge.md](edge.md)
{% endcontent-ref %}

22
start/install/agent/swarm/linux.md
View File

@ -24,7 +24,7 @@ From the menu select **Endpoints** then click **Add endpoint**. Ensure **Agent**
![](../../../../.gitbook/assets/install-agent-swarm-linux-1.gif) ![](../../../../.gitbook/assets/install-agent-swarm-linux-1.gif)
In the **Information** tab click the **Linux** button and select the **Docker Swarm** tab. Copy the command, then run the command on the manager node of your Docker Swarm cluster. In the **Information** tab click the **Linux** button and select the **Docker Swarm** tab. Copy the command, then run the command on the manager node of your Docker Swarm cluster.&#x20;
{% hint style="info" %} {% hint style="info" %}
You must run the command on the Docker Swarm cluster before you proceed to entering the environment details. You must run the command on the Docker Swarm cluster before you proceed to entering the environment details.
@ -34,33 +34,33 @@ You must run the command on the Docker Swarm cluster before you proceed to enter
The deployment command will return something similar to: The deployment command will return something similar to:
```text ```
Creating network portainer-agent_portainer_agent Creating network portainer-agent_portainer_agent
Creating service portainer-agent_agent Creating service portainer-agent_agent
``` ```
To validate the Agent is running, you can run the following command: To validate the Agent is running, you can run the following command:
```text ```
docker service ls docker service ls
``` ```
the result of which should look something like this: the result of which should look something like this:
```text ```
ID NAME MODE REPLICAS IMAGE PORTS ID NAME MODE REPLICAS IMAGE PORTS
tshb6ee2710s portainer-agent_agent global 1/1 portainer/agent:latest tshb6ee2710s portainer-agent_agent global 1/1 portainer/agent:latest
``` ```
## Finishing the configuration ## Finishing the configuration
Once the Agent is running on the Docker Swarm cluster, enter the **environment details** using the table below as a guide: Once the Agent is running on the Docker Swarm cluster, enter the **environment details **using the table below as a guide:
| Field | Overview | | Field | Overview |
| :--- | :--- | | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Name | Give the endpoint a descriptive name. This is a required field. | | Name | Give the endpoint a descriptive name. This is a required field. |
| Endpoint URL | Enter the IP or DNS name at which the Portainer Server instance can reach the endpoint along with the port \(`9001`\) if required. This is a required field. | | Endpoint URL | Enter the IP or DNS name at which the Portainer Server instance can reach the endpoint along with the port (`9001`) if required. This is a required field. |
| Public IP | URL or IP address where exposed containers will be reachable. This is an optional field and will default to the endpoint URL. This can be changed at a later date. | | Public IP | URL or IP address where exposed containers will be reachable. This is an optional field and will default to the endpoint URL. This can be changed at a later date. |
![](../../../../.gitbook/assets/install-agent-swarm-linux-3.png) ![](../../../../.gitbook/assets/install-agent-swarm-linux-3.png)
@ -70,5 +70,3 @@ In the **Metadata** section, as an optional step you can categorize the endpoint
When everything is set, you can click **Add Endpoint**. When everything is set, you can click **Add Endpoint**.

19
start/install/agent/swarm/wcs.md
View File

@ -31,33 +31,33 @@ You must run the command on the Docker Swarm cluster before you proceed to enter
The deployment command will return something similar to: The deployment command will return something similar to:
```text ```
Creating network portainer-agent_portainer_agent Creating network portainer-agent_portainer_agent
Creating service portainer-agent_agent Creating service portainer-agent_agent
``` ```
To validate the Agent is running, you can run the following command: To validate the Agent is running, you can run the following command:
```text ```
docker service ls docker service ls
``` ```
the result of which should look something like this: the result of which should look something like this:
```text ```
ID NAME MODE REPLICAS IMAGE PORTS ID NAME MODE REPLICAS IMAGE PORTS
tshb6ee2710s portainer-agent_agent global 1/1 portainer/agent:latest tshb6ee2710s portainer-agent_agent global 1/1 portainer/agent:latest
``` ```
## Finishing the configuration ## Finishing the configuration
Once the Agent is running on the Docker Swarm cluster, enter the **environment details** using the table below as a guide: Once the Agent is running on the Docker Swarm cluster, enter the **environment details **using the table below as a guide:
| Field | Overview | | Field | Overview |
| :--- | :--- | | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Name | Give the endpoint a descriptive name. This is a required field. | | Name | Give the endpoint a descriptive name. This is a required field. |
| Endpoint URL | Enter the IP or DNS name at which the Portainer Server instance can reach the endpoint along with the port \(`9001`\) if required. This is a required field. | | Endpoint URL | Enter the IP or DNS name at which the Portainer Server instance can reach the endpoint along with the port (`9001`) if required. This is a required field. |
| Public IP | URL or IP address where exposed containers will be reachable. This is an optional field and will default to the endpoint URL. This can be changed at a later date. | | Public IP | URL or IP address where exposed containers will be reachable. This is an optional field and will default to the endpoint URL. This can be changed at a later date. |
![](../../../../.gitbook/assets/install-agent-swarm-linux-3.png) ![](../../../../.gitbook/assets/install-agent-swarm-linux-3.png)
@ -66,4 +66,3 @@ In the **Metadata** section, as an optional step you can categorize the endpoint
![](../../../../.gitbook/assets/install-agent-swarm-linux-4.png) ![](../../../../.gitbook/assets/install-agent-swarm-linux-4.png)
When everything is set, you can click **Add Endpoint**. When everything is set, you can click **Add Endpoint**.

21
start/install/agent/swarm/wsl.md
View File

@ -9,7 +9,7 @@ To get started, you will need:
* The latest version of Docker Desktop installed and working. * The latest version of Docker Desktop installed and working.
* Swarm mode enabled and working, including the overlay network for the swarm service communication. * Swarm mode enabled and working, including the overlay network for the swarm service communication.
* Administrator access on the manager node of your Swarm cluster. * Administrator access on the manager node of your Swarm cluster.
* Windows Subsystem for Linux \(WSL\) installed and a Linux distribution selected. For a new installation we recommend WSL2. * Windows Subsystem for Linux (WSL) installed and a Linux distribution selected. For a new installation we recommend WSL2.
* The manager and worker nodes must be able to communicate with each other over port `9001`. In addition, the Portainer Server installation must be able to reach the nodes on port `9001`. If this is not possible, we advise looking at the [Edge Agent](../edge.md) instead. * The manager and worker nodes must be able to communicate with each other over port `9001`. In addition, the Portainer Server installation must be able to reach the nodes on port `9001`. If this is not possible, we advise looking at the [Edge Agent](../edge.md) instead.
The installation instructions also make the following assumptions about your environment: The installation instructions also make the following assumptions about your environment:
@ -35,33 +35,33 @@ You must run the command on the Docker Swarm cluster before you proceed to enter
The deployment command will return something similar to: The deployment command will return something similar to:
```text ```
Creating network portainer-agent_portainer_agent Creating network portainer-agent_portainer_agent
Creating service portainer-agent_agent Creating service portainer-agent_agent
``` ```
To validate the Agent is running, you can run the following command: To validate the Agent is running, you can run the following command:
```text ```
docker service ls docker service ls
``` ```
the result of which should look something like this: the result of which should look something like this:
```text ```
ID NAME MODE REPLICAS IMAGE PORTS ID NAME MODE REPLICAS IMAGE PORTS
tshb6ee2710s portainer-agent_agent global 1/1 portainer/agent:latest tshb6ee2710s portainer-agent_agent global 1/1 portainer/agent:latest
``` ```
## Finishing the configuration ## Finishing the configuration
Once the Agent is running on the Docker Swarm cluster, enter the **environment details** using the table below as a guide: Once the Agent is running on the Docker Swarm cluster, enter the **environment details **using the table below as a guide:
| Field | Overview | | Field | Overview |
| :--- | :--- | | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Name | Give the endpoint a descriptive name. This is a required field. | | Name | Give the endpoint a descriptive name. This is a required field. |
| Endpoint URL | Enter the IP or DNS name at which the Portainer Server instance can reach the endpoint along with the port \(`9001`\) if required. This is a required field. | | Endpoint URL | Enter the IP or DNS name at which the Portainer Server instance can reach the endpoint along with the port (`9001`) if required. This is a required field. |
| Public IP | URL or IP address where exposed containers will be reachable. This is an optional field and will default to the endpoint URL. This can be changed at a later date. | | Public IP | URL or IP address where exposed containers will be reachable. This is an optional field and will default to the endpoint URL. This can be changed at a later date. |
![](../../../../.gitbook/assets/install-agent-swarm-linux-3.png) ![](../../../../.gitbook/assets/install-agent-swarm-linux-3.png)
@ -70,4 +70,3 @@ In the **Metadata** section, as an optional step you can categorize the endpoint
![](../../../../.gitbook/assets/install-agent-swarm-linux-4.png) ![](../../../../.gitbook/assets/install-agent-swarm-linux-4.png)
When everything is set, you can click **Add Endpoint**. When everything is set, you can click **Add Endpoint**.

23
start/install/server/swarm/linux.md
View File

@ -4,9 +4,11 @@
These instructions are for Portainer Community Edition. For Business Edition, please refer to the [Business Edition documentation](https://docs.portainer.io/v/be-2.7/). These instructions are for Portainer Community Edition. For Business Edition, please refer to the [Business Edition documentation](https://docs.portainer.io/v/be-2.7/).
{% endhint %} {% endhint %}
{% embed url="https://youtu.be/L80QDuix5RE" caption="Prefer a video guide?" %} {% embed url="https://youtu.be/L80QDuix5RE" %}
Prefer a video guide?
{% endembed %}
## Introduction <a id="introduction"></a> ## Introduction <a href="introduction" id="introduction"></a>
Portainer consists of two elements, the _Portainer Server_ and the _Portainer Agent_. Both elements run as lightweight Docker containers on a Docker engine. This document will help you deploy the Portainer Server and Agent containers on your Linux environment. To add a new Linux Swarm environment to an existing Portainer Server installation, please refer to the [Portainer Agent installation instructions](../../agent/swarm/linux.md). Portainer consists of two elements, the _Portainer Server_ and the _Portainer Agent_. Both elements run as lightweight Docker containers on a Docker engine. This document will help you deploy the Portainer Server and Agent containers on your Linux environment. To add a new Linux Swarm environment to an existing Portainer Server installation, please refer to the [Portainer Agent installation instructions](../../agent/swarm/linux.md).
@ -25,36 +27,36 @@ The installation instructions also make the following assumptions about your env
* Docker is running as root. Portainer with rootless Docker has some limitations, and requires additional configuration. * Docker is running as root. Portainer with rootless Docker has some limitations, and requires additional configuration.
* If your nodes are using DNS records to communicate, that all records are resolvable across the cluster. * If your nodes are using DNS records to communicate, that all records are resolvable across the cluster.
## Deployment <a id="deployment"></a> ## Deployment <a href="deployment" id="deployment"></a>
Portainer can be directly deployed as a service in your Docker cluster. Note that this method will automatically deploy a single instance of the Portainer Server, and deploy the Portainer Agent as a global service on every node in your cluster. Portainer can be directly deployed as a service in your Docker cluster. Note that this method will automatically deploy a single instance of the Portainer Server, and deploy the Portainer Agent as a global service on every node in your cluster.
First, retrieve the stack YML manifest: First, retrieve the stack YML manifest:
```text ```
curl -L https://downloads.portainer.io/ce2.6.3/portainer-agent-stack.yml -o portainer-agent-stack.yml curl -L https://downloads.portainer.io/ce2.6.3/portainer-agent-stack.yml -o portainer-agent-stack.yml
``` ```
Then, use the downloaded YML manifest to deploy your stack: Then, use the downloaded YML manifest to deploy your stack:
```text ```
docker stack deploy -c portainer-agent-stack.yml portainer docker stack deploy -c portainer-agent-stack.yml portainer
``` ```
Portainer Server and the Agents have now been installed. You can check to see whether the Portainer Server and Agent containers have started by running `docker ps`: Portainer Server and the Agents have now been installed. You can check to see whether the Portainer Server and Agent containers have started by running `docker ps`:
```text ```
root@manager01:~# docker ps root@manager01:~# docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
59ee466f6b15 portainer/agent:latest "./agent" About a minute ago Up About a minute portainer_agent.xbb8k6r7j1tk9gozjku7e43wr.5sa6b3e8cl6hyu0snlt387sgv 59ee466f6b15 portainer/agent:latest "./agent" About a minute ago Up About a minute portainer_agent.xbb8k6r7j1tk9gozjku7e43wr.5sa6b3e8cl6hyu0snlt387sgv
2db7dd4bfba0 portainer/portainer-ce:2.6.3 "/portainer -H tcp:/…" About a minute ago Up About a minute 8000/tcp, 9000/tcp portainer_portainer.1.gpuvu3pqmt1m19zxfo44v7izx 2db7dd4bfba0 portainer/portainer-ce:2.6.3 "/portainer -H tcp:/…" About a minute ago Up About a minute 8000/tcp, 9000/tcp portainer_portainer.1.gpuvu3pqmt1m19zxfo44v7izx
``` ```
## Logging In <a id="logging-in"></a> ## Logging In <a href="logging-in" id="logging-in"></a>
Now that the installation is complete, you can log into your Portainer Server instance by opening a web browser and going to: Now that the installation is complete, you can log into your Portainer Server instance by opening a web browser and going to:
```text ```
http://localhost:9000/ http://localhost:9000/
``` ```
@ -62,5 +64,6 @@ Replace `localhost` with the relevant IP address or FQDN if needed, and adjust t
You will be presented with the initial setup page for Portainer Server. You will be presented with the initial setup page for Portainer Server.
{% page-ref page="../setup.md" %} {% content-ref url="../setup.md" %}
[setup.md](../setup.md)
{% endcontent-ref %}

29
start/upgrade/README.md Normal file
View File

@ -0,0 +1,29 @@
# Upgrading Portainer
Portainer releases contain new features and bug fixes so it's important to keep your installation up to date. We have [tested and validated](../requirements-and-prerequisites.md#validated-configurations) all Portainer CE version upgrades from 1.24.0 up to the latest release.
While it's possible that an untested unvalidated upgrade path might work, we recommend that all upgrade paths are tested and validated on a non-critical system before applying them to your production systems.
{% hint style="info" %}
We added a [backup and restore feature](../../admin/settings/#backup-portainer) to Portainer CE 2.5 and strongly recommend that you take a backup of your Portainer instance before upgrading.
{% endhint %}
To upgrade Portainer, choose your platform then follow the instructions:
{% content-ref url="docker.md" %}
[docker.md](docker.md)
{% endcontent-ref %}
{% content-ref url="swarm.md" %}
[swarm.md](swarm.md)
{% endcontent-ref %}
{% content-ref url="kubernetes.md" %}
[kubernetes.md](kubernetes.md)
{% endcontent-ref %}
If you want to upgrade from CE to Business Edition, we have instructions for that too:
{% content-ref url="tobe/" %}
[tobe](tobe/)
{% endcontent-ref %}

0
admin/upgrade/docker.md → start/upgrade/docker.md
View File

0
admin/upgrade/kubernetes.md → start/upgrade/kubernetes.md
View File

0
admin/upgrade/swarm.md → start/upgrade/swarm.md
View File

0
admin/upgrade/tobe/README.md → start/upgrade/tobe/README.md
View File

0
admin/upgrade/tobe/docker.md → start/upgrade/tobe/docker.md
View File

0
admin/upgrade/tobe/kubernetes.md → start/upgrade/tobe/kubernetes.md
View File

0
admin/upgrade/tobe/swarm.md → start/upgrade/tobe/swarm.md
View File

12
user/aci/containers/README.md
View File

@ -2,12 +2,14 @@
The **Container Instances** page allows you to interact with containers in your Azure application, letting you add and remove containers as needed. The **Container Instances** page allows you to interact with containers in your Azure application, letting you add and remove containers as needed.
{% page-ref page="add.md" %} {% content-ref url="add.md" %}
[add.md](add.md)
{% endcontent-ref %}
{% page-ref page="remove.md" %} {% content-ref url="remove.md" %}
[remove.md](remove.md)
{% endcontent-ref %}
\

23
user/aci/containers/add.md
View File

@ -1,24 +1,23 @@
# Add a new container # Add a new container
From the menu select **Container instances** then click **Add container**. From the menu select **Container instances **then click **Add container**.
![](../../../.gitbook/assets/aci-containers-add-1.gif) ![](../../../.gitbook/assets/aci-containers-add-1.gif)
Complete the configuration, using the table below as a guide: Complete the configuration, using the table below as a guide:
| Field/Option | Overview | | Field/Option | Overview |
| :--- | :--- | | -------------- | ------------------------------------------------------------------------------------ |
| Subscription | Select the subscription you want to use for the container. | | Subscription | Select the subscription you want to use for the container. |
| Resource group | If two or more resource groups exist, select where you want to deploy the container. | | Resource group | If two or more resource groups exist, select where you want to deploy the container. |
| Location | Select which datacenter to run the container in. | | Location | Select which datacenter to run the container in. |
| Name | Give the container a descriptive name. | | Name | Give the container a descriptive name. |
| Image | Enter the name of the image that will be used to deploy the container. | | Image | Enter the name of the image that will be used to deploy the container. |
| OS | Select the OS \(typically Linux or Windows\). | | OS | Select the OS (typically Linux or Windows). |
| Port mapping | Select the port needed to publish to the Internet. | | Port mapping | Select the port needed to publish to the Internet. |
| CPU | Define how much CPU to allocate to the container. | | CPU | Define how much CPU to allocate to the container. |
| Memory | Define how much memory to allocate to the container. | | Memory | Define how much memory to allocate to the container. |
![](../../../.gitbook/assets/aci-containers-add-2.png) ![](../../../.gitbook/assets/aci-containers-add-2.png)
When you're ready, click **Deploy the container**. When the deployment has finished, you'll see it in the list of Azure container instances. When you're ready, click **Deploy the container**. When the deployment has finished, you'll see it in the list of Azure container instances.

28
user/docker/containers/add.md
View File

@ -8,12 +8,12 @@ Configure the container settings as required.
## Image configuration section ## Image configuration section
| Field/Option | Overview | | Field/Option | Overview |
| :--- | :--- | | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| Name | Give the container a descriptive name. | | Name | Give the container a descriptive name. |
| Registry | Select the registry that contains the image that you want to use for your container. | | Registry | Select the registry that contains the image that you want to use for your container. |
| Image | Enter the name of the image you want to use. | | Image | Enter the name of the image you want to use. |
| Always pull the image | Toggle on to enforce pulling the image from the registry instead of using the locally cached copy \(if you have used the image previously\). | | Always pull the image | Toggle on to enforce pulling the image from the registry instead of using the locally cached copy (if you have used the image previously). |
![](../../../.gitbook/assets/containers-create-2.png) ![](../../../.gitbook/assets/containers-create-2.png)
@ -27,22 +27,22 @@ Alternatively you can switch to advanced mode to manually enter registry and ima
## Actions section ## Actions section
| Field/Option | Overview | | Field/Option | Overview |
| :--- | :--- | | ------------ | ----------------------------------------------------------------------------------------------------------------------------------- |
| Auto remove | Toggle this option on to automatically remove the container once it exits. This is useful if you want to run a container only once. | | Auto remove | Toggle this option on to automatically remove the container once it exits. This is useful if you want to run a container only once. |
![](../../../.gitbook/assets/containers-create-6.png) ![](../../../.gitbook/assets/containers-create-6.png)
## Network ports configuration section ## Network ports configuration section
| Field/Option | Overview | | Field/Option | Overview |
| :--- | :--- | | ------------------------------------------------------ | -------------------------------------------------------------------------------------------------------- |
| Publish all exposed network ports to random host ports | Toggle on to allow Portainer to randomly assign ports on the host to the exposed ports in the container. | | Publish all exposed network ports to random host ports | Toggle on to allow Portainer to randomly assign ports on the host to the exposed ports in the container. |
| Manual network port publishing | Click **publish a new network port** to create manual port mappings for the container. | | Manual network port publishing | Click **publish a new network port** to create manual port mappings for the container. |
![](../../../.gitbook/assets/containers-create-5.png) ![](../../../.gitbook/assets/containers-create-5.png)
Once complete, set any advanced options \(see below\) then click **Deploy the container.** If successful your container will be shown in the container list. Once complete, set any advanced options (see below) then click **Deploy the container. **If successful your container will be shown in the container list.
## Advanced container settings ## Advanced container settings
@ -50,5 +50,3 @@ Choose from a range of options to customize the deployment.
![](../../../.gitbook/assets/containers-create-4.png) ![](../../../.gitbook/assets/containers-create-4.png)

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

@ -18,15 +18,15 @@ For security, these features are disabled by default. Be sure that you understan
### Enable host management features ### Enable host management features
Enabling host management features allows you to see the available devices and storage on the physical node as well as browse the node's filesystem. The endpoint must be [running the Portainer Agent]() to use this functionality, and for filesystem browsing, the root of the host must be bind-mounted to`/host`in the agent deployment: Enabling host management features allows you to see the available devices and storage on the physical node as well as browse the node's filesystem. The endpoint must be [running the Portainer Agent](broken-reference) to use this functionality, and for filesystem browsing, the root of the host must be bind-mounted to`/host`in the agent deployment:
```text ```
-v /:/host -v /:/host
``` ```
For example, starting the Portainer Agent on Linux with the host filesystem mounted at `/host`: For example, starting the Portainer Agent on Linux with the host filesystem mounted at `/host`:
```text ```
docker run -d -p 9001:9001 --name portainer_agent --restart=always -v /var/run/docker.sock:/var/run/docker.sock -v /var/lib/docker/volumes:/var/lib/docker/volumes -v /:/host portainer/agent docker run -d -p 9001:9001 --name portainer_agent --restart=always -v /var/run/docker.sock:/var/run/docker.sock -v /var/lib/docker/volumes:/var/lib/docker/volumes -v /:/host portainer/agent
``` ```
@ -40,13 +40,12 @@ This section allows you to toggle assorted Docker-related security settings for
![](../../../.gitbook/assets/host-5.png) ![](../../../.gitbook/assets/host-5.png)
| Option | Overview | | Option | Overview |
| :--- | :--- | | ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Disable bind mounts for non-administrators | Prevents non-admin users within Portainer from using bind mounts when creating containers and/or services/stacks. When toggled on, the option to attach to a host file system path is removed. | | Disable bind mounts for non-administrators | Prevents non-admin users within Portainer from using bind mounts when creating containers and/or services/stacks. When toggled on, the option to attach to a host file system path is removed. |
| Disable privileged mode for non-administrators | Prevents non-admin users from elevating the privilege of a container to bypass SELinux/AppArmor. When toggled on, the option to select **Privileged** mode when [adding a container](../containers/add.md) is removed. | | Disable privileged mode for non-administrators | Prevents non-admin users from elevating the privilege of a container to bypass SELinux/AppArmor. When toggled on, the option to select **Privileged** mode when [adding a container](../containers/add.md) is removed. |
| Disable the use of host PID 1 for non-administrators | Prevents non-admin users from requesting that a deployed container operates as the host PID. This is a security risk if used by a non-trustworthy authorized user because when they operate as PID1, they are in effect able to run any command in the container console as root on the host. | | Disable the use of host PID 1 for non-administrators | Prevents non-admin users from requesting that a deployed container operates as the host PID. This is a security risk if used by a non-trustworthy authorized user because when they operate as PID1, they are in effect able to run any command in the container console as root on the host. |
| Disable the use of Stacks for non-administrators | This is a 'sledgehammer' approach to removing any possibility for non-admin users within Portainer to find and use weaknesses in the Docker architecture. Whilst Portainer has the ability to disable some of the more common exploits, we cannot possibly block them all because there are any number of capabilities that could be added to a container to attempt to gain access to the host. This feature simply allows an admin to disable all possible entry points. | | Disable the use of Stacks for non-administrators | This is a 'sledgehammer' approach to removing any possibility for non-admin users within Portainer to find and use weaknesses in the Docker architecture. Whilst Portainer has the ability to disable some of the more common exploits, we cannot possibly block them all because there are any number of capabilities that could be added to a container to attempt to gain access to the host. This feature simply allows an admin to disable all possible entry points. |
| Disable device mappings for non-administrators | Blocks users from mapping host devices into containers. Whilst the ability to map devices is generally used for good \(e.g. mapping a GPU into a container\), it can equally be used by non-trustworthy authorized users to map a physical storage device into a container. It is possible to mount `/dev/sda1` into a container, and then from a console of that container, the user would have complete access to the sda1 device without restriction. By toggling this on, Portainer blocks the ability for non-admins to map ANY devices into containers. | | Disable device mappings for non-administrators | Blocks users from mapping host devices into containers. Whilst the ability to map devices is generally used for good (e.g. mapping a GPU into a container), it can equally be used by non-trustworthy authorized users to map a physical storage device into a container. It is possible to mount `/dev/sda1` into a container, and then from a console of that container, the user would have complete access to the sda1 device without restriction. By toggling this on, Portainer blocks the ability for non-admins to map ANY devices into containers. |
| Disable container capabilities for non-administrators | Toggle on to hide the **Container capabilities** tab for non-administrators when they are [adding a container](../containers/add.md). | | Disable container capabilities for non-administrators | Toggle on to hide the **Container capabilities** tab for non-administrators when they are [adding a container](../containers/add.md). |
| Disable sysctl settings for non-administrators | Toggle on to stop non-admin users from using sysctl options, preventing them from recreating, duplicating or editing containers. | | Disable sysctl settings for non-administrators | Toggle on to stop non-admin users from using sysctl options, preventing them from recreating, duplicating or editing containers. |

4
user/docker/images/export.md
View File

@ -14,6 +14,4 @@ When the warning message appears, click **Continue**.
![](../../../.gitbook/assets/images-export-2.png) ![](../../../.gitbook/assets/images-export-2.png)
When the image has downloaded, a success message will appear, and your browser should automatically download the resulting tar file. When the image has downloaded, a success message will appear, and your browser should automatically download the resulting tar file.\

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

@ -1,6 +1,6 @@
# Add a new namespace # Add a new namespace
From the menu select **Namespaces** then click **Add namespace**. From the menu select **Namespaces **then click **Add namespace**.
![](../../../.gitbook/assets/namespaces-add-1.gif) ![](../../../.gitbook/assets/namespaces-add-1.gif)
@ -13,4 +13,3 @@ Load balancer quota and storage quota functionality is only available in Portain
{% endhint %} {% endhint %}
When you're finished, click **Create namespace**. When you're finished, click **Create namespace**.