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

User guide Updates

pull/99/head
keverv 2020-10-21 16:49:40 +13:00
parent 7eeeb83ffd
commit 8246c7870c
13 changed files with 60 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/v2.0/images/build.md
View File

@ -8,23 +8,23 @@ Portainer allows you to create/build new images from a friendly UI. You can defi
## Building an Image using our web editor
Go to <b>Images</b> and click in <b>Build a new image</b>.
Go to <b>Images</b> and click <b>Build a new image</b>.
![build](assets/build-1.png)
In the next screen, you need to define a name for you image and start to write your dockerfile in the editor.
In the next screen, you need to define a <b>name</b> for your image and start to write your dockerfile in the editor.
<b>Note</b>: You can define multiple names for you image.
<b>Note</b>: You can define <b>multiple names</b> for you image.
![build](assets/build-2.png)
When you're ready, scrolldown, select the node you going to save the image and click in <b>Build the image</b>
When you're ready, scrolldown, select the <b>node</b> you going to save the image to and click <b>Build the image</b>
![build](assets/build-3.png)
![build](assets/build-4.png)
When the building process is complete, you need to click in the tab <b>Output</b> and you will see the history of the building and the result. If everything works as expected, you will see something like this at the end of the output:
When the building process is complete, you need to click in the tab <b>Output</b> and you will see the build history and the result. If everything works as expected, you will see a similar output to this:
![build](assets/build-5.png)

10
docs/v2.0/images/export.md
View File

@ -1,20 +1,20 @@
# Export Images
From Portainer UI you can export any Docker image that is store in any node. This is useful when you need to move a container from a one host or another or simply make backup of the images.
Portainer allows you to export any Docker image that is stored in any node. This is useful when you need to move a container from a one host to another or simply make backup of the images.
<b>Note</b>: Be advised that when you export a container to a tar file, the volumes are not exported with it. You need to save the data from that volumes in a another way.
<b>Note</b>: Be advised that when you export a container to a tar file, the volumes are not exported with it. You need to save the data from those volumes in a another way.
## Exporting Images
To export images, do a click in <b>Images</b>, select the image you want to export and do a click in <b>Export</b>.
To export images, click<b>Images</b>, select theimage</b> you want to export and click <b>Export</b>.
![export](assets/export-1.png)
You will see a pop up warning you about that the exportation may take several minutes. This depends of the size of your image. Do a click in <b>Continue</b>.
You will see a pop up warning you about that the export may take several minutes, this time depends of the size of your image. Click <b>Continue</b>.
![export](assets/export-2.png)
When the process is ready you will see a pop up at the top right corner and also, you will see that your image is downloading:
When the process is ready you will see a pop up at the top right corner and you will see that your image is downloading:
![export](assets/export-3.png)

8
docs/v2.0/images/import.md
View File

@ -1,18 +1,18 @@
# Import Images
Portainer is capable to import the images that you created in another Portainer instance or in the CLI of Docker and Docker Swarm.
Portainer allows you to import the images that you have created in another Portainer instance or in the CLI of Docker and Docker Swarm.
## Importing Images
To import an image using Portainer, go a <b>Images</b> and then do a click in <b>Import</b>.
To import an image using Portainer, go a <b>Images</b> and then click <b>Import</b>.
![import](assets/import-1.png)
Select your image, select the node where you will save the image and do a click in <b>Upload</b>.
Select your <b>image</b>, select the <b>node</b> where you will save the image and click <b>Upload</b>.
![import](assets/import-2.png)
Once the image are uploaded, you will see the following pop up:
Once the images have uploaded, you will see the following pop up:
![import](assets/import-3.png)

15
docs/v2.0/images/pull.md
View File

