diff --git a/haproxy/README.md b/haproxy/README.md index e5265e5..6b43d19 100644 --- a/haproxy/README.md +++ b/haproxy/README.md @@ -1,29 +1,94 @@ -haproxy -========== -This provides a Clear Linux* haproxy instance. +# Clear Linux* OS `haproxy` container image -Build ------ -docker build -t clearlinux/haproxy . + +## What is this image? -Or just pull it from Dockerhub ---------------------------- -docker pull clearlinux/haproxy +`clearlinux/haproxy` is a Docker image with `haproxy` running on top of the +[official clearlinux base image](https://hub.docker.com/_/clearlinux). -start a haproxy instance ------------------------ -docker run --name some-haproxy -d -p 8080:80 clearlinux/haproxy + +> [Haproxy](http://www.haproxy.org/) is a free, very fast and reliable solution offering +> high availability, load balancing, and proxying for TCP and HTTP-based applications. -use customized configuration file ---------------------- -Since no two users of haproxy are likely to configure it exactly alike, we provide /usr/local/etc/haproxy/haproxy.cfg as an example, user may need to customize their own and override this default. Please refer to [page](https://cbonte.github.io/haproxy-dconv/) for configure details. +For other Clear Linux* OS +based container images, see: https://hub.docker.com/u/clearlinux -Details of how-to ---------------------- -Please refer to the docker official haproxy image [page](https://hub.docker.com/_/haproxy). +## Why use a clearlinux based image? -Extra Build ARGs ----------------- -- ``swupd_args`` Specifies [SWUPD](https://github.com/clearlinux/swupd-client/blob/master/docs/swupd.1.rst#options) flags + +> [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. -Default build args in Docker are on: https://docs.docker.com/engine/reference/builder/#arg +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 haproxy +image](https://hub.docker.com/_/haproxy). + + +1. Pull the image from Docker Hub: + ``` + docker pull clearlinux/haproxy + ``` + +2. Start a container using the examples below: + + ``` + docker run --name some-haproxy -d -p 8080:80 clearlinux/haproxy + ``` + + +### 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 haproxy/ + ``` + +3. Build the container image: + ``` + docker build -t clearlinux/haproxy . + ``` + + 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