Merge pull request #188 from jamescarppe/master

Add 2.7.0 updates
pull/189/head^2
jamescarppe 2021-07-30 09:31:09 +12:00 committed by GitHub
commit 7d066158ae
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
31 changed files with 124 additions and 84 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 130 KiB

After

Width:  |  Height:  |  Size: 153 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 112 KiB

After

Width:  |  Height:  |  Size: 135 KiB

View File

@ -11,15 +11,16 @@ First select the <b>Endpoint</b> you want to add a container to, then select <b>
Add details to your container: Add details to your container:
* Name: Friendly name for your container * <b>Name</b>: Friendly name for your container
* Registry: Where your image is hosted * <b>Registry</b>: Where your image is hosted
Note: when using DockerHub you can use the Search button to search for the image you have entered to ensure you have the correct name and tag. Portainer also displays the number of pulls remaining for your DockerHub account when using an anonymous account.
* Image: The name of the image you want to deploy * <b>Image</b>: The name of the image you want to deploy
* Ports: Expose the desired ports * <b>Ports</b>: Expose the desired ports
* Advanced Settings: Many options available here to customise the deploymeny from volume and environment configuration to capabilities * <b>Advanced Settings</b>: Many options available here to customise the deployment from volume and environment configuration to capabilities
Once complete, click <b>Deploy the Container<b/>. Once complete, click <b>Deploy the Container<b/>.
![container](assets/create_2.png) ![container](assets/create_2.png)

View File

@ -6,11 +6,11 @@ Viewing container logs is one of the most important features for troubleshooting
To view a container logs, click <b>Containers</b> and then select your container. To view a container logs, click <b>Containers</b> and then select your container.
![logs](assets/inspect-1.png) ![logs](assets/logs-1.png)
Then click <b>Logs</b> Then click <b>Logs</b>
![logs](assets/logs-1.png) ![logs](assets/logs-2.png)
In the following screen, you will see a few options: In the following screen, you will see a few options:
@ -22,7 +22,7 @@ In the following screen, you will see a few options:
* Lines: Specify how many lines you want to the see in the logs; default is 100. * Lines: Specify how many lines you want to the see in the logs; default is 100.
* Actions: You can copy all the logs displayed or a select number of lines. * Actions: You can copy all the logs displayed or a select number of lines.
![logs](assets/logs-2.png) ![logs](assets/logs-3.png)
## :material-note-text: Notes ## :material-note-text: Notes

View File

@ -1,26 +1,28 @@
# View Container Stats # View Container Stats
Stats are very important to understand the resource consumption of yours containers. In Portainer, you are able to monitor this from the UI. Stats are very important to understand the resource consumption of your containers. In Portainer, you are able to monitor this from the UI.
## Viewing Container Stats ## Viewing Container Stats
First Click <b>Containers</b>, select the container you want to see the stats. First click <b>Containers</b>, then select the container.
![stats](assets/inspect-1.png) ![stats](assets/stats-1.png)
Then click <b>Stats</b> Then click <b>Stats</b>
![stats](assets/stats-1.png) ![stats](assets/stats-2.png)
Here, you can view a very comprehensive list of consumption stats: Here, you can view a very comprehensive list of consumption stats:
* Memory Usage * Memory Usage
* CPU Usage * CPU Usage
* Network Usage: RX and TX * Network Usage: RX and TX
* Process running in the container * I/O Usage
* Refresh Rate: You can configure time intervals to get new stats data. * Processes running in the container
![stats](assets/stats-2.png) You can also configure the refresh rate of the displayed stats from the dropdown box.
![stats](assets/stats-3.png)
## :material-note-text: Notes ## :material-note-text: Notes

View File