@ -1,31 +1,32 @@
# Pull Images
From the Portainer UI you can pull images from any registry. This option is only available, at this moment, when you manage Docker and Docker Swarm environments.
You can pull images from any registry already added to Portainer, see how to [add new registries](/v2./registries/connect/) to Portainer for more information. This option is currently only available, when you manage Docker and Docker Swarm environments.
## Pulling Images
### Pulling in Simple Mode
To pull images from Docker Hub or another registry that you connect before in Portainer. Go to <b>Images</b> and then type the name of the image, select the node when the image is going to be downloaded and click in <b>Pull the Image</b>.
To pull images from Docker Hub or another registry that you have connected before you must do the following:
Go to <b>Images</b> and then type the <b>name</b> of the image, select the <b>node</b> that will download the image and click <b>Pull the Image</b>.
![pull](assets/pull-1.png)
![pull](assets/pull-2.png)
When the image is sucessful downloaded, you will see a pop up at the right top corner.
When the image is sucessfully downloaded, you will see a pop up at the right top corner.
![pull](assets/pull-3.png)
To see how to add new registries to Portainer, [click here](/v2./registries/connect/).
### Pulling in Advanced Mode
Another option to download images is in <b>Advanced Mode</b>. The difference with the <b>Simple Mode</b> is the possibility to define a custom registry URL, port and image. This use case is ideal when you run your own private registry.
Using <b>Advanced Mode</b> you can define a <b>custom registry URL</b>, <b>port</b> and <b>image</b>. This use case is ideal when you run your own private registry.
To pull images, go to <b>Images</b> click in Advanced Mode and then, define your registry, port and image, also, you need to specify the node where the image is going to be downloaded and do a click in <b>Pull the Image</b>
To pull images, go to <b>Images</b> click in <b>Advanced Mode</b> and then, define your <b>registry</b>, <b>port</b>, <b>image</b>, and specify the <b>node</b> where the image is going to be downloaded and click <b>Pull the Image</b>
![pull](assets/pull-4.png)
You will see an animation in the button while the imeage is downloading:
![pull](assets/pull-2.png)
When the image is sucessful downloaded, you will see a pop up at the right top corner.

8
docs/v2.0/networks/add.md
View File

@ -1,15 +1,15 @@
# Add a Network
Portainer allows you to manage networks for your containers environments. You will be capable to create this kind of networks:
Portainer allows you to manage networks for your containers environments. You will be able to to create these network types:
* Bridge: he default network driver. If you don’t specify a driver, this is the type of network you are creating. Bridge networks are usually used when your applications run in standalone containers that need to communicate.
* Bridge: the default network driver. If you don’t specify a driver, this is the type of network you are creating. Bridge networks are usually used when your applications run in standalone containers that need to communicate.
* Macvlan: Macvlan networks allow you to assign a MAC address to a container, making it appear as a physical device on your network. The Docker daemon routes traffic to containers by their MAC addresses. Using the macvlan driver is sometimes the best choice when dealing with legacy applications that expect to be directly connected to the physical network, rather than routed through the Docker host’s network stack.
* Overlay: Overlay networks connect multiple Docker daemons together and enable swarm services to communicate with each other. You can also use overlay networks to facilitate communication between a swarm service and a standalone container, or between two standalone containers on different Docker daemons.
* IPvlan: IPvlan is similar to macvlan with the difference being that the endpoints have the same mac address. ipvlan supports L2 and L3 mode. In ipvlan l2 mode, each endpoint gets the same mac address but different ip address. In ipvlan l3 mode, packets are routed between endpoints, so this gives better scalability.
## Adding a Network
To add a network in Portainer, click in <b>Networks</b> and then click in <b>Add Network</b>.
To add a network in Portainer, click <b>Networks</b> and then click <b>Add Network</b>.
![add](assets/add-1.png)
@ -24,7 +24,7 @@ In the next screen, you need to define the following information:
* Enable manual container attachment: Select the toggle if the users can attach this network to running containers.
* Deployment: Select the node where this network is going to be created.
When everything is set, do a click in <b>Create the Network</b>.
When everything is set, click <b>Create the Network</b>.
![add](assets/add-2.png)

4
docs/v2.0/networks/delete.md
View File

