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

Updates to User Guide

pull/99/head
keverv 2020-10-27 16:19:55 +13:00
parent d150959092
commit 7b1965895d
21 changed files with 96 additions and 100 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/v2.0/configs/add.md
View File

@ -4,7 +4,7 @@ Docker 17.06 introduces swarm service configs, which allow you to store non-sens
## Adding Configs
To add configs to Portainer do a click in <b>Configs</b> and then in <b>Add config</b>.
To add configs to Portainer click <b>Configs</b> and then <b>Add config</b>.
![configs](assets/configs-1.png)
@ -12,7 +12,7 @@ Then, in the Editor, you need to write your configuration. In this example, you
Once this config is defined, you can add labels and/or manage access control of this config.
When everything is set, do a click in <b>Create config</b>.
When everything is set, click <b>Create config</b>.
![configs](assets/configs-2.png)

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

@ -1,10 +1,10 @@
# Delete Configs
From Portainer UI you can delete the configs that you created before.
From Portainer you can delete the configs that you created before.
## Deleting Configs
To delete a config, go to <b>Configs</b>, select the config you want to delete and click in <b>Remove</b>.
To delete a config, go to <b>Configs</b>, select the config you want to delete and click <b>Remove</b>.
![configs](assets/config-delete-1.png)

22
docs/v2.0/kubernetes/applications/create.md
View File

@ -1,44 +1,44 @@
# Deploy New Applications
From Portainer, you can deploy new applications in your Kubernetes cluster without need to learn complex CLI commands or edit large YML files. In this help article, you will learn, how to deploy an App into a Kubernetes cluster using Portainer.
From Portainer, you can deploy new applications in your Kubernetes cluster without the need to learn complex CLI commands or edit large YML files. In this help article, you will learn how to deploy an App into a Kubernetes cluster using Portainer.
## Deploying an application
Deploy an application to a Kubernetes is very easy and very customizable depends of you need, using Portainer.
Deploying an application in Portainer to Kubernetes is very easy and very customizable depending on your need.
To deploy a new application, you need to choose your <b>Kubernetes</b> Cluster, click in <b>Applications</b> and then in <b>Add Application</b>.
To deploy a new application, you need to choose your <b>Kubernetes</b> Cluster, click <b>Applications</b> and then <b>Add Application</b>.
![create](assets/create-1.png)
![create](assets/create-2.png)
After that, you will see a complete form to fill depending of you needs. Let's review the options availables:
After that, you will see a form to complete according to your needs. The options available are:
* Name: Name of your Container.
* Image: This is the image you want to use to deploy your container.
* Resource Pool: This is the namespace where your container is going to live. To add a new resource pool, see this [help article](/v2.0/docs/kubernetes/resouce_pool/create.md).
* Stack: Portainer can automatically bundle multiple applications inside a stack. Enter a name of a new stack or select an existing stack in the list. Leave empty to use the application name.
* Environment Variables: Fill the environment that you app need, this is optional and only depends of the configuration supported by your app.
* Environment Variables: Fill the environment that your app needs, this is optional and only depends of the configuration supported by your app.
* Configurations: If you created configuration files before using Portainer, you can select that configuration in this space.
* Persisting Data: Here you need to define what folder of the container needs to be persisted.
* Persisting Data: Define what folder of the container needs to be persisted.
* Data Access Policy: Here you need to specify how the data will be used across instances. The options are the following:
- Shared: All the instances of this application will use the same data.
- Isolated: Every instance of this application will use their own data.
* Resource Reservations: Here, you can define what resources can be used by your application.
* Resource Reservations: Define what resources can be used by your application.
* Deployment: Select how you want to deploy your application inside the cluster. The options are the following:
- Replicated: Run one or multiple instances of this container.
- Global: Deploy an instance of this container on each node of the cluster.
* Auto Scaling: Select this instance to enable the auto scaling of your application and define to how much instances needs to scalate and under what conditions.
* Auto Scaling: Select this to enable the auto scaling of your application and define how many instances need to scale and under what conditions.
* Placement rules: Deploy this application on nodes that respect ALL of the following placement rules. Placement rules are based on node labels.
* Placement Policy: Specify the policy associated to the placement rules. This can be any of two options:
- Preferred: Schedule this application on nodes that match the rules if possible.
- Mandatory: Schedule this application ONLY on nodes that match ALL Rules.
* Publish Application: Select how you want to publish your application. This can be any of two options:
* Publish Application: Select how you want to publish your application. This can be one of two options:
- Internal: Internal communications inside the cluster only.
- Cluster: Publish this application via a port on all nodes of the cluster.
Publish Ports: Depends of you need and the configuration choosen in the last step.
Publish Ports: Only applicable if you have selected Cluster above.
When everything was set up, do a click in <b>Deploy application</b>.
When everything was set up, click <b>Deploy application</b>.
![create](assets/create-3.png)

