Skip to content

Commit 40b454c

Browse files
authored
Updated missing documentation for cluster remap command (#1079)
The `cluster-remap` and `revert-cluster-remap` commands have been added to the project's open-source library to assist administrators in managing their clusters' UC settings. The `cluster-remap` command allows users to remap their clusters to UC-enabled ones by providing a comma-separated list of cluster IDs. It updates the specified clusters to UC-enabled and stores a backup of the existing cluster configuration in a JSON file. This backup can be used to revert the cluster remapping if necessary using the `revert-cluster-remap` command. This command iterates through the list of clusters from the backup folder and reverts the cluster configurations to their original state. These commands provide administrators with the ability to manage their clusters' UC settings and revert any changes made to the cluster configurations if necessary, ensuring the integrity and flexibility of their systems.
1 parent a1014a4 commit 40b454c

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ See [contributing instructions](CONTRIBUTING.md) to help improve this project.
5353
* [`manual-workspace-info` command](#manual-workspace-info-command)
5454
* [`create-account-groups` command](#create-account-groups-command)
5555
* [`validate-groups-membership` command](#validate-groups-membership-command)
56+
* [`cluster-remap` command](#cluster-remap-command)
57+
* [`revert-cluster-remap` command](#revert-cluster-remap-command)
5658
* [Star History](#star-history)
5759
* [Project Support](#project-support)
5860
<!-- TOC -->
@@ -715,6 +717,46 @@ This command is useful for administrators who want to ensure that the groups hav
715717
used to debug issues related to group membership. See [group migration](docs/local-group-migration.md) and
716718
[group migration](#group-migration-workflow) for more details.
717719

720+
## `cluster-remap` command
721+
722+
```text
723+
$ databricks labs ucx cluster-remap
724+
21:29:38 INFO [d.labs.ucx] Remapping the Clusters to UC
725+
Cluster Name Cluster Id
726+
Field Eng Shared UC LTS Cluster 0601-182128-dcbte59m
727+
Shared Autoscaling Americas cluster 0329-145545-rugby794
728+
```
729+
```text
730+
Please provide the cluster id's as comma separated value from the above list (default: <ALL>):
731+
```
732+
733+
This command will remap the cluster to uc enabled one.When we run this command it will list all the clusters
734+
and its id's and asks to provide the cluster id's as comma separated value which has to be remapped, by default it will take all cluster ids.
735+
Once we provide the cluster id's it will update these clusters to UC enabled.Back up of the existing cluster
736+
config will be stored in backup folder inside the installed location(backup/clusters/cluster_id.json) as a json file.This will help
737+
to revert the cluster remapping.
738+
739+
740+
[[back to top](#databricks-labs-ucx)]
741+
742+
743+
## `revert-cluster-remap` command
744+
745+
```text
746+
$ databricks labs ucx revert-cluster-remap
747+
21:31:29 INFO [d.labs.ucx] Reverting the Remapping of the Clusters from UC
748+
21:31:33 INFO [d.labs.ucx] 0301-055912-4ske39iq
749+
21:31:33 INFO [d.labs.ucx] 0306-121015-v1llqff6
750+
Please provide the cluster id's as comma separated value from the above list (default: <ALL>):
751+
```
752+
753+
If a customer want's to revert the cluster remap done using the `cluster-remap` command they can use this command to revert
754+
its configuration from UC to original one.It will iterate through the list of clusters from the back up folder and reverts the
755+
cluster configurations to original one.This will also ask the user to provide the list of clusters that has to be reverted as a prompt.
756+
By default it will revert all the clusters present in the back up folder
757+
758+
759+
718760
[[back to top](#databricks-labs-ucx)]
719761

720762
# Star History

0 commit comments

Comments
 (0)