You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-12Lines changed: 8 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,10 +8,6 @@ For more information about the Drycc Workflow, please visit the main project pag
8
8
9
9
We welcome your input! If you have feedback, please submit an [issue][issues]. If you'd like to participate in development, please read the "Development" section below and submit a [pull request][prs].
10
10
11
-
# About
12
-
13
-
This component is a PostgreSQL database for use in Kubernetes. It builds on the official [postgres](https://registry.hub.docker.com/_/postgres/) Docker image. While it's intended for use inside of the Drycc Workflow open source [PaaS](https://en.wikipedia.org/wiki/Platform_as_a_service), it's flexible enough to be used as a standalone pod on any Kubernetes cluster or even as a standalone Docker container.
14
-
15
11
# Development
16
12
17
13
The Drycc project welcomes contributions from all developers. The high level process for development matches many other open source projects. See below for an outline.
@@ -27,7 +23,7 @@ The Drycc project welcomes contributions from all developers. The high level pro
27
23
In order to develop and test this component in a Drycc cluster, you'll need the following:
28
24
29
25
*[GNU Make](https://www.gnu.org/software/make/)
30
-
*[Docker](https://www.docker.com/) installed, configured and running
26
+
*[Podman](https://podman.io/) installed, configured and running
31
27
* A working Kubernetes cluster and `kubectl` installed and configured to talk to the cluster
32
28
* If you don't have this setup, please see [the Kubernetes documentation][k8s-docs]
33
29
@@ -39,27 +35,27 @@ If your feature or bugfix doesn't easily lend itself to unit/integration testing
39
35
40
36
### Dogfooding
41
37
42
-
Finally, we encourage you to [dogfood](https://en.wikipedia.org/wiki/Eating_your_own_dog_food) this component while you're writing code on it. To do so, you'll need to build and push Docker images with your changes.
38
+
Finally, we encourage you to [dogfood](https://en.wikipedia.org/wiki/Eating_your_own_dog_food) this component while you're writing code on it. To do so, you'll need to build and push Container images with your changes.
43
39
44
40
This project has a [Makefile](https://github.com/drycc/postgres/blob/main/Makefile) that makes these tasks significantly easier. It requires the following environment variables to be set:
45
41
46
-
*`DRYCC_REGISTRY` - A Docker registry that you have push access to and your Kubernetes cluster can pull from
42
+
*`DRYCC_REGISTRY` - A Container registry that you have push access to and your Kubernetes cluster can pull from
47
43
* If this is [Docker Hub](https://hub.docker.com/), leave this variable empty
48
44
* Otherwise, ensure it has a trailing `/`
49
-
*`IMAGE_PREFIX` - The organization in the Docker repository. This defaults to `drycc`, but if you don't have access to that organization, set this to one you have push access to.
45
+
*`IMAGE_PREFIX` - The organization in the Container repository. This defaults to `drycc`, but if you don't have access to that organization, set this to one you have push access to.
50
46
*`SHORT_NAME` (optional) - The name of the image. This defaults to `postgres`
51
-
*`VERSION` (optional) - The tag of the Docker image. This defaults to the current Git SHA (the output of `git rev-parse --short HEAD`)
47
+
*`VERSION` (optional) - The tag of the Container image. This defaults to the current Git SHA (the output of `git rev-parse --short HEAD`)
52
48
53
-
Assuming you have these variables set correctly, run `make docker-build` to build the new image, and `make docker-push` to push it. Here is an example command that would push to `example.com/arschles/postgres:devel`:
49
+
Assuming you have these variables set correctly, run `make podman-build` to build the new image, and `make podman-push` to push it. Here is an example command that would push to `example.com/arschles/postgres:devel`:
54
50
55
51
```console
56
52
export DRYCC_REGISTRY=example.com/
57
53
export IMAGE_PREFIX=arschles
58
54
export VERSION=devel
59
-
make docker-build docker-push
55
+
make podman-build podman-push
60
56
```
61
57
62
-
Note that you'll have to push your image to a Docker repository (`make docker-push`) in order for your Kubernetes cluster to pull the image. This is important for testing in your cluster.
58
+
Note that you'll have to push your image to a Container repository (`make podman-push`) in order for your Kubernetes cluster to pull the image. This is important for testing in your cluster.
0 commit comments