Doc Updates

pull/100/head
keverv 2020-11-27 13:21:37 +13:00
parent d6de4f945b
commit 3a97822bbd
6 changed files with 30 additions and 30 deletions

View File

@ -39,7 +39,7 @@ To enable a Load Balancer quota for this resource pool, enable the toggle <b>Loa
Quotas can be set on each storage option to prevent users from exceeding a specific threshold when deploying applications. You can set a quota to 0 to effectively prevent the usage of a specific storage option inside this resource pool.
To enable Storage Quota for this resource pool, enable the toogle <b>Enable quota<b>, set the <b>Maximum Usage</b> and the unit of storage (MB, GB, TB).
To enable Storage Quota for this resource pool, enable the toogle <b>Enable quota</b>, set the <b>Maximum Usage</b> and the unit of storage (MB, GB, TB).
When everything is set, click <b>Create resource pool</b>.

View File

@ -16,7 +16,7 @@ In the first view, you will see the following data:
![volumes](assets/inspect-1.png)
After select the volume, you will see three tabs, in the first one, you will information about the volume itself.
After selecting the volume, you will see three tabs. In the first one, you will information about the volume itself.
![volumes](assets/inspect-2.png)

View File

@ -1,6 +1,6 @@
# Remove a Volume
In portainer you can remove volumes, but please note the volume needs to be unattached from any container beforehand.
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
@ -12,11 +12,11 @@ Click <b>Edit this application</b>.
![volumes](assets/remove-2.png)
Scroll down to the section <b>Persisting Data</b> anc click the trash basket icon.
Scroll down to the section <b>Persisting Data</b> and click the trash basket icon.
![volumes](assets/remove-3.png)
You will see the volume label with a strikethough effect.
You will see the volume label with a strikethrough effect.
![volumes](assets/remove-4.png)

View File

@ -1,20 +1,20 @@
# Browse a Registry
Portainer Business Edition came with a Registry Manager feature enables simple operational management of your docker registries and their content, such as browsing the registries, exploring repositories and images, manipulating the tags that are attached to repositories and images, adding new tags, and deleting existing tags.
Portainer Business Edition comes with a Registry Manager feature enabling simple operational management of your docker registries and their content, such as browsing the registries, exploring repositories and images, manipulating the tags that are attached to repositories and images, adding new tags, and deleting existing tags.
In this help article, you will see how to browse a registry
## Browsing a Registry
To browse a registry go to <b>Registries</b> and select the registry you want to explore click in <b>browse</b>.
To browse a registry go to <b>Registries</b> and select <b>browse</b> on the desired registry.
![registries](assets/browse1.png)
On the next screen, you will see the repositories and information about Tags count.
On the next screen, you will see the repositories and Tags count.
![registries](assets/browse2.png)
If you enter to any repository, you will capable to see a complete picture of the repository. You will find the following information:
If you enter to any repository, you can see a complete picture of the repository. You will find the following information:
* Name of the repository
* Tags count
@ -26,7 +26,7 @@ If you enter to any repository, you will capable to see a complete picture of th
![registries](assets/browse3.png)
Lastly but not least, when you do a click in any tag, you will a lot of useful data, for example:
If you click a tag, you will see relevant data, for example:
* ID: Identifier of the Tag.
* Parent: ID of the parent tag.
@ -34,9 +34,9 @@ Lastly but not least, when you do a click in any tag, you will a lot of useful d
* Build: Information about the docker version and OS used to build the image.
* Author
In the section DockerFile details, you will find information about the software (And their version) installed in that image.
In the section DockerFile details, you will find information about the software (and the version) installed in that image.
Also, you will see the Image Layers to understand how the image was built.
You will also see the Image Layers to understand how the image was built.
![registries](assets/browse4.png)

View File

