Difference between revisions of "Pymediawikidocker"

From BITPlan Wiki
Jump to navigation Jump to search
Line 62: Line 62:
 
= Usage =
 
= Usage =
 
<source lang='bash'>
 
<source lang='bash'>
usage: mwcluster [-h] [-d] [-V] [-f]
+
usage: mwcluster.py [-h] [-d] [-V] [-vl [VERSIONS ...]] [-bp BASEPORT] [-sp SQLPORT] [-mv MARIADBVERSION] [-f]
  
 
mwcluster
 
mwcluster
Line 76: Line 76:
  
 
optional arguments:
 
optional arguments:
   -h, --help         show this help message and exit
+
   -h, --help           show this help message and exit
   -d, --debug         set debug level [default: False]
+
   -d, --debug           set debug level [default: False]
   -V, --version       show program's version number and exit
+
   -V, --version         show program's version number and exit
   -f, --forceRebuild shall the applications rebuild be forced (with stop and remove of existing containers)
+
  -vl [VERSIONS ...], --versionList [VERSIONS ...]
 +
  -bp BASEPORT, --basePort BASEPORT
 +
  -sp SQLPORT, --sqlBasePort SQLPORT
 +
  -mv MARIADBVERSION, --mariaDBVersion MARIADBVERSION
 +
   -f, --forceRebuild   shall the applications rebuild be forced (with stop and remove of existing containers)
 
</source>
 
</source>
 +
 
= Examples =
 
= Examples =
 
== Default settings ===
 
== Default settings ===

Revision as of 07:50, 22 June 2021

OsProject

OsProject
edit
id  pymediawikidocker
state  
owner  WolfgangFahl
title  Python controlled mediawiki docker image installation
url  https://github.com/WolfgangFahl/pymediawikidocker
version  0.0.7
description  
date  2021-06-22
since  
until  

Freitext

Motivation

Official Mediawiki docker images are available for the different Mediawiki versions.

These images need additional infrastructure to create useable Mediawiki environments. The goal of this project is to semi-automatically create such environments and test the functionality. Python was choosen to as a development environment for the libraries that are needed and available to perform the tasks:

python on whales was chosen over:

Since it supports docker compose.

How it works

The core concept is a "MediawikiCluster" that is a set of docker applications that run MediaWiki instances with varying versions of MediaWiki and the underlying database.

Installation

via pip

pip install pymediawikidocker
# alternatively if your pip is not a python3 pip
pip3 install pymediawikidocker

upgrade

pip install pymediawikidocker -U
# alternatively if your pip is not a python3 pip
pip3 install pymediawikidocker -U

Usage

usage: mwcluster.py [-h] [-d] [-V] [-vl [VERSIONS ...]] [-bp BASEPORT] [-sp SQLPORT] [-mv MARIADBVERSION] [-f]

mwcluster

  Created by Wolfgang Fahl on 2021-06-21.
  Copyright 2021 Wolfgang Fahl. All rights reserved.

  Licensed under the Apache License 2.0
  http://www.apache.org/licenses/LICENSE-2.0

  Distributed on an "AS IS" basis without warranties
  or conditions of any kind, either express or implied.

optional arguments:
  -h, --help            show this help message and exit
  -d, --debug           set debug level [default: False]
  -V, --version         show program's version number and exit
  -vl [VERSIONS ...], --versionList [VERSIONS ...]
  -bp BASEPORT, --basePort BASEPORT
  -sp SQLPORT, --sqlBasePort SQLPORT
  -mv MARIADBVERSION, --mariaDBVersion MARIADBVERSION
  -f, --forceRebuild    shall the applications rebuild be forced (with stop and remove of existing containers)

Examples

Default settings =

Starts a cluster with versions 1.27.7, 1.31.14 and 1.35.2 using MariaDB 10.5

mwcluster -f
starting mediawiki 1.27.7 docker application ...
stopping and removing container mw1_27_7_db_1
stopping and removing container mw1_27_7_mw_1
[+] Building 0.5s (12/12) FINISHED                                                                                     
 => [internal] load build definition from Dockerfile                                                              0.0s
 => => transferring dockerfile: 1.10kB                                                                            0.0s
 => [internal] load .dockerignore                                                                                 0.0s
 => => transferring context: 2B                                                                                   0.0s
 => [internal] load metadata for docker.io/library/mediawiki:1.27.7                                               0.0s
 => [1/7] FROM docker.io/library/mediawiki:1.27.7                                                                 0.0s
 => [internal] load build context                                                                                 0.0s
 => => transferring context: 61.98kB                                                                              0.0s
 => CACHED [2/7] RUN apt-get -y update &&     apt-get -y --no-install-recommends --fix-missing install     maria  0.0s
 => [3/7] COPY LocalSettings.php /var/www/html                                                                    0.0s
 => [4/7] COPY phpinfo.php /var/www/html                                                                          0.0s
 => [5/7] COPY wiki.sql /tmp                                                                                      0.0s
 => [6/7] COPY initdb.sh /tmp                                                                                     0.0s
 => [7/7] RUN chmod +x /tmp/initdb.sh                                                                             0.2s
 => exporting to image                                                                                            0.1s
 => => exporting layers                                                                                           0.0s
 => => writing image sha256:acee6c878b9a8dde738b38c8d73812ae92b175bd1ddefe1f2493d26af7e7bbdb                      0.0s
 => => naming to docker.io/library/mw1_27_7_mw                                                                    0.0s
