Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix docs and a description of supported SSO services #5075

Merged
merged 2 commits into from
Jul 30, 2024
Merged

Fix docs and a description of supported SSO services #5075

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a8f5576
fix available values of SharedSSOConfig.provider
t-kikuc Jul 26, 2024
ce23409
fix description of supported SSO services.
t-kikuc Jul 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...content/en/docs-dev/user-guide/managing-controlplane/configuration-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ Must be one of the following objects:
| Field | Type | Description | Required |
|-|-|-|-|
| name | string | The unique name of the configuration. | Yes |
| provider | string | The SSO service provider. Can be one of the following values<br>`GITHUB`, `GOOGLE`... | Yes |
| provider | string | The SSO service provider. Currently, only `GITHUB` is supported. | Yes |
| sessionTtl | int | The time to live of session for SSO login. Unit is `hour`. Default is 7 * 24 hours. | No |
| github | [SSOConfigGitHub](#ssoconfiggithub) | GitHub sso configuration. | No |

Expand Down
2 changes: 1 addition & 1 deletion ...ent/en/docs-v0.39.x/user-guide/managing-controlplane/configuration-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ Must be one of the following objects:
| Field | Type | Description | Required |
|-|-|-|-|
| name | string | The unique name of the configuration. | Yes |
| provider | string | The SSO service provider. Can be one of the following values<br>`GITHUB`, `GOOGLE`... | Yes |
| provider | string | The SSO service provider. Currently, only `GITHUB` is supported. | Yes |
| github | [SSOConfigGitHub](#ssoconfiggithub) | GitHub sso configuration. | No |

## SSOConfigGitHub
Expand Down
2 changes: 1 addition & 1 deletion ...ent/en/docs-v0.40.x/user-guide/managing-controlplane/configuration-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ Must be one of the following objects:
| Field | Type | Description | Required |
|-|-|-|-|
| name | string | The unique name of the configuration. | Yes |
| provider | string | The SSO service provider. Can be one of the following values<br>`GITHUB`, `GOOGLE`... | Yes |
| provider | string | The SSO service provider. Currently, only `GITHUB` is supported. | Yes |
| github | [SSOConfigGitHub](#ssoconfiggithub) | GitHub sso configuration. | No |

## SSOConfigGitHub
Expand Down
2 changes: 1 addition & 1 deletion ...ent/en/docs-v0.41.x/user-guide/managing-controlplane/configuration-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ Must be one of the following objects:
| Field | Type | Description | Required |
|-|-|-|-|
| name | string | The unique name of the configuration. | Yes |
| provider | string | The SSO service provider. Can be one of the following values<br>`GITHUB`, `GOOGLE`... | Yes |
| provider | string | The SSO service provider. Currently, only `GITHUB` is supported. | Yes |
| sessionTtl | int | The time to live of session for SSO login. Unit is `hour`. Default is 7 * 24 hours. | No |
| github | [SSOConfigGitHub](#ssoconfiggithub) | GitHub sso configuration. | No |

Expand Down
2 changes: 1 addition & 1 deletion ...ent/en/docs-v0.42.x/user-guide/managing-controlplane/configuration-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ Must be one of the following objects:
| Field | Type | Description | Required |
|-|-|-|-|
| name | string | The unique name of the configuration. | Yes |
| provider | string | The SSO service provider. Can be one of the following values<br>`GITHUB`, `GOOGLE`... | Yes |
| provider | string | The SSO service provider. Currently, only `GITHUB` is supported. | Yes |
| sessionTtl | int | The time to live of session for SSO login. Unit is `hour`. Default is 7 * 24 hours. | No |
| github | [SSOConfigGitHub](#ssoconfiggithub) | GitHub sso configuration. | No |

Expand Down
2 changes: 1 addition & 1 deletion ...ent/en/docs-v0.43.x/user-guide/managing-controlplane/configuration-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ Must be one of the following objects:
| Field | Type | Description | Required |
|-|-|-|-|
| name | string | The unique name of the configuration. | Yes |
| provider | string | The SSO service provider. Can be one of the following values<br>`GITHUB`, `GOOGLE`... | Yes |
| provider | string | The SSO service provider. Currently, only `GITHUB` is supported. | Yes |
| sessionTtl | int | The time to live of session for SSO login. Unit is `hour`. Default is 7 * 24 hours. | No |
| github | [SSOConfigGitHub](#ssoconfiggithub) | GitHub sso configuration. | No |

Expand Down
2 changes: 1 addition & 1 deletion ...ent/en/docs-v0.44.x/user-guide/managing-controlplane/configuration-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ Must be one of the following objects:
| Field | Type | Description | Required |
|-|-|-|-|
| name | string | The unique name of the configuration. | Yes |
| provider | string | The SSO service provider. Can be one of the following values<br>`GITHUB`, `GOOGLE`... | Yes |
| provider | string | The SSO service provider. Currently, only `GITHUB` is supported. | Yes |
| sessionTtl | int | The time to live of session for SSO login. Unit is `hour`. Default is 7 * 24 hours. | No |
| github | [SSOConfigGitHub](#ssoconfiggithub) | GitHub sso configuration. | No |

Expand Down
2 changes: 1 addition & 1 deletion ...ent/en/docs-v0.45.x/user-guide/managing-controlplane/configuration-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ Must be one of the following objects:
| Field | Type | Description | Required |
|-|-|-|-|
| name | string | The unique name of the configuration. | Yes |
| provider | string | The SSO service provider. Can be one of the following values<br>`GITHUB`, `GOOGLE`... | Yes |
| provider | string | The SSO service provider. Currently, only `GITHUB` is supported. | Yes |
| sessionTtl | int | The time to live of session for SSO login. Unit is `hour`. Default is 7 * 24 hours. | No |
| github | [SSOConfigGitHub](#ssoconfiggithub) | GitHub sso configuration. | No |

Expand Down
2 changes: 1 addition & 1 deletion ...ent/en/docs-v0.46.x/user-guide/managing-controlplane/configuration-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ Must be one of the following objects:
| Field | Type | Description | Required |
|-|-|-|-|
| name | string | The unique name of the configuration. | Yes |
| provider | string | The SSO service provider. Can be one of the following values<br>`GITHUB`, `GOOGLE`... | Yes |
| provider | string | The SSO service provider. Only `GITHUB` is supported. | Yes |
| sessionTtl | int | The time to live of session for SSO login. Unit is `hour`. Default is 7 * 24 hours. | No |
| github | [SSOConfigGitHub](#ssoconfiggithub) | GitHub sso configuration. | No |

Expand Down
2 changes: 1 addition & 1 deletion ...ent/en/docs-v0.47.x/user-guide/managing-controlplane/configuration-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ Must be one of the following objects:
| Field | Type | Description | Required |
|-|-|-|-|
| name | string | The unique name of the configuration. | Yes |
| provider | string | The SSO service provider. Can be one of the following values<br>`GITHUB`, `GOOGLE`... | Yes |
| provider | string | The SSO service provider. Currently, only `GITHUB` is supported. | Yes |
| sessionTtl | int | The time to live of session for SSO login. Unit is `hour`. Default is 7 * 24 hours. | No |
| github | [SSOConfigGitHub](#ssoconfiggithub) | GitHub sso configuration. | No |

Expand Down
2 changes: 1 addition & 1 deletion ...ent/en/docs-v0.48.x/user-guide/managing-controlplane/configuration-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ Must be one of the following objects:
| Field | Type | Description | Required |
|-|-|-|-|
| name | string | The unique name of the configuration. | Yes |
| provider | string | The SSO service provider. Can be one of the following values<br>`GITHUB`, `GOOGLE`... | Yes |
| provider | string | The SSO service provider. Currently, only `GITHUB` is supported. | Yes |
| sessionTtl | int | The time to live of session for SSO login. Unit is `hour`. Default is 7 * 24 hours. | No |
| github | [SSOConfigGitHub](#ssoconfiggithub) | GitHub sso configuration. | No |

Expand Down
2 changes: 1 addition & 1 deletion web/src/constants/text.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
export const STATIC_ADMIN_DESCRIPTION = `An admin account that was automatically generated while initializing the project. This admin account can be logged in by using the provided or configured username and password.`;
export const SSO_DESCRIPTION = `Single sign-on (SSO) allows to user to log in to PipeCD by relying on a trusted third party service such as GitHub, GitHub Enterprise Server, Google Gmail, BitBucket...`;
export const SSO_DESCRIPTION = `Single sign-on (SSO) allows users to log in to PipeCD by relying on a trusted third party service. Currently, only GitHub is supported.`;
export const RBAC_DESCRIPTION = `Role-based access control (RBAC) allows restricting the access on PipeCD web based on the roles of user groups within the project. Before using this feature, the SSO must be configured.`;
Loading