8000 docs: add Podman machine reboot step to cert install by alilleybrinker · Pull Request #13498 · podman-desktop/podman-desktop · GitHub
[go: up one dir, main page]
Skip to content

docs: add Podman machine reboot step to cert install #13498

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 6 commits into from
Aug 12, 2025
Merged

docs: add Podman machine reboot step to cert install #13498

merged 6 commits into from
Aug 12, 2025

Conversation

alilleybrinker
Copy link
Contributor

What does this PR do?

This adds an optional step to the end of the instructions for installing additional root certificates to a Podman machine. On MacOS, with the podman machine default as my container host, "podman compose up" would continue to fail with self-signed certificate errors after following the instructions in this guide, until I fully rebooted the Podman machine.

What issues does this PR fix or reference?

I did not open an Issue prior to opening the PR.

@alilleybrinker alilleybrinker requested review from axel7083 and removed request for a team August 4, 2025 18:59
@alilleybrinker alilleybrinker changed the title Add Podman machine reboot step to cert install docs: add Podman machine reboot step to cert install Aug 4, 2025
sourcery-ai[bot]
sourcery-ai bot reviewed Aug 4, 2025
View reviewed changes
Copy link
Contributor
@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @alilleybrinker - I've reviewed your changes and they look great!

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@benoitf
Copy link
Collaborator
benoitf commented Aug 4, 2025

thanks @alilleybrinker for the contribution

@coderabbitai coderabbitai
Copy link
Contributor
coderabbitai bot commented Aug 4, 2025 •
edited
Loading
📝 Walkthrough

Walkthrough

The documentation for adding certificates to a Podman machine was updated to include an optional step. After exiting the Podman machine, users are now advised that they may optionally reboot the machine by stopping and starting it with the commands podman machine stop <machine_name> and podman machine start <machine_name>. No changes were made to code or public entities.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

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.

🔧 markdownlint-cli2 (0.17.2)
website/docs/podman/adding-certificates-to-a-podman-machine.md