2
docs/v2.0/kubernetes/applications/delete.md
View File

@ -4,7 +4,7 @@ You can remove/delete applications using the Portainer GUI.
## Deleting an Application
To delete an Application, do a click in <b>Applications</b>, select the Application you want to delete and then do a click in <b>Remove</b>.
To delete an Application, click <b>Applications</b>, select the Application you want to delete and then click <b>Remove</b>.
![delete](assets/delete-1.png)

25
docs/v2.0/kubernetes/applications/inspect.md
View File

@ -1,48 +1,47 @@
# Inspect Application.
From Portainer, you will able to see a lot of details of your application running in the cluster. In this help article, you will see what information you can found using Portainer.
To access to this information about each container, do a click in <b>Applications</b> and the click in the application you want inspect.
From Portainer, you can see a lot of details about your application running in a cluster.
To access to this information click <b>Applications</b> and then click the application you want to inspect.
![inspect](assets/inspect-1.png)
## Application information
In the tab <b>Application</b>, you can found the following information:
In the tab <b>Application</b>, you can find the following information:
* Name: Name of the application.
* Stack: Name of the stack that this container belongs.
* Resource Pool: In what resouce pool / Namespace this application in running.
* Application Type.
* Status: Here, we can see if the application is running.
* Status: See if the application is running.
* Creation: Information about who and when the application was created.
Also, you can find specific configuration of this application:
You can also find specific configuration of this application:
* Port published: Show what is the port published from this container.
* Auto Scaling: Show if this application has a auto scaling policy defined.
* Port published: Show what port is published from this container.
* Auto Scaling: Show if this application has an auto scaling policy defined.
* Configuration: Here, we can see if the application has a special configuration defined.
* Data Persistence: Here we can see what directory are persitent.
* Data Persistence: Here we can see what directories are persitent.
In the Application container section you can see the pod that run your application, what the image is using, status, node and information about when was created. Also, you can access to logs or the console of this Pod.
In the Application container section you can see the pod that runs your application, what the image is using, status, node and information about when it was created. Also, you can access the logs or the console of this Pod.
![inspect](assets/inspect-2.png)
## Placement
In this tab, you will find information about in what node your application is running.
In this tab, you will find information what node your application is running in.
![inspect](assets/inspect-3.png)
## Events
In this tab, you will find information about the events related of your container.
This shows find information about the events related of your container.
![inspect](assets/inspect-4.png)
## YML
In this section, you can find the YML generated from the deplotyment of you application using Portainer. This is very useful to create "backups" of your configuration.
In this section, you can find the YML generated from the deployment of your application using Portainer. This is very useful to create "backups" of your configuration.
![inspect](assets/inspect-5.png)

8
docs/v2.0/kubernetes/applications/manifest.md
View File

