この文書では、KUSANAGI Runs on Docker(以下KUSANAGI RoD)上にWordPress環境を構築する方法を解説します。

概要

超高速CMS実行環境「KUSANAGI」をDocker上で利用することにより、WordPress等のCMSを高速・セキュアに動作させることができます。
そのほか次のような特徴があります。

• WordPressのほか、concrete5、Drupal 7/8、LAMP、LEMP環境としても利用できます。
• 動作環境として、nginx、Apache、php7、MariaDBを利用できます。
• 確認済みのOSは、CentOS7、Ubuntu18.04、Windows10（WSL + Docker Desktop for Windows）、macOS（Docker Deskotp for Mac）です。
• 使用するdocker-compose.yml ファイルの自動生成が可能です。
• データベースのデータベース名、ユーザ名、パスワード情報などの自動生成が可能です。
• データベースの内容および生成したコンテンツのバックアップ・リストアが可能です。

KUSANAGI RoDを使用するために必要なソフトウェアは以下のものになります。

• bash (4.x以上)
• git
• sed
• awk
• grep
• gettext
• envsubst
• curl
• docker (18.0x以上)
• docker-compose
• docker-machine(オプショナル)

インストール

KUSANAGI RoD を使用するためには、docker、docker-machine(オプショナル)、docker-compose が必要になります。
以下に、インストール方法を説明します。

docker

以下のページを参考にして、Windows、Mac、Linuxのいずれかの環境に、dockerをインストールします。

• Docker for Windows
• Docker for Mac OS X
• Docker Engine for Linux

docker machine

以下のページを参考にして、docker-machine をインストールします。

• Docker Machine

docker compose

以下のページを参考にして、docker-compose をインストールします。

• Docker Compose
• Mac OS Xへのインストール
• Ubuntuへのインストール

WindowsでDocker Toolbox をインストールしている場合には、docker-compose もインストールされています。

KUSANAGI RoDのインストール

以下のようにコマンドを実行すると、KUSANAGI RoDが$HOME/.kusanagi 以下にインストールされます。
※事前にGitのユーザー名とメールアドレスを設定してください。

$ curl https://raw.githubusercontent.com/prime-strategy/kusanagi-docker/master/install.sh | bash 
cloning kusanagi-docker commands
Cloning into '/home/kusanagi/.kusanagi'...
remote: Enumerating objects: 193, done.
remote: Counting objects: 100% (193/193), done.
remote: Compressing objects: 100% (123/123), done.
remote: Total 573 (delta 124), reused 125 (delta 67), pack-reused 380
Receiving objects: 100% (573/573), 195.00 KiB | 452.00 KiB/s, done.
Resolving deltas: 100% (308/308), done.
check commands requires kusanagi-docker
kusanagi-docker command install completes.
Please add these line to .bashrc or .zshrc
export PATH=/home/kusanagi/.kusanagi/bin:$PATH
$

上記メッセージのように、$HOME/.kusanagi/bin をPATHに追加しておいてください。
KUSANAGI RoDを更新するときは、$HOME/.kusanagi/install.sh を再実行してください。

KUSANAGI RoDコマンド

KUSANAGI RoDコマンドの本体は、$HOME/.kusanagi/bin/kusanagi-docker となります。

以下はヘルプメッセージになります。

$ kusanagi-docker --help
///////////////////////////////////////////////////
High-Performance WordPress VirtualMachine
///////////////////////////////////////////////////
     __ ____  _______ ___    _   _____   __________
    / //_/ / / / ___//   |  / | / /   | / ____/  _/
   / ,< / / / /\__ \/ /| | /  |/ / /| |/ / __ / /
  / /| / /_/ /___/ / ___ |/ /|  / ___ / /_/ // /
 /_/ |_\____//____/_/  |_/_/ |_/_/  |_\____/___/