@ -1,10 +1,10 @@
# Delete a Network
From Portainer UI you can delete networks.
Portainer allows you to delete networks.
## Deleting Networks
To delete a network, do a click in <b>Networks</b>, select the network you want to delete, and do a click in <b>Remove</b>.
To delete a network, click <b>Networks</b>, select the <b>network</b> you want to delete, and click <b>Remove</b>.
![delete](assets/delete-1.png)

5
docs/v2.0/services/create.md
View File

@ -1,6 +1,7 @@
# How to Create a new service
The services are collections of containers. In this case, We're going to deploy an NGINX Web Server.
Services are collections of containers. In this example, ee're going to deploy an NGINX Web Server.
<b>Note</b>: This article only covers Docker Swarm environments at present.
## Creating a new service
@ -21,7 +22,7 @@ Complete the fields:
![services](assets/create_2.png)
Further settings are available on this screen, once these have been set, click <b>Create The Service</b>.
Further settings are available on this screen, once these have been set appropriately, click <b>Create The Service</b>.
![services](assets/create_3.png)

2
docs/v2.0/services/logs.md
View File

@ -4,7 +4,7 @@ Service logs are incredibly useful for troubleshooting issues and service behavi
## Accessing to Service Logs
Click <b>Services</b> and then choose the service you want to view the logs.
Click <b>Services</b> and then choose the service you want to view the logs for.
![logs](assets/logs_1.png)

16
docs/v2.0/services/options.md
View File

@ -14,13 +14,13 @@ The environment variables are useful to set configuration at the same time that
### Labels
Containers labels can be used to leave notes of that container or specify configuration.
Container labels can be used to leave notes of that container or specify configuration.
![options](assets/options-2.png)
### Mounts
You can mount or bind volumes from Portainer. Also, you can set if that volume needs to set in Read Only. The only thing you need to do is select a created volume, specify the path in container and click in <b>Apply Changes</b>.
You can mount or bind volumes from Portainer. You can also set if that volume needs to set in <b>Read Only</b>. The only thing you need to do is select a created volume, specify the path in container and click <b>Apply Changes</b>.
![options](assets/options-3.png)
@ -28,19 +28,19 @@ You can mount or bind volumes from Portainer. Also, you can set if that volume n
### Networks
You can define one or more networks to you service, even, after of deploy it. You only need to create your network and then, select from the dropdown list.
You can define one or more networks for your service; this can even been done after it has been deployed. You only need to <b>create your network</b> and then, select from the dropdown list.
![options](assets/options-4.png)
### Published Ports
Here, you can publish ports to access to this container from outside the host. You can set new or modify the current ports.
Here, you can publish ports to access this container from outside the host. You can set new or modify the current ports.
![options](assets/options-5.png)
### Host file entries
When you need to specify manually a hostname or url, you can set up from here and associated that URL to a internal or external IP Address.
This is used when you need to manually specify a hostname or url; associat the URL to an internal or external IP Address.
![options](assets/options-6.png)
@ -48,7 +48,7 @@ When you need to specify manually a hostname or url, you can set up from here an
### Resource limits and reservations
From Portiner, you can set limitations about the resource utilization, like Memory, CPU Reservation, CPU Limit, etc.
From Portainer, you can set limitations about the resource utilization, like Memory, CPU Reservation, CPU Limit, etc.
![options](assets/options-7.png)
@ -60,7 +60,7 @@ Use placement constraints to control the nodes a service can be assigned to.
### Placement preferences
While placement constraints limit the nodes a service can run on, placement preferences try to place tasks on appropriate nodes in an algorithmic way (currently, only spread evenly).
While placement constraints limit the nodes a service can run on, placement preferences try to place tasks on appropriate nodes in an algorithmic way (currently, this is only spread evenly).
![options](assets/options-9.png)
@ -74,7 +74,7 @@ The options are the following:
* On Failure: Restart the container if it exits due to an error, which manifests as a non-zero exit code.
* None: Do not automatically restart the container.
Also, you can adjust Restart Delay, Max Attempts and Restart Window.
You can also adjust Restart Delay, Max Attempts and Restart Window.
![options](assets/options-10.png)

10
docs/v2.0/services/rollback.md
View File