@ -1,20 +1,20 @@
# Deploy an App from a manifest
In Portainer you will capable to launch new applications using your currents manifest in format YML for K8s or convert from a docker-compose file format.
In Portainer you can launch new applications using your current manifest in YML for K8s or convert from a docker-compose file format.
<b>Note</b>: Portainer uses Kompose to convert your Compose manifest to a Kubernetes compliant manifest. Be wary that not all the Compose format options are supported by Kompose at the moment.
## Deploying an App from a Kubernetes Manifest.
To start, do a click in <b>Applications</b> and then in <b>Advanced Deployment</b>.
To start, click <b>Applications</b> and then <b>Advanced Deployment</b>.
![manifest](assets/manifest-1.png)
In this section, you need to define the resource pool where your applications is going to be deployed and start to write or paste your Kubernetes Manifest. Once is done, do a click in <b>Deploy</b>.
In this section, you need to define the resource pool where your applications are going to be deployed and start to write or paste your Kubernetes Manifest. Once this is done, click <b>Deploy</b>.
![manifest](assets/manifest-2.png)
If everything work as expected you will see the next pop up.
If everything works as expected you will see this pop up:
![manifest](assets/manifest-3.png)

21
docs/v2.0/kubernetes/cluster/inspect.md
View File

@ -1,17 +1,17 @@
# Inspect the Cluster
From Portainer, you will capable to inspect the cluster. In this help article you will learn how to inspect the Kubernetes cluster from Portainer.
From Portainer, you can inspect Kubernetes Clusters.
## Inspecting the cluster
Do a click in <b>Cluster</b> and you will see information about this cluster.
Click <b>Cluster</b> and you will see information about this cluster.
* Memory Reservation: You will see the memory used and available of this cluster.
* CPU Reservation: You will see how much CPU reserved is used.
* Client Satus: You will see in the components are healthy of they have some problems.
* Memory Reservation: Memory used and available for this cluster.
* CPU Reservation: How much CPU reserved is used.
* Client Satus: View if the components are healthy or they have some any issues.
* Leader Status: You will see if this node is a Leader or not.
In the bottom of the page, you will see information about the nodes that're part of this cluster.
At the bottom of the page, you will see information about the nodes that are part of this cluster.
Name, Role, CPU, Memory, Version of Kubernetes, IP Address.
@ -29,23 +29,20 @@ When you click in a node, you can inspect it. You will find the following inform
* Kubelet Version
* Creation date
* Status
Also, you will find memory and CPU reservation.
* Labels
* Applications running on the node.
* Applications running on this node
![inspect](assets/inspect-2.png)
### Events
In this tab, you will see information about the events related to your node.
In the events tab, you will see information about the events related to your node.
![inspect](assets/inspect-3.png)
### YAML
In this tab, you will find the configuration of your node in YAML format. You can copy the content and saving in a file to mantain a backup of the node configuration.
Here you will find the configuration of your node in YAML format. You can copy the content and save it to mantain a backup of the node configuration.
![inspect](assets/inspect-4.png)

14
docs/v2.0/kubernetes/configurations/create.md
View File

@ -1,24 +1,24 @@
# Create a configuration
From Portainer you can create Configurations files, outside a service’s image or running containers. This allows you to keep your images as generic as possible, without the need to bind-mount configuration files into the containers or use environment variables.
From Portainer you can create Configurations files outside a service’s image or running containers. This allows you to keep your images as generic as possible, without the need to bind-mount configuration files into the containers or use environment variables.
## Creating a configuration
To create a configuration, do a click in <b>Configurations</b> and then do a click in <b>Add configuration</b>.
To create a configuration, click <b>Configurations</b> and then click <b>Add configuration</b>.
![add](assets/add-1.png)
In the next screen, you need to define some things:
In the next screen, you need to define the following:
* Name: Name your configuration.
* Resource Pool: Where the configuration is going to be saved.
* Configuration Type:
- Non-sensitive: This configuration holds non-sensitive information like passwords or certificates.
- Sensitive: This configuration holds sensitive information
- Non-sensitive: This configuration holds non-sensitive information.
- Sensitive: This configuration holds sensitive information like passwords or certificates
In the data section, clicking in <b>Advanced Mode</b> you can define in YAML format your configuration. If not, you can create entries using the fields below or taking from a file.
In the data section, clicking <b>Advanced Mode</b> allows you to define your configuration in YAML format. If you would prefer not to use advanced mode, you can create entries using the fields below or taking from a file.
Once you set your configuration, do a click in <b>Create configuration</b>
Once you have set your configuration, click <b>Create configuration</b>
![add](assets/add-2.png)

