Merge branch 'portainer:master' into 2.7.0
commit
e04229bbf5
File diff suppressed because it is too large
Load Diff
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
Portainer exposes an HTTP API that you can use to automate everything you do via the Portainer UI. You may also use Portainer as a gateway (HTTP queries against the Portainer API) to the underlying Docker/Kubernetes API.
|
Portainer exposes an HTTP API that you can use to automate everything you do via the Portainer UI. You may also use Portainer as a gateway (HTTP queries against the Portainer API) to the underlying Docker/Kubernetes API.
|
||||||
|
|
||||||
!!! Note "API documentation is available [here](../api-schema/)"
|
|
||||||
|
|
||||||
## :octicons-code-review-16: Examples
|
## :octicons-code-review-16: Examples
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,13 @@
|
||||||
|
# :fontawesome-solid-code: API
|
||||||
|
|
||||||
|
Portainer exposes an HTTP API that you can use to automate everything you do via the Portainer UI. You may also use Portainer as a gateway (HTTP queries against the Portainer API) to the underlying Docker/Kubernetes API.
|
||||||
|
|
||||||
|
!!! Note "API examples are [here](../api-examples/)"
|
||||||
|
|
||||||
|
!!swagger api-ee-2.7.0.json!!
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
## :material-note-text: Notes
|
||||||
|
|
||||||
|
[Contribute to these docs](https://github.com/portainer/portainer-docs/blob/master/contributing.md){target=_blank}
|
|
@ -2,7 +2,108 @@
|
||||||
|
|
||||||
Read about the new and enhanced features in our latest releases here.
|
Read about the new and enhanced features in our latest releases here.
|
||||||
=== "Portainer Business"
|
=== "Portainer Business"
|
||||||
???+ Tip "Release 2.4"
|
???+ Tip "Release 2.7"
|
||||||
|
#### Docker:
|
||||||
|
* Added the ability to update and redeploy a stack created from a git repository
|
||||||
|
* Added I/O usage to the container statistics
|
||||||
|
* Enhanced environment variables UI/UX for Docker
|
||||||
|
* sysctl options are available when creating a container
|
||||||
|
* Show the number of Swarm nodes for the endpoint on the Home page
|
||||||
|
* Show how many Docker pulls are remaining for DockerHub to avoid exceeding the quota
|
||||||
|
* Introduced support for compose version 3.8 on docker swarm environments
|
||||||
|
* Display the container IP address(es) in the list of containers
|
||||||
|
* Improved layout of the toggles on the create container setting tab
|
||||||
|
* For Docker Standalone, prevent a stack from being created if the Compose has a container_name that already exists
|
||||||
|
* Creating a container from a DockerHub image will show a search button in the UI
|
||||||
|
* Fixed issue where deploying a stack from Git did not work for Azure DevOps
|
||||||
|
* Fixed issue where stacks with a status of 0 are hidden in the UI
|
||||||
|
* Fixed issue where pulling a large image is failing when using an Agent due to a timeout
|
||||||
|
* Fixed issue where listing the services with Auto-refresh on collapses all services after refresh
|
||||||
|
* Fixed issue where dash characters got removed from the stack name on Docker Standalone
|
||||||
|
* Fixed issue where access control management via labels was not fault tolerant
|
||||||
|
* Fixed issue where the label showing the default location of secrets was incorrect for Windows
|
||||||
|
* Fixed typo in the error message "Unable to start stack"
|
||||||
|
|
||||||
|
#### Registries:
|
||||||
|
* Added ProGet as a specific registry type when adding a registry
|
||||||
|
* Fixed issue where pushing to a quay.io registry failed due to not including the username in the quay registry URL
|
||||||
|
|
||||||
|
#### Templates:
|
||||||
|
* Fixed issue where creating a custom template from uploading a compose file failed
|
||||||
|
* Fixed issue where switching custom template in the template tab of stack create view doesn't update editor
|
||||||
|
* Fixed issue with an invalid template documentation URL in the Settings
|
||||||
|
|
||||||
|
#### Volumes:
|
||||||
|
* Added validation to prevent adding empty mount to an existing service
|
||||||
|
* Fixed issue with the MountType and nfsvers when creating NFS4 volumes
|
||||||
|
* Fixed issue where editing the properties of volumes on a service did not enable the apply button
|
||||||
|
|
||||||
|
#### Kubernetes:
|
||||||
|
* Introduced the ability to deploy a manifest from a git repository when using advanced deployment
|
||||||
|
* The advanced deployment feature has been made available to standard users
|
||||||
|
* Introduced a summary of Kubernetes actions when deploying a Kubernetes resource
|
||||||
|
* Added the ability to display realtime node metrics in Kubernetes
|
||||||
|
* Added functionality to allow multiple ingress networks per kubernetes namespace, with a differing config per ingress
|
||||||
|
* Added the ability to redeploy an externally deployed application
|
||||||
|
* Added the ability to expand the YAML tab of a Kubernetes application to full size
|
||||||
|
* Added the ability to cordon/uncordon/drain nodes
|
||||||
|
* Added a warning in the placement tab when an application can't be scheduled on the cluster
|
||||||
|
* Renamed Resource Pools to Namespaces in the UI
|
||||||
|
* Improved UI for the placement policies when creating an application
|
||||||
|
* Improved how application image names are shown
|
||||||
|
* Form validation has been added for Configuration keys
|
||||||
|
* Environment variable are sorted alphabetically to improve the readability
|
||||||
|
* Display the ImagePull policy in the details of an application
|
||||||
|
* Default to the kube-system namespace in the advanced deployment view on ARM
|
||||||
|
* Fixed minor UI inconsistency when creating an application with an ingress
|
||||||
|
* Fixed issue with the UI layout when creating an application with ingress
|
||||||
|
* Fixed issue where updating the Kubernetes endpoint URL did not get persisted
|
||||||
|
* Fixed issue where the endpoint url is not updated when updating a kubernetes local endpoint
|
||||||
|
* Fixed issue where renaming the endpoint of a kubernetes agent breaks the endpoint
|
||||||
|
* Fixed issue where environment variables with empty values are not showing when editing a kubernetes application
|
||||||
|
* Fixed issue where environment variable validation when creating an application was too restrictive
|
||||||
|
* Fixed issue where creating an application with two different ingresses incorrectly populates the hostname UI fields
|
||||||
|
* Fixed issue where an application with persisted data can't update, after the storage option is disabled in the cluster settings
|
||||||
|
* Fixed issue where adding an ingress route is not prevented when editing an application with existing ingress route and ingress is disabled
|
||||||
|
* Fixed issue where adding an application does not allow Global to be set
|
||||||
|
|
||||||
|
#### ACI:
|
||||||
|
* Fixed issue where ACI stops working after persistence or networking gets added
|
||||||
|
|
||||||
|
#### Edge:
|
||||||
|
* Added the ability to deploy Edge stacks on Docker standalone Edge endpoints
|
||||||
|
* Show the status of the edge agent check-in on the home page dashboard
|
||||||
|
* Hide the webhook UI in the service creation view of an edge endpoint, since it's not applicable
|
||||||
|
* Fixed issue where accessing a down Kubernetes Edge endpoint should redirect the user to the home view
|
||||||
|
|
||||||
|
#### Portainer:
|
||||||
|
* Added the ability to sync Portainer teams with group memberships provided via OAuth
|
||||||
|
* Added SSO support for OAuth and do not enforce a login prompt. Use `<portainer_url>/#!/internal-auth` to login with internal admin.
|
||||||
|
* Added the ability to manage orphaned stacks when Portainer has the compose file
|
||||||
|
* Added the option to specify the local socket location when adding a docker endpoint
|
||||||
|
* Search filters are retained within the browser session
|
||||||
|
* Properly expose backend error when using image management features
|
||||||
|
* Prevent web editor related views from being accidentally closed
|
||||||
|
* Improved descriptions for Portainer initialization errors
|
||||||
|
* Disable sysctl settings for non-administrators incorrectly defaults to being on
|
||||||
|
* Fixed issue where the File select windows gets shown when pressing enter in text fields
|
||||||
|
* Fixed issue where restoring Portainer from a backup file fails in certain circumstances related to the activity logs
|
||||||
|
* Fixed issue where a custom snapshot interval cannot be changed
|
||||||
|
* Fixed issue with incorrect Windows agent deployment command in the agent endpoint creation tab
|
||||||
|
|
||||||
|
#### Podman:
|
||||||
|
* Introduced initial experimental support for Podman.
|
||||||
|
Known limitations are listed in https://github.com/portainer/portainer/issues/5188
|
||||||
|
|
||||||
|
#### Development:
|
||||||
|
* Introduce buildx to support Windows 1903+ Base Images
|
||||||
|
* Added the ability to debug through VSCode
|
||||||
|
* Added check for missing angularJS inject annotation
|
||||||
|
* Removed grunt-karma ang grunt-html2js dependencies
|
||||||
|
* Fixed issue where webpack complains about chardet source maps
|
||||||
|
* Fixed issue where babel complains about missing core-js dependency
|
||||||
|
|
||||||
|
???- Note "Release 2.4"
|
||||||
#### Kubernetes
|
#### Kubernetes
|
||||||
* Pods without workloads are now displayed as applications
|
* Pods without workloads are now displayed as applications
|
||||||
* Improved UI/UX of configurations for creation / edition
|
* Improved UI/UX of configurations for creation / edition
|
||||||
|
|
Binary file not shown.
After Width: | Height: | Size: 84 KiB |
|
@ -62,7 +62,7 @@ Once that all fields are completed, click <b>Save Settings</b>
|
||||||
|
|
||||||
## Manage access to OAuth Team and Users
|
## Manage access to OAuth Team and Users
|
||||||
|
|
||||||
To understand how to enable access to OAuth Teams and Users, please, refer to [this article](/v2.0-be/endpoints/access).
|
To understand how to enable access to OAuth Teams and Users, please, refer to [this article](/v2.0-be/endpoints/access/).
|
||||||
|
|
||||||
## :material-note-text: Notes
|
## :material-note-text: Notes
|
||||||
|
|
||||||
|
|
|
@ -40,7 +40,7 @@ Define the following information and click <b>Save settings</b>.
|
||||||
|
|
||||||
## Manage access to OAuth Team and Users
|
## Manage access to OAuth Team and Users
|
||||||
|
|
||||||
To understand how to enable access to OAuth Teams and Users, please, refer to [this article](/v2.0-be/endpoints/access).
|
To understand how to enable access to OAuth Teams and Users, please, refer to [this article](/v2.0-be/endpoints/access/).
|
||||||
|
|
||||||
## :material-note-text: Notes
|
## :material-note-text: Notes
|
||||||
|
|
||||||
|
|
|
@ -57,7 +57,7 @@ Define the following information and click <b>Save settings</b>.
|
||||||
|
|
||||||
## Manage access to OAuth Team and Users
|
## Manage access to OAuth Team and Users
|
||||||
|
|
||||||
To understand how to enable access to OAuth Teams and Users, please, refer to [this article](/v2.0-be/endpoints/access).
|
To understand how to enable access to OAuth Teams and Users, please, refer to [this article](/v2.0-be/endpoints/access/).
|
||||||
|
|
||||||
## :material-note-text: Notes
|
## :material-note-text: Notes
|
||||||
|
|
||||||
|
|
|
@ -62,7 +62,7 @@ Click <b>Save Settings</b> and you're done.
|
||||||
|
|
||||||
## Manage access to OAuth Team and Users
|
## Manage access to OAuth Team and Users
|
||||||
|
|
||||||
To understand how to enable access to OAuth Teams and Users, please, refer to [this article](/v2.0-be/endpoints/access).
|
To understand how to enable access to OAuth Teams and Users, please, refer to [this article](/v2.0-be/endpoints/access/).
|
||||||
|
|
||||||
## :material-note-text: Notes
|
## :material-note-text: Notes
|
||||||
|
|
||||||
|
|
|
@ -2,75 +2,36 @@
|
||||||
|
|
||||||
Portainer Business Edition can be connected to several OAuth providers in an easy way without need to understand complex configurations.
|
Portainer Business Edition can be connected to several OAuth providers in an easy way without need to understand complex configurations.
|
||||||
|
|
||||||
### Microsoft OAuth Provider
|
To configure OAuth as the external authentication source for Portainer, go to <b>Settings</b> > <b>Authentication</b> and select <b>OAuth</b>.
|
||||||
|
|
||||||
<div class="container">
|
![oauth](assets/oauthgeneral.png)
|
||||||
<iframe src="//www.youtube.com/embed/Wlpnq5SF0dw"
|
|
||||||
frameborder="0" allowfullscreen class="video"></iframe>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
To start to configure Microsoft OAuth Provider, once you logged to Portainer, click in <b>Settings</b> and then in <b>authentication</b>. After that, select <b>OAuth</b> option and then, do select <b>Microsoft</b>.
|
In this screen, you have the following options:
|
||||||
|
|
||||||
![oauth](assets/microsoft1.png)
|
* Use SSO: Using SSO, the OAuth provider is not forced to prompt for credentials when the user has a currently logged in session.
|
||||||
|
* Hide internal authentication prompt: With this toggle on, Portainer will bypass the Portainer Login screen and use SSO to login a user with an existing OAuth session or takes the user straight to OAuth provider login.
|
||||||
|
|
||||||
Here, you only need to define the following information:
|
<b>Note:</b> Use ```<portainer url>/#!/internal-auth``` to login as Portainer internal admin
|
||||||
|
|
||||||
* Tenant ID: ID of the Azure Directory you wish to authenticate against. Also known as the Directory ID.
|
* Automatic User Provisioning: Toggle on the Automatic User Provisioning to see the options. You can use this option if you want a user added to Portainer for each OAuth user on first login. After enabling the toggle, you may choose a team for these Auto Populated Users.
|
||||||
* Application ID: Public identifier of the OAuth application.
|
* Automatic Team membership: You may choose to auto add OAuth users to certain Portainer teams based on the Claim Name. Claim names with be matched with Teams or you can manually link a claim name (regex) with Portainer Teams.
|
||||||
* Application key: The secret of this Application.
|
|
||||||
|
|
||||||
Do a click in save and you're done.
|
|
||||||
|
|
||||||
![oauth](assets/microsoft2.png)
|
<b>Provider</b>
|
||||||
|
|
||||||
### Google OAuth Provider
|
You may choose any of the following providers or use Custom Provider.
|
||||||
|
|
||||||
To start to configure Google OAuth Provider, once you logged to Portainer, click in <b>Settings</b> and then in <b>authentication</b>. After that, select <b>OAuth</b> option and then, do select <b>Google</b>.
|
Click on the name for provider specific instructions
|
||||||
|
|
||||||
Define the following information and do a click in <b>Save settings</b>.
|
* [Microsoft](/v2.0-be/auth/oauth-ms/)
|
||||||
|
* [Google](/v2.0-be/auth/oauth-google/)
|
||||||
* Client ID: Public identifier of the OAuth Application.
|
* [Github](/v2.0-be/auth/oauth-github/)
|
||||||
* Client Secret: The secret of this client.
|
* [Custom](/v2.0-be/auth/oauth-cust/)
|
||||||
|
|
||||||
![oauth](assets/google1.png)
|
|
||||||
|
|
||||||
### Github
|
|
||||||
|
|
||||||
To start to configure Github OAuth Provider, once you logged to Portainer, click in <b>Settings</b> and then in <b>authentication</b>. After that, select <b>OAuth</b> option and then, do select <b>Github</b>.
|
|
||||||
|
|
||||||
Define the following information and do a click in <b>Save settings</b>.
|
|
||||||
|
|
||||||
* Client ID: Public identifier of the OAuth Application.
|
|
||||||
* Client Secret: The secret of this client.
|
|
||||||
|
|
||||||
![oauth](assets/github.png)
|
|
||||||
|
|
||||||
### Custom OAuth Provider
|
|
||||||
|
|
||||||
To configure a custom OAuth provider, once you logged to Portainer, click in <b>Settings</b> and then in <b>authentication</b>. After that, select <b>custom</b> option.
|
|
||||||
|
|
||||||
![oauth](assets/custom.png)
|
|
||||||
|
|
||||||
In this screen, you need to configure the data that you OAuth provider give you to configure Portainer. The fields are:
|
|
||||||
|
|
||||||
* Automatic User Provisioning: Toggle on these options if you want to create users for each user logged using OAuth. After enable the toggle, you need to define in wich team that users should be created.
|
|
||||||
|
|
||||||
![oauth](assets/custom2.png)
|
|
||||||
|
|
||||||
* Client ID: This is the public identifier of the OAuth application.
|
|
||||||
* Client Secret: Here, you need fill with the token access to the OAuth Application.
|
|
||||||
* Authorization URL: URL used to authenticate against the OAuth provider. Will redirect the user to the OAuth provider login view.
|
|
||||||
* Access Token URL: URL used to authenticate against the OAuth provider. Will redirect the user to the OAuth provider login view.
|
|
||||||
* Resource URL: URL used by Portainer to retrieve information about the authenticated user.
|
|
||||||
* Redirect URL: URL used by the OAuth provider to redirect the user after successful authentication. Should be set to your Portainer instance URL.
|
|
||||||
* User Identifier: Identifier that will be used by Portainer to create an account for the authenticated user. Retrieved from the resource server specified via the Resource URL field.
|
|
||||||
* Scopes: Required by the OAuth provider to retrieve information about the authenticated user. Refer to your OAuth provider documentation for more information about this.
|
|
||||||
|
|
||||||
Once that all fields are completed, do a click in <b>Save Settings</b>
|
|
||||||
|
|
||||||
## Manage access to OAuth Team and Users
|
## Manage access to OAuth Team and Users
|
||||||
|
|
||||||
To understand how to enable access to OAuth Teams and Users, please, refer to [this article](/v2.0-be/endpoints/access).
|
To understand how to enable access to OAuth Teams and Users, please, refer to [this article](/v2.0-be/endpoints/access/).
|
||||||
|
</br>
|
||||||
|
|
||||||
## :material-note-text: Notes
|
## :material-note-text: Notes
|
||||||
|
|
||||||
|
|
|
@ -32,13 +32,13 @@ Use the following Docker commands to deploy the Portainer Server; note the agent
|
||||||
docker volume create portainer_data
|
docker volume create portainer_data
|
||||||
```
|
```
|
||||||
```shell
|
```shell
|
||||||
docker run -d -p 8000:8000 -p 9000:9000 --name=portainer --restart=always -v /var/run/docker.sock:/var/run/docker.sock -v portainer_data:/data portainer/portainer-ee:latest
|
docker run -d -p 8000:8000 -p 9000:9000 --name=portainer --restart=always -v /var/run/docker.sock:/var/run/docker.sock -v portainer_data:/data portainer/portainer-ee:2.7.0
|
||||||
```
|
```
|
||||||
|
|
||||||
### Portainer Agent Only Deployment
|
### Portainer Agent Only Deployment
|
||||||
Run the following command to deploy the Agent in your Docker host.
|
Run the following command to deploy the Agent in your Docker host.
|
||||||
```shell
|
```shell
|
||||||
docker run -d -p 9001:9001 --name portainer_agent --restart=always -v /var/run/docker.sock:/var/run/docker.sock -v /var/lib/docker/volumes:/var/lib/docker/volumes portainer/agent:2.0.0
|
docker run -d -p 9001:9001 --name portainer_agent --restart=always -v /var/run/docker.sock:/var/run/docker.sock -v /var/lib/docker/volumes:/var/lib/docker/volumes portainer/agent:2.7.0
|
||||||
```
|
```
|
||||||
|
|
||||||
=== "Docker on Windows WSL / Docker Desktop"
|
=== "Docker on Windows WSL / Docker Desktop"
|
||||||
|
@ -53,14 +53,14 @@ Use the following Docker commands to deploy the Portainer Server; note the agent
|
||||||
```
|
```
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
docker run -d -p 8000:8000 -p 9000:9000 --name=portainer --restart=always -v /var/run/docker.sock:/var/run/docker.sock -v portainer_data:/data portainer/portainer-ee:latest
|
docker run -d -p 8000:8000 -p 9000:9000 --name=portainer --restart=always -v /var/run/docker.sock:/var/run/docker.sock -v portainer_data:/data portainer/portainer-ee:2.7.0
|
||||||
```
|
```
|
||||||
|
|
||||||
### Portainer Agent Only Deployment
|
### Portainer Agent Only Deployment
|
||||||
Run the following command to deploy the Agent in your Docker host.
|
Run the following command to deploy the Agent in your Docker host.
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
docker run -d -p 9001:9001 --name portainer_agent --restart=always -v /var/run/docker.sock:/var/run/docker.sock -v /var/lib/docker/volumes:/var/lib/docker/volumes portainer/agent:2.0.0
|
docker run -d -p 9001:9001 --name portainer_agent --restart=always -v /var/run/docker.sock:/var/run/docker.sock -v /var/lib/docker/volumes:/var/lib/docker/volumes portainer/agent:2.7.0
|
||||||
```
|
```
|
||||||
|
|
||||||
=== "Docker on Windows Container Service"
|
=== "Docker on Windows Container Service"
|
||||||
|
@ -111,7 +111,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent
|
||||||
docker volume create portainer_data
|
docker volume create portainer_data
|
||||||
```
|
```
|
||||||
```PowerShell
|
```PowerShell
|
||||||
docker run -d -p 9000:9000 --name portainer --restart always -v \\.\pipe\docker_engine:\\.\pipe\docker_engine -v portainer_data:C:\data portainer/portainer-ee:latest
|
docker run -d -p 8000:8000 -p 9000:9000 --name portainer --restart always -v \\.\pipe\docker_engine:\\.\pipe\docker_engine -v portainer_data:C:\data portainer/portainer-ee:2.7.0
|
||||||
```
|
```
|
||||||
|
|
||||||
Now you can navigate to http://localhost:9000 or the IP of the server and start using Portainer.
|
Now you can navigate to http://localhost:9000 or the IP of the server and start using Portainer.
|
||||||
|
@ -122,7 +122,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent
|
||||||
To run Portainer Agent in a Windows Container scenario, you need to execute the following commands:
|
To run Portainer Agent in a Windows Container scenario, you need to execute the following commands:
|
||||||
|
|
||||||
```PowerShell
|
```PowerShell
|
||||||
docker run -d -p 9001:9001 --name portainer_agent --restart=always -v \\.\pipe\docker_engine:\\.\pipe\docker_engine portainer/agent:2.0.0
|
docker run -d -p 9001:9001 --name portainer_agent --restart=always -v \\.\pipe\docker_engine:\\.\pipe\docker_engine portainer/agent:2.7.0
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
@ -180,7 +180,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent
|
||||||
--replicas=1 \
|
--replicas=1 \
|
||||||
--constraint 'node.role == manager' \
|
--constraint 'node.role == manager' \
|
||||||
--mount type=bind,src=/var/run/docker.sock,dst=/var/run/docker.sock \
|
--mount type=bind,src=/var/run/docker.sock,dst=/var/run/docker.sock \
|
||||||
portainer/portainer-ce \
|
portainer/portainer-ee:2.7.0 \
|
||||||
--admin-password-file '/run/secrets/portainer-pass' \
|
--admin-password-file '/run/secrets/portainer-pass' \
|
||||||
-H unix:///var/run/docker.sock
|
-H unix:///var/run/docker.sock
|
||||||
```
|
```
|
||||||
|
|
|
@ -51,7 +51,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent
|
||||||
The following step to deploy the Agent:
|
The following step to deploy the Agent:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
docker service create --name portainer_agent --network portainer_agent_network --publish mode=host,target=9001,published=9001 -e AGENT_CLUSTER_ADDR=tasks.portainer_agent --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:2.4.0
|
docker service create --name portainer_agent --network portainer_agent_network --publish mode=host,target=9001,published=9001 -e AGENT_CLUSTER_ADDR=tasks.portainer_agent --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:2.7.0
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
@ -103,7 +103,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
docker service create --name portainer_agent --network portainer_agent_network --publish mode=host,target=9001,published=9001 -e AGENT_CLUSTER_ADDR=tasks.portainer_agent --mode global --mount type=bind
|
docker service create --name portainer_agent --network portainer_agent_network --publish mode=host,target=9001,published=9001 -e AGENT_CLUSTER_ADDR=tasks.portainer_agent --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:2.4.0
|
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:2.7.0
|
||||||
```
|
```
|
||||||
|
|
||||||
=== "Docker Swarm on Windows Container Service"
|
=== "Docker Swarm on Windows Container Service"
|
||||||
|
|
|
@ -12,8 +12,9 @@ To try and alleviate confusion as to what we test against, we have documented th
|
||||||
|
|
||||||
| Portainer Version | Release Date | Docker Version | Kubernetes* Version | Architectures |
|
| Portainer Version | Release Date | Docker Version | Kubernetes* Version | Architectures |
|
||||||
|-----------------------|--------------|----------------|-----------------------|---------------|
|
|-----------------------|--------------|----------------|-----------------------|---------------|
|
||||||
| Business 2.4 (latest) | May 4, 2021 | 20.10.5 | 1.19 1.20.2 1.21 | ARM64, x86_64 |
|
| Business 2.7 (latest) | July 29, 2021| 20.10.6, 20.10.7 | 1.19, 1.20.2, 1.21 | ARM64, x86_64 |
|
||||||
| Business 2.0 | Dec 3, 2020 | 19.03.13 | 1.17.13 1.18.6 1.19.3 | ARM64, x86_64 |
|
| Business 2.4 | May 4, 2021 | 20.10.5 | 1.19, 1.20.2, 1.21 | ARM64, x86_64 |
|
||||||
|
| Business 2.0 | Dec 3, 2020 | 19.03.13 | 1.17.13, 1.18.6, 1.19.3 | ARM64, x86_64 |
|
||||||
|
|
||||||
|
|
||||||
*RBAC needs to be enabled on Kubernetes for Portainer Access Control
|
*RBAC needs to be enabled on Kubernetes for Portainer Access Control
|
||||||
|
|
Binary file not shown.
Before Width: | Height: | Size: 102 KiB After Width: | Height: | Size: 100 KiB |
Binary file not shown.
Before Width: | Height: | Size: 105 KiB After Width: | Height: | Size: 82 KiB |
Binary file not shown.
After Width: | Height: | Size: 91 KiB |
|
@ -8,9 +8,25 @@ In Portainer you can launch new applications using your current manifest in YML
|
||||||
|
|
||||||
To start, click <b>Applications</b> and then <b>Advanced Deployment</b>.
|
To start, click <b>Applications</b> and then <b>Advanced Deployment</b>.
|
||||||
|
|
||||||
|
Here you have the option to use a manifest file that is in a git repo or enter the YAML manifest using the web editor.
|
||||||
|
|
||||||
|
### Manifest from git
|
||||||
|
|
||||||
![manifest](assets/manifest-1.png)
|
![manifest](assets/manifest-1.png)
|
||||||
|
|
||||||
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>.
|
Select the Namespace to deploy the application to, Select Kubernetes or Compose based on the format of your manifest. Select **Git Repository**, enter the details for your git repo. Toggle on and enter Authentication details if required for the repo. Finally, Click **Deploy**.
|
||||||
|
|
||||||
|
![manifest](assets/manifest-git.png)
|
||||||
|
|
||||||
|
If everything works as expected you will see this pop up:
|
||||||
|
|
||||||
|
![manifest](assets/manifest-3.png)
|
||||||
|
|
||||||
|
### Manifest using Web editor
|
||||||
|
|
||||||
|
![manifest](assets/manifest-1.png)
|
||||||
|
|
||||||
|
In this section, you need to define the Namespace/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)
|
![manifest](assets/manifest-2.png)
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Manage access to a resource pool
|
# Manage access to a Namespace/resource pool
|
||||||
|
|
||||||
!!! Warning "Access Control & RBAC"
|
!!! Warning "Access Control & RBAC"
|
||||||
Kubernetres RBAC needs to enabled and working for Access Control to work properly in Portainer.
|
Kubernetres RBAC needs to enabled and working for Access Control to work properly in Portainer.
|
||||||
|
@ -7,7 +7,7 @@ In this help article, you will learn how to manage access to created resource po
|
||||||
|
|
||||||
## Managing access
|
## Managing access
|
||||||
|
|
||||||
Click <b>Resource Pools</b> then click <b>Manage Access</b> of the resource pool you want.
|
Click <b>Namespaces/Resource Pools</b> then click <b>Manage Access</b> of the Namespace/resource pool you want.
|
||||||
|
|
||||||
![access](assets/access-1.png)
|
![access](assets/access-1.png)
|
||||||
|
|
||||||
|
|
|
@ -1,10 +1,13 @@
|
||||||
# Create a Resource Pool
|
???+ Hint ""
|
||||||
|
From Portainer Business 2.7 on, `Resource Pool(s)` has been renamed to `Namespace(s)` to be aligned with Kubernetes lingo.
|
||||||
|
|
||||||
The Resource Pools are helpful when multiple teams are using the same cluster and there is an 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.
|
# Create a Namespaces/Resource Pool
|
||||||
|
|
||||||
## Creating a Resouce Pool
|
The Namespaces/Resource Pools are helpful when multiple teams are using the same cluster and there is an 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 Namespace/Resource Pool using Portainer.
|
||||||
|
|
||||||
Go to <b>Resouce Pools</b> and then click <b>Add resource pool</b>.
|
## Creating a Namespace/Resouce Pool
|
||||||
|
|
||||||
|
Go to <b>Namespaces/Resouce Pools</b> and then click <b>Add Namespace/Resource pool</b>.
|
||||||
|
|
||||||
![resource_pool](assets/create-1.png)
|
![resource_pool](assets/create-1.png)
|
||||||
|
|
||||||
|
@ -14,11 +17,11 @@ In the next screen, you need to define a few things:
|
||||||
|
|
||||||
### Name
|
### Name
|
||||||
|
|
||||||
Name your Resource Pool.
|
Name your Namespace/Resource Pool.
|
||||||
|
|
||||||
### Resource Assignment
|
### Resource Assignment
|
||||||
|
|
||||||
A resource pool is a logical abstraction of a Kubernetes cluster, to provide for more flexible management of resources. The best practice is to set a quota assignment as this ensures the greatest security/stability; alternatively, you can disable assigning a quota for unrestricted access (not recommended).
|
A Namespace is a logical abstraction of a Kubernetes cluster, to provide for more flexible management of resources. The best practice is to set a quota assignment as this ensures the greatest security/stability; alternatively, you can disable assigning a quota for unrestricted access (not recommended).
|
||||||
|
|
||||||
Here you can define resource limits:
|
Here you can define resource limits:
|
||||||
|
|
||||||
|
@ -29,21 +32,21 @@ Here you can define resource limits:
|
||||||
|
|
||||||
### Load balancers
|
### Load balancers
|
||||||
|
|
||||||
You can set a quota on the amount of external load balancers that can be created inside this resource pool. Set this quota to 0 to effectively disable the use of load balancers in this resource pool.
|
You can set a quota on the amount of external load balancers that can be created inside this resource pool. Set this quota to 0 to effectively disable the use of load balancers in this Namespace/resource pool.
|
||||||
|
|
||||||
To enable a Load Balancer quota for this resource pool, enable the toggle <b>Load Balancer quota</b> and set the <b>Max Load Balancers</b>.
|
To enable a Load Balancer quota for this Namespace/resource pool, enable the toggle <b>Load Balancer quota</b> and set the <b>Max Load Balancers</b>.
|
||||||
|
|
||||||
<b>Note</b>: To Enable Load Balancer Quota, you need to enable from the [settings of the cluster](/v2.0-be/settings/lb.md).
|
<b>Note</b>: To Enable Load Balancer Quota, you need to enable from the [settings of the cluster](/v2.0-be/settings/lb.md).
|
||||||
|
|
||||||
### Storages
|
### Storages
|
||||||
|
|
||||||
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.
|
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 Namespace/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>.
|
When everything is set, click <b>Create Namespace/resource pool</b>.
|
||||||
|
|
||||||
If everything works 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 Namespace/resource pool.
|
||||||
|
|
||||||
![resource_pool](assets/create-3.png)
|
![resource_pool](assets/create-3.png)
|
||||||
|
|
||||||
|
|
|
@ -1,10 +1,10 @@
|
||||||
# Delete/Remove a Resource Pool
|
# Delete/Remove a Namespace/Resource Pool
|
||||||
|
|
||||||
When you have finished your project, you can delete resource pools to free up resources.
|
When you have finished your project, you can delete Namespaces/resource pools to free up resources.
|
||||||
|
|
||||||
## Removing a Resouce Pool
|
## Removing a Resouce Pool
|
||||||
|
|
||||||
Click <b>Resouce Pools</b>, select the resource pool and click <b>Remove</b>.
|
Click <b>Namespaces/Resouce Pools</b>, select the Namespacesresource pool and click <b>Remove</b>.
|
||||||
|
|
||||||
![resource](assets/delete-1.png)
|
![resource](assets/delete-1.png)
|
||||||
|
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
# :fontawesome-brands-docker: Upgrade a Standalone Docker Deployment
|
# :fontawesome-brands-docker: Upgrade a Standalone Docker Deployment
|
||||||
|
|
||||||
!!! Warning "Agent Versions"
|
!!! Warning "Agent Versions"
|
||||||
Always match the agent version to Portainer Server version. i.e., while installing or upgrading to Portainer 2.6 make sure all the agents are also version 2.6.
|
Always match the agent version to Portainer Server version. i.e., while installing or upgrading to Portainer 2.7 make sure all the agents are also version 2.7.
|
||||||
|
|
||||||
### Docker Standalone
|
### Docker Standalone
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ Once you logged to Portainer, click in <b>Settings</b> and then in <b>authentica
|
||||||
In this screen, you need to fill in the details using the details provided by your OAuth provider. The fields are:
|
In this screen, you need to fill in the details using the details provided by your OAuth provider. The fields are:
|
||||||
|
|
||||||
* Use SSO: Using SSO, the OAuth provider is not forced to prompt for credentials when the user has a currently logged in session.
|
* Use SSO: Using SSO, the OAuth provider is not forced to prompt for credentials when the user has a currently logged in session.
|
||||||
* Automatic User Provisioning: Toggle on the Automatic User Provisioning to see the options. You can use this option if you want a user added to Portainer for each OAuth useron first login. After enabling the toggle, you may choose a team for these Auto Populated Users.
|
* Automatic User Provisioning: Toggle on the Automatic User Provisioning to see the options. You can use this option if you want a user added to Portainer for each OAuth user on first login. After enabling the toggle, you may choose a team for these Auto Populated Users.
|
||||||
|
|
||||||
![oauth](assets/oauth_2.png)
|
![oauth](assets/oauth_2.png)
|
||||||
|
|
||||||
|
@ -29,7 +29,7 @@ Once that all fields are completed, do a click in <b>Save Settings</b>
|
||||||
|
|
||||||
## Manage access to OAuth Team and Users
|
## Manage access to OAuth Team and Users
|
||||||
|
|
||||||
To understand how to enable access to OAuth Teams and Users, please, refer to [this article](/v2.0/endpoints/access).
|
To understand how to enable access to OAuth Teams and Users, please, refer to [this article](/v2.0/endpoints/access/).
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|
|
@ -113,7 +113,7 @@ Use the following Docker commands to deploy the Portainer Server; note the agent
|
||||||
docker volume create portainer_data
|
docker volume create portainer_data
|
||||||
```
|
```
|
||||||
```shell
|
```shell
|
||||||
docker run -d -p 9000:9000 --name portainer --restart always -v \\.\pipe\docker_engine:\\.\pipe\docker_engine -v portainer_data:C:\data portainer/portainer-ce
|
docker run -d -p 8000:8000 -p 9000:9000 --name portainer --restart always -v \\.\pipe\docker_engine:\\.\pipe\docker_engine -v portainer_data:C:\data portainer/portainer-ce
|
||||||
```
|
```
|
||||||
|
|
||||||
Now you can navigate to http://localhost:9000 or the IP of the server and start using Portainer.
|
Now you can navigate to http://localhost:9000 or the IP of the server and start using Portainer.
|
||||||
|
|
17
mkdocs.yml
17
mkdocs.yml
|
@ -83,6 +83,7 @@ nav:
|
||||||
- 'LDAP' : 'v2.0-be/auth/ldap.md'
|
- 'LDAP' : 'v2.0-be/auth/ldap.md'
|
||||||
- 'Active Directory' : 'v2.0-be/auth/ad.md'
|
- 'Active Directory' : 'v2.0-be/auth/ad.md'
|
||||||
- 'OAuth' :
|
- 'OAuth' :
|
||||||
|
- 'OAuth': 'v2.0-be/auth/oauth.md'
|
||||||
- 'Microsoft': 'v2.0-be/auth/oauth-ms.md'
|
- 'Microsoft': 'v2.0-be/auth/oauth-ms.md'
|
||||||
- 'Google': 'v2.0-be/auth/oauth-google.md'
|
- 'Google': 'v2.0-be/auth/oauth-google.md'
|
||||||
- 'Github': 'v2.0-be/auth/oauth-github.md'
|
- 'Github': 'v2.0-be/auth/oauth-github.md'
|
||||||
|
@ -176,7 +177,7 @@ nav:
|
||||||
- 'Deploy from a Kubernetes Manifest' : 'v2.0/kubernetes/applications/manifest.md'
|
- 'Deploy from a Kubernetes Manifest' : 'v2.0/kubernetes/applications/manifest.md'
|
||||||
- 'Delete an Application' : 'v2.0/kubernetes/applications/delete.md'
|
- 'Delete an Application' : 'v2.0/kubernetes/applications/delete.md'
|
||||||
- 'Inspect an Application' : 'v2.0/kubernetes/applications/inspect.md'
|
- 'Inspect an Application' : 'v2.0/kubernetes/applications/inspect.md'
|
||||||
- 'Resource Pools':
|
- 'Namespace/Resource Pools':
|
||||||
- 'Create a Namespace/Resource Pool' : 'v2.0/kubernetes/resource_pools/create.md'
|
- 'Create a Namespace/Resource Pool' : 'v2.0/kubernetes/resource_pools/create.md'
|
||||||
- 'Manage Access' : 'v2.0/kubernetes/resource_pools/access.md'
|
- 'Manage Access' : 'v2.0/kubernetes/resource_pools/access.md'
|
||||||
- 'Delete a Namespace/Resource Pool' : 'v2.0/kubernetes/resource_pools/delete.md'
|
- 'Delete a Namespace/Resource Pool' : 'v2.0/kubernetes/resource_pools/delete.md'
|
||||||
|
@ -253,10 +254,10 @@ nav:
|
||||||
- 'Deploy from a Kubernetes Manifest' : 'v2.0-be/kubernetes/applications/manifest.md'
|
- 'Deploy from a Kubernetes Manifest' : 'v2.0-be/kubernetes/applications/manifest.md'
|
||||||
- 'Delete an Application' : 'v2.0-be/kubernetes/applications/delete.md'
|
- 'Delete an Application' : 'v2.0-be/kubernetes/applications/delete.md'
|
||||||
- 'Inspect an Application' : 'v2.0-be/kubernetes/applications/inspect.md'
|
- 'Inspect an Application' : 'v2.0-be/kubernetes/applications/inspect.md'
|
||||||
- 'Resource Pools':
|
- 'Namespace/Resource Pools':
|
||||||
- 'Create a Resource Pool' : 'v2.0-be/kubernetes/resource_pools/create.md'
|
- 'Create a Namespace/Resource Pools' : 'v2.0-be/kubernetes/resource_pools/create.md'
|
||||||
- 'Manage Access' : 'v2.0-be/kubernetes/resource_pools/access.md'
|
- 'Manage Access' : 'v2.0-be/kubernetes/resource_pools/access.md'
|
||||||
- 'Delete a Resource Pool' : 'v2.0-be/kubernetes/resource_pools/delete.md'
|
- 'Delete a Namespace/Resource Pools' : 'v2.0-be/kubernetes/resource_pools/delete.md'
|
||||||
- 'Volumes':
|
- 'Volumes':
|
||||||
- 'Inspect a volume' : 'v2.0-be/kubernetes/volumes/inspect.md'
|
- 'Inspect a volume' : 'v2.0-be/kubernetes/volumes/inspect.md'
|
||||||
- 'Resize a volume' : 'v2.0-be/kubernetes/volumes/resize.md'
|
- 'Resize a volume' : 'v2.0-be/kubernetes/volumes/resize.md'
|
||||||
|
@ -278,8 +279,11 @@ nav:
|
||||||
- 'Browse a Registry' : 'v2.0-be/registries/browse.md'
|
- 'Browse a Registry' : 'v2.0-be/registries/browse.md'
|
||||||
- 'Manage a Registry' : 'v2.0-be/registries/manage.md'
|
- 'Manage a Registry' : 'v2.0-be/registries/manage.md'
|
||||||
- API:
|
- API:
|
||||||
- 'Documentation': 'api/api-schema.md'
|
|
||||||
- 'Examples': 'api/api-examples.md'
|
- 'Examples': 'api/api-examples.md'
|
||||||
|
- Community Edition:
|
||||||
|
- 'Documentation': 'api/api-schema-ce.md'
|
||||||
|
- Business Edition:
|
||||||
|
- 'Documentation': 'api/api-schema-be.md'
|
||||||
- Upgrading Portainer:
|
- Upgrading Portainer:
|
||||||
- 'Upgrade Path': 'upgrade.md'
|
- 'Upgrade Path': 'upgrade.md'
|
||||||
- 'Upgrade CE to Business': 'v2.0/upgrade/updBE.md'
|
- 'Upgrade CE to Business': 'v2.0/upgrade/updBE.md'
|
||||||
|
@ -352,7 +356,8 @@ plugins:
|
||||||
'v2.0-be/deploy/linux.md': 'quickstart.md'
|
'v2.0-be/deploy/linux.md': 'quickstart.md'
|
||||||
'v2.0-be/deploy/windows10.md': 'quickstart.md'
|
'v2.0-be/deploy/windows10.md': 'quickstart.md'
|
||||||
'v2.0-be/deploy/windowsserver.md': 'quickstart.md'
|
'v2.0-be/deploy/windowsserver.md': 'quickstart.md'
|
||||||
'api.md': 'api/api-schema.md'
|
'api.md': 'api/api-schema-ce.md'
|
||||||
|
'api/api-schema.md': 'api/api-schema-ce.md'
|
||||||
|
|
||||||
extra:
|
extra:
|
||||||
analytics:
|
analytics:
|
||||||
|
|
Loading…
Reference in New Issue