markdownlint-cli2 v0.17.2 (markdownlint v0.37.4)
Finding: website/docs/podman/adding-certificates-to-a-podman-machine.md
Linting: 1 file(s)
Summary: 0 error(s)
AggregateError: Unable to import module 'markdownlint-cli2-formatter-summarize'.
at importModule (file:///usr/local/lib/node_modules/markdownlint-cli2/markdownlint-cli2.mjs:92:11)
at async Promise.all (index 0)
at async outputSummary (file:///usr/local/lib/node_modules/markdownlint-cli2/markdownlint-cli2.mjs:864:9)
at async main (file:///usr/local/lib/node_modules/markdownlint-cli2/markdownlint-cli2.mjs:1043:25)
at async file:///usr/local/lib/node_modules/markdownlint-cli2/markdownlint-cli2-bin.mjs:12:22 {
[errors]: [
Error: Cannot find module 'markdownlint-cli2-formatter-summarize'
Require stack:
- /usr/local/lib/node_modules/markdownlint-cli2/node_modules/markdownlint/lib/resolve-module.cjs
at Module._resolveFilename (node:internal/modules/cjs/loader:1369:15)
at resolve (node:i

... [truncated 1177 characters] ...

4:11)
at moduleResolve (node:internal/modules/esm/resolve:859:10)
at defaultResolve (node:internal/modules/esm/resolve:983:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:801:12)
at #cachedDefaultResolve (node:internal/modules/esm/loader:725:25)
at ModuleLoader.resolve (node:internal/modules/esm/loader:708:38)
at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:309:38)
at onImport.tracePromise.proto (node:internal/modules/esm/loader:659:36)
at TracingChannel.tracePromise (node:diagnostics_channel:344:14)
at ModuleLoader.import (node:internal/modules/esm/loader:658:21) {
code: 'ERR_MODULE_NOT_FOUND',
url: 'file:///markdownlint-cli2-formatter-summarize'
}
]
}

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9a40e22 and eae2734.

📒 Files selected for processing (1)
  • website/docs/podman/adding-certificates-to-a-podman-machine.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • website/docs/podman/adding-certificates-to-a-podman-machine.md
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.
  • 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.

Support

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

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 generate unit tests to generate unit tests for 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.

coderabbitai[bot]
coderabbitai bot reviewed Aug 4, 2025
View reviewed changes
Copy link
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: 1

🧹 Nitpick comments (1)
website/docs/podman/adding-certificates-to-a-podman-machine.md (1)

74-75: Add <machine_name> placeholder for consistency with earlier commands

All previous machine-scoped commands include the <machine_name> parameter. Re-introducing it here avoids confusion for users who run multiple machines.

-$ podman machine stop
-$ podman machine start
+$ podman machine stop <machine_name>
+$ podman machine start <machine_name>
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1d75121 and 9a40e22.

📒 Files selected for processing (1)
  • website/docs/podman/adding-certificates-to-a-podman-machine.md (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings 
Learnt from: benoitf
PR: podman-desktop/podman-desktop#13043
File: packages/main/src/plugin/image-checker.ts:39-46
Timestamp: 2025-07-02T08:30:22.649Z
Learning: In Podman Desktop, benoitf prefers to add dependency injection annotations (@injectable, @inject) in separate PRs before implementing the actual container bindings and DI activation. This allows for incremental adoption of dependency injection.
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (10)
  • GitHub Check: smoke e2e tests (production)
  • GitHub Check: smoke e2e tests (development)
  • GitHub Check: unit tests / windows-2025
  • GitHub Check: unit tests / macos-15
  • GitHub Check: unit tests / ubuntu-24.04
  • GitHub Check: linter, formatters
  • GitHub Check: Windows
  • GitHub Check: macOS
  • GitHub Check: Linux
  • GitHub Check: take screenshots

@codecov Codecov
Copy link
codecov bot commented Aug 4, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@alilleybrinker
docs: add Podman machine reboot step to cert install
eae2734 
This adds an optional step to the end of the instructions for installing
additional root certificates to a Podman machine. On MacOS, with the podman
machine default as my container host, "podman compose up" would continue to
fail with self-signed certificate errors after following the instructions in
this guide, until I fully rebooted the Podman machine.

Signed-off-by: Andrew Lilley Brinker <alilleybrinker@gmail.com>
@alilleybrinker alilleybrinker force-pushed the cert-install-docs-fix branch from 9a40e22 to eae2734 Compare August 4, 2025 20:54
@alilleybrinker
Copy link
Contributor Author

Added the <machine_name> to the stop/start commands, as suggested.

shipsing
shipsing approved these changes Aug 6, 2025
View reviewed changes
Copy link
Contributor
@shipsing shipsing left a comment

Choose a reason for hiding this comment

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

Thanks, @alilleybrinker

@shipsing shipsing merged commit 2dcf92c into podman-desktop:main Aug 12, 2025
23 checks passed
@podman-desktop-bot podman-desktop-bot added this to the 1.21.0 milestone Aug 12, 2025
@alilleybrinker alilleybrinker deleted the cert-install-docs-fix branch August 12, 2025 15:50
@coderabbitai coderabbitai bot mentioned this pull request Aug 25, 2025
Merged
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@benoitf benoitf benoitf approved these changes

@shipsing shipsing shipsing approved these changes

@slemeur slemeur Awaiting requested review from slemeur slemeur is a code owner

@cdrage cdrage Awaiting requested review from cdrage cdrage is a code owner

@Firewall Firewall Awaiting requested review from Firewall Firewall is a code owner

@axel7083 axel7083 Awaiting requested review from axel7083 axel7083 is a code owner automatically assigned from podman-desktop/reviewers

Assignees
No one assigned
Labels
area/website
Projects
None yet
Milestone
1.21.0
Development

Successfully merging this pull request may close these issues.
4 participants
@alilleybrinker @benoitf @shipsing @podman-desktop-bot
0