From e348ea3186154333645e98b50ffcc14cdaf7b093 Mon Sep 17 00:00:00 2001 From: Alexander Thor Date: Mon, 15 Jul 2024 19:21:53 +0200 Subject: [PATCH] docs: release notes 0.47 --- docs/blog/0.47.md | 80 +++++++++++++++++++ docs/docs/reference/cli/billing/billing.md | 23 ++++++ docs/docs/reference/cli/billing/plan/list.md | 25 ++++++ docs/docs/reference/cli/billing/plan/plan.md | 22 +++++ .../cli/billing/subscription/create.md | 32 ++++++++ .../cli/billing/subscription/edit.md | 32 ++++++++ .../cli/billing/subscription/list.md | 31 +++++++ .../cli/billing/subscription/subscription.md | 24 ++++++ docs/docs/reference/cli/cli.md | 3 + docs/docs/reference/cli/deploy.md | 1 + docs/docs/reference/cli/share-url/create.md | 36 +++++++++ docs/docs/reference/cli/share-url/delete.md | 26 ++++++ docs/docs/reference/cli/share-url/list.md | 35 ++++++++ .../docs/reference/cli/share-url/share-url.md | 30 +++++++ docs/docs/reference/cli/user/add.md | 1 + docs/docs/reference/cli/user/list.md | 1 + docs/docs/reference/cli/user/remove.md | 1 + docs/docs/reference/cli/usergroup/add.md | 34 ++++++++ docs/docs/reference/cli/usergroup/create.md | 31 +++++++ docs/docs/reference/cli/usergroup/delete.md | 31 +++++++ docs/docs/reference/cli/usergroup/edit.md | 31 +++++++ docs/docs/reference/cli/usergroup/list.md | 34 ++++++++ docs/docs/reference/cli/usergroup/remove.md | 33 ++++++++ docs/docs/reference/cli/usergroup/rename.md | 32 ++++++++ docs/docs/reference/cli/usergroup/set.md | 34 ++++++++ docs/docs/reference/cli/usergroup/show.md | 31 +++++++ .../docs/reference/cli/usergroup/usergroup.md | 30 +++++++ 27 files changed, 724 insertions(+) create mode 100644 docs/blog/0.47.md create mode 100644 docs/docs/reference/cli/billing/billing.md create mode 100644 docs/docs/reference/cli/billing/plan/list.md create mode 100644 docs/docs/reference/cli/billing/plan/plan.md create mode 100644 docs/docs/reference/cli/billing/subscription/create.md create mode 100644 docs/docs/reference/cli/billing/subscription/edit.md create mode 100644 docs/docs/reference/cli/billing/subscription/list.md create mode 100644 docs/docs/reference/cli/billing/subscription/subscription.md create mode 100644 docs/docs/reference/cli/share-url/create.md create mode 100644 docs/docs/reference/cli/share-url/delete.md create mode 100644 docs/docs/reference/cli/share-url/list.md create mode 100644 docs/docs/reference/cli/share-url/share-url.md create mode 100644 docs/docs/reference/cli/usergroup/add.md create mode 100644 docs/docs/reference/cli/usergroup/create.md create mode 100644 docs/docs/reference/cli/usergroup/delete.md create mode 100644 docs/docs/reference/cli/usergroup/edit.md create mode 100644 docs/docs/reference/cli/usergroup/list.md create mode 100644 docs/docs/reference/cli/usergroup/remove.md create mode 100644 docs/docs/reference/cli/usergroup/rename.md create mode 100644 docs/docs/reference/cli/usergroup/set.md create mode 100644 docs/docs/reference/cli/usergroup/show.md create mode 100644 docs/docs/reference/cli/usergroup/usergroup.md diff --git a/docs/blog/0.47.md b/docs/blog/0.47.md new file mode 100644 index 00000000000..b424f3de07e --- /dev/null +++ b/docs/blog/0.47.md @@ -0,0 +1,80 @@ +--- + +date: 2024-07-10 +image: https://github.com/rilldata/rill/assets/5587788/b30486f6-002a-445d-8a1b-955b6ec0066d + +--- + +# Rill 0.47 - Public Links, User Groups, Host files and easier security rules. + +:::note +⚡ Rill Developer is a tool that makes it effortless to transform your datasets with SQL and create fast, exploratory dashboards. Rill Cloud can then help to enable shared collaboration at scale. + +To [try out Rill Developer, check out these instructions](/home/install) and [join us over on Discord](https://bit.ly/3bbcSl9) to meet the team behind the product as well as other users. In addition, once you have a project set up in Rill Developer, you can then [deploy the project](/deploy/existing-project) and collaborate with others / invite your team members by [logging into Rill Cloud](https://ui.rilldata.com)! +::: + +![release-0 47]() + +## Public Links +Sometimes you want to provide a fast and filtered access to a dashboard, perhaps to a customer or partner, and now you can! Easily create a Public Link that takes any filters that were present at the point of creation and locks them down. This ensures that however you sent the link to can only see that specific slice of your data and can't navigate to other parts of your data that could be sensitive. Optionally add a expiration date for added security! + + +## User Groups +We have introduced the concept of user groups that allows you to assign users to groups. +User groups are ideal for when you want to manage access to dashboards or row level data access and don't want role based access. You can now write security rules such as `access: {{ has "finance" .user.groups }}` to easily manage access to resources in Rill. Use the CLI to add new groups and assign users to them, [read more here](/reference/cli/usergroup/usergroup), with a Rill Cloud UI based management coming soon! + +## Host static files +By default we now serve any files placed inside of a `public` folder in the root of your project and you can configure additional folders via `public_paths` in [rill.yaml](/reference/project-files/rill-yaml). This will allow you host for example images, geojson or shapefiles that can used in new and exciting features coming soon, stay tuned! + +## Security Rules +We have introduced the ability to utilize wildcards in inclusion and exclusion security rules to make avoid having to list all columns when defining inclusion and exclusion rules together. See more [here](/manage/security#use-wildcards-to-select-all-dimensions-and-measures). + + +## Bug Fixes and Misc +- Added support for scheduling a report directly from a time dimension detail or pivot view. +- Rill Cloud will now include more detailed error messages when showing an error page. +- Added support for using subqueries for measure and threshold based filters to ensure measure filters are not limited to returning only 250 values (and thus potentially return unexpected or incorrect results). +- Introduced styling updates for buttons. +- Upgraded Rill to utilize GPT4o for dashboard AI generation. +- Introduced better error handling when connection to the runtime itself has been lost. +- Improved UX where clicking a table entry now automatically navigates to the table preview in Rill Developer. +- Added pivot and export support for advanced measures. +- Improved our OLAP engine connector modal so that the password visibility can be toggled. +- Added various UX improvements and improved consistency within the connectors page in Rill Developer. +- Fixed issue where advanced measures could produce an incorrect total. +- Fixed issue where the pivot table would sometimes incorrectly display measure values as being null. +- Fixed an issue when using Druid-backed dashboards where pivot tables would enter an error state when trying to fetch null or non-existant dimensional values. +- Fixed an issue where revisiting a project page in Rill Cloud could trigger a HTTP 401 error due to a stale JWT. +- Fixed an issue where adding mutually exclusive filters on a pivot table would cause the pivot table to crash. +- Improved performance of the global dimension search for Druid-backed dashboards. +- Added hardening to dimension table exports to filter out invalid advanced measures. +- Added UX improvement so that clicking the dashboard title in the preview opens the dashboard switcher dropdown. +- Improved the Rill installation binary so that we automatically embed the most commonly used DuckDB extensions. +- Improved the install options UX when using the Rill install script. +- Improved the ingestion speed of our BigQuery connector. +- Improved the performance of our underlying parquet writer. +- Fixed an issue where users could encounter an "empty" table when scrolling on the pivot table beyond 50 values. +- Added UX improvement to show the reconciliation status and spinner on charts when the project is reconciling. +- Introduced UX improvement so users can directly start a new pivot table from a dimension detail view. +- Fixed an issue where expanding a row in the pivot table does not always reveal sub-rows when there are no columns. +- Fixed an issue where the organization breadcrumb was missing for anonymous users in Rill Cloud. +- Fixed an issue where `duckdb.Decimal` was being serialized as an object instead of a number. +- Refactored the project status indicators in Rill Cloud, including displaying deployment errors, resource errors, and parse errors in the project deployment status page. +- Fixed an issue where creating a bookmark with "Save filters only" enabled wasn't working properly. +- Improved syntax highlighting in Rill Developer so that SQL is automatically highlighted in API and metrics view YAML files. +- Improved how measure filters are applied and displayed in configured alerts. +- Added further consistency to how Rill Cloud displays and properly reflects the underlying deployment status of a project. +- Fixed an UX issue where there was a missing scrollbar in the `Add Data` modal in Rill Developer. +- Improved Rill's support for utilizing multiple OLAP engines in the same project, including how multiple connectors are displayed in the Connector Explorer in Rill Developer. +- Fixed an issue where Rill Developer would not work properly when using http with a non-localhost hostname. +- Fixed an issue where loading a parquet file with `infinity` values would lead to 400 Bad Request errors in downstream models and dashboards. +- Fixed an issue where Rill was not properly applying `ignore_paths` during `rill start`, which could lead to initialization issues when trying to start a large but valid Rill project. +- Added UX improvement so that the keyboard shortcut for the Save functionality (i.e. Cmd-S) is more easily discoverable in Rill Developer via a tooltip. +- Fixed an issue where adding or re-adding a measure to an existing pivot table with a set of dimensions already selected could lead to the wrong results being displayed. +- Fixed an issue where users would not be able to shift-click from the time dimension detail or pivot table to copy a dimension value to their clipboard. +- Fixed an issue where using the Athena connector with a table greater than 10GB in size would result in a `glob pattern exceeds limit` error. +- Refactored how export limits are handled under the hood to make exports safer and based on the actual data size, applying a default limit of 128MB on Rill Cloud and unlimited for local exports in Rill Developer. +- Changed the `Last Triggered` timestamp for alerts from `executionTime` to `finishedOn`. +- Improved error handling in Rill Cloud to show a more informational message when a security policy results in zero measures being returned for a dashboard. +- Improved error handling to better and more consistently surface any underlying error statuses coming from the Druid response body when using Druid-backed dashboards. +- Fixed an issue where using comparison by time with Druid-backed dashboards would result in the dashboard to not be able to render correctly. \ No newline at end of file diff --git a/docs/docs/reference/cli/billing/billing.md b/docs/docs/reference/cli/billing/billing.md new file mode 100644 index 00000000000..c52448a6fa9 --- /dev/null +++ b/docs/docs/reference/cli/billing/billing.md @@ -0,0 +1,23 @@ +--- +note: GENERATED. DO NOT EDIT. +title: rill billing +--- +## rill billing + +Billing related commands for org + +### Global flags + +``` + --api-token string Token for authenticating with the cloud API + --format string Output format (options: "human", "json", "csv") (default "human") + -h, --help Print usage + --interactive Prompt for missing required parameters (default true) +``` + +### SEE ALSO + +* [rill](../cli.md) - Rill CLI +* [rill billing plan](plan/plan.md) - Get billing plans +* [rill billing subscription](subscription/subscription.md) - Manage organisation subscription + diff --git a/docs/docs/reference/cli/billing/plan/list.md b/docs/docs/reference/cli/billing/plan/list.md new file mode 100644 index 00000000000..6921c5bdf7f --- /dev/null +++ b/docs/docs/reference/cli/billing/plan/list.md @@ -0,0 +1,25 @@ +--- +note: GENERATED. DO NOT EDIT. +title: rill billing plan list +--- +## rill billing plan list + +List plans + +``` +rill billing plan list [flags] +``` + +### Global flags + +``` + --api-token string Token for authenticating with the cloud API + --format string Output format (options: "human", "json", "csv") (default "human") + -h, --help Print usage + --interactive Prompt for missing required parameters (default true) +``` + +### SEE ALSO + +* [rill billing plan](plan.md) - Get billing plans + diff --git a/docs/docs/reference/cli/billing/plan/plan.md b/docs/docs/reference/cli/billing/plan/plan.md new file mode 100644 index 00000000000..c99ccd627ee --- /dev/null +++ b/docs/docs/reference/cli/billing/plan/plan.md @@ -0,0 +1,22 @@ +--- +note: GENERATED. DO NOT EDIT. +title: rill billing plan +--- +## rill billing plan + +Get billing plans + +### Global flags + +``` + --api-token string Token for authenticating with the cloud API + --format string Output format (options: "human", "json", "csv") (default "human") + -h, --help Print usage + --interactive Prompt for missing required parameters (default true) +``` + +### SEE ALSO + +* [rill billing](../billing.md) - Billing related commands for org +* [rill billing plan list](list.md) - List plans + diff --git a/docs/docs/reference/cli/billing/subscription/create.md b/docs/docs/reference/cli/billing/subscription/create.md new file mode 100644 index 00000000000..5c5b60703d2 --- /dev/null +++ b/docs/docs/reference/cli/billing/subscription/create.md @@ -0,0 +1,32 @@ +--- +note: GENERATED. DO NOT EDIT. +title: rill billing subscription create +--- +## rill billing subscription create + +Create subscription for an organization + +``` +rill billing subscription create [flags] +``` + +### Flags + +``` + --org string Organization Name + --plan string Plan Name to subscribe to +``` + +### Global flags + +``` + --api-token string Token for authenticating with the cloud API + --format string Output format (options: "human", "json", "csv") (default "human") + -h, --help Print usage + --interactive Prompt for missing required parameters (default true) +``` + +### SEE ALSO + +* [rill billing subscription](subscription.md) - Manage organisation subscription + diff --git a/docs/docs/reference/cli/billing/subscription/edit.md b/docs/docs/reference/cli/billing/subscription/edit.md new file mode 100644 index 00000000000..5c2cf92dc39 --- /dev/null +++ b/docs/docs/reference/cli/billing/subscription/edit.md @@ -0,0 +1,32 @@ +--- +note: GENERATED. DO NOT EDIT. +title: rill billing subscription edit +--- +## rill billing subscription edit + +Edit organization subscription + +``` +rill billing subscription edit [flags] +``` + +### Flags + +``` + --org string Organization name + --plan string Plan Name to change subscription to +``` + +### Global flags + +``` + --api-token string Token for authenticating with the cloud API + --format string Output format (options: "human", "json", "csv") (default "human") + -h, --help Print usage + --interactive Prompt for missing required parameters (default true) +``` + +### SEE ALSO + +* [rill billing subscription](subscription.md) - Manage organisation subscription + diff --git a/docs/docs/reference/cli/billing/subscription/list.md b/docs/docs/reference/cli/billing/subscription/list.md new file mode 100644 index 00000000000..7def4d68bfc --- /dev/null +++ b/docs/docs/reference/cli/billing/subscription/list.md @@ -0,0 +1,31 @@ +--- +note: GENERATED. DO NOT EDIT. +title: rill billing subscription list +--- +## rill billing subscription list + +List subscription for an organization + +``` +rill billing subscription list [flags] +``` + +### Flags + +``` + --org string Organization Name +``` + +### Global flags + +``` + --api-token string Token for authenticating with the cloud API + --format string Output format (options: "human", "json", "csv") (default "human") + -h, --help Print usage + --interactive Prompt for missing required parameters (default true) +``` + +### SEE ALSO + +* [rill billing subscription](subscription.md) - Manage organisation subscription + diff --git a/docs/docs/reference/cli/billing/subscription/subscription.md b/docs/docs/reference/cli/billing/subscription/subscription.md new file mode 100644 index 00000000000..f19d4fae18d --- /dev/null +++ b/docs/docs/reference/cli/billing/subscription/subscription.md @@ -0,0 +1,24 @@ +--- +note: GENERATED. DO NOT EDIT. +title: rill billing subscription +--- +## rill billing subscription + +Manage organisation subscription + +### Global flags + +``` + --api-token string Token for authenticating with the cloud API + --format string Output format (options: "human", "json", "csv") (default "human") + -h, --help Print usage + --interactive Prompt for missing required parameters (default true) +``` + +### SEE ALSO + +* [rill billing](../billing.md) - Billing related commands for org +* [rill billing subscription create](create.md) - Create subscription for an organization +* [rill billing subscription edit](edit.md) - Edit organization subscription +* [rill billing subscription list](list.md) - List subscription for an organization + diff --git a/docs/docs/reference/cli/cli.md b/docs/docs/reference/cli/cli.md index 281a218596a..4862c89680f 100644 --- a/docs/docs/reference/cli/cli.md +++ b/docs/docs/reference/cli/cli.md @@ -19,6 +19,7 @@ Rill CLI ### SEE ALSO +* [rill billing](billing/billing.md) - Billing related commands for org * [rill deploy](deploy.md) - Deploy project to Rill Cloud * [rill docs](docs/docs.md) - Open docs.rilldata.com * [rill env](env/env.md) - Manage variables for a project @@ -27,10 +28,12 @@ Rill CLI * [rill org](org/org.md) - Manage organisations * [rill project](project/project.md) - Manage projects * [rill service](service/service.md) - Manage service accounts +* [rill share-url](share-url/share-url.md) - Manage shareable URLs * [rill start](start.md) - Build project and start web app * [rill uninstall](uninstall.md) - Uninstall the Rill binary * [rill upgrade](upgrade.md) - Upgrade Rill to the latest version * [rill user](user/user.md) - Manage users +* [rill usergroup](usergroup/usergroup.md) - Manage user groups * [rill version](version.md) - Show Rill version * [rill whoami](whoami.md) - Show current user diff --git a/docs/docs/reference/cli/deploy.md b/docs/docs/reference/cli/deploy.md index c0f45f8c992..6bf5ccb0c3a 100644 --- a/docs/docs/reference/cli/deploy.md +++ b/docs/docs/reference/cli/deploy.md @@ -23,6 +23,7 @@ rill deploy [flags] --provisioner string Project provisioner --prod-version string Rill version (default: the latest release version) (default "latest") --prod-branch string Git branch to deploy from (default: the default Git branch) + -u, --upload Upload project files to Rill managed storage instead of github ``` ### Global flags diff --git a/docs/docs/reference/cli/share-url/create.md b/docs/docs/reference/cli/share-url/create.md new file mode 100644 index 00000000000..85cfebcc4d7 --- /dev/null +++ b/docs/docs/reference/cli/share-url/create.md @@ -0,0 +1,36 @@ +--- +note: GENERATED. DO NOT EDIT. +title: rill share-url create +--- +## rill share-url create + +Create a shareable URL + +``` +rill share-url create [] [flags] +``` + +### Flags + +``` + --project string Project name + --path string Project directory (default ".") + --ttl-minutes int Duration until the token expires (use 0 for no expiry) + --filter string Limit access to the provided filter (json) + --fields strings Limit access to the provided fields +``` + +### Global flags + +``` + --api-token string Token for authenticating with the cloud API + --format string Output format (options: "human", "json", "csv") (default "human") + -h, --help Print usage + --interactive Prompt for missing required parameters (default true) + --org string Organization Name +``` + +### SEE ALSO + +* [rill share-url](share-url.md) - Manage shareable URLs + diff --git a/docs/docs/reference/cli/share-url/delete.md b/docs/docs/reference/cli/share-url/delete.md new file mode 100644 index 00000000000..fe0102fb27a --- /dev/null +++ b/docs/docs/reference/cli/share-url/delete.md @@ -0,0 +1,26 @@ +--- +note: GENERATED. DO NOT EDIT. +title: rill share-url delete +--- +## rill share-url delete + +Delete a shareable URL + +``` +rill share-url delete [flags] +``` + +### Global flags + +``` + --api-token string Token for authenticating with the cloud API + --format string Output format (options: "human", "json", "csv") (default "human") + -h, --help Print usage + --interactive Prompt for missing required parameters (default true) + --org string Organization Name +``` + +### SEE ALSO + +* [rill share-url](share-url.md) - Manage shareable URLs + diff --git a/docs/docs/reference/cli/share-url/list.md b/docs/docs/reference/cli/share-url/list.md new file mode 100644 index 00000000000..5c0a0688dd3 --- /dev/null +++ b/docs/docs/reference/cli/share-url/list.md @@ -0,0 +1,35 @@ +--- +note: GENERATED. DO NOT EDIT. +title: rill share-url list +--- +## rill share-url list + +List all shareable URLs + +``` +rill share-url list [] [flags] +``` + +### Flags + +``` + --project string Project name + --path string Project directory (default ".") + --page-size uint32 Number of projects to return per page (default 50) + --page-token string Pagination token +``` + +### Global flags + +``` + --api-token string Token for authenticating with the cloud API + --format string Output format (options: "human", "json", "csv") (default "human") + -h, --help Print usage + --interactive Prompt for missing required parameters (default true) + --org string Organization Name +``` + +### SEE ALSO + +* [rill share-url](share-url.md) - Manage shareable URLs + diff --git a/docs/docs/reference/cli/share-url/share-url.md b/docs/docs/reference/cli/share-url/share-url.md new file mode 100644 index 00000000000..25e5840d0c4 --- /dev/null +++ b/docs/docs/reference/cli/share-url/share-url.md @@ -0,0 +1,30 @@ +--- +note: GENERATED. DO NOT EDIT. +title: rill share-url +--- +## rill share-url + +Manage shareable URLs + +### Flags + +``` + --org string Organization Name +``` + +### Global flags + +``` + --api-token string Token for authenticating with the cloud API + --format string Output format (options: "human", "json", "csv") (default "human") + -h, --help Print usage + --interactive Prompt for missing required parameters (default true) +``` + +### SEE ALSO + +* [rill](../cli.md) - Rill CLI +* [rill share-url create](create.md) - Create a shareable URL +* [rill share-url delete](delete.md) - Delete a shareable URL +* [rill share-url list](list.md) - List all shareable URLs + diff --git a/docs/docs/reference/cli/user/add.md b/docs/docs/reference/cli/user/add.md index eb98bc64484..f30915ea8cc 100644 --- a/docs/docs/reference/cli/user/add.md +++ b/docs/docs/reference/cli/user/add.md @@ -14,6 +14,7 @@ rill user add [flags] ``` --email string Email of the user + --group string User group --org string Organization --project string Project --role string Role of the user (options: admin, viewer) diff --git a/docs/docs/reference/cli/user/list.md b/docs/docs/reference/cli/user/list.md index 044ed03c29f..a85f6878158 100644 --- a/docs/docs/reference/cli/user/list.md +++ b/docs/docs/reference/cli/user/list.md @@ -13,6 +13,7 @@ rill user list [flags] ### Flags ``` + --group string User group --org string Organization --page-size uint32 Number of users to return per page (default 50) --page-token string Pagination token diff --git a/docs/docs/reference/cli/user/remove.md b/docs/docs/reference/cli/user/remove.md index cb8d52f7d46..cb19a60e0b9 100644 --- a/docs/docs/reference/cli/user/remove.md +++ b/docs/docs/reference/cli/user/remove.md @@ -14,6 +14,7 @@ rill user remove [flags] ``` --email string Email of the user + --group string User group --keep-project-roles Keep roles granted directly on projects in the org --org string Organization --project string Project diff --git a/docs/docs/reference/cli/usergroup/add.md b/docs/docs/reference/cli/usergroup/add.md new file mode 100644 index 00000000000..112f859b4fd --- /dev/null +++ b/docs/docs/reference/cli/usergroup/add.md @@ -0,0 +1,34 @@ +--- +note: GENERATED. DO NOT EDIT. +title: rill usergroup add +--- +## rill usergroup add + +Add role to a user group in an organization or project + +``` +rill usergroup add [flags] +``` + +### Flags + +``` + --group string User group + --org string Organization + --project string Project + --role string Role of the user group (options: admin, viewer) +``` + +### Global flags + +``` + --api-token string Token for authenticating with the cloud API + --format string Output format (options: "human", "json", "csv") (default "human") + -h, --help Print usage + --interactive Prompt for missing required parameters (default true) +``` + +### SEE ALSO + +* [rill usergroup](usergroup.md) - Manage user groups + diff --git a/docs/docs/reference/cli/usergroup/create.md b/docs/docs/reference/cli/usergroup/create.md new file mode 100644 index 00000000000..44480fd95f6 --- /dev/null +++ b/docs/docs/reference/cli/usergroup/create.md @@ -0,0 +1,31 @@ +--- +note: GENERATED. DO NOT EDIT. +title: rill usergroup create +--- +## rill usergroup create + +Create a user group + +``` +rill usergroup create [] [flags] +``` + +### Flags + +``` + --org string Organization +``` + +### Global flags + +``` + --api-token string Token for authenticating with the cloud API + --format string Output format (options: "human", "json", "csv") (default "human") + -h, --help Print usage + --interactive Prompt for missing required parameters (default true) +``` + +### SEE ALSO + +* [rill usergroup](usergroup.md) - Manage user groups + diff --git a/docs/docs/reference/cli/usergroup/delete.md b/docs/docs/reference/cli/usergroup/delete.md new file mode 100644 index 00000000000..40ced0b9255 --- /dev/null +++ b/docs/docs/reference/cli/usergroup/delete.md @@ -0,0 +1,31 @@ +--- +note: GENERATED. DO NOT EDIT. +title: rill usergroup delete +--- +## rill usergroup delete + +Delete a user group + +``` +rill usergroup delete [flags] +``` + +### Flags + +``` + --org string Organization +``` + +### Global flags + +``` + --api-token string Token for authenticating with the cloud API + --format string Output format (options: "human", "json", "csv") (default "human") + -h, --help Print usage + --interactive Prompt for missing required parameters (default true) +``` + +### SEE ALSO + +* [rill usergroup](usergroup.md) - Manage user groups + diff --git a/docs/docs/reference/cli/usergroup/edit.md b/docs/docs/reference/cli/usergroup/edit.md new file mode 100644 index 00000000000..a136ce253bc --- /dev/null +++ b/docs/docs/reference/cli/usergroup/edit.md @@ -0,0 +1,31 @@ +--- +note: GENERATED. DO NOT EDIT. +title: rill usergroup edit +--- +## rill usergroup edit + +Edit a user group + +``` +rill usergroup edit [] [flags] +``` + +### Flags + +``` + --org string Organization +``` + +### Global flags + +``` + --api-token string Token for authenticating with the cloud API + --format string Output format (options: "human", "json", "csv") (default "human") + -h, --help Print usage + --interactive Prompt for missing required parameters (default true) +``` + +### SEE ALSO + +* [rill usergroup](usergroup.md) - Manage user groups + diff --git a/docs/docs/reference/cli/usergroup/list.md b/docs/docs/reference/cli/usergroup/list.md new file mode 100644 index 00000000000..00c823a2f05 --- /dev/null +++ b/docs/docs/reference/cli/usergroup/list.md @@ -0,0 +1,34 @@ +--- +note: GENERATED. DO NOT EDIT. +title: rill usergroup list +--- +## rill usergroup list + +List user groups + +``` +rill usergroup list [flags] +``` + +### Flags + +``` + --org string Organization + --page-size uint32 Number of user groups to return per page (default 50) + --page-token string Pagination token + --project string Project +``` + +### Global flags + +``` + --api-token string Token for authenticating with the cloud API + --format string Output format (options: "human", "json", "csv") (default "human") + -h, --help Print usage + --interactive Prompt for missing required parameters (default true) +``` + +### SEE ALSO + +* [rill usergroup](usergroup.md) - Manage user groups + diff --git a/docs/docs/reference/cli/usergroup/remove.md b/docs/docs/reference/cli/usergroup/remove.md new file mode 100644 index 00000000000..665e5937a14 --- /dev/null +++ b/docs/docs/reference/cli/usergroup/remove.md @@ -0,0 +1,33 @@ +--- +note: GENERATED. DO NOT EDIT. +title: rill usergroup remove +--- +## rill usergroup remove + +Remove role of a user group in an organization or prodject + +``` +rill usergroup remove [flags] +``` + +### Flags + +``` + --group string User group + --org string Organization + --project string Project +``` + +### Global flags + +``` + --api-token string Token for authenticating with the cloud API + --format string Output format (options: "human", "json", "csv") (default "human") + -h, --help Print usage + --interactive Prompt for missing required parameters (default true) +``` + +### SEE ALSO + +* [rill usergroup](usergroup.md) - Manage user groups + diff --git a/docs/docs/reference/cli/usergroup/rename.md b/docs/docs/reference/cli/usergroup/rename.md new file mode 100644 index 00000000000..3ceaeb1e61f --- /dev/null +++ b/docs/docs/reference/cli/usergroup/rename.md @@ -0,0 +1,32 @@ +--- +note: GENERATED. DO NOT EDIT. +title: rill usergroup rename +--- +## rill usergroup rename + +Rename a user group + +``` +rill usergroup rename [] [flags] +``` + +### Flags + +``` + --new-name string New user group name + --org string Organization +``` + +### Global flags + +``` + --api-token string Token for authenticating with the cloud API + --format string Output format (options: "human", "json", "csv") (default "human") + -h, --help Print usage + --interactive Prompt for missing required parameters (default true) +``` + +### SEE ALSO + +* [rill usergroup](usergroup.md) - Manage user groups + diff --git a/docs/docs/reference/cli/usergroup/set.md b/docs/docs/reference/cli/usergroup/set.md new file mode 100644 index 00000000000..f0f06527407 --- /dev/null +++ b/docs/docs/reference/cli/usergroup/set.md @@ -0,0 +1,34 @@ +--- +note: GENERATED. DO NOT EDIT. +title: rill usergroup set +--- +## rill usergroup set + +Set role to a user group in an organization or project + +``` +rill usergroup set [flags] +``` + +### Flags + +``` + --group string User group + --org string Organization + --project string Project + --role string Role of the user group (options: admin, viewer) +``` + +### Global flags + +``` + --api-token string Token for authenticating with the cloud API + --format string Output format (options: "human", "json", "csv") (default "human") + -h, --help Print usage + --interactive Prompt for missing required parameters (default true) +``` + +### SEE ALSO + +* [rill usergroup](usergroup.md) - Manage user groups + diff --git a/docs/docs/reference/cli/usergroup/show.md b/docs/docs/reference/cli/usergroup/show.md new file mode 100644 index 00000000000..6b382d8e755 --- /dev/null +++ b/docs/docs/reference/cli/usergroup/show.md @@ -0,0 +1,31 @@ +--- +note: GENERATED. DO NOT EDIT. +title: rill usergroup show +--- +## rill usergroup show + +Show a user group + +``` +rill usergroup show [flags] +``` + +### Flags + +``` + --org string Organization +``` + +### Global flags + +``` + --api-token string Token for authenticating with the cloud API + --format string Output format (options: "human", "json", "csv") (default "human") + -h, --help Print usage + --interactive Prompt for missing required parameters (default true) +``` + +### SEE ALSO + +* [rill usergroup](usergroup.md) - Manage user groups + diff --git a/docs/docs/reference/cli/usergroup/usergroup.md b/docs/docs/reference/cli/usergroup/usergroup.md new file mode 100644 index 00000000000..bde46b1d2c0 --- /dev/null +++ b/docs/docs/reference/cli/usergroup/usergroup.md @@ -0,0 +1,30 @@ +--- +note: GENERATED. DO NOT EDIT. +title: rill usergroup +--- +## rill usergroup + +Manage user groups + +### Global flags + +``` + --api-token string Token for authenticating with the cloud API + --format string Output format (options: "human", "json", "csv") (default "human") + -h, --help Print usage + --interactive Prompt for missing required parameters (default true) +``` + +### SEE ALSO + +* [rill](../cli.md) - Rill CLI +* [rill usergroup add](add.md) - Add role to a user group in an organization or project +* [rill usergroup create](create.md) - Create a user group +* [rill usergroup delete](delete.md) - Delete a user group +* [rill usergroup edit](edit.md) - Edit a user group +* [rill usergroup list](list.md) - List user groups +* [rill usergroup remove](remove.md) - Remove role of a user group in an organization or prodject +* [rill usergroup rename](rename.md) - Rename a user group +* [rill usergroup set](set.md) - Set role to a user group in an organization or project +* [rill usergroup show](show.md) - Show a user group +