-
Notifications
You must be signed in to change notification settings - Fork 401
Cloud: add guides for adjusting SQL console access and org and service level role assignment #4401
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "label": "SQL console", | ||
| "collapsible": true, | ||
| "collapsed": true, | ||
| } |
84 changes: 84 additions & 0 deletions
84
docs/cloud/guides/SQL_console/configure_org_and_service_role_assignments.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| --- | ||
| slug: /cloud/guides/sql-console/configure-org-service-role-assignments | ||
| sidebar_label: 'Configuring organization and service role assignments' | ||
| title: 'Configuring organization and service role assignments within the console' | ||
| description: 'Guide showing how to configure org and service role assignments within the console' | ||
| --- | ||
|
|
||
| import Image from '@theme/IdealImage'; | ||
| import step_1 from '@site/static/images/cloud/guides/sql_console/org_level_access/1_org_settings.png' | ||
| import step_2 from '@site/static/images/cloud/guides/sql_console/org_level_access/2_org_settings.png' | ||
| import step_3 from '@site/static/images/cloud/guides/sql_console/org_level_access/3_org_settings.png' | ||
| import step_4 from '@site/static/images/cloud/guides/sql_console/org_level_access/4_org_settings.png' | ||
| import step_5 from '@site/static/images/cloud/guides/sql_console/org_level_access/5_org_settings.png' | ||
| import step_6 from '@site/static/images/cloud/guides/sql_console/org_level_access/6_org_settings.png' | ||
| import step_7 from '@site/static/images/cloud/guides/sql_console/org_level_access/7_org_settings.png' | ||
|
|
||
| # Configuring organization and service role assignments within the console | ||
|
|
||
| > This guide shows you how to configure role assignments at the organization and service level. | ||
|
|
||
| <VerticalStepper> | ||
|
|
||
| ## Access organization settings {#access-service-settings} | ||
|
|
||
| From the services page, select the name of your organization: | ||
|
|
||
| <Image img={step_1} size="md"/> | ||
|
|
||
| Select the `Users and roles` menu item from the popup menu. | ||
|
|
||
| <Image img={step_2} size="md"/> | ||
|
|
||
| ## Adjust access per user {#access-per-user} | ||
|
|
||
| Select the menu item at the end of the row for the user that you which to modify | ||
| access for: | ||
|
|
||
| <Image img={step_3} size="lg"/> | ||
|
|
||
| Select `edit`: | ||
|
|
||
| <Image img={step_4} size="lg"/> | ||
|
|
||
| A tab will display on the right hand side of the page: | ||
|
|
||
| <Image img={step_5} size="lg"/> | ||
|
|
||
| Select the drop-down menu items to adjust console-wide access permissions and which features a user can access from within the ClickHouse console. | ||
| This manages high-level access and administrative settings for an organization: | ||
|
|
||
| | Role | Description | | ||
| |-------------|----------------------------------------------------------------------------------| | ||
| | `Admin` | Perform all administrative activities for an organization, control all settings. | | ||
| | `Developer` | View everything except Services, create API keys with equal or lower access. | | ||
| | `Member` | Sign in only with ability to manage personal profile settings. | | ||
| | `Billing` | View usage and invoices, and manage payment methods | | ||
|
|
||
| Select the drop-down menu items to adjust the access scope of the service role of the selected user. | ||
| This defines security and operational settings for individual services: | ||
|
|
||
| | Access scope | | ||
| |---------------------| | ||
| | `All services` | | ||
| | `Specific services` | | ||
| | `No services` | | ||
|
|
||
| When selecting `Specific services`, you can control the role of the user per | ||
| service: | ||
|
|
||
| <Image img={step_6} size="md"/> | ||
|
|
||
| You can choose from the following roles: | ||
|
|
||
| | Role | Description | | ||
| |-------------|--------------------------------------------------------------------| | ||
| | `Admin` | Full control over configuration and security. Can delete service. | | ||
| | `Read-only` | Can see service data and security settings. Can't modify anything. | | ||
| | `No access` | Doesn't know the service exists. | | ||
|
|
||
| Save your changes with the `Save changes` button at the bottom of the tab: | ||
|
|
||
| <Image img={step_7} size="md"/> | ||
|
|
||
| </VerticalStepper> |
74 changes: 74 additions & 0 deletions
74
docs/cloud/guides/SQL_console/configure_sql_console_role_assignments.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| --- | ||
| slug: /cloud/guides/sql-console/config-sql-console-role-assignments | ||
| sidebar_label: 'Configuring SQL console role assignments' | ||
| title: 'Configuring SQL console role assignments' | ||
| description: 'Guide showing how to configure SQL console role assignments' | ||
| --- | ||
|
|
||
| import Image from '@theme/IdealImage'; | ||
| import step_1 from '@site/static/images/cloud/guides/sql_console/service_level_access/1_service_settings.png' | ||
| import step_2 from '@site/static/images/cloud/guides/sql_console/service_level_access/2_service_settings.png' | ||
| import step_3 from '@site/static/images/cloud/guides/sql_console/service_level_access/3_service_settings.png' | ||
| import step_4 from '@site/static/images/cloud/guides/sql_console/service_level_access/4_service_settings.png' | ||
| import step_5 from '@site/static/images/cloud/guides/sql_console/service_level_access/5_service_settings.png' | ||
| import step_6 from '@site/static/images/cloud/guides/sql_console/service_level_access/6_service_settings.png' | ||
| import step_7 from '@site/static/images/cloud/guides/sql_console/service_level_access/7_service_settings.png' | ||
|
|
||
| # Configuring SQL console role assignments | ||
|
|
||
| > This guide shows you how to configure SQL console role assignments, which | ||
| determine console-wide access permissions and the features that a user can | ||
| access within Cloud console. | ||
|
|
||
| <VerticalStepper> | ||
|
|
||
| ## Access service settings {#access-service-settings} | ||
|
|
||
| From the services page, click the menu in the top right corner of the service | ||
| for which you want to adjust SQL console access settings. | ||
|
|
||
| <Image img={step_1} size="lg"/> | ||
|
|
||
| Select `settings` from the popup menu. | ||
|
|
||
| <Image img={step_2} size="lg"/> | ||
|
|
||
| ## Adjust SQL console access {#adjust-sql-console-access} | ||
|
|
||
| Under the "Security" section, find the "SQL console access" area: | ||
|
|
||
| <Image img={step_3} size="md"/> | ||
|
|
||
| Select the drop-down menu for Service Admin to change the access control settings for Service Admin roles: | ||
|
|
||
| <Image img={step_4} size="md"/> | ||
|
|
||
| You can choose from the following roles: | ||
|
|
||
| | Role | | ||
| |---------------| | ||
| | `No access` | | ||
| | `Read only` | | ||
| | `Full access` | | ||
|
|
||
| Select the drop-down menu for Service Read Only to change the access control settings for Service Read Only roles: | ||
|
|
||
| <Image img={step_5} size="md"/> | ||
|
|
||
| You can choose from the following roles: | ||
|
|
||
| | Role | | ||
| |---------------| | ||
| | `No access` | | ||
| | `Read only` | | ||
| | `Full access` | | ||
|
|
||
| An overview of users for the service can be viewed by selecting the user count: | ||
|
|
||
| <Image img={step_6} size="md"/> | ||
|
|
||
| A tab will open to the right of the page showing the total number of users and their roles: | ||
|
|
||
| <Image img={step_7} size="md"/> | ||
|
|
||
| </VerticalStepper> | ||
Binary file added
BIN
+587 KB
static/images/cloud/guides/sql_console/org_level_access/1_org_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+65.7 KB
static/images/cloud/guides/sql_console/org_level_access/2_org_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+138 KB
static/images/cloud/guides/sql_console/org_level_access/3_org_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+176 KB
static/images/cloud/guides/sql_console/org_level_access/4_org_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+409 KB
static/images/cloud/guides/sql_console/org_level_access/5_org_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+48.9 KB
static/images/cloud/guides/sql_console/org_level_access/6_org_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+316 KB
static/images/cloud/guides/sql_console/org_level_access/7_org_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+67.7 KB
...mages/cloud/guides/sql_console/org_level_access/Xnapper-2025-09-09-11.43.59.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+300 KB
static/images/cloud/guides/sql_console/service_level_access/1_service_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+268 KB
static/images/cloud/guides/sql_console/service_level_access/2_service_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+187 KB
static/images/cloud/guides/sql_console/service_level_access/3_service_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+188 KB
static/images/cloud/guides/sql_console/service_level_access/4_service_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+188 KB
static/images/cloud/guides/sql_console/service_level_access/5_service_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+188 KB
static/images/cloud/guides/sql_console/service_level_access/6_service_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+1000 KB
static/images/cloud/guides/sql_console/service_level_access/7_service_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.