4
docs/v2.0/kubernetes/configurations/remove.md
View File

@ -1,10 +1,10 @@
# Delete a configuration
From Portainer GUI, you can delete configurations created before.
From Portainer, you can delete configurations created previously.
## Deleting a configuration
Go to <b>Configurations</b>, select the configuration and then, do a click in <b>Remove</b>.
Go to <b>Configurations</b>, select the configuration and then, click <b>Remove</b>.
![remove](assets/remove-1.png)

6
docs/v2.0/kubernetes/resource_pools/access.md
View File

@ -4,15 +4,15 @@ In this help article, you will learn how to manage access to created resource po
## Managing access
To manage access of the resource pools, do a click in <b>Resource Pools</b> and click in <b>Manage Access</b> of the resource pool you want.
Click <b>Resource Pools</b> then click <b>Manage Access</b> of the resource pool you want.
![access](assets/access-1.png)
Select the user(s) and or team(s) to add and do a click in <b>Create Access</b>.
Select the user(s) and or team(s) to add and click <b>Create Access</b>.
![access](assets/access-2.png)
If everything work as expected, you will see this pop up confirming your action.
If everything works as expected, you will see this pop up confirming your action.
![access](assets/access-3.png)

10
docs/v2.0/kubernetes/resource_pools/create.md
View File

@ -1,20 +1,20 @@
# Create a Resource Pool
The Resource pools are helpful when multiple teams are using the same cluster and there is a potential of name collision. It can be as a virtual wall between multiple clusters. In this help article, you will learn how to create a Resource Pool (Namespace) using Portainer.
The Resource Pools are helpful when multiple teams are using the same cluster and there is potential collision, you can prevent this by using a virtual wall between multiple clusters. In this help article, you will learn how to create a Resource Pool (Namespace) using Portainer.
## Creating a Resouce Pool
To create a Resource Pool, go to <b>Resouce Pools</b> and then, do a click in <b>Add resource pool</b>.
Go to <b>Resouce Pools</b> and then click <b>Add resource pool</b>.
![resource_pool](assets/create-1.png)
In the next scree, you need to name your resource pool, assign a quota (Optional), set the limits of that quota indicating how much memory and CPU is assigned to this Resource Pool.
In the next screen, you need to <b>name</b> your resource pool, assign a <b>quota<b> (Optional), set the <b>resource limits</b> of that quota indicating how much memory and CPU is assigned to this Resource Pool.
When everything is set, do a click in <b>Create resource pool</b>.
When everything is set, click <b>Create resource pool</b>.
![resource_pool](assets/create-2.png)
If everything work as expected, you will see a pop up confirming the creation of this resource pool.
If everything works as expected, you will see a pop up confirming the creation of this resource pool.
![resource_pool](assets/create-3.png)

6
docs/v2.0/kubernetes/resource_pools/delete.md
View File

@ -1,10 +1,10 @@
# Delete/Remove a Resource Pool
When you finished your project, you can delete this resource pool and free the resources.
When you have finished your project, you can delete resource pools to free up resources.
## Removing a Resouce Pool
Do a click in <b>Resouce Pools</b>, select the resource pool and do a click in <b>Remove</b>.
Click <b>Resouce Pools</b>, select the resource pool and click <b>Remove</b>.
![resource](assets/delete-1.png)
@ -12,7 +12,7 @@ You need to confirm this action:
![resource](assets/delete-2.png)
If everything work as expected, you wil see a pop up confirming your action.
If everything works as expected, you will see a pop up confirming your action.
![resource](assets/delete-3.png)

16
docs/v2.0/kubernetes/volumes/inspect.md
View File

