feat: Container Registry #194

monoxgas · 2025-10-02T07:46:11Z

Key Changes:

CLI refactors to consolidate Docker operations - lots of cleanup in the platform CLI
Added container registry pull command with api_key auth to the server-side registries
Cleaned up various logging mechanics throughout the CLI
Pulled forward some changes from AIRT around rich console consolidation

Generated Summary:

Updated API documentation to rename get_container_registry_credentials to get_platform_registry_credentials for clarity.
Introduced a consistent method signature for get_platform_releases by removing the cli_version parameter, now defaulting to the imported VERSION.
Implemented a new Docker CLI module that includes functionality for managing Docker operations, including pulling images, tagging, and retrieving container details.
Enhanced output messages in various commands to utilize a consistent logging and display method.
Replaced rich library outputs with custom logging functions for better control over console output.
Integrated error handling for potential Docker command failures, allowing for more informative feedback when running Docker commands.
Reduced unnecessary try-except statements in the get_platform_releases method, streamlining error handling and logic flow.
Improved user prompts and confirmation mechanisms for actions requiring user input within the CLI.

This summary was generated with ❤️ by rigging

Copilot

Pull Request Overview

This PR consolidates Docker operations in the CLI and adds container registry functionality, with significant refactoring of the platform management system. The changes include cleanup of logging mechanisms and consolidation of rich console usage throughout the CLI.

Refactored Docker operations to use a consolidated DockerImage class and centralized docker command execution
Added container registry pull command with API key authentication
Replaced scattered rich console usage with centralized logging functions
Restructured platform CLI by removing several utility modules and consolidating functionality

Reviewed Changes

Copilot reviewed 32 out of 34 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
tests/cli/test_github.py	New comprehensive test suite for GitHub repository parsing functionality
tests/cli/test_docker.py	New test suite for Docker image parsing and normalization
tests/cli/test_config.py	New tests for user configuration management
pyproject.toml	Updated test linting rules to allow security issues in tests
dreadnode/user_config.py	Replaced rich.print with centralized print_info function
dreadnode/main.py	Replaced rich console calls with centralized logging functions
dreadnode/logging_.py	Consolidated rich console usage and added utility print functions
dreadnode/cli/shared.py	Updated type alias from LogLevelLiteral to LogLevel
dreadnode/cli/profile/cli.py	Replaced rich console calls with centralized logging functions
dreadnode/cli/platform/version.py	New version management module replacing old schemas
dreadnode/cli/platform/utils/versions.py	Removed utility module, functionality moved elsewhere
dreadnode/cli/platform/utils/printing.py	Removed utility module, functionality consolidated in logging_
dreadnode/cli/platform/upgrade.py	Removed upgrade module, functionality moved to cli.py
dreadnode/cli/platform/tag.py	New tag management utilities
dreadnode/cli/platform/stop.py	Removed stop module, functionality moved to cli.py
dreadnode/cli/platform/status.py	Removed status module, functionality moved to cli.py
dreadnode/cli/platform/start.py	Removed start module, functionality moved to cli.py
dreadnode/cli/platform/schemas.py	Removed schemas module, replaced by version.py
dreadnode/cli/platform/login.py	Removed login module, functionality moved to compose.py
dreadnode/cli/platform/env_mgmt.py	Updated imports and type references
dreadnode/cli/platform/download.py	Significant refactoring to use new version management system
dreadnode/cli/platform/docker_.py	Removed Docker utilities module, functionality moved to main docker.py
dreadnode/cli/platform/constants.py	Updated constants to use new type casting approach
dreadnode/cli/platform/configure.py	Removed configure module, functionality moved to cli.py
dreadnode/cli/platform/compose.py	New compose management module with Docker utilities
dreadnode/cli/platform/cli.py	Consolidated platform commands with inlined functionality
dreadnode/cli/main.py	Added new pull command and updated console usage
dreadnode/cli/github.py	Replaced rich console calls with centralized logging functions
dreadnode/cli/docker.py	New centralized Docker operations module
dreadnode/api/client.py	Renamed registry credentials method and simplified platform releases
docs/sdk/main.mdx	Updated documentation to reflect console usage changes
docs/sdk/api.mdx	Updated API documentation for renamed registry method

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

tests/cli/test_github.py

pyproject.toml

dreadnode/cli/platform/tag.py

dreadnode/cli/platform/compose.py

dreadnode/cli/docker.py

monoxgas · 2025-10-02T07:49:55Z

dreadnode/api/client.py

-        payload = {
-            "tag": tag,
-            "services": services,
-            "cli_version": cli_version,
-        }
-        try:
-            response = self.request("POST", "/platform/get-releases", json_data=payload)
-
-        except RuntimeError as e:
-            if "403" in str(e):
-                raise RuntimeError("You do not have access to platform releases.") from e
-
-            if "404" in str(e):
-                if "Image not found" in str(e):
-                    raise RuntimeError("Image not found") from e
+        from dreadnode.version import VERSION

-                raise RuntimeError(
-                    f"Failed to get platform releases: {e}. The feature is likely disabled on this server"
-                ) from e
-            raise


I only removed this as I think it's a poor pattern to reflect in the API client code. Might be aggressive to remove clarity from the errors for users - open to moving this somewhere else in the CLI

Yeah, I was considering how best to provide thoughtful errors in a "public" SDk that attempts to access "private" features?

monoxgas · 2025-10-02T07:52:05Z

dreadnode/cli/platform/cli.py

