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.

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

release-23.1: sql: emphasize "virtual cluster" for tenant management in user-facing UX #106376

Merged

Conversation

knz
Copy link
Contributor

@knz knz commented Jul 7, 2023

Informs #106068.
Epic: CRDB-29380

Summary of changes:

  • the SQL syntax surface (CREATE TENANT etc) is now also available as CREATE VIRTUAL CLUSTER etc. The TENANT syntax remains available as well in case someone has muscle memory.
  • session var disable_drop_tenant renamed to disable_drop_virtual_cluster
  • output sub-directory in debug zip is now just cluster (previously tenant).

The changes to data structure names, comments etc are on a separate issue (#106069) and will not be backported.

Backport:

Please see individual PRs for details.

/cc @cockroachdb/release


Release justification: ensures consistent UX between the 23.1 and 23.2 branches, ensuring there is just 1 UX surface for the doc team to process

@knz knz requested review from a team as code owners July 7, 2023 10:07
@knz knz requested a review from a team July 7, 2023 10:07
@knz knz requested review from a team as code owners July 7, 2023 10:07
@knz knz requested review from rhu713, dhartunian and msirek and removed request for a team July 7, 2023 10:07
@cockroach-teamcity
Copy link
Member

This change is Reviewable

@knz knz requested review from stevendanna and yuzefovich and removed request for a team, rhu713, dhartunian and msirek July 7, 2023 11:36
@knz knz changed the title sql: emphasize "virtual cluster" for tenant management in user-facing UX release-23.1: sql: emphasize "virtual cluster" for tenant management in user-facing UX Jul 7, 2023
Copy link
Member

@yuzefovich yuzefovich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Didn't review this carefully since I'm assuming the merge conflicts were minor.

@knz
Copy link
Contributor Author

knz commented Jul 7, 2023

correct there were virtually none.

But I will wait team meeting next week before merging this.

This aliases `INCLUDE_ALL_SECONDARY_TENANTS` which becomes hidden.

Release note: None
knz added 19 commits July 19, 2023 15:35
This aliases `TENANT_NAME` which becomes hidden.

Release note: None
This aliases `TENANT` (in `RESTORE` options) which becomes hidden.

Release note: None
Before this patch:
```
$ cockroach start-single-node --config-profile=help
...
replication-source                  configuration suitable for a replication source cluster (alias for "multitenant+app+sharedservice+repl")
replication-target                  configuration suitable for a replication target cluster (alias for "multitenant+noapp+repl")`
multitenant+app+sharedservice       multi-tenant cluster with one secondary tenant configured to serve SQL application traffic
multitenant+app+sharedservice+repl  multi-tenant cluster with one secondary tenant configured to serve SQL application traffic, with replication enabled
multitenant+noapp                   multi-tenant cluster with no secondary tenant defined yet
multitenant+noapp+repl              multi-tenant cluster with no secondary tenant defined yet, with replication enabled
```

After this patch:
```
replication-source              configuration suitable for a replication source cluster (alias for "virtual+app+sharedservice+repl")
replication-target              configuration suitable for a replication target cluster (alias for "virtual+noapp+repl")
virtual+app+sharedservice       one virtual cluster configured to serve SQL application traffic
virtual+app+sharedservice+repl  one virtual cluster configured to serve SQL application traffic, with replication enabled
virtual+noapp                   virtualization enabled but no virtual cluster defined yet
virtual+noapp+repl              virtualization enabled but no virtual cluster defined yet, with replication enabled
```

Release note: None
This replaces `disable_drop_tenant`, together with the cluster setting
`sql.drop_virtual_cluster.enabled` (replaces
`sql.drop_tenant.enabled`).

We are OK with this breaking change since the feature was not yet
exposed to end-users.

Release note: None
…nant"

Release note (cluster virtualization): This patch renames the
subdirectory inside the output of `cockroach debug zip` when pointed
to a cluster with virtualization enabled to be `cluster`, which brings
the UX in coherence with the parameter of the same name in `cockroach
sql` and the HTTP API parameter in the same name.
@knz knz force-pushed the backport23.1-106110-106116-106121-106298 branch from 18b829b to ff2480d Compare July 19, 2023 13:36
@knz
Copy link
Contributor Author

knz commented Jul 19, 2023

FWIW, @livlobo finds this backport desirable, and @amruss did not object.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants