Meza/Commands

Help
Once installed, if you run the  command all by itself, it will display help like the following:

Mediawiki EZ Admin

Usage: meza COMMAND [directives]

To setup a multi-server environment, do:

$ meza setup env # Setup the environment, following prompts $ sudo vi /opt/conf-meza/secret//hosts $ sudo vi /opt/conf-meza/secret//secret.yml $ sudo meza deploy 
 * 1) Edit config as required:

Commands   Directives           Description --- install    dev-networking       Setup networking on VM            monolith             Install server on this machine docker              Install Docker (CentOS only) deploy       Deploy your server setup      env                  Setup an environment dev                 Setup dev features (Git, FTP) create     wiki                 Create a wiki wiki-promptless     Create a wiki without prompts backup       Create a backup of an env docker     run                  (experimental) Start container exec                Execute command on container

Every command has directives. If you run any command without directives it will provide help for that command.

Pass-through
Meza uses a program called Ansible to do a lot of work. Meza ultimately passes through options and arguments to Ansible's  command. So, if there are  options that you wish to use, you can do so. Particularly useful for getting to know Meza are the,  ;   and   options. The first two are options that do not actually run the playbook, but rather they tell you more about it.

Tags
(where  is your environment name, which is likely   or  )

Will output something like the following:

First it shows you the actual invocation of  that is run:

sudo -u meza-ansible ansible-playbook /opt/meza/src/playbooks/site.yml -i /opt/conf-meza/secret/monolith/hosts --vault-password-file /opt/conf-meza/users/meza-ansible/.vault-pass-monolith.txt --extra-vars '{"env": "monolith"}' --list-tags

Followed by the number of plays, and the tags associated with each:

playbook: /opt/meza/src/playbooks/site.yml

play #1 (localhost): localhost       TAGS: [] TASK TAGS: []

play #2 (app-servers): app-servers   TAGS: [] TASK TAGS: []

play #3 (all:!exclude-all:!load-balancers-unmanaged): all:!exclude-all:!load-balancers-unmanaged     TAGS: [base] TASK TAGS: [base, latest]

play #4 (load-balancers): load-balancers     TAGS: [load-balancer] TASK TAGS: [load-balancer]

play #5 (app-servers): app-servers   TAGS: [apache-php] TASK TAGS: [apache-php, latest]

play #6 (app-servers): app-servers   TAGS: [gluster] TASK TAGS: [gluster]

play #7 (memcached-servers): memcached-servers       TAGS: [memcached] TASK TAGS: [latest, memcached]

play #8 (db-master): db-master       TAGS: [database] TASK TAGS: [database]

play #9 (db-slaves): db-slaves       TAGS: [database] TASK TAGS: [database]

play #10 (elastic-servers): elastic-servers  TAGS: [elasticsearch] TASK TAGS: [elasticsearch]

play #11 (app-servers): app-servers  TAGS: [mediawiki] TASK TAGS: [composer-extensions, git-core-extensions, git-extensions, git-local-extensions, git-submodules, latest, mediawiki, search-index, smw-data, update.php, verify-wiki]

play #12 (parsoid-servers): parsoid-servers  TAGS: [parsoid] TASK TAGS: [latest, parsoid, parsoid-deps]

play #13 (logging-servers): logging-servers  TAGS: [logging] TASK TAGS: [logging]

play #14 (all:!exclude-all:!load-balancers-unmanaged): all:!exclude-all:!load-balancers-unmanaged    TAGS: [cron] TASK TAGS: [cron]

Tasks
There is a lot of detail in the list-tasks output. This is for reference only, and will change constantly as development is ongoing.

In the task list, you can see tags that are associated at the task level. Again, this command will not execute a deploy. It will only show you the tasks that would be run.

Will output something like the following:

playbook: /opt/meza/src/playbooks/site.yml

play #1 (localhost): localhost       TAGS: [] tasks: Ensure no password on meza-ansible user on controller    TAGS: [] Ensure controller has user alt-meza-ansible      TAGS: [] Ensure user alt-meza-ansible .ssh dir configured TAGS: [] Copy meza-ansible keys to alt-meza-ansible       TAGS: [] Copy meza-ansible known_hosts to alt-meza-ansible TAGS: [] Ensure secret.yml encrypted      TAGS: [] Ensure secret.yml owned by meza-ansible  TAGS: []

play #2 (app-servers): app-servers   TAGS: [] tasks: set-vars : Set meza-core path variables  TAGS: [] set-vars : If using gluster (app-servers > 1), override m_uploads_dir    TAGS: [] set-vars : Set meza local public variables       TAGS: [] set-vars : Get individual wikis dirs from localhost      TAGS: [] set_fact TAGS: [] set-vars : Set meza local secret variables       TAGS: [] init-controller-config : Does controller have local config       TAGS: [] init-controller-config : Get local config repo if set    TAGS: [] init-controller-config : Does controller have local config       TAGS: [] init-controller-config : Ensure m_local_public configured on controller  TAGS: [] init-controller-config : Ensure m_local_public/wikis exists      TAGS: [] init-controller-config : Ensure pre/post settings directories exists in config   TAGS: [] init-controller-config : Ensure base files present, do NOT overwrite     TAGS: []

And so on...

At the very end of output, it shows you the underlying ansible command:

As a side note, you can use the 'aha' utility to easily create [an HTML file for reference](https://freephile.org/wiki/Aha).

Using Tags and Skipping Tags
To be written. In our next update, we'll show you how to use and skip tags. You can even combine listing and skipping.

Will show you all the tasks that would be executed if you skipped the cron tasks.

After making configuration changes to a meza wiki server, it will be common to run deploy with options such as this example:

(one or both) and/or  (one or more)

Tags we recommend typically specifying:


 * specifies all mediawiki setup steps, including config changes


 *  is rarely necessary to specify, but it comes after mediawiki so if you're repeatedly running things starting at mediawiki it can be handy to run to the end by also specifying pars oid

Tags that are of ten a good idea to skip:


 *  gets the  latest versions of software, including git-fetch of mediawiki core and extensions. This can take a long time (but may be necessary to include if you add an extension).
 * TO-DO: There are also ways to specify just git extensions or just composer extensions, or just meza core extensions versus local config extensions.
 * updates the MediaWiki database. This is not required if you're not changing MediaWiki version or extensions that make database changes. This takes a lo ng time on large/plentiful wikis.
 *  basically makes sure a bunch of stuff is present for each wiki, but it does not do specific config for each wiki. So if you make a wiki config change you still can skip this.
 *  rebuilds SMW data. This takes ~24 hours on large wikis. This won't run unless a new wiki is created/imported, but you can still specify to skip it j ust to be sure.
 * <span class="mx_MessageTimestamp" title="Tue, May 8 2018 12:30:43">  rebuilds the Elasticsearch data. This takes several hours on large wikis.