Skip to content

Commit 5e50226

Browse files
committed
Add instructions on using Podman
make test will work just fine in Podman, provided the Docker-compatible socket is set up and the `DOCKER_HOST` environment variable is set. This allows the Docker API client libraries used by ory/dockertest to provision Podman containers. Signed-off-by: Alexander Scheel <alex.scheel@control-plane.io>
1 parent c5cfeed commit 5e50226

1 file changed

Lines changed: 14 additions & 2 deletions

File tree

DEVELOPMENT.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,18 @@ There are a number of dependencies required to be able to run the controller and
1010

1111
- [Install Go](https://golang.org/doc/install)
1212
- [Install Kustomize](https://kubernetes-sigs.github.io/kustomize/installation/)
13-
- [Install Docker](https://docs.docker.com/engine/install/)
13+
- [Install Docker](https://docs.docker.com/engine/install/) or [Podman](https://podman.io/).
1414
- (Optional) [Install Kubebuilder](https://book.kubebuilder.io/quick-start.html#installation)
1515

16+
> [!NOTE]
17+
>
18+
> When using Podman, start the user daemon before running the tests:
19+
>
20+
> ```shell
21+
> systemctl --user enable --now podman.socket
22+
> export DOCKER_HOST=unix:///run/user/1000/podman/podman.sock
23+
> ```
24+
1625
## How to run the test suite
1726
1827
Prerequisites:
@@ -24,6 +33,9 @@ You can run the test suite by simply doing
2433
make test
2534
```
2635
36+
These tests spin up containers using `ory/dockertest` and will read
37+
`DOCKER_HOST`.
38+
2739
## How to run the controller locally
2840

2941
Install the controller's CRDs on your test cluster:
@@ -91,4 +103,4 @@ Deploy `kustomize-controller` into the cluster that is configured in the local k
91103
make deploy
92104
```
93105

94-
Running the above will also deploy `source-controller` and its CRDs to the cluster.
106+
Running the above will also deploy `source-controller` and its CRDs to the cluster.

0 commit comments

Comments
 (0)