diff --git a/postgres/README.md b/postgres/README.md index d9ce8aa..5aaf262 100644 --- a/postgres/README.md +++ b/postgres/README.md @@ -1,31 +1,92 @@ -PostgreSQL -========== -This provides a Clear Linux* PostgreSQL instance. +# Clear Linux* OS `postgres` container image -Build ------ -``` -docker build -t clearlinux/postgres . -``` + +## What is this image? -Or just pull it from Dockerhub ---------------------------- -``` -docker pull clearlinux/postgres -``` +`clearlinux/postgres` is a Docker image with `postgres` running on top of the +[official clearlinux base image](https://hub.docker.com/_/clearlinux). -Start PostgreSQL Container ------------------------ -``` -docker run -p 5432:5432 -e POSTGRES_PASSWORD=secret -d clearlinux/postgres -``` + +> [PostgreSQL](https://www.postgresql.org/) is a powerful, open source object-relational +> database system with over 30 years of active development that has earned it a strong +> reputation for reliability, feature robustness, and performance. -Environment Variables ---------------------- -- See ``Environment Variables`` section of the official postgres image [page](https://hub.docker.com/_/postgres). +For other Clear Linux* OS +based container images, see: https://hub.docker.com/u/clearlinux -Extra Build ARGs ----------------- -- ``swupd_args`` Specifies [SWUPD](https://github.com/clearlinux/swupd-client/blob/master/docs/swupd.1.rst#options) flags +## Why use a clearlinux based image? -Default build args in Docker are on: https://docs.docker.com/engine/reference/builder/#arg + +> [Clear Linux* OS](https://clearlinux.org/) is an open source, rolling release +> Linux distribution optimized for performance and security, from the Cloud to +> the Edge, designed for customization, and manageability. + +Clear Linux* OS based container images use: +* Optimized libraries that are compiled with latest compiler versions and + flags. +* Software packages that follow upstream source closely and update frequently. +* An aggressive security model and best practices for CVE patching. +* A multi-staged build approach to keep a reduced container image size. +* The same container syntax as the official images to make getting started + easy. + +To learn more about Clear Linux* OS, visit: https://clearlinux.org. + + +## Deployment: + +### Deploy with Docker +The easiest way to get started with this image is by simply pulling it from +Docker Hub. + +*Note: This container uses the same syntax as the [official postgres image](https://hub.docker.com/_/postgres). + + +1. Pull the image from Docker Hub: + ``` + docker pull clearlinux/postgres + ``` + +2. Start a container using the examples below: + + ``` + docker run -p 5432:5432 -e POSTGRES_PASSWORD=secret -d clearlinux/postgres + ``` + + +### Deploy with Kubernetes + + +## Build and modify: + +The Dockerfiles for all Clear Linux* OS based container images are available at +https://github.com/clearlinux/dockerfiles. These can be used to build and +modify the container images. + +1. Clone the clearlinux/dockerfiles repository. + ``` + git clone https://github.com/clearlinux/dockerfiles.git + ``` + +2. Change to the directory of the application: + ``` + cd postgres/ + ``` + +3. Build the container image: + ``` + docker build -t clearlinux/postgres . + ``` + + Refer to the Docker documentation for [default build arguments](https://docs.docker.com/engine/reference/builder/#arg). + Additionally: + + - `swupd_args` - specifies arguments to pass to the Clear Linux* OS software + manager. See the [swupd man pages](https://github.com/clearlinux/swupd-client/blob/master/docs/swupd.1.rst#options) + for more information. + + +## Licenses + +All licenses for the Clear Linux* Project and distributed software can be found +at https://clearlinux.org/terms-and-policies