Naming things: Rename environment variables

amotl · amotl · commit 5a5bba6c6281 · 2025-04-29T18:42:11.000+02:00
- `CRATEDB_CLOUD_CLUSTER_ID` to `CRATEDB_CLUSTER_ID`
- `CRATEDB_CLOUD_CLUSTER_NAME` to `CRATEDB_CLUSTER_NAME`
diff --git a/cratedb_toolkit/cluster/core.py b/cratedb_toolkit/cluster/core.py
@@ -49,15 +49,15 @@ class ManagedClusterSettings:
         Setting(
             click=click.Option(
                 param_decls=["--cluster-id"],
-                envvar="CRATEDB_CLOUD_CLUSTER_ID",
+                envvar="CRATEDB_CLUSTER_ID",
                 help="CrateDB Cloud cluster identifier (UUID)",
             ),
             group="cluster-identifier",
         ),
         Setting(
             click=click.Option(
                 param_decls=["--cluster-name"],
-                envvar="CRATEDB_CLOUD_CLUSTER_NAME",
+                envvar="CRATEDB_CLUSTER_NAME",
                 help="CrateDB Cloud cluster name",
             ),
             group="cluster-identifier",
@@ -170,8 +170,8 @@ def from_env(cls, stop_on_exit: bool = False) -> "ManagedCluster":
         When the toolkit environment is configured with `settings_accept_env`,
         the settings can be specified that way:
 
-            export CRATEDB_CLOUD_CLUSTER_ID='<YOUR_CLUSTER_ID_HERE>'
-            export CRATEDB_CLOUD_CLUSTER_NAME='<YOUR_CLUSTER_NAME_HERE>'
+            export CRATEDB_CLUSTER_ID='<YOUR_CLUSTER_ID_HERE>'
+            export CRATEDB_CLUSTER_NAME='<YOUR_CLUSTER_NAME_HERE>'
         """
         if not CONFIG.settings_accept_cli and not CONFIG.settings_accept_env:
             raise DatabaseAddressMissingError(
@@ -333,7 +333,7 @@ def load_table(
 
         Synopsis
         --------
-        export CRATEDB_CLOUD_CLUSTER_ID=95998958-4d96-46eb-a77a-a894e7dde128
+        export CRATEDB_CLUSTER_ID=95998958-4d96-46eb-a77a-a894e7dde128
         ctk load table https://cdn.crate.io/downloads/datasets/cratedb-datasets/cloud-tutorials/data_weather.csv.gz
 
         https://console.cratedb.cloud
diff --git a/cratedb_toolkit/exception.py b/cratedb_toolkit/exception.py
@@ -22,7 +22,7 @@ class DatabaseAddressMissingError(ClickException):
     EXTENDED_MESSAGE = (
         f"{STANDARD_MESSAGE}. "
         "Use --cluster-id / --cluster-name / --sqlalchemy-url / --http-url CLI options "
-        "or CRATEDB_CLOUD_CLUSTER_ID / CRATEDB_CLOUD_CLUSTER_NAME / CRATEDB_SQLALCHEMY_URL / CRATEDB_HTTP_URL "
+        "or CRATEDB_CLUSTER_ID / CRATEDB_CLUSTER_NAME / CRATEDB_SQLALCHEMY_URL / CRATEDB_HTTP_URL "
         "environment variables."
     )
 
diff --git a/cratedb_toolkit/job/cli.py b/cratedb_toolkit/job/cli.py
@@ -13,7 +13,7 @@
 
 @click.command(name="list-jobs")
 @click.option(
-    "--cluster-id", envvar="CRATEDB_CLOUD_CLUSTER_ID", type=str, required=True, help="CrateDB Cloud cluster identifier"
+    "--cluster-id", envvar="CRATEDB_CLUSTER_ID", type=str, required=True, help="CrateDB Cloud cluster identifier"
 )
 @click.option(
     "--format",
diff --git a/cratedb_toolkit/option.py b/cratedb_toolkit/option.py
@@ -1,10 +1,10 @@
 import click
 
 option_cluster_id = click.option(
-    "--cluster-id", envvar="CRATEDB_CLOUD_CLUSTER_ID", type=str, required=False, help="CrateDB Cloud cluster identifier"
+    "--cluster-id", envvar="CRATEDB_CLUSTER_ID", type=str, required=False, help="CrateDB Cloud cluster identifier"
 )
 option_cluster_name = click.option(
-    "--cluster-name", envvar="CRATEDB_CLOUD_CLUSTER_NAME", type=str, required=False, help="CrateDB Cloud cluster name"
+    "--cluster-name", envvar="CRATEDB_CLUSTER_NAME", type=str, required=False, help="CrateDB Cloud cluster name"
 )
 option_sqlalchemy_url = click.option(
     "--sqlalchemy-url", envvar="CRATEDB_SQLALCHEMY_URL", type=str, required=False, help="CrateDB SQLAlchemy URL"
diff --git a/cratedb_toolkit/util/croud.py b/cratedb_toolkit/util/croud.py
@@ -78,7 +78,7 @@ def invoke(self) -> t.Any:
             if "Resource not found" in message:
                 explanation = (
                     "Apparently, the addressed cluster resource was not found. "
-                    "Please validate the `--cluster-id` option, or the `CRATEDB_CLOUD_CLUSTER_ID` environment variable "
+                    "Please validate the `--cluster-id` option, or the `CRATEDB_CLUSTER_ID` environment variable "
                     "used by CrateDB Toolkit."
                 )
             if "Another cluster operation is currently in progress" in message:
diff --git a/doc/backlog/main.md b/doc/backlog/main.md
@@ -52,7 +52,7 @@
 - UX: Provide Bash/zsh completion
 - Beautify `list-jobs` output
 - `ctk list-clusters`
-- Store `CRATEDB_CLOUD_CLUSTER_ID` into `cratedb_toolkit.constants`
+- Store `CRATEDB_CLUSTER_ID` into `cratedb_toolkit.constants`
 - Cloud Tests: Verify file uploads
 - Docs: Add examples in more languages: Java, JavaScript, Lua, PHP
 - Docs:
diff --git a/doc/bugs.md b/doc/bugs.md
@@ -7,7 +7,7 @@ orphan: true
 ## 
 
 ```
-$ croud clusters import-jobs list --cluster-id=$CRATEDB_CLOUD_CLUSTER_ID --format=table
+$ croud clusters import-jobs list --cluster-id=$CRATEDB_CLUSTER_ID --format=table
 Traceback (most recent call last):
   File "/Users/amo/dev/crate/ecosystem/cratedb-retentions/.venv/bin/croud", line 8, in <module>
     sys.exit(main())
diff --git a/doc/cluster/_address.md b/doc/cluster/_address.md
@@ -6,7 +6,7 @@ in different situations, managed or not.
 :CLI options:
   `--cluster-id`, `--cluster-name`, `--sqlalchemy-url`, `--http-url`
 :Environment variables:
-  `CRATEDB_CLOUD_CLUSTER_ID`, `CRATEDB_CLOUD_CLUSTER_NAME`, `CRATEDB_SQLALCHEMY_URL`, `CRATEDB_HTTP_URL`
+  `CRATEDB_CLUSTER_ID`, `CRATEDB_CLUSTER_NAME`, `CRATEDB_SQLALCHEMY_URL`, `CRATEDB_HTTP_URL`
 
 :::{note}
 - All address options are mutually exclusive.
diff --git a/doc/cluster/backlog.md b/doc/cluster/backlog.md
@@ -12,8 +12,6 @@ a patch for some item, it will be very much welcome.
 [issues]: https://github.com/crate/cratedb-toolkit/issues
 
 ## Iteration +1
-- CLI: Naming things: Rename `--cluster-id` to `--id`, etc.
-- CLI: Naming things: Rename `CRATEDB_CLOUD_CLUSTER_NAME` to `CRATEDB_CLUSTER_NAME`, etc. 
 - CLI: Is it possible to just use `--url` instead of `--sqlalchemy-url` or `--http-url`?
 - CLI: Is it possible to just use `--cluster` to address a cluster, effectively shrinking
   all four addressing options into a single one? Maybe optionally?
@@ -77,3 +75,5 @@ a patch for some item, it will be very much welcome.
 - Documentation
 - Naming things: s/UniversalCluster/DatabaseCluster/`
 - CLI: Naming things: Rename `--cratedb-sqlalchemy-url` to `--sqlalchemy-url`, etc.
+- CLI: Naming things: Rename `--cluster-id` to `--id`, etc.
+- CLI: Naming things: Rename `CRATEDB_CLOUD_CLUSTER_NAME` to `CRATEDB_CLUSTER_NAME`, etc. 
diff --git a/doc/cluster/python.md b/doc/cluster/python.md
@@ -39,7 +39,7 @@ export CRATEDB_CLOUD_API_SECRET='<YOUR_API_SECRET_HERE>'
 environment variables.
 
 :Environment variables:
-  `CRATEDB_CLOUD_CLUSTER_ID`, `CRATEDB_CLOUD_CLUSTER_NAME`, `CRATEDB_SQLALCHEMY_URL`, `CRATEDB_HTTP_URL`
+  `CRATEDB_CLUSTER_ID`, `CRATEDB_CLUSTER_NAME`, `CRATEDB_SQLALCHEMY_URL`, `CRATEDB_HTTP_URL`
 
 :::{note}
 - All address options are mutually exclusive.
diff --git a/doc/cluster/tutorial.md b/doc/cluster/tutorial.md
@@ -19,8 +19,8 @@ CRATEDB_CLOUD_API_KEY='<YOUR_API_KEY_HERE>'
 CRATEDB_CLOUD_API_SECRET='<YOUR_API_SECRET_HERE>'
 
 # CrateDB Cloud cluster identifier (id or name).
-# CRATEDB_CLOUD_CLUSTER_ID='<YOUR_CLUSTER_ID_HERE>'
-CRATEDB_CLOUD_CLUSTER_NAME='<YOUR_CLUSTER_NAME_HERE>'
+# CRATEDB_CLUSTER_ID='<YOUR_CLUSTER_ID_HERE>'
+CRATEDB_CLUSTER_NAME='<YOUR_CLUSTER_NAME_HERE>'
 
 # Database credentials.
 CRATEDB_USERNAME='<YOUR_DATABASE_USERNAME_HERE>'
diff --git a/doc/io/index.md b/doc/io/index.md
@@ -54,7 +54,7 @@ croud clusters list
 Define the cluster id of your CrateDB Cloud Cluster you are aiming to connect
 to, and its connection credentials.
 ```shell
-export CRATEDB_CLOUD_CLUSTER_ID='e1e38d92-a650-48f1-8a70-8133f2d5c400'
+export CRATEDB_CLUSTER_ID='e1e38d92-a650-48f1-8a70-8133f2d5c400'
 ```
 
 Define authentication credentials, to satisfy the `ctk shell` command you will
diff --git a/examples/notebook/cloud_import.ipynb b/examples/notebook/cloud_import.ipynb
@@ -65,7 +65,7 @@
     "export CRATEDB_CLOUD_ORGANIZATION_ID='<YOUR_ORG_ID_HERE>'\n",
     "\n",
     "# Configure cluster name.\n",
-    "export CRATEDB_CLOUD_CLUSTER_NAME='<YOUR_CLUSTER_NAME_HERE>'\n",
+    "export CRATEDB_CLUSTER_NAME='<YOUR_CLUSTER_NAME_HERE>'\n",
     "```"
    ]
   },
diff --git a/examples/python/cloud_cluster.py b/examples/python/cloud_cluster.py
@@ -62,8 +62,8 @@
 
 Alternatively, you can use environment variables::
 
-    export CRATEDB_CLOUD_CLUSTER_ID='<YOUR_CLUSTER_ID_HERE>'
-    export CRATEDB_CLOUD_CLUSTER_NAME='<YOUR_CLUSTER_NAME_HERE>'
+    export CRATEDB_CLUSTER_ID='<YOUR_CLUSTER_ID_HERE>'
+    export CRATEDB_CLUSTER_NAME='<YOUR_CLUSTER_NAME_HERE>'
 
 Command line arguments take precedence. When omitted, the program will
 fall back to probe the environment variables.
diff --git a/examples/python/cloud_import.py b/examples/python/cloud_import.py
@@ -48,8 +48,8 @@
 
 Alternatively, you can use environment variables::
 
-    export CRATEDB_CLOUD_CLUSTER_ID='<YOUR_CLUSTER_ID_HERE>'
-    export CRATEDB_CLOUD_CLUSTER_NAME='<YOUR_CLUSTER_NAME_HERE>'
+    export CRATEDB_CLUSTER_ID='<YOUR_CLUSTER_ID_HERE>'
+    export CRATEDB_CLUSTER_NAME='<YOUR_CLUSTER_NAME_HERE>'
 
 Command line arguments take precedence. When omitted, the program will
 fall back to probe the environment variables.
diff --git a/examples/shell/cloud_cluster.sh b/examples/shell/cloud_cluster.sh
@@ -44,8 +44,8 @@
 #
 # Other than authentication information, you need to provide information about
 # identifying the database cluster, for example using the `--cluster-id` or
-# `--cluster-name` CLI options, or the `CRATEDB_CLOUD_CLUSTER_ID` or
-# `CRATEDB_CLOUD_CLUSTER_NAME` environment variables.
+# `--cluster-name` CLI options, or the `CRATEDB_CLUSTER_ID` or
+# `CRATEDB_CLUSTER_NAME` environment variables.
 #
 # Cluster deployment
 # ------------------
@@ -72,7 +72,7 @@
 #
 # Initialize a cluster instance, and run basic query::
 #
-#   export CRATEDB_CLOUD_CLUSTER_NAME='<YOUR_CLUSTER_NAME_HERE>'
+#   export CRATEDB_CLUSTER_NAME='<YOUR_CLUSTER_NAME_HERE>'
 #   sh examples/shell/cloud_cluster.sh
 #
 
diff --git a/examples/shell/cloud_import.sh b/examples/shell/cloud_import.sh
@@ -46,8 +46,8 @@
 #
 # Other than authentication information, you need to provide information about
 # identifying the database cluster, for example using the `--cluster-id` or
-# `--cluster-name` CLI options, or the `CRATEDB_CLOUD_CLUSTER_ID` or
-# `CRATEDB_CLOUD_CLUSTER_NAME` environment variables.
+# `--cluster-name` CLI options, or the `CRATEDB_CLUSTER_ID` or
+# `CRATEDB_CLUSTER_NAME` environment variables.
 #
 # Cluster deployment
 # ------------------
@@ -74,7 +74,7 @@
 #
 # Initialize a cluster instance, and run a data import::
 #
-#   export CRATEDB_CLOUD_CLUSTER_NAME='<YOUR_CLUSTER_NAME_HERE>'
+#   export CRATEDB_CLUSTER_NAME='<YOUR_CLUSTER_NAME_HERE>'
 #   sh examples/shell/cloud_import.sh
 #
 # Query imported data::
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -139,15 +139,15 @@ def cloud_cluster_id() -> str:
     """
     Provide the ID of a CrateDB Cloud cluster to be used for integration tests.
     """
-    return os.environ.get("TEST_CRATEDB_CLOUD_CLUSTER_ID", "7475893f-9672-469a-9943-5e413c598589")
+    return os.environ.get("TEST_CRATEDB_CLUSTER_ID", "7475893f-9672-469a-9943-5e413c598589")
 
 
 @pytest.fixture()
 def cloud_cluster_name() -> str:
     """
     Provide the name of a CrateDB Cloud cluster to be used for integration tests.
     """
-    return os.environ.get("TEST_CRATEDB_CLOUD_CLUSTER_NAME", "testcluster")
+    return os.environ.get("TEST_CRATEDB_CLUSTER_NAME", "testcluster")
 
 
 @pytest.fixture()
@@ -159,7 +159,7 @@ def cloud_environment(mocker, cloud_cluster_name) -> t.Generator[t.Dict[str, str
         "CRATEDB_CLOUD_API_KEY": os.environ.get("TEST_CRATEDB_CLOUD_API_KEY"),
         "CRATEDB_CLOUD_API_SECRET": os.environ.get("TEST_CRATEDB_CLOUD_API_SECRET"),
         "CRATEDB_CLOUD_ORGANIZATION_ID": os.environ.get("TEST_CRATEDB_CLOUD_ORGANIZATION_ID"),
-        "CRATEDB_CLOUD_CLUSTER_NAME": cloud_cluster_name,
+        "CRATEDB_CLUSTER_NAME": cloud_cluster_name,
         "CRATEDB_USERNAME": os.environ.get("TEST_CRATEDB_USERNAME"),
         "CRATEDB_PASSWORD": os.environ.get("TEST_CRATEDB_PASSWORD"),
     }

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ class DatabaseAddressMissingError(ClickException):`
`22`	`22`	`EXTENDED_MESSAGE = (`
`23`	`23`	`f"{STANDARD_MESSAGE}. "`
`24`	`24`	`"Use --cluster-id / --cluster-name / --sqlalchemy-url / --http-url CLI options "`
`25`		`- "or CRATEDB_CLOUD_CLUSTER_ID / CRATEDB_CLOUD_CLUSTER_NAME / CRATEDB_SQLALCHEMY_URL / CRATEDB_HTTP_URL "`
	`25`	`+ "or CRATEDB_CLUSTER_ID / CRATEDB_CLUSTER_NAME / CRATEDB_SQLALCHEMY_URL / CRATEDB_HTTP_URL "`
`26`	`26`	`"environment variables."`
`27`	`27`	`)`
`28`	`28`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`
`14`	`14`	`@click.command(name="list-jobs")`
`15`	`15`	`@click.option(`
`16`		`- "--cluster-id", envvar="CRATEDB_CLOUD_CLUSTER_ID", type=str, required=True, help="CrateDB Cloud cluster identifier"`
	`16`	`+ "--cluster-id", envvar="CRATEDB_CLUSTER_ID", type=str, required=True, help="CrateDB Cloud cluster identifier"`
`17`	`17`	`)`
`18`	`18`	`@click.option(`
`19`	`19`	`"--format",`
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,10 @@`
`1`	`1`	`import click`
`2`	`2`
`3`	`3`	`option_cluster_id = click.option(`
`4`		`- "--cluster-id", envvar="CRATEDB_CLOUD_CLUSTER_ID", type=str, required=False, help="CrateDB Cloud cluster identifier"`
	`4`	`+ "--cluster-id", envvar="CRATEDB_CLUSTER_ID", type=str, required=False, help="CrateDB Cloud cluster identifier"`
`5`	`5`	`)`
`6`	`6`	`option_cluster_name = click.option(`
`7`		`- "--cluster-name", envvar="CRATEDB_CLOUD_CLUSTER_NAME", type=str, required=False, help="CrateDB Cloud cluster name"`
	`7`	`+ "--cluster-name", envvar="CRATEDB_CLUSTER_NAME", type=str, required=False, help="CrateDB Cloud cluster name"`
`8`	`8`	`)`
`9`	`9`	`option_sqlalchemy_url = click.option(`
`10`	`10`	`"--sqlalchemy-url", envvar="CRATEDB_SQLALCHEMY_URL", type=str, required=False, help="CrateDB SQLAlchemy URL"`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ def invoke(self) -> t.Any:`
`78`	`78`	`if "Resource not found" in message:`
`79`	`79`	`explanation = (`
`80`	`80`	`"Apparently, the addressed cluster resource was not found. "`
`81`		- "Please validate the `--cluster-id` option, or the `CRATEDB_CLOUD_CLUSTER_ID` environment variable "
	`81`	+ "Please validate the `--cluster-id` option, or the `CRATEDB_CLUSTER_ID` environment variable "
`82`	`82`	`"used by CrateDB Toolkit."`
`83`	`83`	`)`
`84`	`84`	`if "Another cluster operation is currently in progress" in message:`