KUSANAGI-DOCKER CLI Subcommand inforamtion
Manual : http://en.kusanagi.tokyo/document/command/
---------------------
- help -
# kusanagi-docker [-h | --help | help]
show this snippet.
# kusanagi-docker [-V|--version]
show this version
---------------------
- create/remove target -
provision [options] --fqdn domainname target(like kusanagi.tokyo)
    [--wp|--wordpress|--WordPress [WPOPTION]|
    WPOPTION:
         --wplang lang(like en_US, ja)]
         [--admin-user admin] [--admin-pass pass] [--admin-email email]
         [--wp-title title] [--kusanagi-pass pass] [--notfp|--no-ftp] |
     --lamp|--c5|--concrete5|
     --drupal|--drupal7|--drupal8]

    [--nginx|--httpd]
    [--http-port port][--tls-port port]
    [--dbsystem mysql|mariadb|pgsql|postgrsql]
    [--dbhost host]
    [--dbrootpass pasword
    [--dbname dbname]
    [--dbuser username]
    [--dbpass password]
remove [-y] [target]
- configuration (runs on target dir) -
ssl [options]
    [--cert file --key file]
    [--redirect|--noredirect]
    [--hsts [on|off]]
    [--oscp [on|off]]
    [--ct [on|off]]
    [--help|help]
config command
    bcache [on|off]
    fcache [on|off]
    pull
    push
    dbdump [file]
    dbrestore [file]
    backup
    restore
    [--help|help]
wp [wpcli commands]
import/export
---------------------
- status (runs on target dir) -
start|stop|restart|status
----------------------
INFO: 完了しました。

主なサブコマンドは以下になります。

• provision KUSANAGI RoDの環境を作成します
• remove KUSANAGI RoDの環境を削除します
• ssl KUSANAGI RoDのSSL関連の設定を変更します
• config KUSANAGI RoD の設定を行います
• wp WordPressのCLIコマンドを実施します(WordPressのみ)
• import/export Docker上に設定したファイルおよびDB情報をローカルディレクトリにimport/exportします
• start/stop/restart 作成したKUSANAGI RoD環境を開始/停止/再起動を行います
• status 作成したKUSANAGI RoD環境の状態を確認します

provision

provisionサブコマンドでは、末尾に指定したtarget名のディレクトリをカレントディレクトリ以下に作成し、KUSANAGI RoDの環境を作成します。

provisonサブコマンドのオプション

provision サブコマンドのオプションは以下のとおりです。

• オプションは、--option value もしくは、--option=value の形で指定できます。
• オプション指定の優先順位は、オプション指定、環境変数指定、デフォルト値となります。
• DBHOSTにlocalhost以外を指定し、使用するDBが作成されていない場合、DB_ROOTPASSを正しく指定する必要があります。
• DBHOSTにlocalhost以外を指定し、使用するDBが作成している場合、DBNAME/DBUSER/DBPASSを正しく指定する必要があります。

ターゲットディレクトリ

プロビジョンが成功すると、ターゲットディレクトリに以下のファイル・ディレクトリが作成されます。

プロビジョンが終わったあと、contents ディレクトリ以下にプロビジョンで生成されたDocker上のファイルをコピーし、Git登録済みの状態になり、管理を行うことが出来ます。

作成されるDockerコンテナ

provision後、以下のDockerコンテナが起動されます。

provision実行後に作成されるdocker-compose.yml は、最低限の記述しかしていません。
logging方式の変更、共有ストレージの使用、swarm化などは、docker-compose.yml を修正して対応してください。また、docker-composeを使用して、start/stop/ps/run/exec などの操作が可能です。

その他環境変数

provision実行時に、環境変数でのみ設定できる項目があります。これらの環境変数は、.kusanagi.* に書かれます。

remove

provisionで作成したRoD環境を削除します。このとき、作成されたDockerコンテナ、ボリューム、ブリッジの停止/削除と、ターゲットディレクトリを削除します。

このコマンドは、ターゲットディレクトリの親ディレクトリ上で動作する必要があります。

ssl

RoD環境のSSL周りの設定を行います。

このコマンドは、ターゲットディレクトリ上で動作する必要があります。

--hsts、--oscp、--ct は、自己SSL証明書を指定していると指定できないのに注意してください。

config

configコマンドは、RoD環境の設定や、情報のbackup/restore を行います。

このコマンドは、ターゲットディレクトリ上で動作する必要があります。

pullおよびdbdumpを実行しても、自動的にGitにcommitされません。適宜git コマンドを使用して管理してください。

wp

WordPressを使用しているときのみ使用できます。wpcliのコマンドを指定することで、WordPressに対する操作を行うことが出来ます。

このコマンドは、ターゲットディレクトリ上で動作する必要があります。

import/export

kusanagi-docker config backup/restore と同じ動作をします。

このコマンドは、ターゲットディレクトリ上で動作する必要があります。

start/stop/restart/status

start/stop/restartは、RoD環境のDockerコンテナを開始・停止・再起動を行います。statusはDockerコンテナの状況を確認することが出来ます。また、httpd/php/db/ftp などコンテナ名を指定することで、特定コンテナだけを開始・停止/再起動を行うことが出来ます

このコマンドは、ターゲットディレクトリ上で動作する必要があります。

これらのコマンドは、docker-composeコマンドのwrapperなので、ターゲットディレクトリ上でdocker-composeを使用しても構いません。

使用されるDocker イメージ

KUSANAGI RoD向けのイメージはDockerHubで公開済みです。すべてalpine10ベースのイメージですが、今後変更される可能性があります。
推奨バージョン(現状の最新版)を使用するには、$HOME/.kusanagi/update_version を定期的に実行してください。

docker-machineとの併用

KUSANAGI RoDは、docker-machineと併用することが出来ます。通常通りdocker-machineを作成し、eval $(docker-machine env ホスト名)を実行して、kusanagi-docker provisionを行ってください。

また以下の手順で、既存コンテナを別docker-machineへ移行することが可能です。

1. kusanagi-docker importを実施して、現状のコンテナ情報をimportする
2. kusanagi-docker stopでコンテナを停止
3. eval $(docker-machine env ホスト名)を実行
4. docker-compose up -dを実行
5. DBがlocalhostの場合、DB初期化まで待つ。
   初期化が終わったかどうかは、以下のコマンドで確認可能。

   $ source .kusanagi.db
   $ docker-compose run --rm config  mysqladmin status -u$DBUSER -p"$DBPASS" 2>&1 > /dev/null && echo ok || echo ng
   

6. kusanagi-docker exportを実行し、コンテナ情報をexportする.