the docker for Apache APISIX

Clone this repo:
  1. f198360 chore: fix spelling (#141) by John Bampton · 35 hours ago master
  2. 20e2a6a chore: remove unneeded whitespace (#142) by John Bampton · 35 hours ago
  3. 5675363 feat: support build apisix image from local code (#137) by Shuyang Wu · 4 days ago
  4. 4b9063b CI: add apisix-docker test (#133) by kv · 6 days ago
  5. f73d0b9 docs: improve the documentation of alpine (#134) by Yuelin Zheng · 7 days ago

Docker images are not official ASF releases but provided for convenience. Recommended usage is always to build the source.

How To Build Image

The master branch is for the version of Apache APISIX 2.x. If you need a previous version, please build from the v1.x tag.

Build an image from source

  1. Build from release version:
# Assign Apache release version number to variable `APISIX_VERSION`, for example: 2.2. The latest version can be find at `https://github.com/apache/apisix/releases`

export APISIX_VERSION=2.2
docker build -t apisix:${APISIX_VERSION}-alpine --build-arg APISIX_VERSION=${APISIX_VERSION} -f alpine/Dockerfile alpine
  1. Build from master branch version, which has latest code(ONLY for the developer's convenience):
export APISIX_VERSION=master
docker build -t apisix:${APISIX_VERSION}-alpine --build-arg APISIX_VERSION=${APISIX_VERSION} -f alpine/Dockerfile alpine
  1. Build from local code:
# To copy apisix into image, we need to include it in build context
cd <APISIX-PATH>
docker build -t apisix:alpine-local --build-arg APISIX_PATH=. -f <APISIX-DOCKER-PATH>/alpine-local/Dockerfile alpine
# Might need root privilege if encounter "error checking context: 'can't stat'"

Note: For Chinese, the following command is always recommended. The additional build argument ENABLE_PROXY=true will enable proxy to definitely accelerate the progress.

$ docker build -t apisix:${APISIX_VERSION}-alpine --build-arg APISIX_VERSION=${APISIX_VERSION} --build-arg ENABLE_PROXY=true -f alpine/Dockerfile alpine

Manual deploy apisix via docker

Manual deploy

QuickStart via docker-compose

start all modules with docker-compose

$ cd example
$ docker-compose -p docker-apisix up -d

You can refer to the docker-compose example for more try.

Quick test with all dependencies in one Docker container

  • All in one Docker container for Apache APISIX
$ docker build -t apache/apisix:whole -f ./all-in-one/apisix/Dockerfile .
$ docker run -v `pwd`/all-in-one/apisix/config.yaml:/usr/local/apisix/conf/config.yaml -p 9080:9080 -p 2379:2379 -d apache/apisix:whole
  • All in one Docker container for Apache apisix-dashboard

The latest version of apisix-dashboard is 2.4 and should be used with APISIX 2.3.

$ docker build --build-arg APISIX_VERSION=2.2 --build-arg APISIX_DASHBOARD_VERSION=v2.3 -t apache/apisix-dashboard:whole -f ./all-in-one/apisix-dashboard/Dockerfile .
$ docker run -v `pwd`/all-in-one/apisix/config.yaml:/usr/local/apisix/conf/config.yaml -v `pwd`/all-in-one/apisix-dashboard/conf.yaml:/usr/local/apisix-dashboard/conf/conf.yaml -p 9080:9080 -p 2379:2379 -p 9000:9000 -d apache/apisix-dashboard:whole

Tips: If there is a port conflict, please modify the host port through docker run -p, e.g.

$ docker run -v `pwd`/all-in-one/apisix/config.yaml:/usr/local/apisix/conf/config.yaml -v `pwd`/all-in-one/apisix-dashboard/conf.yaml:/usr/local/apisix-dashboard/conf/conf.yaml -p 19080:9080 -p 12379:2379 -p 19000:9000 -d apache/apisix-dashboard:whole