acryl-datahub 1.1.1rc3__py3-none-any.whl → 1.2.0__py3-none-any.whl

datahub/cli/docker_cli.py

@@ -20,6 +20,7 @@ import requests
 from expandvars import expandvars
 from requests_file import FileAdapter
 
+from datahub._version import __version__, is_dev_mode, nice_version_name
 from datahub.cli.config_utils import DATAHUB_ROOT_FOLDER
 from datahub.cli.docker_check import (
     DATAHUB_COMPOSE_LEGACY_VOLUME_FILTERS,
@@ -28,45 +29,86 @@ from datahub.cli.docker_check import (
     DockerComposeVersionError,
     QuickstartStatus,
     check_docker_quickstart,
+    check_upgrade_supported,
     get_docker_client,
     run_quickstart_preflight_checks,
 )
-from datahub.cli.quickstart_versioning import QuickstartVersionMappingConfig
+from datahub.cli.quickstart_versioning import (
+    QuickstartVersionMappingConfig,
+)
 from datahub.ingestion.run.pipeline import Pipeline
 from datahub.telemetry import telemetry
 from datahub.upgrade import upgrade
 from datahub.utilities.perf_timer import PerfTimer
 
 logger = logging.getLogger(__name__)
-_ClickPositiveInt = click.IntRange(min=1)
 
-NEO4J_AND_ELASTIC_QUICKSTART_COMPOSE_FILE = (
-    "docker/quickstart/docker-compose.quickstart.yml"
-)
-ELASTIC_QUICKSTART_COMPOSE_FILE = (
-    "docker/quickstart/docker-compose-without-neo4j.quickstart.yml"
-)
-NEO4J_AND_ELASTIC_M1_QUICKSTART_COMPOSE_FILE = (
-    "docker/quickstart/docker-compose-m1.quickstart.yml"
-)
-ELASTIC_M1_QUICKSTART_COMPOSE_FILE = (
-    "docker/quickstart/docker-compose-without-neo4j-m1.quickstart.yml"
-)
-CONSUMERS_QUICKSTART_COMPOSE_FILE = (
-    "docker/quickstart/docker-compose.consumers.quickstart.yml"
-)
-ELASTIC_CONSUMERS_QUICKSTART_COMPOSE_FILE = (
-    "docker/quickstart/docker-compose.consumers-without-neo4j.quickstart.yml"
-)
-KAFKA_SETUP_QUICKSTART_COMPOSE_FILE = (
-    "docker/quickstart/docker-compose.kafka-setup.quickstart.yml"
-)
+_ClickPositiveInt = click.IntRange(min=1)
 
+QUICKSTART_COMPOSE_FILE = "docker/quickstart/docker-compose.quickstart-profile.yml"
 
 _QUICKSTART_MAX_WAIT_TIME = datetime.timedelta(minutes=10)
 _QUICKSTART_UP_TIMEOUT = datetime.timedelta(seconds=100)
 _QUICKSTART_STATUS_CHECK_INTERVAL = datetime.timedelta(seconds=2)
 
+MIGRATION_REQUIRED_INSTRUCTIONS = f"""
+Your existing DataHub server was installed with an \
+older CLI and is incompatible with the current CLI (version {nice_version_name}).
+
+Required steps to upgrade:
+1. Backup your data (recommended): datahub docker quickstart --backup
+   Guide: https://docs.datahub.com/docs/quickstart#back-up-datahub
+
+2. Remove old installation: datahub docker nuke
+
+3. Start fresh installation: datahub docker quickstart
+
+4. Restore data:
+    datahub docker quickstart --restore
+
+⚠️  Without backup, all existing data will be lost.
+
+For fresh start (if data is not needed):
+1. Remove installation: 
+    datahub docker nuke
+
+2. Start fresh: 
+    datahub docker quickstart
+"""
+
+REPAIR_REQUIRED_INSTRUCTIONS = f"""
+Unhealthy DataHub Installation Detected
+
+Your DataHub installation has issues that cannot be fixed with the current CLI.
+
+Your options:
+
+OPTION 1 - Preserve data (if needed):
+1. Downgrade CLI to version 1.1: 
+    pip install acryl-datahub==1.1
+2. Fix the installation: 
+    datahub docker quickstart
+3. Create backup:
+    datahub docker quickstart --backup
+4. Upgrade CLI back:
+    pip install acryl-datahub=={nice_version_name()}
+5. Migrate: 
+    datahub docker nuke && datahub docker quickstart
+6. Restore data:
+    datahub docker quickstart --restore
+
+OPTION 2 - Fresh start (if data not needed):
+1. Remove installation: 
+    datahub docker nuke
+2. Start fresh: 
+    datahub docker quickstart
+
+⚠️  The current CLI cannot repair installations created by older versions.
+
+Additional information on backup and restore: https://docs.datahub.com/docs/quickstart#back-up-datahub
+Troubleshooting guide: https://docs.datahub.com/docs/troubleshooting/quickstart
+"""
+
 
 class Architectures(Enum):
     x86 = "x86"
@@ -89,6 +131,14 @@ def _docker_subprocess_env() -> Dict[str, str]:
     return env
 
 
+def show_migration_instructions():
+    click.secho(MIGRATION_REQUIRED_INSTRUCTIONS, fg="red")
+
+
+def show_repair_instructions():
+    click.secho(REPAIR_REQUIRED_INSTRUCTIONS, fg="red")
+
+
 @click.group()
 def docker() -> None:
     """Helper commands for setting up and interacting with a local
@@ -97,19 +147,22 @@ def docker() -> None:
 
 
 @docker.command()
-@upgrade.check_upgrade
-@telemetry.with_telemetry()
 def check() -> None:
     """Check that the Docker containers are healthy"""
     status = check_docker_quickstart()
+
     if status.is_ok():
         click.secho("✔ No issues detected", fg="green")
+        if status.running_unsupported_version:
+            show_migration_instructions()
     else:
+        if status.running_unsupported_version:
+            show_repair_instructions()
         raise status.to_exception("The following issues were detected:")
 
 
-def is_m1() -> bool:
-    """Check whether we are running on an M1 machine"""
+def is_apple_silicon() -> bool:
+    """Check whether we are running on an Apple Silicon machine"""
     try:
         return (
             platform.uname().machine == "arm64" and platform.uname().system == "Darwin"
@@ -119,52 +172,11 @@ def is_m1() -> bool:
         return False
 
 
-def is_arch_m1(arch: Architectures) -> bool:
-    return arch in [Architectures.arm64, Architectures.m1, Architectures.m2]
-
-
-def should_use_neo4j_for_graph_service(graph_service_override: Optional[str]) -> bool:
-    if graph_service_override is not None:
-        if graph_service_override == "elasticsearch":
-            click.echo("Starting with elasticsearch due to graph-service-impl param\n")
-            return False
-        if graph_service_override == "neo4j":
-            click.echo("Starting with neo4j due to graph-service-impl param\n")
-            return True
-        else:
-            click.secho(
-                graph_service_override
-                + " is not a valid graph service option. Choose either `neo4j` or "
-                "`elasticsearch`\n",
-                fg="red",
-            )
-            raise ValueError(f"invalid graph service option: {graph_service_override}")
-    with get_docker_client() as client:
-        if len(client.volumes.list(filters={"name": "datahub_neo4jdata"})) > 0:
-            click.echo(
-                "Datahub Neo4j volume found, starting with neo4j as graph service.\n"
-                "If you want to run using elastic, run `datahub docker nuke` and re-ingest your data.\n"
-            )
-            return True
-
-        logger.debug(
-            "No Datahub Neo4j volume found, starting with elasticsearch as graph service.\n"
-            "To use neo4j as a graph backend, run \n"
-            "`datahub docker quickstart --graph-service-impl neo4j`"
-            "\nfrom the root of the datahub repo\n"
-        )
-        return False
-
-
 def _set_environment_variables(
     version: Optional[str],
-    mysql_version: Optional[str],
     mysql_port: Optional[int],
-    zk_port: Optional[int],
     kafka_broker_port: Optional[int],
-    schema_registry_port: Optional[int],
     elastic_port: Optional[int],
-    kafka_setup: Optional[bool],
 ) -> None:
     if version is not None:
         if not version.startswith("v") and "." in version:
@@ -173,24 +185,25 @@ def _set_environment_variables(
             )
             version = f"v{version}"
         os.environ["DATAHUB_VERSION"] = version
-    if mysql_version is not None:
-        os.environ["DATAHUB_MYSQL_VERSION"] = mysql_version
     if mysql_port is not None:
         os.environ["DATAHUB_MAPPED_MYSQL_PORT"] = str(mysql_port)
 
-    if zk_port is not None:
-        os.environ["DATAHUB_MAPPED_ZK_PORT"] = str(zk_port)
-
     if kafka_broker_port is not None:
         os.environ["DATAHUB_MAPPED_KAFKA_BROKER_PORT"] = str(kafka_broker_port)
 
-    if schema_registry_port is not None:
-        os.environ["DATAHUB_MAPPED_SCHEMA_REGISTRY_PORT"] = str(schema_registry_port)
-
     if elastic_port is not None:
         os.environ["DATAHUB_MAPPED_ELASTIC_PORT"] = str(elastic_port)
-    if kafka_setup:
-        os.environ["DATAHUB_PRECREATE_TOPICS"] = "true"
+
+    os.environ["METADATA_SERVICE_AUTH_ENABLED"] = "false"
+
+    cliVersion = nice_version_name()
+    if is_dev_mode():  # This should only happen during development/CI.
+        cliVersion = __version__.replace(".dev0", "")
+        logger.info(
+            f"Development build: Using {cliVersion} instead of '{__version__}' version of CLI for UI ingestion"
+        )
+
+    os.environ["UI_INGESTION_DEFAULT_CLI_VERSION"] = cliVersion
 
 
 def _get_default_quickstart_compose_file() -> Optional[str]:
@@ -250,6 +263,8 @@ def _attempt_stop(quickstart_compose_file: List[pathlib.Path]) -> None:
         compose = _docker_compose_v2()
         base_command: List[str] = [
             *compose,
+            "--profile",
+            "quickstart",
             *itertools.chain.from_iterable(
                 ("-f", f"{path}") for path in compose_files_for_stopping
             ),
@@ -346,12 +361,15 @@ EBEAN_DATASOURCE_HOST=mysql:${DATAHUB_MAPPED_MYSQL_PORT:-3306}
 EBEAN_DATASOURCE_URL=jdbc:mysql://mysql:${DATAHUB_MAPPED_MYSQL_PORT:-3306}/datahub?verifyServerCertificate=false&useSSL=true&useUnicode=yes&characterEncoding=UTF-8
 EBEAN_DATASOURCE_DRIVER=com.mysql.jdbc.Driver
 ENTITY_REGISTRY_CONFIG_PATH=/datahub/datahub-gms/resources/entity-registry.yml
-
+GRAPH_SERVICE_IMPL=elasticsearch
 KAFKA_BOOTSTRAP_SERVER=broker:29092
-KAFKA_SCHEMAREGISTRY_URL=http://schema-registry:${DATAHUB_MAPPED_SCHEMA_REGISTRY_PORT:-8081}
+KAFKA_SCHEMAREGISTRY_URL=http://datahub-gms:8080/schema-registry/api/
+SCHEMA_REGISTRY_TYPE=INTERNAL
 
-ELASTICSEARCH_HOST=elasticsearch
+ELASTICSEARCH_HOST=search
 ELASTICSEARCH_PORT=${DATAHUB_MAPPED_ELASTIC_PORT:-9200}
+ELASTICSEARCH_INDEX_BUILDER_MAPPINGS_REINDEX=true
+ELASTICSEARCH_PROTOCOL=http
 
 #NEO4J_HOST=http://<your-neo-host>:7474
 #NEO4J_URI=bolt://<your-neo-host>
@@ -385,6 +403,7 @@ DATAHUB_MAE_CONSUMER_PORT=9091
                     logger.debug(f"Env file contents: {env_fp_reader.read()}")
 
             # continue to issue the restore indices command
+            # TODO Use --version if passed
             command = (
                 "docker pull acryldata/datahub-upgrade:${DATAHUB_VERSION:-head}"
                 + f" && docker run --network datahub_network --env-file {env_fp.name} "
@@ -412,12 +431,16 @@ DATAHUB_MAE_CONSUMER_PORT=9091
     return result.returncode
 
 
+# TODO: Do we really need this? If someone wants to use  a different arg, they can still pass the standard docker env var DOCKER_DEFAULT_PLATFORM
+# We dont really need to select a different image unlike earlier (mysql vs mariadb) since we do publish both archs for all images (or are available for external images).
 def detect_quickstart_arch(arch: Optional[str]) -> Architectures:
-    running_on_m1 = is_m1()
-    if running_on_m1:
-        click.secho("Detected M1 machine", fg="yellow")
+    running_on_apple_silicon = is_apple_silicon()
+    if running_on_apple_silicon:
+        click.secho("Detected Apple Silicon", fg="yellow")
 
-    quickstart_arch = Architectures.x86 if not running_on_m1 else Architectures.arm64
+    quickstart_arch = (
+        Architectures.x86 if not running_on_apple_silicon else Architectures.arm64
+    )
     if arch:
         matched_arch = [a for a in Architectures if arch.lower() == a.value]
         if not matched_arch:
@@ -437,13 +460,6 @@ def detect_quickstart_arch(arch: Optional[str]) -> Architectures:
     default="default",
     help="Datahub version to be deployed. If not set, deploy using the defaults from the quickstart compose. Use 'stable' to start the latest stable version.",
 )
-@click.option(
-    "--build-locally",
-    type=bool,
-    is_flag=True,
-    default=False,
-    help="Attempt to build the containers locally before starting",
-)
 @click.option(
     "--pull-images/--no-pull-images",
     type=bool,
@@ -466,13 +482,6 @@ def detect_quickstart_arch(arch: Optional[str]) -> Architectures:
     default=False,
     help="If true, the docker-compose logs will be printed to console if something fails",
 )
-@click.option(
-    "--graph-service-impl",
-    type=str,
-    is_flag=False,
-    default=None,
-    help="If set, forces docker-compose to use that graph service implementation",
-)
 @click.option(
     "--mysql-port",
     type=_ClickPositiveInt,
@@ -480,13 +489,6 @@ def detect_quickstart_arch(arch: Optional[str]) -> Architectures:
     default=None,
     help="If there is an existing mysql instance running on port 3306, set this to a free port to avoid port conflicts on startup",
 )
-@click.option(
-    "--zk-port",
-    type=_ClickPositiveInt,
-    is_flag=False,
-    default=None,
-    help="If there is an existing zookeeper instance running on port 2181, set this to a free port to avoid port conflicts on startup",
-)
 @click.option(
     "--kafka-broker-port",
     type=_ClickPositiveInt,
@@ -494,13 +496,6 @@ def detect_quickstart_arch(arch: Optional[str]) -> Architectures:
     default=None,
     help="If there is an existing Kafka broker running on port 9092, set this to a free port to avoid port conflicts on startup",
 )
-@click.option(
-    "--schema-registry-port",
-    type=_ClickPositiveInt,
-    is_flag=False,
-    default=None,
-    help="If there is an existing process running on port 8081, set this to a free port to avoid port conflicts with Kafka schema registry on startup",
-)
 @click.option(
     "--elastic-port",
     type=_ClickPositiveInt,
@@ -558,51 +553,29 @@ def detect_quickstart_arch(arch: Optional[str]) -> Architectures:
     default=False,
     help="Disables the restoration of indices of a running quickstart instance when used in conjunction with --restore.",
 )
-@click.option(
-    "--standalone_consumers",
-    required=False,
-    is_flag=True,
-    default=False,
-    help="Launches MAE & MCE consumers as stand alone docker containers",
-)
-@click.option(
-    "--kafka-setup",
-    required=False,
-    is_flag=True,
-    default=False,
-    help="Launches Kafka setup job as part of the compose deployment",
-)
 @click.option(
     "--arch",
     required=False,
     help="Specify the architecture for the quickstart images to use. Options are x86, arm64, m1 etc.",
 )
-@upgrade.check_upgrade
 @telemetry.with_telemetry(
     capture_kwargs=[
         "version",
-        "build_locally",
         "pull_images",
         "stop",
         "backup",
         "restore",
         "restore_indices",
-        "standalone_consumers",
-        "kafka_setup",
         "arch",
     ]
 )
 def quickstart(
     version: Optional[str],
-    build_locally: bool,
     pull_images: bool,
     quickstart_compose_file: List[pathlib.Path],
     dump_logs_on_failure: bool,
-    graph_service_impl: Optional[str],
     mysql_port: Optional[int],
-    zk_port: Optional[int],
     kafka_broker_port: Optional[int],
-    schema_registry_port: Optional[int],
     elastic_port: Optional[int],
     stop: bool,
     backup: bool,
@@ -611,8 +584,6 @@ def quickstart(
     restore_file: str,
     restore_indices: bool,
     no_restore_indices: bool,
-    standalone_consumers: bool,
-    kafka_setup: bool,
     arch: Optional[str],
 ) -> None:
     """Start an instance of DataHub locally using docker-compose.
@@ -641,8 +612,8 @@ def quickstart(
         )
         return
 
-    quickstart_arch = detect_quickstart_arch(arch)
     quickstart_versioning = QuickstartVersionMappingConfig.fetch_quickstart_config()
+
     quickstart_execution_plan = quickstart_versioning.get_quickstart_execution_plan(
         version
     )
@@ -668,28 +639,26 @@ def quickstart(
         download_compose_files(
             quickstart_compose_file_name,
             quickstart_compose_file,
-            graph_service_impl,
-            kafka_setup,
-            quickstart_arch,
-            standalone_consumers,
             quickstart_execution_plan.composefile_git_ref,
         )
 
+    # check if running datahub can be upgraded to the latest version.
+    if not _check_upgrade_and_show_instructions(quickstart_compose_file):
+        sys.exit(1)
+
     # set version
     _set_environment_variables(
         version=quickstart_execution_plan.docker_tag,
-        mysql_version=quickstart_execution_plan.mysql_tag,
         mysql_port=mysql_port,
-        zk_port=zk_port,
         kafka_broker_port=kafka_broker_port,
-        schema_registry_port=schema_registry_port,
         elastic_port=elastic_port,
-        kafka_setup=kafka_setup,
     )
 
     compose = _docker_compose_v2()
     base_command: List[str] = [
         *compose,
+        "--profile",
+        "quickstart",
         *itertools.chain.from_iterable(
             ("-f", f"{path}") for path in quickstart_compose_file
         ),
@@ -697,6 +666,8 @@ def quickstart(
         DOCKER_COMPOSE_PROJECT_NAME,
     ]
 
+    click.echo(f"base_command: {base_command}")
+
     # Pull and possibly build the latest containers.
     try:
         if pull_images:
@@ -737,15 +708,6 @@ def quickstart(
             fg="red",
         )
 
-    if build_locally:
-        logger.info("Building docker images locally...")
-        subprocess.run(
-            base_command + ["build", "--pull", "-q"],
-            check=True,
-            env=_docker_subprocess_env(),
-        )
-        logger.info("Finished building docker images!")
-
     # Start it up! (with retries)
     click.echo("\nStarting up DataHub...")
     start_time = datetime.datetime.now()
@@ -836,36 +798,17 @@ def get_docker_compose_base_url(version_tag: str) -> str:
     return f"https://raw.githubusercontent.com/datahub-project/datahub/{version_tag}"
 
 
-def get_github_file_url(neo4j: bool, is_m1: bool, release_version_tag: str) -> str:
+def get_github_file_url(release_version_tag: str) -> str:
     base_url = get_docker_compose_base_url(release_version_tag)
-    if neo4j:
-        github_file = (
-            f"{base_url}/{NEO4J_AND_ELASTIC_QUICKSTART_COMPOSE_FILE}"
-            if not is_m1
-            else f"{base_url}/{NEO4J_AND_ELASTIC_M1_QUICKSTART_COMPOSE_FILE}"
-        )
-    else:
-        github_file = (
-            f"{base_url}/{ELASTIC_QUICKSTART_COMPOSE_FILE}"
-            if not is_m1
-            else f"{base_url}/{ELASTIC_M1_QUICKSTART_COMPOSE_FILE}"
-        )
+    github_file = f"{base_url}/{QUICKSTART_COMPOSE_FILE}"
     return github_file
 
 
 def download_compose_files(
-    quickstart_compose_file_name,
-    quickstart_compose_file_list,
-    graph_service_impl,
-    kafka_setup,
-    quickstart_arch,
-    standalone_consumers,
-    compose_git_ref,
+    quickstart_compose_file_name, quickstart_compose_file_list, compose_git_ref
 ):
     # download appropriate quickstart file
-    should_use_neo4j = should_use_neo4j_for_graph_service(graph_service_impl)
-    is_m1 = is_arch_m1(quickstart_arch)
-    github_file = get_github_file_url(should_use_neo4j, is_m1, compose_git_ref)
+    github_file = get_github_file_url(compose_git_ref)
     # also allow local files
     request_session = requests.Session()
     request_session.mount("file://", FileAdapter())
@@ -879,57 +822,14 @@ def download_compose_files(
         logger.info(f"Fetching docker-compose file {github_file} from GitHub")
         # Download the quickstart docker-compose file from GitHub.
         quickstart_download_response = request_session.get(github_file)
+        if quickstart_download_response.status_code == 404:
+            raise click.ClickException(
+                f"Could not find quickstart compose file for version {compose_git_ref}. "
+                "Please try a different version or check the version exists at https://github.com/datahub-project/datahub/releases"
+            )
         quickstart_download_response.raise_for_status()
         tmp_file.write(quickstart_download_response.content)
         logger.debug(f"Copied to {path}")
-    if standalone_consumers:
-        base_url = get_docker_compose_base_url(compose_git_ref)
-        consumer_github_file = (
-            f"{base_url}/{CONSUMERS_QUICKSTART_COMPOSE_FILE}"
-            if should_use_neo4j
-            else f"{base_url}/{ELASTIC_CONSUMERS_QUICKSTART_COMPOSE_FILE}"
-        )
-
-        default_consumer_compose_file = (
-            Path(DATAHUB_ROOT_FOLDER) / "quickstart/docker-compose.consumers.yml"
-        )
-        with (
-            open(default_consumer_compose_file, "wb")
-            if default_consumer_compose_file
-            else tempfile.NamedTemporaryFile(suffix=".yml", delete=False)
-        ) as tmp_file:
-            path = pathlib.Path(tmp_file.name)
-            quickstart_compose_file_list.append(path)
-            click.echo(
-                f"Fetching consumer docker-compose file {consumer_github_file} from GitHub"
-            )
-            # Download the quickstart docker-compose file from GitHub.
-            quickstart_download_response = request_session.get(consumer_github_file)
-            quickstart_download_response.raise_for_status()
-            tmp_file.write(quickstart_download_response.content)
-            logger.debug(f"Copied to {path}")
-    if kafka_setup:
-        base_url = get_docker_compose_base_url(compose_git_ref)
-        kafka_setup_github_file = f"{base_url}/{KAFKA_SETUP_QUICKSTART_COMPOSE_FILE}"
-
-        default_kafka_compose_file = (
-            Path(DATAHUB_ROOT_FOLDER) / "quickstart/docker-compose.kafka-setup.yml"
-        )
-        with (
-            open(default_kafka_compose_file, "wb")
-            if default_kafka_compose_file
-            else tempfile.NamedTemporaryFile(suffix=".yml", delete=False)
-        ) as tmp_file:
-            path = pathlib.Path(tmp_file.name)
-            quickstart_compose_file_list.append(path)
-            click.echo(
-                f"Fetching consumer docker-compose file {kafka_setup_github_file} from GitHub"
-            )
-            # Download the quickstart docker-compose file from GitHub.
-            quickstart_download_response = request_session.get(kafka_setup_github_file)
-            quickstart_download_response.raise_for_status()
-            tmp_file.write(quickstart_download_response.content)
-            logger.debug(f"Copied to {path}")
 
 
 def valid_restore_options(
@@ -963,7 +863,7 @@ def valid_restore_options(
     default=None,
     help="The token to be used when ingesting, used when datahub is deployed with METADATA_SERVICE_AUTH_ENABLED=true",
 )
-@telemetry.with_telemetry()
+@upgrade.check_upgrade
 def ingest_sample_data(token: Optional[str]) -> None:
     """Ingest sample data into a running DataHub instance."""
 
@@ -1031,3 +931,25 @@ def nuke(keep_data: bool) -> None:
         click.echo(f"Removing networks in the {DOCKER_COMPOSE_PROJECT_NAME} project")
         for network in client.networks.list(filters=DATAHUB_COMPOSE_PROJECT_FILTER):
             network.remove()
+
+
+def _check_upgrade_and_show_instructions(
+    quickstart_compose_file: List[pathlib.Path],
+) -> bool:
+    """Check if running datahub can be upgraded to the latest version and show appropriate instructions.
+
+    Args:
+        quickstart_compose_file: List of compose file paths
+
+    Returns:
+        bool: True if upgrade is supported, False otherwise
+    """
+    quickstart_status = check_docker_quickstart()
+
+    if not check_upgrade_supported(quickstart_compose_file, quickstart_status):
+        if quickstart_status.is_ok():
+            show_migration_instructions()
+        else:
+            show_repair_instructions()
+        return False
+    return True

datahub/cli/exists_cli.py

@@ -7,7 +7,6 @@ from click_default_group import DefaultGroup
 
 from datahub.ingestion.graph.client import get_default_graph
 from datahub.ingestion.graph.config import ClientMode
-from datahub.telemetry import telemetry
 from datahub.upgrade import upgrade
 
 logger = logging.getLogger(__name__)
@@ -23,7 +22,6 @@ def exists() -> None:
 @click.option("--urn", required=False, type=str)
 @click.pass_context
 @upgrade.check_upgrade
-@telemetry.with_telemetry()
 def urn(ctx: Any, urn: Optional[str]) -> None:
     """
     Get metadata for an entity with an optional list of aspects to project.

datahub/cli/get_cli.py

@@ -8,7 +8,6 @@ from click_default_group import DefaultGroup
 from datahub.cli.cli_utils import get_aspects_for_entity
 from datahub.ingestion.graph.client import get_default_graph
 from datahub.ingestion.graph.config import ClientMode
-from datahub.telemetry import telemetry
 from datahub.upgrade import upgrade
 
 logger = logging.getLogger(__name__)
@@ -32,7 +31,6 @@ def get() -> None:
 )
 @click.pass_context
 @upgrade.check_upgrade
-@telemetry.with_telemetry()
 def urn(ctx: Any, urn: Optional[str], aspect: List[str], details: bool) -> None:
     """
     Get metadata for an entity with an optional list of aspects to project.

datahub/cli/iceberg_cli.py

@@ -16,6 +16,7 @@ from datahub.ingestion.graph.client import DataHubGraph, get_default_graph
 from datahub.ingestion.graph.config import ClientMode
 from datahub.metadata.schema_classes import SystemMetadataClass
 from datahub.telemetry import telemetry
+from datahub.upgrade import upgrade
 
 logger = logging.getLogger(__name__)
 
@@ -164,6 +165,7 @@ def validate_warehouse(data_root: str) -> None:
     help=f"Expiration duration for temporary credentials used for role. Defaults to {DEFAULT_CREDS_EXPIRY_DURATION_SECONDS} seconds if unspecified",
 )
 @telemetry.with_telemetry(capture_kwargs=["duration_seconds"])
+@upgrade.check_upgrade
 def create(
     warehouse: str,
     description: Optional[str],
@@ -317,6 +319,7 @@ def create(
     help=f"Expiration duration for temporary credentials used for role. Defaults to {DEFAULT_CREDS_EXPIRY_DURATION_SECONDS} seconds if unspecified",
 )
 @telemetry.with_telemetry(capture_kwargs=["duration_seconds"])
+@upgrade.check_upgrade
 def update(
     warehouse: str,
     data_root: str,
@@ -403,6 +406,7 @@ def update(
 
 @iceberg.command()
 @telemetry.with_telemetry()
+@upgrade.check_upgrade
 def list() -> None:
     """
     List iceberg warehouses
@@ -419,6 +423,7 @@ def list() -> None:
     "-w", "--warehouse", required=True, type=str, help="The name of the warehouse"
 )
 @telemetry.with_telemetry()
+@upgrade.check_upgrade
 def get(warehouse: str) -> None:
     """Fetches the details of the specified iceberg warehouse"""
     client = get_default_graph(ClientMode.CLI)