Tool:Containers

Toolforge tools

Toolforge Containers
Website	https://toolsadmin.wikimedia.org/tools/id/containers
Description	Collection of Build Service manged containers suitable for reuse by other tools.
Keywords	build-service, container
Author(s)	BryanDavis
Maintainer(s)	BryanDavis (View all)
License	GNU General Public License 3.0 or later
Issues	Open tasks · Report a bug
Admin log	Tools.containers/SAL

{"name":"containers","repository":"","author":"BryanDavis","url":"https://toolsadmin.wikimedia.org/tools/id/containers","keywords":"build-service, container","description":"Collection of Build Service manged containers suitable for reuse by other tools."}

Toolforge Containers is a project to maintain and publish a collection of build service managed containers for use by other Toolforge tools.

Containers

BNC container

Container running ZNC to act as a BNC (Bounced Network Connection) for an IRC bot. The container also includes Irssi with configuration to connect to the bouncer.

Container name

tool-containers/bnc:latest

Commands

bouncer - Run ZNC

client - Run irssi

Source code

https://gitlab.wikimedia.org/toolforge-repos/containers-bnc

Usage

$ ssh login.toolforge.org
$ become $TOOL
$ toolforge envvars create BNC_USER
$ toolforge envvars create BNC_NICK
$ toolforge envvars create BNC_REALNAME
$ toolforge envvars create BNC_PASSWORD
$ toolforge jobs run \
  --image tool-containers/bnc:latest \
  --command bouncer \
  --continuous \
  --emails none \
  --port 6667 \
  bnc

The ZNC server will be available to your other containers at bnc:6667. Clients will need to authenticate as $BNC_USER/$BNC_NETWORK:$BNC_PASSWORD. The default BNC_NETWORK value is "libera".

Redirect container

Container for redirecting all web requests to a different host.

Container name

tool-containers/redirect:latest

Commands

web - Run redirect webservice

Source code

https://gitlab.wikimedia.org/toolforge-repos/containers-redirect

Usage

$ ssh login.toolforge.org
$ become $TOOL
$ toolforge envvars create REDIRECT_HOST
$ cat > $HOME/service.template <<EOF
type: buildservice
buildservice-image: tool-containers/redirect:latest
health-check-path: /healthz
mount: none
cpu: 125m
mem: 128Mi
EOF
$ toolforge webservice start

Configuration

The redirector can be configured using environment variables.

REDIRECT_HOST

Replace the host component of the requested URL with this value.

Example: another-tool.toolforge.org

Required

REDIRECT_PATH

Format string for constructing the path of the target URL. A %s in the value will be replaced by the request URL path in the target URL.

Example: /new_path_prefix%s

Default: %s

REDIRECT_PROTO

Set the protocol of the target URL.

Default: https

Redis container

Tracked in Phabricator
Task T360378

Container running Redis.

Container name

tool-containers/redis:latest

Commands

server - Run redis-server

client - Run redis-cli

Source code

https://gitlab.wikimedia.org/toolforge-repos/containers-redis

Usage

$ ssh login.toolforge.org
$ become $TOOL
$ toolforge envvars create REDIS_PASSWORD
$ toolforge jobs run \
  --image tool-containers/redis:latest \
  --command server \
  --continuous \
  --emails none \
  --port 6379 \
  redis

The Redis server will be available to your other containers at redis:6379. Clients will need to use the REDIS_PASSWORD envvar to authenticate to the server.