BE 2.7 updates
parent
3bfac454f1
commit
88ef75d90e
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
|
||||||
|
|
||||||
|
|
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)
|
||||||
|
|
||||||
|
|
|
@ -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
|
||||||
|
|
||||||
|
|
|
@ -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'
|
||||||
|
|
Loading…
Reference in New Issue