From 94be5d424de3bdb89d57dd4770fde9d66cc0e65a Mon Sep 17 00:00:00 2001 From: James Carppe Date: Wed, 7 Jul 2021 20:43:03 +1200 Subject: [PATCH 1/3] Spelling and grammar --- docs/v2.0-be/deploy/beinstalldocker.md | 18 +++++++++--------- docs/v2.0-be/deploy/beinstallk8s.md | 8 ++++---- docs/v2.0-be/deploy/beinstallswarm.md | 18 +++++++++--------- docs/v2.0/deploy/ceinstalldocker.md | 16 ++++++++-------- docs/v2.0/deploy/ceinstallk8s.md | 14 +++++++------- docs/v2.0/deploy/ceinstallswarm.md | 25 ++++++++++++------------- docs/v2.0/deploy/requirements.md | 4 ++-- 7 files changed, 51 insertions(+), 52 deletions(-) diff --git a/docs/v2.0-be/deploy/beinstalldocker.md b/docs/v2.0-be/deploy/beinstalldocker.md index 6f57949..4a78c21 100644 --- a/docs/v2.0-be/deploy/beinstalldocker.md +++ b/docs/v2.0-be/deploy/beinstalldocker.md @@ -23,7 +23,7 @@ To learn more about the requirements please visit the [requirements](/v2.0-be/de ## :fontawesome-solid-paper-plane: Portainer Deployment -Use the following Docker commands to deploy the Portainer Server; note the agent is not needed on standalone hosts, however it does provide additional functionality if used (see Portainer and agent scenario below): +Use the following Docker commands to deploy the Portainer Server; note the agent is not needed on standalone hosts, however it does provide additional functionality if used: === "Docker on Linux" !!! Abstract "" @@ -45,7 +45,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent !!! Abstract "" Before you can deploy Portainer in Docker Standalone running in Windows, you need to install WSL. [Read this guide to know more about WSL/WSL2](https://docs.microsoft.com/en-us/windows/wsl/install-win10){target=_blank} - Use the following Docker commands to deploy the Portainer Server; note the agent is not needed on standalone hosts, however it does provide additional functionality if used (see portainer and agent scenario below): + Use the following Docker commands to deploy the Portainer Server; note the agent is not needed on standalone hosts, however it does provide additional functionality if used: ### Portainer Server Deployment ```shell @@ -65,7 +65,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent === "Docker on Windows Container Service" !!! Abstract "" - To run Portainer in a Windows Server/Desktop Environment, you need to create exceptions in the firewall. These, can be easy added trough PowerShell, running the following commands: + To run Portainer in a Windows Server/Desktop Environment you need to create exceptions in the firewall. These can be easily be added through PowerShell by running the following commands: ```PowerShell netsh advfirewall firewall add rule name="cluster_management" dir=in action=allow protocol=TCP localport=2377 @@ -103,7 +103,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent Install-Package -Name docker -ProviderName DockerMsftProvider ``` - Lastly, you need to restart your Windows Server. After it has restarted, you're ready to deploy Portainer. + Lastly, you need to restart your Windows Server. Once it has restarted you're ready to deploy Portainer. ### Portainer Server Deployment @@ -114,7 +114,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent docker run -d -p 9000:9000 --name portainer --restart always -v \\.\pipe\docker_engine:\\.\pipe\docker_engine -v portainer_data:C:\data portainer/portainer-ee:latest ``` - Now, you can navigate to http://localhost:9000 or the IP of the server and start using Portainer. + Now you can navigate to http://localhost:9000 or the IP of the server and start using Portainer. ### Portainer Agent Only Deployment @@ -153,7 +153,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent ### Inside a file You can also store the plaintext password inside a file and use the --admin-password-file flag: - Add your password to a file running the following command: + Add your password to a file, for example with the following command: ```shell echo -n mypassword > /tmp/portainer_password @@ -197,7 +197,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent docker run -d --label owner=acme nginx ``` - To hide this container, simply add the -l owner=acme option on the CLI when starting Portainer: + To hide this container, simply add the -l owner=acme option on the CLI when starting Portainer: ```shell docker run -d -p 9000:9000 -p 8000:8000 -v /var/run/docker.sock:/var/run/docker.sock portainer/portainer-ce -l owner=acme @@ -211,7 +211,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent ## Use your own logo - You do not like our logo? Want to make Portainer more corporate? Don’t worry, you can easily switch for an external logo (it must be exactly 155px by 55px) using the --logo flag: + If you wish to replace our logo with your own, you can specify an external logo (it must be exactly 155px by 55px) using the --logo flag: ```shell docker run -d -p 9000:9000 -p 8000:8000 -v /var/run/docker.sock:/var/run/docker.sock portainer/portainer-ce --logo "https://www.docker.com/sites/all/themes/docker/assets/images/brand-full.svg" @@ -245,7 +245,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent * --edge-compute: Automatically enable edge-compute features * --hide-label, -l: Hide containers with a specific label in the UI * --host, -H: Docker daemon endpoint - * --logo: URL to a picture to be displayed as a logo in the UI, use Portainer logo if not specified + * --logo: URL to an image to be displayed as a logo in the UI. Uses the Portainer logo if not specified * --snapshot-interval: Time interval between two endpoint snapshot jobs expressed as a string, e.g. 30s, 5m, 1h… as supported by the time.ParseDuration method (default: 5m) * --ssl: Secure Portainer instance using SSL (default: false) * --sslcert: Path to the SSL certificate used to secure the Portainer instance (default: /certs/portainer.crt, C:\certs\portainer.crt on Windows) diff --git a/docs/v2.0-be/deploy/beinstallk8s.md b/docs/v2.0-be/deploy/beinstallk8s.md index 071a5fe..9846f55 100644 --- a/docs/v2.0-be/deploy/beinstallk8s.md +++ b/docs/v2.0-be/deploy/beinstallk8s.md @@ -213,7 +213,7 @@ Alternatively, if installing using our helm chart you can add the following opti ### :fontawesome-solid-server: Portainer Server Deployment - Based on how you would like expose Portainer Service, Select an option below + Based on how you would like expose the Portainer Service, select an option below: === "NodePort" Using the following command, Portainer will be available on port 30777. @@ -254,15 +254,15 @@ Alternatively, if installing using our helm chart you can add the following opti In some Kubernetes clusters (microk8s), the default Storage Class simply creates hostPath volumes, which are not explicitly tied to a particular node. In a multi-node cluster, this can create an issue when the pod is terminated and rescheduled on a different node, "leaving" all the persistent data behind and starting the pod with an "empty" volume. - While this behaviour is inherently a limitation of using hostPath volumes, a suitable workaround is to use add a nodeSelector to the deployment, which effectively "pins" the portainer pod to a particular node. + While this behaviour is inherently a limitation of using hostPath volumes, a suitable workaround is to use add a nodeSelector to the deployment, which effectively "pins" the Portainer pod to a particular node. The nodeSelector can be added in the following ways: - 1. Edit your own values.yaml and set the value of nodeSelector like this: + 1. Edit your own values.yaml and set the value of nodeSelector: nodeSelector: kubernetes.io/hostname: \ - 2. Explicictly set the target node when deploying/updating the helm chart on the CLI, by including `--set nodeSelector.kubernetes.io/hostname=` + 2. Explicitly set the target node when deploying/updating the helm chart on the CLI, by including `--set nodeSelector.kubernetes.io/hostname=` 3. If you've deployed Portainer via manifests, without Helm, run the following one-liner to "patch" the deployment, forcing the pod to always be scheduled on the node it's currently running on: diff --git a/docs/v2.0-be/deploy/beinstallswarm.md b/docs/v2.0-be/deploy/beinstallswarm.md index e277f39..e393b43 100644 --- a/docs/v2.0-be/deploy/beinstallswarm.md +++ b/docs/v2.0-be/deploy/beinstallswarm.md @@ -23,12 +23,12 @@ To learn more about the requirements please visit the [requirements](/v2.0-be/de ## :fontawesome-solid-paper-plane: Portainer Deployment -Use the following Docker commands to deploy the Portainer Server; note the agent is not needed on standalone hosts, however it does provide additional functionality if used (see Portainer and agent scenario below): +Use the following Docker commands to deploy the Portainer Server; note the agent is not needed on standalone hosts, however it does provide additional functionality if used: === "Docker Swarm on Linux" !!! Abstract "" ### Portainer Server Deployment - Deploying Portainer and the Portainer Agent to manage a Swarm cluster is easy! You can directly deploy Portainer 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. ```shell curl -L https://downloads.portainer.io/portainer-ee-agent-stack.yml -o portainer-agent-stack.yml @@ -59,10 +59,10 @@ Use the following Docker commands to deploy the Portainer Server; note the agent !!! Abstract "" Before you can deploy Portainer in Docker Swarm running in Windows, you need to install WSL. [Read this guide to know more about WSL/WSL2](https://docs.microsoft.com/en-us/windows/wsl/install-win10){target=_blank} - Use the following Docker Swarm commands to deploy the Portainer Server; note the agent is not needed on standalone hosts, however it does provide additional functionality if used (see portainer and agent scenario below): + Use the following Docker Swarm commands to deploy the Portainer Server; note the agent is not needed on standalone hosts, however it does provide additional functionality if used: ### Portainer Server Deployment - Deploying Portainer and the Portainer Agent to manage a Swarm cluster is easy! You can directly deploy Portainer as a service in your Docker cluster. Note that this method will automatically deploy a single instance + 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 deploys the Portainer Agent as a global service on every node in your cluster. Remember to initiate the Docker Swarm mode when you use Docker Desktop. You can do this running the following command: @@ -76,14 +76,14 @@ Use the following Docker commands to deploy the Portainer Server; note the agent ```shell Swarm initialized: current node (15gbf4d66mvzk3die00sgirpf) is now a manager. - To add a worker to this swarm, run the following command: + To add a worker to this swarm, run the swarm join command that is provided when initializing the swarm (it will look similar to the following): docker swarm join --token SWMTKN-1-096qbnf2b9yywagu5ht3731zlpkeqazgctffolntsiljfp0m34-c4snnxplgwq2bd1ohta8k48b9 192.168.65.3:2377 To add a manager to this swarm, run 'docker swarm join-token manager' and follow the instructions. ``` - Once this is done, you can continue with the installation running the following command: + Once this is done, you can continue with the installation by running the following command: ```shell curl -L https://downloads.portainer.io/portainer-ee-agent-stack.yml -o portainer-agent-stack.yml @@ -99,7 +99,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent docker network create --driver overlay --attachable portainer_agent_network ``` - Deploy Portainer Agent on a Swarm Cluster as a Swarm Service, run this command in a manager node in the cluster. + To deploy Portainer Agent on a Swarm Cluster as a Swarm Service, run this command in a manager node in the cluster: ```shell docker service create --name portainer_agent --network portainer_agent_network --publish mode=host,target=9001,published=9001 -e AGENT_CLUSTER_ADDR=tasks.portainer_agent --mode global --mount type=bind @@ -108,7 +108,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent === "Docker Swarm on Windows Container Service" !!! Abstract "" - To run Portainer in a Windows Server/Desktop Environment, you need to create exceptions in the firewall. These, can be easy added through PowerShell, running the following commands: + To run Portainer in a Windows Server/Desktop Environment, you need to create exceptions in the firewall. These can be easily added through PowerShell by running the following commands: ```shell netsh advfirewall firewall add rule name="cluster_management" dir=in action=allow protocol=TCP localport=2377 @@ -134,7 +134,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent netsh advfirewall firewall add rule name="swarm_dns_udp" dir=in action=allow protocol=UDP localport=53 ``` - You also need to install Windows Container Host Service and Install Docker. + You also need to install Windows Container Host Service and install Docker. ```shell Enable-WindowsOptionalFeature -Online -FeatureName containers -All diff --git a/docs/v2.0/deploy/ceinstalldocker.md b/docs/v2.0/deploy/ceinstalldocker.md index c816c70..adb0ee7 100644 --- a/docs/v2.0/deploy/ceinstalldocker.md +++ b/docs/v2.0/deploy/ceinstalldocker.md @@ -25,7 +25,7 @@ To learn more about the requirements please visit the [requirements](/v2.0/deplo ## :fontawesome-solid-paper-plane: Portainer Deployment -Use the following Docker commands to deploy the Portainer Server; note the agent is not needed on standalone hosts, however it does provide additional functionality if used (see Portainer and agent scenario below): +Use the following Docker commands to deploy the Portainer Server; note the agent is not needed on standalone hosts, however it does provide additional functionality if used: === "Docker on Linux" !!! Abstract "" @@ -47,7 +47,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent !!! Abstract "" Before you can deploy Portainer in Docker Standalone running in Windows, you need to install WSL. [Read this guide to know more about WSL/WSL2](https://docs.microsoft.com/en-us/windows/wsl/install-win10){target=_blank} - Use the following Docker commands to deploy the Portainer Server; note the agent is not needed on standalone hosts, however it does provide additional functionality if used (see portainer and agent scenario below): + Use the following Docker commands to deploy the Portainer Server; note the agent is not needed on standalone hosts, however it does provide additional functionality if used: ### :fontawesome-solid-server: Portainer Server Deployment ```shell @@ -67,7 +67,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent === "Docker on Windows Container Service" !!! Abstract "" - To run Portainer in a Windows Server/Desktop Environment, you need to create exceptions in the firewall. These, can be easy added trough PowerShell, running the following commands: + To run Portainer in a Windows Server/Desktop Environment you need to create exceptions in the firewall. These can be easily be added through PowerShell by running the following commands: ```shell netsh advfirewall firewall add rule name="cluster_management" dir=in action=allow protocol=TCP localport=2377 @@ -105,7 +105,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent Install-Package -Name docker -ProviderName DockerMsftProvider ``` - Lastly, you need to restart your Windows Server. After it has restarted, you're ready to deploy Portainer. + Lastly, you need to restart your Windows Server. Once it has restarted you're ready to deploy Portainer. ### :fontawesome-solid-server: Portainer Server Deployment @@ -155,7 +155,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent ### Inside a file You can also store the plaintext password inside a file and use the --admin-password-file flag: - Add your password to a file running the following command: + Add your password to a file, for example with the following command: ```shell echo -n mypassword > /tmp/portainer_password @@ -199,7 +199,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent docker run -d --label owner=acme nginx ``` - To hide this container, simply add the -l owner=acme option on the CLI when starting Portainer: + To hide this container, simply add the -l owner=acme option on the CLI when starting Portainer: ```shell docker run -d -p 9000:9000 -p 8000:8000 -v /var/run/docker.sock:/var/run/docker.sock portainer/portainer-ce -l owner=acme @@ -213,7 +213,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent ## Use your own logo - You do not like our logo? Want to make Portainer more corporate? Don’t worry, you can easily switch for an external logo (it must be exactly 155px by 55px) using the --logo flag: + If you wish to replace our logo with your own, you can specify an external logo (it must be exactly 155px by 55px) using the --logo flag: ```shell docker run -d -p 9000:9000 -p 8000:8000 -v /var/run/docker.sock:/var/run/docker.sock portainer/portainer-ce --logo "https://www.docker.com/sites/all/themes/docker/assets/images/brand-full.svg" @@ -247,7 +247,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent * --edge-compute: Automatically enable edge-compute features * --hide-label, -l: Hide containers with a specific label in the UI * --host, -H: Docker daemon endpoint - * --logo: URL to a picture to be displayed as a logo in the UI, use Portainer logo if not specified + * --logo: URL to an image to be displayed as a logo in the UI. Uses the Portainer logo if not specified * --snapshot-interval: Time interval between two endpoint snapshot jobs expressed as a string, e.g. 30s, 5m, 1h… as supported by the time.ParseDuration method (default: 5m) * --ssl: Secure Portainer instance using SSL (default: false) * --sslcert: Path to the SSL certificate used to secure the Portainer instance (default: /certs/portainer.crt, C:\certs\portainer.crt on Windows) diff --git a/docs/v2.0/deploy/ceinstallk8s.md b/docs/v2.0/deploy/ceinstallk8s.md index d2eed8a..d6178cb 100644 --- a/docs/v2.0/deploy/ceinstallk8s.md +++ b/docs/v2.0/deploy/ceinstallk8s.md @@ -48,7 +48,7 @@ kubectl patch storageclass -p '{"metadata": {"annotations": and replace with the name of your storage class Example: `kubectl patch storageclass local-path -p '{"metadata": {"annotations":{"storageclass.kubernetes.io/is-default-class":"true"}}}'` -Alternatively, if installing using our helm chart you can add the following option with helm install: +Alternatively, if installing using our Helm chart you can add the following option with helm install: ```shell --set persistence.storageClass= ``` @@ -60,10 +60,10 @@ Alternatively, if installing using our helm chart you can add the following opti === "Deploy using Helm" !!! Abstract "" ### :fontawesome-solid-server: Portainer Server Deployment - Ensure you're using at least helm v3.2, which [includes support](https://github.com/helm/helm/pull/7648) for the `--create-namespace` argument. + Ensure you're using at least Helm v3.2, which [includes support](https://github.com/helm/helm/pull/7648) for the `--create-namespace` argument. - First, add the Portainer helm repo running the following: + First, add the Portainer helm repo by running the following: ```shell helm repo add portainer https://portainer.github.io/k8s/ @@ -73,7 +73,7 @@ Alternatively, if installing using our helm chart you can add the following opti helm repo update ``` - Based on how you would like expose Portainer Service, Select an option below + Based on how you would like expose the Portainer Service, select an option below: === "NodePort" Using the following command, Portainer will be available on port 30777. @@ -147,7 +147,7 @@ Alternatively, if installing using our helm chart you can add the following opti ### :fontawesome-solid-laptop: Portainer Agent Only Deployment Helm chart for Agent Only Deployments will be available soon. - In the mean time please head over to YAML Manifests tab. + In the meantime please head over to YAML Manifests tab. === "Deploy using YAML Manifests" !!! Abstract "" @@ -212,7 +212,7 @@ Alternatively, if installing using our helm chart you can add the following opti ### :fontawesome-solid-server: Portainer Server Deployment - Based on how you would like expose Portainer Service, Select an option below + Based on how you would like expose the Portainer Service, select an option below: === "NodePort" Using the following command, Portainer will be available on port 30777. @@ -229,7 +229,7 @@ Alternatively, if installing using our helm chart you can add the following opti ``` ### :fontawesome-solid-laptop: Portainer Agent Only Deployment - Choose one of the tabs below based on how you would like to expose the agent. + Choose one of the tabs below based on how you would like to expose the agent: === "NodePort" Run the following command to deploy the Agent in your Kubernetes Cluster, agent will be available on port 30778. diff --git a/docs/v2.0/deploy/ceinstallswarm.md b/docs/v2.0/deploy/ceinstallswarm.md index 533a37e..b34c91d 100644 --- a/docs/v2.0/deploy/ceinstallswarm.md +++ b/docs/v2.0/deploy/ceinstallswarm.md @@ -26,12 +26,12 @@ To learn more about the requirements please visit the [requirements](/v2.0/deplo ## :fontawesome-solid-paper-plane: Portainer Deployment -Use the following Docker commands to deploy the Portainer Server; note the agent is not needed on standalone hosts, however it does provide additional functionality if used (see Portainer and agent scenario below): +Use the following Docker commands to deploy the Portainer Server; note the agent is not needed on standalone hosts, however it does provide additional functionality if used: === "Docker Swarm on Linux" !!! Abstract "" ### :fontawesome-solid-server: Portainer Server Deployment - Deploying Portainer and the Portainer Agent to manage a Swarm cluster is easy! You can directly deploy Portainer 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. ```shell curl -L https://downloads.portainer.io/portainer-agent-stack.yml -o portainer-agent-stack.yml @@ -40,10 +40,10 @@ Use the following Docker commands to deploy the Portainer Server; note the agent docker stack deploy -c portainer-agent-stack.yml portainer ``` - Note: By default this stack doesn't enable Host Management Features, you need to enable from the UI of Portainer. + Note: By default this stack doesn't enable Host Management Features, you need to enable this from the UI of Portainer. ### :fontawesome-solid-laptop: Portainer Agent Only Deployment - Deploy Portainer Agent on a remote LINUX Swarm Cluster as a Swarm Service, run this command on a manager node in the remote cluster. + To deploy Portainer Agent on a remote Linux Swarm Cluster as a Swarm Service, run this command on a manager node in the remote cluster. First create the network: @@ -51,7 +51,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent docker network create --driver overlay --attachable portainer_agent_network ``` - The following step is deploy the Agent: + The following step will deploy the Agent: ```shell docker service create --name portainer_agent --network portainer_agent_network --publish mode=host,target=9001,published=9001 -e AGENT_CLUSTER_ADDR=tasks.portainer_agent --mode global --mount type=bind,src=//var/run/docker.sock,dst=/var/run/docker.sock --mount type=bind,src=//var/lib/docker/volumes,dst=/var/lib/docker/volumes --mount type=bind,src=/,dst=/host portainer/agent @@ -62,13 +62,12 @@ Use the following Docker commands to deploy the Portainer Server; note the agent !!! Abstract "" Before you can deploy Portainer in Docker Swarm running in Windows, you need to install WSL. [Read this guide to know more about WSL/WSL2](https://docs.microsoft.com/en-us/windows/wsl/install-win10){target=_blank} - Use the following Docker Swarm commands to deploy the Portainer Server; note the agent is not needed on standalone hosts, however it does provide additional functionality if used (see portainer and agent scenario below): + Use the following Docker Swarm commands to deploy the Portainer Server; note the agent is not needed on standalone hosts, however it does provide additional functionality if used: ### :fontawesome-solid-server: Portainer Server Deployment - Deploying Portainer and the Portainer Agent to manage a Swarm cluster is easy! You can directly deploy Portainer as a service in your Docker cluster. Note that this method will automatically deploy a single instance - of the Portainer Server, and deploys 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 deploys the Portainer Agent as a global service on every node in your cluster. - Remember to initiate the Docker Swarm mode when you use Docker Desktop. You can do this running the following command: + Remember to initiate the Docker Swarm mode when you use Docker Desktop. You can do this by running the following command: ```shell docker swarm init @@ -79,14 +78,14 @@ Use the following Docker commands to deploy the Portainer Server; note the agent ```shell Swarm initialized: current node (15gbf4d66mvzk3die00sgirpf) is now a manager. - To add a worker to this swarm, run the following command: + To add a worker to this swarm, run the swarm join command that is provided when initializing the swarm (it will look similar to the following): docker swarm join --token SWMTKN-1-096qbnf2b9yywagu5ht3731zlpkeqazgctffolntsiljfp0m34-c4snnxplgwq2bd1ohta8k48b9 192.168.65.3:2377 To add a manager to this swarm, run 'docker swarm join-token manager' and follow the instructions. ``` - Once this is done, you can continue with the installation running the following command: + Once this is done, you can continue with the installation by running the following command: ```shell curl -L https://downloads.portainer.io/portainer-agent-stack.yml -o portainer-agent-stack.yml @@ -102,7 +101,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent docker network create --driver overlay --attachable portainer_agent_network ``` - Deploy Portainer Agent on a Swarm Cluster as a Swarm Service, run this command in a manager node in the cluster. + To deploy Portainer Agent on a Swarm Cluster as a Swarm Service, run this command in a manager node in the cluster: ```shell docker service create --name portainer_agent --network portainer_agent_network --publish mode=host,target=9001,published=9001 -e AGENT_CLUSTER_ADDR=tasks.portainer_agent --mode global --mount type=bind @@ -111,7 +110,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent === "Docker Swarm on Windows Container Service" !!! Abstract "" - To run Portainer in a Windows Server/Desktop Environment, you need to create exceptions in the firewall. These, can be easy added through PowerShell, running the following commands: + To run Portainer in a Windows Server/Desktop Environment, you need to create exceptions in the firewall. These can be easily added through PowerShell by running the following commands: ```shell netsh advfirewall firewall add rule name="cluster_management" dir=in action=allow protocol=TCP localport=2377 diff --git a/docs/v2.0/deploy/requirements.md b/docs/v2.0/deploy/requirements.md index 0dd7ece..a74586b 100644 --- a/docs/v2.0/deploy/requirements.md +++ b/docs/v2.0/deploy/requirements.md @@ -6,7 +6,7 @@ By default, Portainer will expose the UI over the port `#!Ruby 9000` and expose Every single release of Portainer goes through an extensive testing process (functional tests, release tests, post release tests) to ensure that what we are creating actually works as expected. Obviously though, we cannot possibly test Portainer against every single configuration variant out there, so we have elected to test against just a subset. -To try and alleviate confusion as to what we test against, we have documented the configurations that we personally validate as "functional"; any other variant is not tested (this does not mean it wont work, it just means its not tested). +To try and alleviate confusion as to what we test against, we have documented the configurations that we personally validate as "functional"; any other variant is not tested (this does not mean it won't work, it just means its not tested). ## :fontawesome-solid-check-double: Validated Configurations @@ -14,7 +14,7 @@ To try and alleviate confusion as to what we test against, we have documented th |--------------------|--------------|----------------|--------------------|---------------| | Community 2.6.0 (latest) | June 25, 2021 | 20.10.5 / 20.10.6 | 1.19 1.20.2 1.21 | ARM64, x86_64 | | Community 2.5.1 | May 18, 2021 | 20.10.5 / 20.10.6 | 1.19 1.20.2 1.21 | ARM64, x86_64 | -| Community 2.5. | May 18, 2021 | 20.10.5 | 1.19 1.20.2 1.21 | ARM64, x86_64 | +| Community 2.5.0 | May 18, 2021 | 20.10.5 | 1.19 1.20.2 1.21 | ARM64, x86_64 | | Community 2.1.x | Feb 2, 2021 | 20.10.2 | 1.20.0 | ARM64, x86_64 | | Community 2.0.1 | Jan 7, 2021 | 20.10.0 | 1.17.13 1.18.9 1.19.3 1.20.0 | ARM64, x86_64 | | Community 2.0 | Aug 31, 2020 | 19.03.12 | 1.17.13 1.18.6 1.18.9 1.19.3 | ARM64, x86_64 | From 68f15d3efc5969a8f078a8efa9dfa18270a651e3 Mon Sep 17 00:00:00 2001 From: James Carppe Date: Wed, 7 Jul 2021 20:53:05 +1200 Subject: [PATCH 2/3] Remove extra "be" --- docs/v2.0-be/deploy/beinstalldocker.md | 2 +- docs/v2.0/deploy/ceinstalldocker.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/v2.0-be/deploy/beinstalldocker.md b/docs/v2.0-be/deploy/beinstalldocker.md index 4a78c21..150d0c4 100644 --- a/docs/v2.0-be/deploy/beinstalldocker.md +++ b/docs/v2.0-be/deploy/beinstalldocker.md @@ -65,7 +65,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent === "Docker on Windows Container Service" !!! Abstract "" - To run Portainer in a Windows Server/Desktop Environment you need to create exceptions in the firewall. These can be easily be added through PowerShell by running the following commands: + To run Portainer in a Windows Server/Desktop Environment you need to create exceptions in the firewall. These can easily be added through PowerShell by running the following commands: ```PowerShell netsh advfirewall firewall add rule name="cluster_management" dir=in action=allow protocol=TCP localport=2377 diff --git a/docs/v2.0/deploy/ceinstalldocker.md b/docs/v2.0/deploy/ceinstalldocker.md index adb0ee7..c959770 100644 --- a/docs/v2.0/deploy/ceinstalldocker.md +++ b/docs/v2.0/deploy/ceinstalldocker.md @@ -67,7 +67,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent === "Docker on Windows Container Service" !!! Abstract "" - To run Portainer in a Windows Server/Desktop Environment you need to create exceptions in the firewall. These can be easily be added through PowerShell by running the following commands: + To run Portainer in a Windows Server/Desktop Environment you need to create exceptions in the firewall. These can easily be added through PowerShell by running the following commands: ```shell netsh advfirewall firewall add rule name="cluster_management" dir=in action=allow protocol=TCP localport=2377 From 44151082db98c2a92234267533fa9c6fabd953b4 Mon Sep 17 00:00:00 2001 From: James Carppe Date: Wed, 7 Jul 2021 21:00:20 +1200 Subject: [PATCH 3/3] Consistency --- docs/v2.0/deploy/ceinstalldocker.md | 2 +- docs/v2.0/deploy/ceinstallk8s.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/v2.0/deploy/ceinstalldocker.md b/docs/v2.0/deploy/ceinstalldocker.md index c959770..48bc322 100644 --- a/docs/v2.0/deploy/ceinstalldocker.md +++ b/docs/v2.0/deploy/ceinstalldocker.md @@ -116,7 +116,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent docker run -d -p 9000:9000 --name portainer --restart always -v \\.\pipe\docker_engine:\\.\pipe\docker_engine -v portainer_data:C:\data portainer/portainer-ce ``` - Now, you can navigate to http://localhost:9000 or the IP of the server and start using Portainer. + Now you can navigate to http://localhost:9000 or the IP of the server and start using Portainer. ### :fontawesome-solid-laptop: Portainer Agent Only Deployment diff --git a/docs/v2.0/deploy/ceinstallk8s.md b/docs/v2.0/deploy/ceinstallk8s.md index d6178cb..4ddc8b1 100644 --- a/docs/v2.0/deploy/ceinstallk8s.md +++ b/docs/v2.0/deploy/ceinstallk8s.md @@ -253,15 +253,15 @@ Alternatively, if installing using our Helm chart you can add the following opti In some Kubernetes clusters (microk8s), the default Storage Class simply creates hostPath volumes, which are not explicitly tied to a particular node. In a multi-node cluster, this can create an issue when the pod is terminated and rescheduled on a different node, "leaving" all the persistent data behind and starting the pod with an "empty" volume. - While this behaviour is inherently a limitation of using hostPath volumes, a suitable workaround is to use add a nodeSelector to the deployment, which effectively "pins" the portainer pod to a particular node. + While this behaviour is inherently a limitation of using hostPath volumes, a suitable workaround is to use add a nodeSelector to the deployment, which effectively "pins" the Portainer pod to a particular node. The nodeSelector can be added in the following ways: - 1. Edit your own values.yaml and set the value of nodeSelector like this: + 1. Edit your own values.yaml and set the value of nodeSelector: nodeSelector: kubernetes.io/hostname: \ - 2. Explicictly set the target node when deploying/updating the helm chart on the CLI, by including `--set nodeSelector.kubernetes.io/hostname=` + 2. Explicitly set the target node when deploying/updating the helm chart on the CLI, by including `--set nodeSelector.kubernetes.io/hostname=` 3. If you've deployed Portainer via manifests, without Helm, run the following one-liner to "patch" the deployment, forcing the pod to always be scheduled on the node it's currently running on: