Deis Postgres

Deis (pronounced DAY-iss) Workflow is an open source Platform as a Service (PaaS) that adds a developer-friendly layer to any Kubernetes cluster, making it easy to deploy and manage applications on your own servers.

For more information about the Deis Workflow, please visit the main project page at https://github.com/deis/workflow.

We welcome your input! If you have feedback, please submit an issue. If you'd like to participate in development, please read the "Development" section below and submit a pull request.

About

This component is a PostgreSQL database for use in Kubernetes. It builds on the official postgres Docker image. While it's intended for use inside of the Deis Workflow open source PaaS, it's flexible enough to be used as a standalone pod on any Kubernetes cluster or even as a standalone Docker container.

Development

The Deis project welcomes contributions from all developers. The high level process for development matches many other open source projects. See below for an outline.

• Fork this repository
• Make your changes
• Submit a pull request (PR) to this repository with your changes, and unit tests whenever possible
• If your PR fixes any issues, make sure you write Fixes #1234 in your PR description (where #1234 is the number of the issue you're closing)
• The Deis core contributors will review your code. After each of them sign off on your code, they'll label your PR with LGTM1 and LGTM2 (respectively). Once that happens, a contributor will merge it

Prerequisites

In order to develop and test this component in a Deis cluster, you'll need the following:

• GNU Make
• Docker installed, configured and running
• A working Kubernetes cluster and kubectl installed and configured to talk to the cluster
• If you don't have this setup, please see the Kubernetes documentation

Testing Your Code

Once you have all the aforementioned prerequisites, you are ready to start writing code. Once you've finished building a new feature or fixed a bug, please write a unit or integration test for it if possible. See an existing test for an example test.

If your feature or bugfix doesn't easily lend itself to unit/integration testing, you may need to add tests at a higher level. Please consider adding a test to our end-to-end test suite in that case. If you do, please reference the end-to-end test pull request in your pull request for this repository.

Dogfooding

Finally, we encourage you to dogfood this component while you're writing code on it. To do so, you'll need to build and push Docker images with your changes.

This project has a Makefile that makes these tasks significantly easier. It requires the following environment variables to be set:

• DEIS_REGISTRY - A Docker registry that you have push access to and your Kubernetes cluster can pull from
  • If this is Docker Hub, leave this variable empty
  • Otherwise, ensure it has a trailing /. For example, if you're using Quay.io, use quay.io/
• IMAGE_PREFIX - The organization in the Docker repository. This defaults to deis, but if you don't have access to that organization, set this to one you have push access to.
• SHORT_NAME (optional) - The name of the image. This defaults to postgres
• VERSION (optional) - The tag of the Docker image. This defaults to the current Git SHA (the output of git rev-parse --short HEAD)

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 quay.io/arschles/postgres:devel:

export DEIS_REGISTRY=quay.io/
export IMAGE_PREFIX=arschles
export VERSION=devel
make docker-build docker-push

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.

License

© 2015, 2016 Engine Yard, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.