From af0b9a81bfa358c3d39754685c58db1c7d450e06 Mon Sep 17 00:00:00 2001 From: Gong Sophia Date: Fri, 30 Aug 2019 13:25:35 +0800 Subject: [PATCH] update golang README.md Signed-off-by: Gong Sophia --- golang/README.md | 116 +++++++++++++++++++++++++++++++++++------------ 1 file changed, 86 insertions(+), 30 deletions(-) diff --git a/golang/README.md b/golang/README.md index 7a86e7c..5d0f974 100644 --- a/golang/README.md +++ b/golang/README.md @@ -1,38 +1,94 @@ -golang -========== -This provides a Clear Linux* golang instance. +# Clear Linux* OS `golang` container image -Build ------ -``` -docker build -t clearlinux/golang . -``` + +## What is this image? -Or just pull it from Dockerhub ---------------------------- -``` -docker pull clearlinux/golang -``` +`clearlinux/golang` is a Docker image with `golang` running on top of the +[official clearlinux base image](https://hub.docker.com/_/clearlinux). -Test go version ------------------------ -``` -docker run --rm clearlinux/golang go version -``` + +> [Golang](https://golang.org/) is an open source programming language that makes it easy +> to build simple, reliable, and efficient software. -Test go build ---------------------- -``` -docker run --rm -v "$PWD":/usr/src/myapp -w /usr/src/myapp clearlinux/golang go build -v -``` +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 golang image [page](https://hub.docker.com/_/golang). +## Why use a clearlinux based image? + + +> [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 golang image](https://hub.docker.com/_/golang). -Extra Build ARGs ----------------- -- ``swupd_args`` Specifies [SWUPD](https://github.com/clearlinux/swupd-client/blob/master/docs/swupd.1.rst#options) flags +1. Pull the image from Docker Hub: + ``` + docker pull clearlinux/golang + ``` -Default build args in Docker are on: https://docs.docker.com/engine/reference/builder/#arg +2. Start a container using the examples below: + ``` + docker run --rm clearlinux/golang go version + ``` + + ``` + docker run --rm -v "$PWD":/usr/src/myapp -w /usr/src/myapp clearlinux/golang go build -v + ``` + + +### 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 golang/ + ``` + +3. Build the container image: + ``` + docker build -t clearlinux/golang . + ``` + + 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