MWStake MediaWiki Manager: Difference between revisions

From MWStake
Jump to navigation Jump to search
Line 32: Line 32:
== Use Cases ==
== Use Cases ==


=== {{mlb|Install/upgrade system(s)}} ===
=== {{mlb|Install/configure/upgrade system(s)}} ===


{|class=wikitable
{|class=wikitable
Line 58: Line 58:
|}
|}


=== Manage MW ===
=== {{mlb|Install/enable/disable/upgrade/configure extensions}} ===
==== Settings ====
# [https://github.com/dataspects/mediawiki-manager/blob/main/catalogues/systemSettings.json systemSettings.json]
==== Upgrade ====


# [https://github.com/dataspects/mediawiki-manager/blob/main/catalogues/versions.json upgrades.json]
=== {{mlb|Backup/restore/clone/compare/consolidate system(s) (snapshots) ===


ย 
=== {{mlb|Troubleshoot/safe mode}} ===
=== Manage MW Extensions (install/enable/disable/upgrade) ===
ย 
# [https://github.com/dataspects/mediawiki-manager/blob/main/catalogues/extensions.json extensions.json]
ย 
==== MediaWiki Stakeholders Group Certified Extensions Service ====
ย 
* Some background:
** [[Action:7]]
** [[Talk:MWStake_incorporation/Board_meeting]]
* Format right now: https://github.com/dataspects/mediawiki-manager/blob/main/catalogues/extensions.json
* Management, roles, responsibilities, privileges, processes, QA?
* Hosting?
ย 
=== Snapshots (backup/restore/clone) ===
ย 
=== SafeMode ===


'''Idea''': if someone corrupts <code>extensions/</code> and/or <code>LocalSettings.php</code>, then <code>./start-SAFE-MODE.sh</code> restarts the wiki in safe mode, by falling back to container-internal versions of <code>extensions/</code> and <code>LocalSettings.php</code>.
'''Idea''': if someone corrupts <code>extensions/</code> and/or <code>LocalSettings.php</code>, then <code>./start-SAFE-MODE.sh</code> restarts the wiki in safe mode, by falling back to container-internal versions of <code>extensions/</code> and <code>LocalSettings.php</code>.
Line 97: Line 78:
|}
|}


=== Manage MW Content (inject/extract/facet/edit) ===
=== {{mlb|Inject/extract/facet/edit/consolidate/iport/export/remove apps/structures/ontologies}} ===
ย 
=== {{mlb|Scripting}} ===
ย 
=== {{mlb|Package system(s) ===


# [https://github.com/dataspects/mediawiki-manager/blob/main/catalogues/apps.json mediawiki-apps.json]
# [https://github.com/dataspects/mediawiki-manager/blob/main/catalogues/apps.json mediawiki-apps.json]
=== MediaWiki Stakeholders Group Certified Extensions Service ===
* Some background:
** [[Action:7]]
** [[Talk:MWStake_incorporation/Board_meeting]]
* Format right now: https://github.com/dataspects/mediawiki-manager/blob/main/catalogues/extensions.json
* Management, roles, responsibilities, privileges, processes, QA?
* Hosting?


== Abstraction Layers ==
== Abstraction Layers ==

Revision as of 06:54, 11 April 2021

What is this about?

  1. Install MediaWiki.
  
  2. Manage (settings), upgrades, extensions, snapshots and content through an independent CLI/API/UI.
  
  3. Put MediaWiki in SafeMode in case of problems.

Development Broadcasting

There are videos about MWStake MWM at dataspects' YouTube channel.

Target User Groups

UGcli: Users willing/able to use the command line

UGclis: Users wanting to script actions

UGui: Users requiring a UI, NOT willing/able to use the command line

Use Cases

Install/configure/upgrade system(s)

Where How Why
locally on a single computer as a containerized app for personal/private use
in an intranet
  • as a containerized app on a root server
  • as a containerized app on a PAAS
for corporate internal use

on the internet/in the cloud

  • on a shared host
  • as a containerized app on a root server
  • as a containerized app on a PAAS
for corporate internal/external/public use

Install/enable/disable/upgrade/configure extensions

{{mlb|Backup/restore/clone/compare/consolidate system(s) (snapshots)

Troubleshoot/safe mode

Idea: if someone corrupts extensions/ and/or LocalSettings.php, then ./start-SAFE-MODE.sh restarts the wiki in safe mode, by falling back to container-internal versions of extensions/ and LocalSettings.php.

MWMSafeModeAlert.png

MWM Normal Mode MWM Safe Mode

Mwm-normal-mode.png

Mwm-safe-mode.png

Inject/extract/facet/edit/consolidate/iport/export/remove apps/structures/ontologies

Scripting

{{mlb|Package system(s)

  1. mediawiki-apps.json

MediaWiki Stakeholders Group Certified Extensions Service

Abstraction Layers

Mediawiki-manager-Service-Architecture.png

ALcontainerization: Podman

  1. The mediawiki container image contains a full MediaWiki installation.
  2. initialize-persistent-mediawiki-service-volumes.sh will copy the 5 persistence-relevant files/directories out to the host so they can be volumed in when starting the mediawiki container.
  3. This shall allow for start-SAFE-MODE.sh.

ALcli: shell scripts using MWAPI and CRUDing files in service volumes

ALapi: MWM API (Go) wrapping and parametrizing ALcli shell scripts and using MWAPI

https://github.com/dataspects/mwmapi

Unit Testing

ALui: MWM UI (React/Material UI) using and parametrizing ALapi endpoints

https://github.com/dataspects/mwmui

Integration Testing