@ -1,22 +1,22 @@
# Manage a Registry
From Portainer Business Edition, you can manage Registries and Repositories. In this help article, you will see how to operate a repository.
From Portainer Business Edition, you can manage Registries and Repositories.
## Managing a Repository
### Add a Tag
Adding a tag to an image hosted in the registry is a easy task with Portainer, doesn't require type any commands in the CLI.
Adding a tag to an image hosted in the registry is an easy task with Portainer, it doesn't require type any commands in the CLI.
Go to <b>Registries</b>, choose the registry you want to manage and do a click in <b>browse</b>.
Go to <b>Registries</b>, choose the registry you want to manage and click <b>browse</b>.
![managing](assets/browse1.png)
After that, you will see the repositories saved in that registry. Do a click in wich one you want to manage.
After that, you will see the repositories saved in that registry. Select the one you want to manage.
![managing](assets/browse2.png)
The next step is to look at the top right of the screen, you will see a box with the section name <b>Add tag</b>, there, you only need write the tag, select the image and do a click in <b>Add tag</b>.
The next step is to look at the top right of the screen, you will see a box with the section name <b>Add tag</b>, you only need write the name of the tag, select the image and click <b>Add tag</b>.
![managing](assets/manage1.png)
@ -26,21 +26,21 @@ If everything work as expected, you will see a pop up at the right top corner.
### Retag
<b>Note</b>: If you're hosted your own Docker registry, you need to add a specific environment variable to enable retag and deleting. The env is <code>REGISTRY_STORAGE_DELETE_ENABLED=TRUE</code>.
<b>Note</b>: If you have hosted your own Docker registry, you need to add a specific environment variable to enable retag and deleting. The env is <code>REGISTRY_STORAGE_DELETE_ENABLED=TRUE</code>.
Another capability of Portainer Business Edition is Retagging the current images saved in a repository. To do this, you need to go to <b>Registries</b>, choose the registry you want to manage and do a click in <b>browse</b>.
Another capability of Portainer Business Edition is Retagging the current images saved in a repository. To do this, you need to go to <b>Registries</b>, choose the registry you want to manage and click <b>browse</b>.
![managing](assets/browse1.png)
After that, you will see the repositories saved in that registry. Do a click in wich one exist the image you want to Retag.
After that, you will see the repositories saved in that registry. Select the image you want to Retag.
![managing](assets/browse2.png)
After that, do a click in <b>Retag</b>.
After that, click <b>Retag</b>.
![managing](assets/manage3.png)
Type the new tag for this image and do a click in the <b></b>
Type the new tag for this image and click the <b></b>
![managing](assets/manage4.png)
@ -50,25 +50,25 @@ If everything work as expected, you will see a pop-up confirming the action.
### Remove a Tag
<b>Note</b>: If you're hosted your own Docker registry, you need to add a specific environment variable to enable retag and deleting. The env is <code>REGISTRY_STORAGE_DELETE_ENABLED=TRUE</code>.
<b>Note</b>: If you have hosted your own Docker registry, you need to add a specific environment variable to enable retag and deleting. The env is <code>REGISTRY_STORAGE_DELETE_ENABLED=TRUE</code>.
You can remove a tag from Portainer Business Edition. To do this, you need to go to <b>Registries</b>, choose the registry you want to manage and do a click in <b>browse</b>.
You can remove a tag from Portainer Business Edition. To do this, you need to go to <b>Registries</b>, choose the registry you want to manage and click <b>browse</b>.
![managing](assets/browse1.png)
After that, you will see the repositories saved in that registry. Do a click in wich one exist the image you want to Remove.
After that, you will see the repositories saved in that registry. Select the image you want to Remove.
![managing](assets/browse2.png)
Select the image/tag and do a click in <b>Remove</b>.
Select the image/tag and click <b>Remove</b>.
![managing](assets/manage6.png)
You will ask for confirmation, if you're sure, do a click in <b>Remove</b>.
You will be asked for confirmation, if you're sure, click <b>Remove</b>.
![managing](assets/manage7.png)
If everything work as expected, you will see a pop-up confirming the action.
If everything works as expected, you will see a pop-up confirming the action.
![managing](assets/manage8.png)

View File

@ -12,11 +12,11 @@ Click <b>Edit this application</b>.
![volumes](assets/remove-2.png)
Scroll down to the section <b>Persisting Data</b> anc click the trash basket icon.
Scroll down to the section <b>Persisting Data</b> and click the trash basket icon.
![volumes](assets/remove-3.png)
You will see the volume label with a strikethough effect.
You will see the volume label with a strikethrough effect.
![volumes](assets/remove-4.png)