kubevela
/
kubevela.github.io
mirror of https://github.com/kubevela/kubevela.github.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Docs: update the SSO document 

Signed-off-by: barnettZQG <barnett.zqg@gmail.com>
This commit is contained in:
barnettZQG 2022-08-11 17:33:28 +08:00
parent cf397ead13
commit 315efca127
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/tutorials/sso.md
View File

@ -4,7 +4,7 @@ title: SSO Login
## Description
In KubeVela V1.3, we provide two methods to login: local login and SSO.
In KubeVela V1.3, we provide two methods to log in: local login and SSO.
Local login uses the username and password stored in the local database to log in, and SSO integrates [Dex](https://dexidp.io/), which can be configured by configuring Dex's [OpenID Connect](https://dexidp.io/docs/openid-connect) to implement many different ways to log in, such as GitHub, LDAP, Gitlab, Oidc, Saml, Google etc.
@ -25,11 +25,11 @@ After the platform is initialized, local login is used by default. Platform admi
Next, we need to configure the Dex Connectors.
### Configure GitHub Connector
Take GitHub Connector as an example, if you don't have a GitHub Oauth App, you need to create an Oauth App on GitHub's Developer settings first, and set the App's Authorization callback URL to `[Vela UX address]/dex/callback`.
Take GitHub Connector as an example, if you don't have a GitHub Oauth App, you need to create an OAuth App on GitHub's Developer settings first, and set the App's Authorization callback URL to `[Vela UX address]/dex/callback`.
> Note that please make sure your Vela UX has a public IP address due to third-party redirection involved.
After creating the Oauth App, configure the Dex Connector in the integration configuration page. We choose the type `GitHub`, and set the Client ID and Client Secret corresponding to the Oauth App. Note that the Redirect URI here must be the same as the `[Vela UX address]/dex/callback` previously configured when the Oauth App was created.
After creating the Oauth App, configure the Dex Connector on the integration configuration page. We choose the type `GitHub`, and set the Client ID and Client Secret corresponding to the Oauth App. Note that the Redirect URI here must be the same as the `[Vela UX address]/dex/callback` previously configured when the Oauth App was created.
![alt](https://static.kubevela.net/images/1.3/intergration.png)
@ -51,7 +51,7 @@ If your LDAP does not provide anonymous authentication access, then you need to
## Platform setting
Users who log in through SSO will be automatically bound to the users who have the same email in the local database, otherwise, a new user will be created.
Users who logged in through SSO will be automatically bound to the users who have the same email in the local database, otherwise, a new user will be created.
Since the newly logged-in user does not have any permissions, we need to set an email address for the platform administrator first. After that, when you use a user with the same email address for SSO login, you can automatically have platform administrator privileges.

8
versioned_docs/version-v1.5/tutorials/sso.md
View File

@ -4,7 +4,7 @@ title: SSO Login
## Description
In KubeVela V1.3, we provide two methods to login: local login and SSO.
In KubeVela V1.3, we provide two methods to log in: local login and SSO.
Local login uses the username and password stored in the local database to log in, and SSO integrates [Dex](https://dexidp.io/), which can be configured by configuring Dex's [OpenID Connect](https://dexidp.io/docs/openid-connect) to implement many different ways to log in, such as GitHub, LDAP, Gitlab, Oidc, Saml, Google etc.
@ -25,11 +25,11 @@ After the platform is initialized, local login is used by default. Platform admi
Next, we need to configure the Dex Connectors.
### Configure GitHub Connector
Take GitHub Connector as an example, if you don't have a GitHub Oauth App, you need to create an Oauth App on GitHub's Developer settings first, and set the App's Authorization callback URL to `[Vela UX address]/dex/callback`.
Take GitHub Connector as an example, if you don't have a GitHub Oauth App, you need to create an OAuth App on GitHub's Developer settings first, and set the App's Authorization callback URL to `[Vela UX address]/dex/callback`.
> Note that please make sure your Vela UX has a public IP address due to third-party redirection involved.
After creating the Oauth App, configure the Dex Connector in the integration configuration page. We choose the type `GitHub`, and set the Client ID and Client Secret corresponding to the Oauth App. Note that the Redirect URI here must be the same as the `[Vela UX address]/dex/callback` previously configured when the Oauth App was created.
After creating the Oauth App, configure the Dex Connector on the integration configuration page. We choose the type `GitHub`, and set the Client ID and Client Secret corresponding to the Oauth App. Note that the Redirect URI here must be the same as the `[Vela UX address]/dex/callback` previously configured when the Oauth App was created.
![alt](https://static.kubevela.net/images/1.3/intergration.png)
@ -51,7 +51,7 @@ If your LDAP does not provide anonymous authentication access, then you need to
## Platform setting
Users who log in through SSO will be automatically bound to the users who have the same email in the local database, otherwise, a new user will be created.
Users who logged in through SSO will be automatically bound to the users who have the same email in the local database, otherwise, a new user will be created.
Since the newly logged-in user does not have any permissions, we need to set an email address for the platform administrator first. After that, when you use a user with the same email address for SSO login, you can automatically have platform administrator privileges.