Skip to content

fix: create correct Docker Registry V2 directory structure #184

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

LiYomi
Copy link

@LiYomi LiYomi commented May 19, 2025

Fix directory structure issue when running modctl ls for the first time.

Problem Description:

  • The modctl ls command fails immediately after installing modctl due to missing Docker Registry V2 directory structure
  • Error message indicates that /docker/registry/v2/repositories directory cannot be found
  • This issue only occurs on fresh installations, as pulling from registry would automatically create the required directory structure

Solution:

  • Create the correct Docker Registry V2 directory structure in the NewStorage function
  • Ensure the directory structure complies with Docker Registry V2 specifications
  • Initialize the directory structure during first run to prevent the error

Testing:

  • Verified that modctl ls command works correctly on first run after installation
  • Directory structure is properly created at ~/.modctl/content.v1/docker/registry/v2/repositories
  • Confirmed that subsequent operations (like pull) work as expected

Summary by CodeRabbit

  • Bug Fixes
    • Improved reliability by ensuring required Docker Registry V2 directories are created automatically if missing, preventing initialization errors related to missing folders.

Copy link

coderabbitai bot commented May 19, 2025

Walkthrough

The NewStorage function in the storage distribution package was updated to explicitly create the necessary Docker Registry V2 directory structure under the specified root directory before initializing the filesystem driver. Error handling was added for each directory creation step, ensuring proper setup and reporting failures.

Changes

File(s) Change Summary
pkg/storage/distribution/distribution.go Modified NewStorage to create required Docker Registry V2 directories before driver initialization, with error checks.

Poem

In the warren of code, new tunnels appear,
Directories made with intentions clear.
If a burrow collapses, we’re quick to know—
Errors are caught before data can flow.
Registry roots now stand up tall,
Ready for Docker, safe for all! 🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 golangci-lint (1.64.8)

Error: you are using a configuration file for golangci-lint v2 with golangci-lint v1: please use golangci-lint v2
Failed executing command with error: you are using a configuration file for golangci-lint v2 with golangci-lint v1: please use golangci-lint v2

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 7ca2577 and 16c4fbc.

📒 Files selected for processing (1)
  • pkg/storage/distribution/distribution.go (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • pkg/storage/distribution/distribution.go
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Test
  • GitHub Check: Analyze (go)
  • GitHub Check: Lint
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
pkg/storage/distribution/distribution.go (1)

66-82: Well-implemented directory structure creation

The implementation correctly creates the Docker Registry V2 directory structure before initializing the filesystem driver, which addresses the issue of modctl ls failing on fresh installations. Good job with:

  1. Creating all required directories in the proper order
  2. Using proper error handling with descriptive messages for each step
  3. Using filepath.Join for cross-platform path handling
  4. Adding clear comments for each directory creation step

For improved maintainability, consider refactoring the repeated directory creation pattern using a loop:

-	// Create Docker Registry V2 directory structure
-	dockerRegistryDir := filepath.Join(rootDir, "docker", "registry")
-	if err := os.MkdirAll(dockerRegistryDir, 0755); err != nil {
-		return nil, fmt.Errorf("failed to create docker registry directory: %w", err)
-	}
-
-	// Create v2 directory
-	v2Dir := filepath.Join(dockerRegistryDir, "v2")
-	if err := os.MkdirAll(v2Dir, 0755); err != nil {
-		return nil, fmt.Errorf("failed to create v2 directory: %w", err)
-	}
-
-	// Create repositories directory under v2
-	repositoriesDir := filepath.Join(v2Dir, "repositories")
-	if err := os.MkdirAll(repositoriesDir, 0755); err != nil {
-		return nil, fmt.Errorf("failed to create repositories directory: %w", err)
-	}
+	// Create Docker Registry V2 directory structure
+	dirPaths := []string{
+		filepath.Join(rootDir, "docker", "registry"),
+		filepath.Join(rootDir, "docker", "registry", "v2"),
+		filepath.Join(rootDir, "docker", "registry", "v2", "repositories"),
+	}
+	
+	dirNames := []string{"docker registry", "v2", "repositories"}
+	for i, path := range dirPaths {
+		if err := os.MkdirAll(path, 0755); err != nil {
+			return nil, fmt.Errorf("failed to create %s directory: %w", dirNames[i], err)
+		}
+	}

This maintains the same functionality while reducing code duplication.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between ffd7149 and 7ca2577.

📒 Files selected for processing (1)
  • pkg/storage/distribution/distribution.go (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Test
  • GitHub Check: Lint
  • GitHub Check: Analyze (go)
🔇 Additional comments (1)
pkg/storage/distribution/distribution.go (1)

24-25: Appropriate import additions

The imports for "os" and "path/filepath" are correctly added to support directory creation operations.

@LiYomi LiYomi force-pushed the fix_first_times_modctl_ls branch from 7ca2577 to 16c4fbc Compare May 19, 2025 15:19
@chlins
Copy link
Contributor

chlins commented May 27, 2025

Is the permission(0755 in code) same as if the directory generated by distribution automatically when build the first model artifact?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants