Merge #106117

106117: cli/zip: emphasize "cluster virtualization" r=yuzefovich a=knz Informs #106068. Epic: [CRDB-29380](https://cockroachlabs.atlassian.net/browse/CRDB-29380) Release note (cli change): When `debug zip` is pointed at a multi-tenant cluster or a cluster with virtualization enabled, data about virtual clusters is now stored in a `virtual` sub-directory (this was previously named `tenants`). Co-authored-by: Raphael 'kena' Poss <[email protected]>
cockroachdb · Jul 6, 2023 · 5e87ff5 · 5e87ff5
2 parents 6578cef + cc1ffa7
commit 5e87ff5
Show file tree

Hide file tree

Showing 11 changed files with 140 additions and 140 deletions.
diff --git a/pkg/cli/testdata/zip/partial1 b/pkg/cli/testdata/zip/partial1
@@ -1,7 +1,7 @@
 zip
 ----
 debug zip --concurrency=1 --cpu-profile-duration=0s /dev/null
-[cluster] discovering tenants on cluster... done
+[cluster] discovering virtual clusters... done
 [cluster] creating output file /dev/null... done
 [cluster] establishing RPC connection to ...
 [cluster] using SQL address: ...

diff --git a/pkg/cli/testdata/zip/partial1_excluded b/pkg/cli/testdata/zip/partial1_excluded
@@ -1,7 +1,7 @@
 zip
 ----
 debug zip /dev/null --concurrency=1 --exclude-nodes=2 --cpu-profile-duration=0
-[cluster] discovering tenants on cluster... done
+[cluster] discovering virtual clusters... done
 [cluster] creating output file /dev/null... done
 [cluster] establishing RPC connection to ...
 [cluster] using SQL address: ...

diff --git a/pkg/cli/testdata/zip/partial2 b/pkg/cli/testdata/zip/partial2
@@ -1,7 +1,7 @@
 zip
 ----
 debug zip --concurrency=1 --cpu-profile-duration=0 /dev/null
-[cluster] discovering tenants on cluster... done
+[cluster] discovering virtual clusters... done
 [cluster] creating output file /dev/null... done
 [cluster] establishing RPC connection to ...
 [cluster] using SQL address: ...

diff --git a/pkg/cli/testdata/zip/testzip b/pkg/cli/testdata/zip/testzip
@@ -1,7 +1,7 @@
 zip
 ----
 debug zip --concurrency=1 --cpu-profile-duration=1s /dev/null
-[cluster] discovering tenants on cluster... done
+[cluster] discovering virtual clusters... done
 [cluster] creating output file /dev/null... done
 [cluster] establishing RPC connection to ...
 [cluster] using SQL address: ...

diff --git a/pkg/cli/testdata/zip/testzip_concurrent b/pkg/cli/testdata/zip/testzip_concurrent
@@ -2,8 +2,8 @@ zip
 ----
 [cluster] creating output file /dev/null...
 [cluster] creating output file /dev/null: done
-[cluster] discovering tenants on cluster...
-[cluster] discovering tenants on cluster: done
+[cluster] discovering virtual clusters...
+[cluster] discovering virtual clusters: done
 [cluster] establishing RPC connection to ...
 [cluster] establishing RPC connection to ...
 [cluster] hot range summary script...

diff --git a/...tdata/zip/testzip_tenant_separate_process → ...p/testzip_external_process_virtualization b/...tdata/zip/testzip_tenant_separate_process → ...p/testzip_external_process_virtualization
@@ -1,7 +1,7 @@
 zip
 ----
 debug zip --concurrency=1 --cpu-profile-duration=1s /dev/null
-[cluster] discovering tenants on cluster... done
+[cluster] discovering virtual clusters... done
 [cluster] creating output file /dev/null... done
 [cluster] establishing RPC connection to ...
 [cluster] using SQL address: ...

diff --git a/pkg/cli/testdata/zip/testzip_include_range_info b/pkg/cli/testdata/zip/testzip_include_range_info
@@ -1,7 +1,7 @@
 zip
 ----
 debug zip --concurrency=1 --cpu-profile-duration=1s --include-range-info /dev/null
-[cluster] discovering tenants on cluster... done
+[cluster] discovering virtual clusters... done
 [cluster] creating output file /dev/null... done
 [cluster] establishing RPC connection to ...
 [cluster] using SQL address: ...

diff --git a/...estdata/zip/testzip_shared_process_tenant → ...zip/testzip_shared_process_virtualization b/...estdata/zip/testzip_shared_process_tenant → ...zip/testzip_shared_process_virtualization
diff --git a/pkg/cli/testdata/zip/unavailable b/pkg/cli/testdata/zip/unavailable
@@ -1,7 +1,7 @@
 zip
 ----
 debug zip --concurrency=1 --cpu-profile-duration=0 /dev/null --timeout=.5s
-[cluster] discovering tenants on cluster... done
+[cluster] discovering virtual clusters... done
 [cluster] creating output file /dev/null... done
 [cluster] establishing RPC connection to ...
 [cluster] using SQL address: ...

diff --git a/pkg/cli/zip.go b/pkg/cli/zip.go
@@ -160,15 +160,15 @@ func runDebugZip(cmd *cobra.Command, args []string) (retErr error) {
 
 	var tenants []*serverpb.Tenant
 	if err := func() error {
-		s := zr.start("discovering tenants on cluster")
+		s := zr.start("discovering virtual clusters")
 		conn, _, finish, err := getClientGRPCConn(ctx, serverCfg)
 		if err != nil {
 			return s.fail(err)
 		}
 		defer finish()
 
 		var resp *serverpb.ListTenantsResponse
-		if err := timeutil.RunWithTimeout(context.Background(), "list tenants", timeout, func(ctx context.Context) error {
+		if err := timeutil.RunWithTimeout(context.Background(), "list virtual clusters", timeout, func(ctx context.Context) error {
 			resp, err = serverpb.NewAdminClient(conn).ListTenants(ctx, &serverpb.ListTenantsRequest{})
 			return err
 		}); err != nil {
@@ -267,7 +267,7 @@ func runDebugZip(cmd *cobra.Command, args []string) (retErr error) {
 			// Only add tenant prefix for non system tenants.
 			var prefix string
 			if tenant.TenantId.ToUint64() != roachpb.SystemTenantID.ToUint64() {
-				prefix = fmt.Sprintf("/tenants/%s", tenant.TenantName)
+				prefix = fmt.Sprintf("/virtual/%s", tenant.TenantName)
 			}
 
 			zc := debugZipContext{

diff --git a/pkg/cli/zip_tenant_test.go b/pkg/cli/zip_tenant_test.go
@@ -34,7 +34,7 @@ func TestTenantZip(t *testing.T) {
 		addTenantArgs func(params TestCLIParams) TestCLIParams
 	}{
 		{
-			testName: "testzip tenant separate process",
+			testName: "testzip external process virtualization",
 			addTenantArgs: func(params TestCLIParams) TestCLIParams {
 				tenantDir, tenantDirCleanupFn := testutils.TempDir(t)
 				defer tenantDirCleanupFn()
@@ -47,7 +47,7 @@ func TestTenantZip(t *testing.T) {
 			},
 		},
 		{
-			testName: "testzip shared process tenant",
+			testName: "testzip shared process virtualization",
 			addTenantArgs: func(params TestCLIParams) TestCLIParams {
 				params.SharedProcessTenantArgs = &base.TestSharedProcessTenantArgs{
 					TenantName: "test-tenant",