@ -12,7 +12,7 @@ Edge stacks lets you deploy an app to all selected edge endpoints concurrently,
Next 1. <b>Name</b> your stack and 2. select one or more <b>Edge Groups</b>. Next 1. <b>Name</b> your stack and 2. select one or more <b>Edge Groups</b>.
3. In the <b>Build Methond</b> you need to define how to deploy your app from one of these options: 3. In the <b>Build Method</b> you need to define how to deploy your app from one of these options:
* Web Editor: You can use our web editor to write or paste a docker-compose file. * Web Editor: You can use our web editor to write or paste a docker-compose file.
* Upload: Upload a docker-compose.yml file from your computer * Upload: Upload a docker-compose.yml file from your computer

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

View File

@ -1,14 +1,13 @@
# Add a Docker Swarm Endpoint # Add a Docker Swarm Endpoint
Add a Docker Swarm Endpoint is very straighforward in Portainer Business 2.0. Add a Docker Swarm Endpoint is very straighforward in Portainer.
## Deploy the Agent. ## Deploy the Agent.
Once logged into Portainer, go to <b>Endpoints</b> and select <b>Agent</b> as the <b>Environment Type</b>. Once logged into Portainer, go to <b>Endpoints</b> and select <b>Agent</b> as the <b>Environment Type</b>.
In the tabbed section below titled <b>Information</b>, select <b>Docker Swarm</b> and copy the command. In the tabbed section below titled <b>Information</b>, select <b>Docker Swarm</b> and copy the command.
Note: It is important run the command in the Docker Swarm host before to fill the environment details. Note: It is important run the command on the Docker Swarm host before adding the endpoint in Portainer to ensure the configuration is set up correctly.
![swarm_endpoint](assets/swarm_1.png) ![swarm_endpoint](assets/swarm_1.png)
@ -16,7 +15,7 @@ Use this same command each time you want to add a new Docker Swarm endpoint:
<pre><code>curl -L https://downloads.portainer.io/agent-stack.yml -o agent-stack.yml && docker stack deploy --compose-file=agent-stack.yml portainer-agent</code></pre> <pre><code>curl -L https://downloads.portainer.io/agent-stack.yml -o agent-stack.yml && docker stack deploy --compose-file=agent-stack.yml portainer-agent</code></pre>
Once running in the Docker Swam host, the terminal will reply with something similar to: The command will output something similar to:
<pre><code> % Total % Received % Xferd Average Speed Time Time Time Current <pre><code> % Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed Dload Upload Total Spent Left Speed
@ -24,11 +23,11 @@ Once running in the Docker Swam host, the terminal will reply with something sim
Creating network portainer-agent_portainer_agent Creating network portainer-agent_portainer_agent
Creating service portainer-agent_agent</code></pre> Creating service portainer-agent_agent</code></pre>
To validate is the Agent is running, you can run the following command: To validate the Portainer Agent is running, you can run the following command:
<pre><code> docker service ls</code></pre> <pre><code> docker service ls</code></pre>
The result of that command should be something like this: which should respond with something like this:
<pre><code>ID NAME MODE REPLICAS IMAGE PORTS <pre><code>ID NAME MODE REPLICAS IMAGE PORTS
tshb6ee2710s portainer-agent_agent global 1/1 portainer/agent:latest</code></pre> tshb6ee2710s portainer-agent_agent global 1/1 portainer/agent:latest</code></pre>
@ -37,11 +36,11 @@ Now, we're ready to move on to the next step.
## Finishing the configuration ## Finishing the configuration
Once the Agent is running in the Docker Swarm host, you need to fill the <b>environment details</b>. The following options are available: Once the Agent is running on the Docker Swarm host, you need to fill in the <b>environment details</b>. The following options are available:
* Name: This is a descriptive name for your endpoint. This field is required. * Name: This is a descriptive name for your endpoint. This field is required.
* Endpoint URL: Define your IP or name to connect to the endpoint (Docker Swarm Host) and specify the port (9001) if this is needed. This field is requiered. * Endpoint URL: Define your IP or name to connect to the endpoint (Docker Swarm Host) and specify the port (9001) if this is needed. This field is required.
* Public IP: URL or IP address where exposed containers will be reachable. This field is optional and will default to the endpoint URL. * Public IP: URL or IP address where exposed containers will be reachable. This field is optional and will default to the endpoint URL if not defined.
In the <b>Metadata</b> section, you can define a <b>group</b> and <b>tags</b> for this endpoint. In the <b>Metadata</b> section, you can define a <b>group</b> and <b>tags</b> for this endpoint.
@ -49,10 +48,14 @@ See the following screenshot for reference.
![docker_swarm](assets/swarm_2.png) ![docker_swarm](assets/swarm_2.png)
When everything is set, you can click <b>Add Endpoint</b>. If successful, you will see this pop up at the top right corner. When everything is set, you can click <b>Add Endpoint</b>. If successful, you will see this pop up at the top right corner:
![docker_swarm](assets/swarm_3.png) ![docker_swarm](assets/swarm_3.png)
and you will be able to see your new endpoint in the list on the home page:
![docker_swarm](assets/swarm_4.png)
## :material-note-text: Notes ## :material-note-text: Notes
[Contribute to these docs](https://github.com/portainer/portainer-docs/blob/master/contributing.md){target=_blank} [Contribute to these docs](https://github.com/portainer/portainer-docs/blob/master/contributing.md){target=_blank}

Binary file not shown.

After

Width:  |  Height:  |  Size: 106 KiB

View File

@ -1,6 +1,6 @@
# Add / Connect a new registry # Add / Connect a new registry
Portainer can connect to many of the well-known registries including Quay.io, Azure Container Registry, Gitlab Container Registry, and a Custom Registry. Portainer can connect to many of the well-known registries including Quay.io, ProGet, Azure Container Registry, Gitlab Container Registry, and a Custom Registry.
## Quay.io ## Quay.io
To connect to a Quay registry, go to <b>Registries</b> and then <b>Add Registry</b> To connect to a Quay registry, go to <b>Registries</b> and then <b>Add Registry</b>
@ -11,6 +11,15 @@ In the next screen, choose <b>Quay.io</b> and enter your <b>Username</b> and <b>
![registries](assets/quay.png) ![registries](assets/quay.png)
## ProGet
To connect to a ProGet registry, go to <b>Registries</b> and then <b>Add Registry</b>
![registries](assets/registry1.png)
In the next screen, choose <b>ProGet</b> and enter the registry <b>Name</b>, <b>Registry URL</b>, the <b>Base URL</b> of the ProGet registry, your <b>Username</b> and <b>Password</b>, then click <b>Add registry</b>.
![registries](assets/proget.png)
## Azure Container Registry ## Azure Container Registry

Binary file not shown.

Before

Width:  |  Height:  |  Size: 131 KiB

After

Width:  |  Height:  |  Size: 93 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 115 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 166 KiB

After

Width:  |  Height:  |  Size: 166 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 166 KiB

After

Width:  |  Height:  |  Size: 166 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 162 KiB

After

Width:  |  Height:  |  Size: 166 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 166 KiB

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 137 KiB

After

Width:  |  Height:  |  Size: 115 KiB

View File

@ -2,15 +2,15 @@
In todays world you can easily have hundreds - if not thousands - of Docker-enabled devices in your environment. Most of these systems run without any form of clustering or run a lean orchestrator such as Docker Swarm or Kubernetes. In todays world you can easily have hundreds - if not thousands - of Docker-enabled devices in your environment. Most of these systems run without any form of clustering or run a lean orchestrator such as Docker Swarm or Kubernetes.
Remote devices may be distributed across multiple sites and/or across many different networks, some may even be attached to the internet using mobile data or satellite. To be managed effectively, engineers need a way to control distributed instances centrally, which is exactly what Portainer does with Edge Computer Features. Remote devices may be distributed across multiple sites and/or across many different networks, some may even be attached to the internet using mobile data or satellite. To be managed effectively, engineers need a way to control distributed instances centrally, which is exactly what Portainer does with Edge Compute Features.
## Enabling Edge Compute Features ## Enabling Edge Compute Features
First you must enable Edge Compute in the Portainer Settings. First you must enable Edge Compute in the Portainer Settings.
1. Click <b>Settings</b> and scroll down to <b>Edge Compute</b> section. 1. Click <b>Settings</b> and scroll down to <b>Edge Compute</b> section.
2. Enable the toggle
2. Enable the toggle and 3. click <b>Save Settings</b> 3. Click <b>Save Settings</b>
![edge](assets/edge_1.png) ![edge](assets/edge_1.png)
@ -20,11 +20,11 @@ After that, you will see that a few options appear in the side menu.
## More Resources ## More Resources
Take a look to the Edge section in the User Guide to see how to use it. Have a look at the Edge section in the User Guide to see how to use the Edge Compute functionality.
* [Deploy an Stack](/v2.0-be/edge/stacks/) * [Deploy a Stack](/v2.0-be/edge/stacks/)
* [Add a Job](/v2.0-be/edge/jobs/add/) * [Add a Job](/v2.0-be/edge/jobs/add/)
* [Managind Edge Groups](/v2.0-be/edge/groups/) * [Managing Edge Groups](/v2.0-be/edge/groups/)
# Notes # Notes

View File

@ -1,6 +1,9 @@
# Enable Host Management features # Enable Host Management features
From Portainer, you can enable Host Management Features. The benefit of enabling this setting is to do Host system browsing, understand what PCI devices, and physical disk are present in the node. From Portainer, you can enable Host Management Features. The benefit of enabling this setting is to enable host system browsing and the ability to interact directly with PCI devices and physical disks on the node.
!!! warning
This is a powerful and therefore dangerous feature. Please consider whether you need this functionality before enabling it.
To get access to this data from Portainer, you need to run the agent with the following environment variable <code>CAP_HOST_MANAGEMENT: 1</code>. To get access to this data from Portainer, you need to run the agent with the following environment variable <code>CAP_HOST_MANAGEMENT: 1</code>.
@ -11,14 +14,14 @@ The following features are disabled by default for security reasons:
In order to enable these features, the agent must be configured properly by: In order to enable these features, the agent must be configured properly by:
* Enabling the host management features via the CAP_HOST_MANAGEMENT environment variable * Enabling the host management features via the `CAP_HOST_MANAGEMENT` environment variable
* Bind-mounting the root of the host in the agent container (must be bind-mounted in /host) * Bind-mounting the root of the host in the agent container (must be bind-mounted in `/host`)
## Deploy Portainer Agent ## Deploy Portainer Agent
### Docker Swarm ### Docker Swarm
To deploy a new agent with this setting enable, you must run the following: To deploy a new agent with this setting enabled, you can run the following:
<pre><code>docker service create --name portainer_agent --network portainer_agent_network --publish mode=host,target=9001,published=9001 -e AGENT_CLUSTER_ADDR=tasks.portainer_agent -e CAP_HOST_MANAGEMENT=1 --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</code></pre> <pre><code>docker service create --name portainer_agent --network portainer_agent_network --publish mode=host,target=9001,published=9001 -e AGENT_CLUSTER_ADDR=tasks.portainer_agent -e CAP_HOST_MANAGEMENT=1 --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</code></pre>
@ -54,6 +57,12 @@ networks:
attachable: true attachable: true
</code></pre>. </code></pre>.
## Enable Host Management in Portainer
Once the agent has been deployed with the necessary settings to enable host management, you can enable this functionality within Portainer under <b>Host</b>, <b>Setup</b> (or <b>Swarm</b>, <b>Setup</b> if you are using Docker Swarm):
![security](assets/host_management.png)
## :material-note-text: Notes ## :material-note-text: Notes
[Contribute to these docs](https://github.com/portainer/portainer-docs/blob/master/contributing.md){target=_blank} [Contribute to these docs](https://github.com/portainer/portainer-docs/blob/master/contributing.md){target=_blank}

View File

@ -1,20 +1,21 @@
# Enable external Load Balancer usage # Enable use of an external load balancer (Kubernetes Only)
Enabling the load balancer feature will allow users to expose applications they deploy over an external IP address assigned by Cloud provider. Enabling the load balancer feature will allow users to expose applications they deploy over an external IP address assigned by their cloud provider.
<b>Note</b>: Ensure that your cloud provider allows you to create load balancers if you want to use this feature. Might incur costs. !!! note
Ensure that your cloud provider allows you to create load balancers if you want to use this feature. Using this feature may incur costs from your cloud provider.
## Enabling usage of External Balancer ## Enabling usage of an external Load Balancer
To do this, you need to open Portainer Business Edition, go to <b>Cluster</b> and the to <b>Setup</b>. After that, you need to enable the toggle <b>Allow users to use external load balancer</b>. Open Portainer, go to <b>Cluster</b> and then to <b>Setup</b>. Here, enable the toggle labeled <b>Allow users to use external load balancer</b>.
![namespace](assets/lb.png) ![namespace](assets/lb.png)
After you enabled the toggle, scroll down and do a click in <b>Save Configuration</b>. After you enabled the toggle, scroll down and click on <b>Save Configuration</b>.
![namespace](assets/save_conf.png) ![namespace](assets/save_conf.png)
Starting now, when you create a resource pool, you can define an external load balancer quota. With this enabled, when you create a resource pool you will be able to define an external load balancer quota.
## :material-note-text: Notes ## :material-note-text: Notes

View File

@ -1,18 +1,18 @@
# Limit usage of "default" Kubernetes Namespace (Kubernetes Only) # Limit usage of "default" Kubernetes Namespace (Kubernetes Only)
By default, a Kubernetes cluster will instantiate a default namespace when provisioning the cluster to hold the default set of Pods, Services, and Deployments used by the cluster but for an any reason, you want to limitate the usage of that namespace, with Portainer Business Edition, you can do it. By default, a Kubernetes cluster will instantiate a default namespace when provisioning the cluster to hold the default set of Pods, Services, and Deployments used by the cluster. If you would like to limit the usage of that namespace, you can do so with Portainer.
## Limiting the usage of "default" namespace ## Limiting the usage of "default" namespace
To do this, you need to open Portainer Business Edition, go to <b>Cluster</b> and the to <b>Setup</b>. After that, you need to enable the toggle <b>Restrict access to the default namespace</b>. To do this, go to <b>Cluster</b> and then to <b>Setup</b>, then enable the toggle <b>Restrict access to the default namespace</b>.
![namespace](assets/namespaces.png) ![namespace](assets/namespaces.png)
After you enabled the toggle, scroll down and click <b>Save Configuration</b>. Then scroll down and click <b>Save Configuration</b>.
![namespace](assets/save_conf.png) ![namespace](assets/save_conf.png)
Starting now, the only user with the power to run applications in the default namespace is the Administrator of Portainer. With this enabled, the only users with the power to run applications in the default namespace are Portainer Administrator users.
## :material-note-text: Notes ## :material-note-text: Notes

View File

@ -1,26 +1,27 @@
# Over Commitment of Resources (Kubernetes Only) # Over Commitment of Resources (Kubernetes Only)
With Portainer Business Edition, you can use your resources on full where are most needed. You can configure more resources to namespaces than is physically available in the cluster. With Portainer you can use your resources to the fullest extent and where they are most needed. You can allocate more resources to namespaces than are physically available in the cluster.
<b>Important</b>: By ENABLING resource over-commit, you are able to assign more resources to namespaces than is physically available in the cluster. This may lead to unexpected deployment failures if there is insufficient resources to service demand. By DISABLING resource over-commit (highly recommended), you are only able to assign resources to namespaces that are less (in aggregate) than the cluster total minus any system resource reservation. !!! warning
By <b>enabling</b> resource over-commit, you are able to assign more resources to namespaces than are physically available in the cluster. This may lead to unexpected deployment failures if there are insufficient resources to service demand. By <b>disabling</b> resource over-commit (highly recommended), you are only able to assign resources to namespaces that are less (in aggregate) than the cluster total minus any system resource reservation.
## Enabling Over Commitment of Resources ## Enabling Over Commitment of Resources
To do this, you need to open Portainer Business Edition, go to <b>Cluster</b> and then to <b>Setup</b>. After that, you need to enable the toggle <b>Allow resource over-commit</b>. To enable resource over-commit, go to <b>Cluster</b> and then to <b>Setup</b>. Then enable the toggle <b>Allow resource over-commit</b>.
![namespace](assets/over.png) ![namespace](assets/over.png)
After you enabled the toggle, scroll down and click <b>Save Configuration</b>. Then scroll down and click <b>Save Configuration</b>.
![namespace](assets/save_conf.png) ![namespace](assets/save_conf.png)
## Disabling Over Commitment of Resources ## Disabling Over Commitment of Resources
When you disable the Over Commitment of resources, you can reserve a system resource reservation percentage. To do this, you need to open Portainer Business Edition, go to <b>Cluster</b> and then to <b>Setup</b>. After that, you need to disable the toggle <b>Allow resource over-commit</b>, you cam then do a reservation of resources. Insert the percentage of the resources you want to reserve... When you disable the over commitment of resources, you can set a system resource reservation percentage. To do this, go to <b>Cluster</b> and then to <b>Setup</b>, then disable the toggle <b>Allow resource over-commit</b>. Once this is done you will be able to define a reservation of resources:
![namespace](assets/reserve.png) ![namespace](assets/reserve.png)
After you disabled the toggle, scroll down and click <b>Save Configuration</b>. Once you've made the necessary changes, scroll down and click <b>Save Configuration</b>.
![namespace](assets/save_conf.png) ![namespace](assets/save_conf.png)

View File

@ -1,8 +1,11 @@
# Security Options # Security Settings
Portainer allows various configuration options to add secuirty to your environment. In this help article, we going to review the security options that you can find under <b>Settings</b>. Portainer allows various configuration options to add security to your environment. In this help article, we going to review the security options that you can find under <b>Host</b>, <b>Setup</b> (or <b>Swarm</b>, <b>Setup</b> when using Docker Swarm).
## Docker Endpoint Security Options !!! note
These settings were previously available under the <b>Settings</b> menu but have now moved to their own section, and are set individually for each endpoint.
## Docker Security Settings
![security](assets/security1.png) ![security](assets/security1.png)
@ -18,6 +21,7 @@ Portainer allows various configuration options to add secuirty to your environme
* <b>Disable container capabilities for non-administrators</b>: Enabling the setting will hide the container capabilities tab for non-administrators when they are creating a container. * <b>Disable container capabilities for non-administrators</b>: Enabling the setting will hide the container capabilities tab for non-administrators when they are creating a container.
* <b>Disable sysctl settings for non-administrators</b>: Enabling the setting will hide the opntion to add sysctl settings for non-administrators when they are creating a container.
## :material-note-text: Notes ## :material-note-text: Notes
[Contribute to these docs](https://github.com/portainer/portainer-docs/blob/master/contributing.md){target=_blank} [Contribute to these docs](https://github.com/portainer/portainer-docs/blob/master/contributing.md){target=_blank}

Binary file not shown.

Before

Width:  |  Height:  |  Size: 80 KiB

After

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 138 KiB

After

Width:  |  Height:  |  Size: 110 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 69 KiB

View File

@ -1,23 +1,30 @@
# Inspect a Stack # Edit/Inspect a Stack
In Portainer, you can inspect your stacks to see what is running or access to their logs and stats. In Portainer, you can inspect your stacks to see what is running or access to their logs and stats, as well as make changes to a stack you have already deployed.
## Inspecting a Stack ## Inspecting a Stack
To inspect the task associated to your stack, select <b>Stacks</b> and then select the stack you want to inspect. To inspect the tasks associated to your stack, select <b>Stacks</b> and then select the stack you want to inspect.
![inspect](assets/inspect-1.png) ![inspect](assets/inspect-1.png)
Here you can: Here you can:
* View what services that make up this stack
* If they are running or stopped * Stop, delete or create a template from this stack
* How many replicas running in each host * Edit the stack YML directly
* Access to logs * If the stack was deployed from a Git repository, you can redeploy the stack using an updated compose file from the Git repository
* Inspect the task stats * [Duplicate or migrate the stack](/v2.0-be/stacks/duplicate_migration/)
* Access to the container console
![inspect](assets/inspect-2.png) ![inspect](assets/inspect-2.png)
* View what services that make up the stack, and whether they are running or stopped
* How many replicas running in each host
* Access the service logs
* Inspect the task stats
* Access the container console
![inspect](assets/inspect-3.png)
## :material-note-text: Notes ## :material-note-text: Notes
[Contribute to these docs](https://github.com/portainer/portainer-docs/blob/master/contributing.md){target=_blank} [Contribute to these docs](https://github.com/portainer/portainer-docs/blob/master/contributing.md){target=_blank}

View File

@ -11,15 +11,16 @@ First select the <b>Endpoint</b> you want to add a container to, then select <b>
Add details to your container: Add details to your container:
* Name: Friendly name for your container * <b>Name</b>: Friendly name for your container
* Registry: Where your image is hosted * <b>Registry</b>: Where your image is hosted
Note: when using DockerHub you can use the Search button to search for the image you have entered to ensure you have the correct name and tag. Portainer also displays the number of pulls remaining for your DockerHub account when using an anonymous account.
* Image: The name of the image you want to deploy * <b>Image</b>: The name of the image you want to deploy
* Ports: Expose the desired ports * <b>Ports</b>: Expose the desired ports
* Advanced Settings: Many options available here to customise the deploymeny from volume and environment configuration to capabilities * <b>Advanced Settings</b>: Many options available here to customise the deployment from volume and environment configuration to capabilities
Once complete, click <b>Deploy the Container<b/>. Once complete, click <b>Deploy the Container<b/>.
![container](assets/create_2.png) ![container](assets/create_2.png)

View File

@ -1,10 +1,10 @@
# View Container Stats # View Container Stats
Stats are very important to understand the resource consumption of yours containers. In Portainer, you are able to monitor this from the UI. Stats are very important to understand the resource consumption of your containers. In Portainer, you are able to monitor this from the UI.
## Viewing Container Stats ## Viewing Container Stats
First Click <b>Containers</b>, select the container you want to see the stats. First click <b>Containers</b>, then select the container.
![stats](assets/inspect-1.png) ![stats](assets/inspect-1.png)
@ -17,8 +17,10 @@ Here, you can view a very comprehensive list of consumption stats:
* Memory Usage * Memory Usage
* CPU Usage * CPU Usage
* Network Usage: RX and TX * Network Usage: RX and TX
* Process running in the container * I/O Usage
* Refresh Rate: You can configure time intervals to get new stats data. * Processes running in the container
You can also configure the refresh rate of the displayed stats from the dropdown box.
![stats](assets/stats-2.png) ![stats](assets/stats-2.png)

View File

@ -12,7 +12,7 @@ Edge stacks lets you deploy an app to all selected edge endpoints concurrently,
Next 1. <b>Name</b> your stack and 2. select one or more <b>Edge Groups</b>. Next 1. <b>Name</b> your stack and 2. select one or more <b>Edge Groups</b>.
3. In the <b>Build Methond</b> you need to define how to deploy your app from one of these options: 3. In the <b>Build Method</b> you need to define how to deploy your app from one of these options:
* Web Editor: You can use our web editor to write or paste a docker-compose file. * Web Editor: You can use our web editor to write or paste a docker-compose file.
* Upload: Upload a docker-compose.yml file from your computer * Upload: Upload a docker-compose.yml file from your computer

View File

@ -103,13 +103,13 @@ nav:
- 'Connect to a Registry' : 'v2.0-be/registries/connect.md' - 'Connect to a Registry' : 'v2.0-be/registries/connect.md'
- 'Enable Docker Hub Authentication' : 'v2.0-be/registries/auth-docker-hub.md' - 'Enable Docker Hub Authentication' : 'v2.0-be/registries/auth-docker-hub.md'
- Configuring Settings: - Configuring Settings:
- 'Enable use of external load balancer' : 'v2.0-be/settings/lb.md'
- 'Allow/Disallow over-commitment of resources' : 'v2.0-be/settings/overcommit.md'
- 'Limit usage of default namespace' : 'v2.0-be/settings/namespaces.md'
- 'Security Options' : 'v2.0-be/settings/security.md'
- 'Enable Edge Computing' : 'v2.0-be/settings/edge.md'
- 'App Templates' : 'v2.0-be/settings/apps.md' - 'App Templates' : 'v2.0-be/settings/apps.md'
- 'Enable Edge Computing' : 'v2.0-be/settings/edge.md'
- 'K8s: Enable use of external load balancer' : 'v2.0-be/settings/lb.md'
- 'K8s: Limit usage of default namespace' : 'v2.0-be/settings/namespaces.md'
- 'K8s: Allow/Disallow over-commitment of resources' : 'v2.0-be/settings/overcommit.md'
- 'Enable Host Management Features' : 'v2.0-be/settings/host_management.md' - 'Enable Host Management Features' : 'v2.0-be/settings/host_management.md'
- 'Security Settings' : 'v2.0-be/settings/security.md'
- Backup and Restore: - Backup and Restore:
- 'Backup': 'v2.0-be/backup/backup.md' - 'Backup': 'v2.0-be/backup/backup.md'
- 'Restore': 'v2.0-be/backup/restore.md' - 'Restore': 'v2.0-be/backup/restore.md'
@ -127,7 +127,7 @@ nav:
- 'Add/Create a Stack' : 'v2.0/stacks/create.md' - 'Add/Create a Stack' : 'v2.0/stacks/create.md'
- 'Create a template from a Stack' : 'v2.0/stacks/template.md' - 'Create a template from a Stack' : 'v2.0/stacks/template.md'
- 'Duplicate / Migrate Stacks' : 'v2.0/stacks/duplicate_migration.md' - 'Duplicate / Migrate Stacks' : 'v2.0/stacks/duplicate_migration.md'
- 'Inspect a Stack' : 'v2.0/stacks/inspect.md' - 'Edit/Inspect a Stack' : 'v2.0/stacks/inspect.md'
- 'Webhooks': - 'Webhooks':
- 'Configure a Webhook' : 'v2.0/webhooks/create.md' - 'Configure a Webhook' : 'v2.0/webhooks/create.md'
- 'Containers': - 'Containers':
@ -202,9 +202,9 @@ nav:
- Docker & Docker Swarm: - Docker & Docker Swarm:
- 'Stacks': - 'Stacks':
- 'Add/Create a Stack' : 'v2.0-be/stacks/create.md' - 'Add/Create a Stack' : 'v2.0-be/stacks/create.md'
- 'Edit/Inspect a Stack' : 'v2.0-be/stacks/inspect.md'
- 'Create a template from a Stack' : 'v2.0-be/stacks/template.md' - 'Create a template from a Stack' : 'v2.0-be/stacks/template.md'
- 'Duplicate / Migrate Stacks' : 'v2.0-be/stacks/duplicate_migration.md' - 'Duplicate / Migrate Stacks' : 'v2.0-be/stacks/duplicate_migration.md'
- 'Inspect a Stack' : 'v2.0-be/stacks/inspect.md'
- 'Webhooks': - 'Webhooks':
- 'Configure a Webhook' : 'v2.0-be/webhooks/create.md' - 'Configure a Webhook' : 'v2.0-be/webhooks/create.md'
- 'Containers': - 'Containers':