Initializing MediaWiki SQL tables
Trying DB-Connection to wiki on localhost port 9306 with user wikiuser with max 6 tries and 10s timeout per try - initial sleep 2.5s
Connection to wiki on localhost with user wikiuser established database returns: ('wiki',)
starting mediawiki 1.31.14 docker application ...
stopping and removing container mw1_31_14_db_1
stopping and removing container mw1_31_14_mw_1
[+] Building 0.5s (12/12) FINISHED                                                                                     
 => [internal] load build definition from Dockerfile                                                              0.0s
 => => transferring dockerfile: 1.10kB                                                                            0.0s
 => [internal] load .dockerignore                                                                                 0.0s
 => => transferring context: 2B                                                                                   0.0s
 => [internal] load metadata for docker.io/library/mediawiki:1.31.14                                              0.0s
 => [1/7] FROM docker.io/library/mediawiki:1.31.14                                                                0.0s
 => [internal] load build context                                                                                 0.0s
 => => transferring context: 72.20kB                                                                              0.0s
 => CACHED [2/7] RUN apt-get -y update &&     apt-get -y --no-install-recommends --fix-missing install     maria  0.0s
 => [3/7] COPY LocalSettings.php /var/www/html                                                                    0.0s
 => [4/7] COPY phpinfo.php /var/www/html                                                                          0.0s
 => [5/7] COPY wiki.sql /tmp                                                                                      0.0s
 => [6/7] COPY initdb.sh /tmp                                                                                     0.0s
 => [7/7] RUN chmod +x /tmp/initdb.sh                                                                             0.2s
 => exporting to image                                                                                            0.1s
 => => exporting layers                                                                                           0.0s
 => => writing image sha256:a478ee76ef95f5c6eafc88828058a1d67f4033fcb110abc1b0085729d682c613                      0.0s
 => => naming to docker.io/library/mw1_31_14_mw                                                                   0.0s
Initializing MediaWiki SQL tables
Trying DB-Connection to wiki on localhost port 9307 with user wikiuser with max 6 tries and 10s timeout per try - initial sleep 2.5s
Connection to wiki on localhost with user wikiuser established database returns: ('wiki',)
starting mediawiki 1.35.2 docker application ...
stopping and removing container mw1_35_2_db_1
stopping and removing container mw1_35_2_mw_1
[+] Building 0.5s (12/12) FINISHED                                                                                     
 => [internal] load build definition from Dockerfile                                                              0.0s
 => => transferring dockerfile: 1.10kB                                                                            0.0s
 => [internal] load .dockerignore                                                                                 0.0s
 => => transferring context: 2B                                                                                   0.0s
 => [internal] load metadata for docker.io/library/mediawiki:1.35.2                                               0.0s
 => [1/7] FROM docker.io/library/mediawiki:1.35.2                                                                 0.0s
 => [internal] load build context                                                                                 0.0s
 => => transferring context: 69.71kB                                                                              0.0s
 => CACHED [2/7] RUN apt-get -y update &&     apt-get -y --no-install-recommends --fix-missing install     maria  0.0s
 => [3/7] COPY LocalSettings.php /var/www/html                                                                    0.0s
 => [4/7] COPY phpinfo.php /var/www/html                                                                          0.0s
 => [5/7] COPY wiki.sql /tmp                                                                                      0.0s
 => [6/7] COPY initdb.sh /tmp                                                                                     0.0s
 => [7/7] RUN chmod +x /tmp/initdb.sh                                                                             0.2s
 => exporting to image                                                                                            0.1s
 => => exporting layers                                                                                           0.1s
 => => writing image sha256:a90cfd37ad0fc08329db5b499437f2539364c6b9d0c4a40cfbadcb9b51debd29                      0.0s
 => => naming to docker.io/library/mw1_35_2_mw                                                                    0.0s
Initializing MediaWiki SQL tables
Trying DB-Connection to wiki on localhost port 9308 with user wikiuser with max 6 tries and 10s timeout per try - initial sleep 2.5s
Connection to wiki on localhost with user wikiuser established database returns: ('wiki',)

Mediawiki applications will be available at

  1. http://localhost:9080
  2. http://localhost:9081
  3. http://localhost:9082

Single 1.27.5

python mwdocker/mwcluster.py --forceRebuild --versionList 1.27.5 --basePort 8480 --sqlBasePort 10306 --mariaDBVersion 10.5

Mediawiki applications will be available at

  1. http://localhost:8480

Links