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

Merge pull request #175 from samdulam/master 

Pre-Reqs to CE Install Docs
pull/177/head
samdulam 2021-07-07 11:57:15 +12:00 committed by GitHub
parent 7e046d8143 c977284e2f
commit 427e993fd4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 26 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/v2.0/deploy/ceinstalldocker.md
View File

@ -4,9 +4,16 @@ hide:
---
# :fontawesome-brands-docker: Deploying Portainer CE in Docker
Portainer is comprised of two elements, the Portainer Server, and the Portainer Agent. Both elements run as lightweight Docker containers on a Docker engine or within a Swarm cluster. Due to the nature of Docker, there are many possible deployment scenarios, however, we have detailed the most common below. Please use the scenario that matches your configuration.
Portainer is comprised of two elements, the Portainer Server, and the Portainer Agent. Both elements run as lightweight Docker containers on a Docker engine. Due to the nature of Docker, there are many possible deployment scenarios, however, we have detailed the most common below. Please use the scenario that matches your configuration.
If you are using Docker Swarm, please refer to the Swarm-specific installation [instructions](/v2.0/deploy/ceinstallswarm/).
Regardless of your configuration, you will need:
* The latest version of Docker installed and working. You can refer to [the Docker documentation](https://docs.docker.com/get-docker/) for platform-specific instructions.
* Administrator or sudo access on the machine that will host your Portainer instance.
* If you are using Docker Desktop on Windows you need to enable WSL2 if you need to run Linux containers.
Note that the recommended deployment mode when using Swarm is using the Portainer Agent.
By default, Portainer will expose the UI over the port `#!Ruby 9000` and expose a TCP tunnel server over the port `#!Ruby 8000`. The latter is optional and is only required if you plan to use the Edge compute features with Edge agents.

9
docs/v2.0/deploy/ceinstallk8s.md
View File

@ -6,7 +6,14 @@
frameborder="0" allowfullscreen class="video"></iframe>
</div>
Portainer is comprised of two elements, the Portainer Server, and the Portainer Agent. Both elements run as lightweight Docker containers on a Docker engine. There are many possible deployment scenarios, however, we have detailed the most common below. Please use the scenario that matches your configuration.
Portainer is comprised of two elements, the Portainer Server, and the Portainer Agent. Both elements run as lightweight containers on Kubernetes. There are many possible deployment scenarios, however, we have detailed the most common below. Please use the scenario that matches your configuration.
Regardless of your configuration, you will need:
* A working and up to date Kubernetes cluster
* Access to run Helm or kubectl commands on your cluster
* Cluster Admin rights on your Kubernetes cluster. This is so Portainer can create the necessary `#!Ruby ServiceAccount` and `#!Ruby ClusterRoleBinding` for it to access the Kubernetes cluster.
* A default StorageClass configured (see below)
By default, Portainer will expose the UI over the port `#!Ruby 9000` and expose a TCP tunnel server over the port `#!Ruby 8000`. The latter is optional and is only required if you plan to use the Edge compute features with Edge agents.

11
docs/v2.0/deploy/ceinstallswarm.md
View File

@ -5,9 +5,16 @@
frameborder="0" allowfullscreen class="video"></iframe>
</div>
Portainer is comprised of two elements, the Portainer Server, and the Portainer Agent. Both elements run as lightweight Docker containers on a Docker engine or within a Swarm cluster. Due to the nature of Docker, there are many possible deployment scenarios, however, we have detailed the most common below. Please use the scenario that matches your configuration.
Portainer is comprised of two elements, the Portainer Server, and the Portainer Agent. Both elements run as lightweight Docker containers within a Swarm cluster. Due to the nature of Docker, there are many possible deployment scenarios, however, we have detailed the most common below. Please use the scenario that matches your configuration.
<!-- **Note:** The recommended deployment mode when using Swarm is using the Portainer Agent. -->
Regardless of your configuration, you will need:
* The latest version of Docker installed and working, with swarm mode enabled and your nodes added. You can refer to [the Docker documentation](https://docs.docker.com/get-docker/) for platform-specific instructions.
* Administrator or sudo access on the machine that will host the Portainer Server service.
* Administrator or sudo access on the machines where you will deploy the Portainer Agent if you need to add more endpoints to your Portainer instance.
Note that the recommended deployment mode when using Swarm is using the Portainer Agent.
By default, Portainer will expose the UI over the port `#!Ruby 9000` and expose a TCP tunnel server over the port `#!Ruby 8000`. The latter is optional and is only required if you plan to use the Edge compute features with Edge agents.