update httpd README.md

Signed-off-by: Gong Sophia <sophia.gong@intel.com>
This commit is contained in:
Gong Sophia
2019-08-30 15:33:41 +08:00
committed by qzheng527
parent 96b2cb133a
commit 419511d0d3
+89 -46
View File
@@ -1,57 +1,100 @@
httpd
==========
This provides a Clear Linux* httpd instance.
# Clear Linux* OS `httpd` container image
Build
-----
```
docker build -t clearlinux/httpd .
```
<!-- Required -->
## What is this image?
Or just pull it from Dockerhub
---------------------------
```
docker pull clearlinux/httpd
```
`clearlinux/httpd` is a Docker image with `httpd` running on top of the
[official clearlinux base image](https://hub.docker.com/_/clearlinux).
start a redis instance
-----------------------
```
docker run --name some-httpd -dit -p 8080:80 clearlinux/httpd
```
<!-- application introduction -->
> [Httpd](https://httpd.apache.org/docs/2.4/programs/httpd.html) is the Apache HyperText
> Transfer Protocol (HTTP) server program. It is designed to be run as a standalone
> daemon process. When used like this it will create a pool of child processes or threads
> to handle requests.
connecting
---------------------
```
curl http://localhost:8080/ # locally
curl http://${server-ip}:8080/ # remotely
```
For other Clear Linux* OS
based container images, see: https://hub.docker.com/u/clearlinux
benchmark test using apache ab
---------------------
Please refer to the [page](https://httpd.apache.org/docs/2.4/programs/ab.html) for details.
## Why use a clearlinux based image?
```
ab -n 25000 -c 50 -k http://${server-ip}:8080/
```
<!-- CL introduction -->
> [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.
<!-- Required -->
## 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 httpd image](https://hub.docker.com/_/httpd).
use customized configuration file
---------------------
The default conf file on clear Linux* is put on /usr/share/defaults/httpd/httpd.conf.
The /etc/httpd/conf.d/httpd.conf could be used to override the defaul one.
The default DocumentRoot is on /var/www/html/.
Above could be modified dynamically by "docker run -v " option, for example,
1. Pull the image from Docker Hub:
```
docker pull clearlinux/httpd
```
```
docker run --name some-httpd -dit -p 8080:80 \
-v /etc/httpd/conf.d:/etc/httpd/conf.d \
-v $PWD/html:/var/www/html \
clearlinux/httpd
```
2. Start a container using the examples below:
Extra Build ARGs
----------------
- ``swupd_args`` Specifies [SWUPD](https://github.com/clearlinux/swupd-client/blob/master/docs/swupd.1.rst#options) flags
```
docker run --name some-httpd -dit -p 8080:80 clearlinux/httpd
```
connecting
```
curl http://localhost:8080/ # locally
curl http://${server-ip}:8080/ # remotely
```
<!-- Optional -->
### Deploy with Kubernetes
Default build args in Docker are on: https://docs.docker.com/engine/reference/builder/#arg
<!-- Required -->
## 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 httpd/
```
3. Build the container image:
```
docker build -t clearlinux/httpd .
```
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.
<!-- Required -->
## Licenses
All licenses for the Clear Linux* Project and distributed software can be found
at https://clearlinux.org/terms-and-policies