@ -1,30 +1,30 @@
# Inspect a volume
In Portainer, you will capable to inspect volumes that you mounted in Kubernetes Pod.
In Portainer, you can inspect volumes that you mounted in a Kubernetes Pod.
## Inspecting a Volume
To inspect a volume, go to <b>Volumes</b> and the choose the volume you want inspect.
Go to <b>Volumes</b> and then choose the volume you want inspect.
In a first view, you will able to see the following data:
In the first view, you will see the following data:
* Resource pool where this volume was saved
* Used By: Name of the app that's using the volume
* Used By: Name of the app that is using the volume
* Storage: What is the storage
* Size
* Created: Information about who and when was created.
* Created: Information about who and when it was created.
![volumes](assets/inspect-1.png)
After you click in the volume, you will see three tabs, in the first one, you will information about the volume itself.
After select the volume, you will see three tabs, in the first one, you will information about the volume itself.
![volumes](assets/inspect-2.png)
In the tab <b>events</b>, you will see the events related to this volume:
In the <b>events</b> tab you will see the events related to this volume:
![volumes](assets/inspect-3.png)
And the YAML tab, you will see the configuration of this volume in YAML format. From this tab, you can copy the content and save in a file.
And the YAML tab you will see the configuration of this volume in YAML format. From this tab, you can copy and save the content as a backup.
![volumes](assets/inspect-4.png)

22
docs/v2.0/kubernetes/volumes/remove.md
View File

@ -1,46 +1,46 @@
# Remove a Volume
In portainer you will able to remove volumes. Be avised that the volume need to be unattached from any container.
In portainer you can remove volumes, but please note the volume needs to be unattached from any container beforehand.
## Unattaching a volume from a container
To remove the volume that is attached to a container, go to <b>Applications</b>, select the App.
To remove the volume that is attached to a container, go to <b>Applications</b> and select the App.
![volumes](assets/remove-1.png)
Do a click in <b>Edit this application</b>.
Click <b>Edit this application</b>.
![volumes](assets/remove-2.png)
Scroll down to the section <b>Persisting Data</b>, do a click in the trash basket icon.
Scroll down to the section <b>Persisting Data</b> anc click the trash basket icon.
![volumes](assets/remove-3.png)
You will see the volume labeled.
You will see the volume label with a strikethough effect.
![volumes](assets/remove-4.png)
Scroll down and do a click in <b>Update Application</b>.
Scroll down anc click <b>Update Application</b>.
![volumes](assets/remove-5.png)
You will see a warning about this action. If you're sure about, do a click in <b>Update</b>.
A warning will pop up. Click <b>Update</b> to confirm.
![volumes](assets/remove-6.png)
# Removing a Volume
If you volume are free, now, you can delete it.
If your volume is free you can delete it.
To do this, do a click in <b>Volumes</b>, select the volume you want delete, and a click in <b>Remove</b>.
First click <b>Volumes</b>, select the volume you want delete, and click <b>Remove</b>.
![volumes](assets/remove-7.png)
You will asked for confirmation, if you're sure do a click in <b>Remove</b>.
You will be asked for confirmation, click <b>Remove</b> to confirm.
![volumes](assets/remove-8.png)
If everything work as expected, you will see a pop up confirmating this action:
If everything works as expected, you will see a pop up confirmating this action:
![volumes](assets/remove-9.png)

10
docs/v2.0/kubernetes/volumes/resize.md
View File

@ -1,6 +1,6 @@
# Increase the volume
Using Portainer, you can increase a volume.
Using Portainer, you can increase the size of a volume.
<b>Note</b>: Is only possible to increase the size of the volume. You cannot reduce the size of a volume.
@ -10,17 +10,17 @@ Go to <b>Volumes</b> and select the volume you want resize.
![increase](assets/inspect-1.png)
In the TAB <b>Volume</b> you will the current size of your volume. Do a click in <b>Increase size</b>. After that you will able to enter a new size for that volume.
In the tab <b>Volume</b> you will see the current size of your volume. Click <b>Increase size</b>. After that you will able to enter a new size for that volume.
![increase](assets/resize-2.png)
Enter the new value for this field, and do a click in <b>Update size</b>.
Enter the new value and click <b>Update size</b>.
You will see a warning if the volume is used by any app in that moment and will ask you if you want resize and redeploy the app in that moment. If you're agree, do a click in <b>Redeploy the applications</b>.
You will see a warning if the volume is used by any app at this this time and you will be asked to confirm if you want resize and redeploy the app. Click <b>Redeploy the applications</b> to confirm.
![increase](assets/resize-3.png)
If eveything work as expected, you will see a pop up confirming the resize of your volume.
If eveything works as expected, you will see a pop up confirming the resize of your volume.
![increase](assets/resize-4.png)

