Skip to content

Configured ssh agent forwarding for docker compose#22232

Merged
cmraible merged 5 commits into
TryGhost:mainfrom
cmraible:ssh-agent-forwarding
Feb 19, 2025
Merged

Configured ssh agent forwarding for docker compose#22232
cmraible merged 5 commits into
TryGhost:mainfrom
cmraible:ssh-agent-forwarding

Conversation

@cmraible
Copy link
Copy Markdown
Collaborator

@cmraible cmraible commented Feb 19, 2025

no issue

  • Currently running any git commands in the docker container (i.e. updating submodules) that use ssh are failing because the container can't see your ssh keys. This commit adds a volume & environment variable to enable forwarding your local ssh agent into the container. As long as you've got an ssh agent running locally with your keys enabled, this will allow you to e.g. push to a remote over ssh from inside the container.
  • It also mounts your local .gitconfig file into the container, so your git configuration (i.e. name & email address) will also work inside the container
  • Finally, it adds githubs ssh keys to known_hosts in the development target of the Dockerfile to avoid the prompt, which only works in interactive environments and fails in any kind of script (like yarn main:submodules).

@cmraible cmraible marked this pull request as ready for review February 19, 2025 07:28
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Feb 19, 2025

Warning

Rate limit exceeded

@cmraible has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 2 minutes and 59 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 8d805c7101502519b4bfc7926e29a889d2af664d and 2c61123.

📒 Files selected for processing (2)
  • .docker/Dockerfile (1 hunks)
  • compose.yml (2 hunks)

Walkthrough

The pull request updates the compose.yml file for the ghost service by adding two new environment variables and an additional volume mapping. The environment variable SSH_AUTH_SOCK=/ssh-agent is introduced, and the volume mapping ${SSH_AUTH_SOCK}:/ssh-agent is added to enable access to the SSH agent socket within the container. Additionally, a new volume mapping ${HOME}/.gitconfig:/root/.gitconfig:ro allows the container to access the user's Git configuration file in a read-only manner. Furthermore, the .docker/Dockerfile is modified to include a command that adds GitHub to the known hosts, which is essential for Git submodule operations. Lastly, the .docker/development.entrypoint.sh script is updated to include a command that initializes and updates Git submodules before executing the main command.

Possibly related PRs


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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. (Beta)
  • @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
Copy Markdown
Contributor

@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)
.docker/development.entrypoint.sh (1)

3-4: Git Submodule Update Command Added
The command git submodule update --init --recursive is correctly added to ensure all submodules are initialized and updated before the main command executes. This enhancement is essential for operations that depend on submodules. You might consider adding error handling (e.g., checking the exit status) to catch and log failures during the update process.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ffd17364f0a5d8b572537eb205bf301ee1625ce9 and 8d805c7101502519b4bfc7926e29a889d2af664d.

📒 Files selected for processing (2)
  • .docker/Dockerfile (1 hunks)
  • .docker/development.entrypoint.sh (1 hunks)
🔇 Additional comments (1)
.docker/Dockerfile (1)

40-44: Addition of GitHub Known Hosts Configuration
The new commands correctly add GitHub's SSH key to the known hosts, ensuring that SSH connections (required for git submodule updates) do not prompt for verification and thus fail in a non-interactive container environment. This safeguard is critical for seamless git operations inside the container.

@cmraible cmraible force-pushed the ssh-agent-forwarding branch from 8d805c7 to 4796a40 Compare February 19, 2025 08:19
@cmraible cmraible merged commit fa377b5 into TryGhost:main Feb 19, 2025
@cmraible cmraible deleted the ssh-agent-forwarding branch February 19, 2025 17:38
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.

1 participant