@ -1,15 +1,21 @@
# Rollback a Service
After make a change to a service in Docker Swarm, you can rollback that changes if you applications is not working as expected. You can do this rollback from Portainer UI.
After make a change to a service in Docker Swarm, you can rollback those changes if your applications are not working as expected.
## Rollbacking a Service
To rollback a service to the last state, it's very easy trough Portainer. Do a click in <b>Services</b>, choose the service you want to rollback, and then do a click in <b>Rollback the service</b>.
To rollback a service to the last state click <b>Services</b>, choose the <b>service</b> you want to rollback.
![rollback](assets/rollback-1.png)
Then click <b>Rollback the service</b>.
![rollback](assets/rollback-2.png)
You will be asked to confirm this rollback.
![rollback](assets/rollback-3.png)
If successful, a green pop up confirming will show at the top right of screen.
![rollback](assets/rollback-4.png)

4
docs/v2.0/services/scale.md
View File

@ -4,11 +4,11 @@ This is a powerful feature that allows you to scale your services horizontally.
## Scaling a Service
Click in <b>Services</b> and then Click <b>scale</b>.
Click <b>Services</b> and then Click <b>scale</b>.
![scale](assets/scale_1.png)
Enter the number of replicas you want for this service and select the <b>check</b>.
Enter the number of replicas you want for this service and click the <b>check box</b>.
![scale](assets/scale_2.png)

8
docs/v2.0/templates/deploy_container.md
View File

@ -1,18 +1,18 @@
# Deploy an standalone app (Container)
From Portainer, you will able to deploy an standalone app from the default template list. In this help article, you will learn how to do it.
From Portainer, you can deploy a standalone app from the default template list.
## Deploying an standalone app
To deploy a standalone container from the templates, you need to go to <b>App Templates</b>, enable the toogle <b>Show container templates</b> and pick the app you want to deploy. For this example, I will deploy an Apache Web Server.
To deploy a standalone container from the templates, you need to go to <b>App Templates</b>, enable the toggle <b>Show container templates</b> and pick the app you want to deploy. For this example, we will deploy an Apache Web Server.
![templates](assets/container-1.png)
After that, define a name, network, access control if needed, port mapping, volumes and when all is set, do a click in <b>Deploy the Container</b>.
After that, define a <b>name</b>, <b>network</b>, <b>access control</b> if needed, <b>port mapping</b>, <b>volumes</b> and when all is set, do a click in <b>Deploy the Container</b>.
![templates](assets/container-2.png)
Meanwhile the container is deployed, you will see an animation in the button.
You will see an animation in the button while the container is deploying:
![templates](assets/container-3.png)

12
docs/v2.0/templates/deploy_stack.md
View File

@ -1,18 +1,18 @@
# How to deploy and stack from a template
# How to deploy a stack from a template
Portainer allows you to deploy an entire stack from a template included in the template list by default or a custom template created before. See how [Create a template from a Stack](/v2.0/stacks/template.md).
Portainer allows you to deploy an entire stack from a template from the template list which includes default and custom templates. Also see [creating a template from a Stack](/v2.0/stacks/template).
## Deploying an Stack
To deploy an stack, go to <b>App Templates</b> and choose the template you want to deploy. In this example, I will deploy a cluster of CockroachDB.
To deploy a stack, go to <b>App Templates</b> and choose the template you want to deploy. In this example, I will deploy a CockroachDB cluster.
![templates](assets/stack-1.png)
Set a name, define access control (if enabled with the toogle) and do a click in <b>Deploy the Stack</b>
Set a <b>name</b>, define access control (if enabled with the toogle) and click <b>Deploy the Stack</b>
![templates](assets/stack-2.png)
You will see an animation in the button meanwhile is deploying this stack:
You will see an animation in the button while the stack is deploying:
![templates](assets/stack-3.png)
@ -20,7 +20,7 @@ If everything work as expected, you will see your new stack deployed.
![templates](assets/stack-4.png)
Do a click in the name of your stack to see the details of the deployment:
Click the name of your stack to see the details of the deployment:
![templates](assets/stack-5.png)