Skip to content

Add ssh parameter support for image builds #642

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

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

Add ssh parameter support for image builds #642

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions podman/domain/images_build.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ def build(self, **kwargs) -> tuple[Image, Iterator[bytes]]:
manifest (str) - add the image to the specified manifest list.
Creates manifest list if it does not exist.
secrets (list[str]) - Secret files/envs to expose to the build
ssh (list[str]) - SSH agent socket or keys to expose to the build
Copy link
Copy Markdown
Member

@Honny1 Honny1 Apr 29, 2026

Choose a reason for hiding this comment

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

I would add an example of how content should look, or refer that content should look like podman build --ssh.


Returns:
first item is the podman.domain.images.Image built
Expand Down Expand Up @@ -216,5 +217,8 @@ def _render_params(kwargs) -> dict[str, list[Any]]:
if "secrets" in kwargs:
params["secrets"] = json.dumps(kwargs.get("secrets"))

if "ssh" in kwargs:
params["ssh"] = json.dumps(kwargs.get("ssh"))
Copy link
Copy Markdown
Member

@Honny1 Honny1 Apr 29, 2026

Choose a reason for hiding this comment

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

Non-blocking: What if kwargs.get("ssh") returns an empty array?


# Remove any unset parameters
return dict(filter(lambda i: i[1] is not None, params.items()))
7 changes: 5 additions & 2 deletions podman/tests/unit/test_build.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
import io
import requests
import json
import unittest

import requests

try:
# Python >= 3.10
from collections.abc import Iterable
Expand Down Expand Up @@ -71,7 +72,8 @@ def test_build(self, mock_prepare_containerfile, mock_create_tar):
"&extrahosts=%7B%22database%22%3A+%22127.0.0.1%22%7D"
"&labels=%7B%22Unittest%22%3A+%22true%22%7D"
"&manifest=example%3Av1.2.3"
"&secrets=%5B%22id%3Dexample%2Csrc%3Dpodman-build-secret123%22%5D",
"&secrets=%5B%22id%3Dexample%2Csrc%3Dpodman-build-secret123%22%5D"
"&ssh=%5B%22default%22%5D",
text=buffer.getvalue(),
)
mock.get(
Expand Down Expand Up @@ -105,6 +107,7 @@ def test_build(self, mock_prepare_containerfile, mock_create_tar):
labels={"Unittest": "true"},
manifest="example:v1.2.3",
secrets=["id=example,src=podman-build-secret123"],
ssh=["default"],
)
self.assertIsInstance(image, Image)
self.assertEqual(image.id, good_image_id)
Expand Down
Loading