Install OpenResty Edge Admin container

1. Preparation

The following documents/information need to be prepared before installation:

  • Configuration package: openresty-edge-VERSION.tar.gz, download from Download Center.
  • Your DB’s IP, port and password, corresponding to DB_HOST, DB_PORT and DB_PASSWORD below.
  • Image Address, corresponding to DOCKER_IMAGE below.
  • Registry username and password: REGISTRY_USERNAME and REGISTRY_PASSWORD
  • (Optional)SSL crt/key for Admin: ssl.key, ssl.crt.

2. Download Image

  • Login Registry
sudo docker login --username=REGISTRY_USERNAME registry.openresty.com
# enter password: REGISTRY_PASSWORD
  • Download Image
docker pull DOCKER_IMAGE

# example
docker pull registry.openresty.com/edge/ubuntu/20.04/openresty-edge-admin:22.6.1

3. Run Container

  • Create a new folder to be mounted in the container: custom/

  • Copy openresty-edge-VERSION.tar.gz to custom/

  • Generate the configuration file for Edge Admin: custom/config.ini

Please replace DB_HOST, DB_PORT and DB_PASSWORD with their actual contents.

#
# NOTICE: please feel free to edit these configurations if necessary.
#
# Both [postgresql] section and [log_server] section need to be configured below.
#


[postgresql]

# the host to connect to, default:
host = "DB_HOST"

# the port to connect to, default:
port = "DB_PORT"

# password for authentication, default:
password = 'DB_PASSWORD'

# enable ssl, default:
ssl = false

# abort the connection if the server does not support SSL connections, default:
ssl_required = false


# NOTICE: we hard code the database: or_edge_admin and the user: or_edge_admin
# please contact us when you want to change them.


[log_server]

# log server host, default:
host = "127.0.0.1"


[clone_admin]

# Another admin server host when you have deployed two admin servers.
# It is optional, please ignore it when you only deployed one admin.
# host = ""

# The role for the current edge-admin, it can be "main", "staging" or "normal"(default).
# The main edge-admin will send the release events to staging edge-admin,
# so that the staging edge-admin will release the related configurations to gray gateway nodes.
# It's only useful during edge-admin gray upgrade.
# role = "normal"

  • (Optional) Configure SSL certificate and key

Copy the certificate and key to custom/, the names are ssl.key and ssl.crt respectively.

  • Run Container

Suppose the absolute path to custom/ is /root/custom/.


docker run -d -p 443:443 -p 12345:12345 --name openresty-edge-admin -v /root/custom/:/usr/local/oredge-admin/custom/ DOCKER_IMAGE

# example:
docker run -d -p 443:443 -p 12345:12345 --name openresty-edge-admin -v /root/custom/:/usr/local/oredge-admin/custom/ registry.openresty.com/edge/ubuntu/20.04/openresty-edge-admin:22.6.1
  • If an error occurs, the container can be stopped and deleted using the following command:
docker stop openresty-edge-admin
docker rm openresty-edge-admin

Now, the installation of the OpenResty Edge Admin container is complete.