4
docs/v2.0/secrets/add.md
View File

@ -12,11 +12,11 @@ You can use secrets to manage any sensitive data which a container needs at runt
## Creating a Secret
To create a secret in Portainer, go to <b>Secrets</b> and click in <b>Add Secret</b>.
To create a secret in Portainer, go to <b>Secrets</b> and click <b>Add Secret</b>.
![secrets](assets/secret-1.png)
In the next screen, you need to set a name for you secret, define the 'secret', choose if you need to encode that secret, this is useful when you set a password in plain text and do a click in <b>Create the secret</b>.
In the next screen, you need to set a <b>name</b> for you secret, define the <b>'secret'</b>, choose if you need to encode that secret, (this is useful when you set a password in plain text) and click <b>Create the secret</b>.
![secrets](assets/secret-2.png)

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

@ -1,10 +1,10 @@
# Delete a Secret
Is a good practice delete the secrets that you don't need anymore. From the Portainer UI, you ca do it easily.
It is good practice to delete the secrets that you don't need anymore.
## Deleting a Secret
To delete a secret, go to <b>Secrets</b>, select the secret you want delete and then, click in <b>Remove</b>.
To delete a secret, go to <b>Secrets</b>, select the secret you want delete and then, click <b>Remove</b>.
![secrets](assets/delete-1.png)
## Notes

4
docs/v2.0/volumes/attaching.md
View File

@ -1,7 +1,7 @@
# Attach an existing Volume to a Container
Portainer can attach a new volume to a running container.
<b>Be advised that this operation destroys the running container and starts a new one with the volume attached. Backup your data before doing this operation.</b>
<b>Be advised that this operation destroys the running container and starts a new one with the volume attached. Backup your data before doing this.</b>
## Attaching a volume
@ -25,7 +25,7 @@ Finally, click <b>Deploy The Container</b>. You will receive the following warni
![volumes](assets/attach_5.png)
If successful you will see the confirmation pop up at the top right of screen
If successful you will see the confirmation pop up at the top right of screen.
![volumes](assets/attach_6.png)

2
docs/v2.0/volumes/browse.md
View File

@ -8,7 +8,7 @@ Click <b>Volumes</b> from the side menu, and then click <b>browse</b> next to th
![volumes](assets/browse_1.png)
From this screen, you can upload files to this volume and expose it to the container quickly and without using any CLI.
From this screen, you can upload files to this volume and expose it to the container quickly and without using a CLI.
![volumes](assets/browse_2.png)

4
docs/v2.0/volumes/create.md
View File

@ -1,7 +1,7 @@
# How to create a new volume
Volumes are used to make persistent storage that you can manage from Portainer.
Note: Create a standalone volume is only supported in a Docker Swarm and Docker Standalone endpoints.
Note: Creating a standalone volume is only supported in a Docker Swarm and Docker Standalone endpoints.
## Creating a LOCAL volume
@ -22,7 +22,7 @@ Once complete, click <b>Create the Volume</b>.
## Creating an NFS volume
In Portainer, you can mount a NFS volume to persist the data of your containers. To achieve this, go to <b>Volumes</b> and then click <b>Create Volume.</b>
In Portainer, you can mount an NFS volume to persist the data of your containers. To achieve this, go to <b>Volumes</b> and then click <b>Create Volume.</b>
![volumes](assets/create_1.png)

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

@ -1,10 +1,10 @@
# Delete a Volume
From Portainer UI you can delete a volume. Note that all the content inside that the volume is going to be erased.
From Portainer you can delete a volume. Note that all the content inside the deleted volume will be erased.
## Deleting a Volume
Go to <b>Volumes</b>, select the volume you want remove, and do a click in <b>Remove</b>.
Go to <b>Volumes</b>, select the volume you want remove, and click <b>Remove</b>.
![delete](assets/delete-1.png)