+    if not env_overrides:
+        print_warning("No configuration changes specified.")
+        return
+
+    print_info("Setting environment overrides ...")
+    build_compose_override_file(PLATFORM_SERVICES, current_version)
+    build_env_file(current_version.configure_overrides_env_file, **env_overrides)
+    print_info(
+        f"Configuration written to {current_version.local_path}.\n\n"
+        "These will take effect the next time the platform is started. "
+        "You can modify or remove them at any time."
+    )


Generally did a lot of inlining of helper functions that were only used in a single place. I don't think we should be fighting to keep code "small" in arbitrary places at the trade-off having to jump around to understand functionality + more arg typing + more docstrings.

monoxgas · 2025-10-02T07:53:20Z

dreadnode/cli/platform/compose.py

@@ -0,0 +1,212 @@
+import typing as t


Essentially using this file for the bonding layer between our LocalVersion object and the general docker helpers.

monoxgas · 2025-10-02T07:53:52Z

dreadnode/cli/platform/constants.py


 SupportedArchitecture = t.Literal["amd64", "arm64"]
-SUPPORTED_ARCHITECTURES: list[SupportedArchitecture] = ["amd64", "arm64"]
+SUPPORTED_ARCHITECTURES = t.cast("list[SupportedArchitecture]", t.get_args(SupportedArchitecture))


Little more verbose, but helps prevent deltas in the code as changes to the literal reflect in the list

monoxgas · 2025-10-02T07:54:28Z

dreadnode/cli/platform/download.py

+    tag = tag or "latest"
+    tag = add_tag_arch_suffix(tag)


Tried to make tag selection a little more flexible. Users can pass a version with/without an arch.

monoxgas · 2025-10-02T07:55:36Z

dreadnode/cli/platform/tag.py

@@ -0,0 +1,40 @@
+import platform


These functions could be in compose or version, but the cyclic issues pushed me to segment it.

I do wonder longterm about making Tag a structured object with some parsing and helpers so we aren't always doing translations.

monoxgas · 2025-10-02T07:56:15Z

dreadnode/cli/platform/version.py

+        raise ValueError(f"Unknown service: {service}")
+
+
+class VersionConfig(BaseModel):


Re-used our patterns from UserConfig here as versions.json is a file saved on disk. Object is charged with serializing itself back/forth from disk.

dreadnode/cli/docker.py

monoxgas · 2025-10-02T07:58:48Z

dreadnode/cli/docker.py

+    return DEFAULT_DOCKER_REGISTRY_LOCAL_PORT
+
+
+def get_registry(config: ServerConfig) -> str:


Helper code from the original CLI, I'm trusting it generally, but it's probably fragile and needs some more consideration later for on-prem instances when we get there.

briangreunke · 2025-10-03T13:30:25Z

dreadnode/api/client.py

-        payload = {
-            "tag": tag,
-            "services": services,
-            "cli_version": cli_version,
-        }
-        try:
-            response = self.request("POST", "/platform/get-releases", json_data=payload)
-
-        except RuntimeError as e:
-            if "403" in str(e):
-                raise RuntimeError("You do not have access to platform releases.") from e
-
-            if "404" in str(e):
-                if "Image not found" in str(e):
-                    raise RuntimeError("Image not found") from e
+        from dreadnode.version import VERSION

-                raise RuntimeError(
-                    f"Failed to get platform releases: {e}. The feature is likely disabled on this server"
-                ) from e
-            raise


Yeah, I was considering how best to provide thoughtful errors in a "public" SDk that attempts to access "private" features?

Add pull command. Refactor docker cli mechs.

c4ee4a3

monoxgas requested a review from Copilot October 2, 2025 07:46

dreadnode-renovate-bot bot added area/docs Changes to documentation and guides area/python Changes to Python package configuration and dependencies area/tests Changes to test files and testing infrastructure type/docs Documentation updates and improvements labels Oct 2, 2025

Copilot AI reviewed Oct 2, 2025

View reviewed changes

tests/cli/test_github.py Outdated Show resolved Hide resolved

pyproject.toml Show resolved Hide resolved

dreadnode/cli/platform/tag.py Outdated Show resolved Hide resolved

dreadnode/cli/platform/compose.py Outdated Show resolved Hide resolved

dreadnode/cli/docker.py Show resolved Hide resolved

monoxgas commented Oct 2, 2025

View reviewed changes

co-pilot suggestions

ebb6ba5

monoxgas requested a review from briangreunke October 2, 2025 08:02

briangreunke approved these changes Oct 3, 2025

View reviewed changes

fix: fixed platform status checker

ae070db

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: Container Registry #194

feat: Container Registry #194

Uh oh!

monoxgas commented Oct 2, 2025 •

edited by github-actions bot

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

monoxgas Oct 2, 2025

Uh oh!

briangreunke Oct 3, 2025

Uh oh!

monoxgas Oct 2, 2025

Uh oh!

monoxgas Oct 2, 2025

Uh oh!

monoxgas Oct 2, 2025

Uh oh!

monoxgas Oct 2, 2025

Uh oh!

monoxgas Oct 2, 2025

Uh oh!

monoxgas Oct 2, 2025

Uh oh!

Uh oh!

Uh oh!

monoxgas Oct 2, 2025

Uh oh!

briangreunke Oct 3, 2025

Uh oh!

Uh oh!

		raise ValueError(f"Unknown service: {service}")


		class VersionConfig(BaseModel):

		return DEFAULT_DOCKER_REGISTRY_LOCAL_PORT


		def get_registry(config: ServerConfig) -> str:

feat: Container Registry #194

Are you sure you want to change the base?

feat: Container Registry #194

Uh oh!

Conversation

monoxgas commented Oct 2, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Generated Summary:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

monoxgas commented Oct 2, 2025 •

edited by github-actions bot

Loading