MWStake MediaWiki Manager: Difference between revisions

From MWStake
Jump to navigation Jump to search
No edit summary
No edit summary
 
(47 intermediate revisions by the same user not shown)
Line 1: Line 1:
  What is this about?
  '''[https://mwstake.org/mwstake/wiki/Special:AllPages?from=MWStake&to=&namespace=0 SUBPAGES]'''
  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.


__TOC__
'''[https://github.com/dataspects/mediawiki-manager/search?q=CreateCampEMWCon2021 GitHub Repo Tag "CreateCampEMWCon2021"]'''
Code Base at              https://github.com/dataspects/mediawiki-manager
Development Discussion at https://riot.im/app/#/room/#mwdeployment:matrix.org


<gallery mode="slideshow">
== Project Reasoning and Potential Goals ==
File:mediawiki-manager-Service-Architecture.png|MWM Service Architecture


</gallery>
Facilitate managing all aspects and use cases regarding the operation of MediaWiki instance(s)


# Across set up modes and operating systems
# Targeting all user groups accordingly
# Conveying best practices
# Component monitoring and certification services
# Not integrated, but besides MediaWiki instance(s)
# Install/configure/upgrade system(s)
# Install/enable/disable/upgrade/configure extensions
#* MediaWiki Stakeholders Group Certified Extensions Service
# Backup/restore/clone/compare/consolidate system(s) (snapshots)
# Inject/extract/facet/edit/consolidate/import/export/remove apps/structures/ontologies
#* MediaWiki Stakeholders Group Certified Apps Service
# Script/automate/schedule tasks
# Package/move/archive/migrate system(s)
# ORTHOGONAL MODULARITY


__TOC__


== Development Broadcasting ==
== Backlog ==


There are videos about MWStake MWM at [https://www.youtube.com/channel/UCoP-EgZJPhB0UE4WaKCHR1w dataspects' YouTube channel].
* Permissions (owner, group, rwx, executing user, etc.)
 
* Apache (SSL, configuration)
* [https://www.youtube.com/watch?v=MTYq2a2Xsls First glimpse at the idea of an MWStake MediaWiki Manager]
* Certified extensions and apps catalog (selection, fields, mechanisms, policies, stewardship)
 
* SSO
== Project Reasoning and Potential Goals ==
* Search
 
<div style="margin:20px; padding:50px; border-radius:50px; background-color:beige;">
Slide 1/10: '''Why and What?'''
# Your kitchen / hotel chain kitchens
#* appliances vs. parts
#* integration levels and interfaces
# MWM:
## <code>git clone</code>
## <code>install.sh</code>
## manage:
##* Install/configure/upgrade system(s)
##* Install/enable/disable/upgrade/configure extensions
##** MediaWiki Stakeholders Group Certified Extensions Service
##* Backup/restore/clone/compare/consolidate system(s) (snapshots)
##* Troubleshoot/safe mode
##* Inject/extract/facet/edit/consolidate/import/export/remove apps/structures/ontologies
##** MediaWiki Stakeholders Group Certified Apps Service
##* Scripting/automate/schedule tasks
##* Package/move/archive/migrate system(s)
</div>


== MWM Implementation Aspects ==
== MWM Implementation Aspects ==


<div style="margin:20px; padding:50px; border-radius:50px; background-color:beige;">
'''How and Why?'''
Slide 2/10: '''How and Why?'''


* Dissect system&hellip;
* Dissect system&hellip;
Line 64: Line 53:
=== [https://podman.io/ Podman]-managed [https://github.com/dataspects/mediawiki-manager/blob/main/mediawiki-manager.tpl MWM Kubernetes deploy manifest] ("Containers") ===
=== [https://podman.io/ Podman]-managed [https://github.com/dataspects/mediawiki-manager/blob/main/mediawiki-manager.tpl MWM Kubernetes deploy manifest] ("Containers") ===
# Pod "mwm"
# Pod "mwm"
# Container "mediawiki" + user volumes and config envs
# [https://github.com/dataspects/dataspectsSystemBuilder/tree/master/docker-images/mediawiki Container "mediawiki"] + [https://github.com/dataspects/mediawiki-manager/blob/main/mediawiki-manager.tpl user volumes] and [https://github.com/dataspects/mediawiki-manager/tree/main/envs config envs]
# Container "mediawiki-safemode" + config envs
# Container "mariadb" + config envs
# Container "mariadb" + config envs


==== Config envs ====
==== Config envs ====
 
Pending: [http://docs.podman.io/en/latest/markdown/podman-secret.1.html podman secret]
{|
{|
|<syntaxhighlight lang=bash>
# my-new-system.env
export WG_DB_PASSWORD=8n65f%6n5
</syntaxhighlight>
|&rArr; envsubst &rArr;
|<syntaxhighlight lang=bash>
|<syntaxhighlight lang=bash>
# mediawiki-manager.yml
# mediawiki-manager.yml
Line 79: Line 72:
     env:
     env:
       - name: WG_DB_PASSWORD
       - name: WG_DB_PASSWORD
         value: wgdbpassword
         value: 8n65f%6n5
       - ...
       - ...
...
...
Line 90: Line 83:
|}
|}


==== [https://github.com/dataspects/mediawiki-manager/blob/main/cli/install-system/install-system.sh Install] ====
==== Config database ====
<syntaxhighlight lang=bash>
 
envsubst < mediawiki-manager.tpl > mediawiki-manager.yml      # <-- Customize system
{|
podman play kube mediawiki-manager.yml                        # <-- Schedule system (runs normal mediawiki container)
|<syntaxhighlight lang=php>
podman container stop mwm-deployment-pod-0-mediawiki-safemode  # <-- Stop safe mode mediawiki container
<?php
# addToMWMSQLite.php
 
$name  = $argv[1];
$localsettingsdirectives = $argv[2];
$db = new SQLite3('mwmconfigdb.sqlite');
 
$stmt = $db->prepare('INSERT INTO extensions (name, localsettingsdirectives) VALUES ( :name, :localsettingsdirectives)');
$stmt->bindValue(':name', $name, SQLITE3_TEXT);
$stmt->bindValue(':localsettingsdirectives', $localsettingsdirectives, SQLITE3_TEXT);
 
$stmt->execute();
</syntaxhighlight>
</syntaxhighlight>
|&rArr;
|<syntaxhighlight lang=php>
<?php
# updateMWMLocalSettings.php
$db = new SQLite3('mwmconfigdb.sqlite');
$stmt = $db->prepare('SELECT localsettingsdirectives FROM extensions');
$result = $stmt->execute();


==== Normal mode ====
$mwmLocalSettingsString = "";
<syntaxhighlight lang=bash>
while($res = $result->fetchArray(SQLITE3_ASSOC)){
# From scratch
    $mwmLocalSettingsString .= trim($res["localsettingsdirectives"])."\n";
podman pod start mwm-deployment-pod-0                          # <-- Run pod
}
podman container stop mwm-deployment-pod-0-mediawiki-safemode  # <-- Stop safe mode mediawiki container


# Returning from safe mode
$mwmLS = fopen("mwmLocalSettings.php", "w");
podman container stop mwm-deployment-pod-0-mediawiki-safemode  # <-- Stop safe mode mediawiki container
fwrite($mwmLS, "<?php\n".$mwmLocalSettingsString);
podman container stop mwm-deployment-pod-0-mediawiki          # <-- Start normal mediawiki container
fclose($mwmLS);
</syntaxhighlight>
</syntaxhighlight>
 
|&rArr;
==== [https://github.com/dataspects/mediawiki-manager/blob/main/cli/manage-system/start-SAFE-MODE.sh Safe mode] ====
|<syntaxhighlight lang=php># Localsettings.php
<syntaxhighlight lang=bash>
$mwmls = "../mwmLocalSettings.php";
podman container stop mwm-deployment-pod-0-mediawiki          # <-- Stop normal mediawiki container
# MWStake MediaWiki Manager
podman container start mwm-deployment-pod-0-mediawiki-safemode # <-- Start safe mode mediawiki container
if(file_exists($mwmls)) {
require_once($mwmls);
} else {
echo "ERROR: ".$mwmls." include not loaded.";
}
</syntaxhighlight>
</syntaxhighlight>
# <code>/images</code> still volumed in
|}
# still uses production database
# mostly unchanged envs
# "volumed out" and falling back to reliable container-internal versions:
#* LocalSettings.php (containing <code>$wgReadOnly = true; $wgSiteNotice = "================ MWM Safe Mode ================";</code>)
#* extensions
#* skins
#* vendor
#* composer.json
</div>


== Target User Groups ==
== Target User Groups ==
<div style="margin:20px; padding:50px; border-radius:50px; background-color:beige;">
<div style="margin:20px; padding:50px; border-radius:50px; background-color:beige;">
Slide 2/10: '''Who can use the concepts in MWM how?'''
'''Who can use the concepts in MWM how?'''
Here I try to segregate target users into groups that share capabilities and needs.
Here I try to segregate target users into groups that share capabilities and needs.
{|class=wikitable
{|class=wikitable
Line 174: Line 180:
</div>
</div>


== MWStake MWM Service Portfolio ==
== Use Cases ==
<div style="margin:20px; padding:50px; border-radius:50px; background-color:beige;">
[[File:mediawiki-manager-Service-Protfolio.png]]
</div>


== Use Cases ==
=== {{mlb|Install/configure/upgrade/run/operate system(s)}} ===


=== {{mlb|Install/configure/upgrade system(s)}} ===
# Favored path: Kubernetes-based only for mwmITLocal, mwmITIntra and mwmITCloud


{|class=wikitable
{|class=wikitable
Line 188: Line 191:
!Why
!Why
|-
|-
|locally on a single computer
|mwmITLocal: locally on a single computer
|as a containerized app
|containerized
|for personal/private/development use
|for personal/private/development use
|-
|-
|in an intranet
|mwmITIntra: in an intranet
|
|
* as a containerized app on a root server
containerized
* as a containerized app on a PAAS
|for corporate internal use
|for corporate internal use
|-
|-
|
|mwmITCloud: on the internet/in the cloud
on the internet/in the cloud
|containerized
|
* 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
|for corporate internal/external/public use
|}
|}
=== {{mlb|Run/operate system(s)}} ===
<div style="margin:20px; padding:50px; border-radius:50px; background-color:beige;">
[[File:Mediawiki-manager-InteractionLogics.png]]
</div>


=== {{mlb|Install/enable/disable/upgrade/configure extensions}} ===
=== {{mlb|Install/enable/disable/upgrade/configure extensions}} ===


==== CLI (Bash) ====
[[MWStake MediaWiki Manager/MWStakeServices/ExtensionsCatalog]]
 
The command:
 
<code>./cli/manage-extensions/show-extension-catalogue.sh</code>
 
parses https://github.com/dataspects/mediawiki-manager/blob/main/catalogues/extensions.json to '''offer the selection of "certified" extensions''' upon which the commands:
* <code>./cli/manage-extensions/enable-extension.sh <EXTNAME></code> and
* <code>./cli/manage-extensions/disable-extension.sh <EXTNAME></code>
 
can be executed.
 
[[File:MWM manage extensions on cli bash abstraction level.png]]
 
[[File:Mediawiki-manager-ExtensionsStore.png]]


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


=== {{mlb|Troubleshoot/safe mode}} ===
=== {{mlb|Inject/extract/facet/edit/consolidate/import/export/remove apps/structures/ontologies}} ===


'''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>.
==== CLI (Bash) ====


[[File:MWMSafeModeAlert.png]]
https://github.com/dataspects/mediawiki-manager/tree/main/cli/manage-content


{|class=wikitable
=== {{mlb|Scripting}} ===
!MWM Normal Mode
!MWM Safe Mode
|-
|
[[File:mwm-normal-mode.png]]
|
[[File:mwm-safe-mode.png]]
|}


=== {{mlb|Inject/extract/facet/edit/consolidate/import/export/remove apps/structures/ontologies}} ===
==== CLI (Bash) ====


=== {{mlb|Scripting}} ===
https://github.com/dataspects/mediawiki-manager/blob/main/cli/manage-extensions/tests.sh


=== {{mlb|Package system(s)}} ===
=== {{mlb|Package system(s)}} ===
Line 256: Line 227:
# [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 ===
== MWStake MWM Service Portfolio ==
 
[[MWStake_MediaWiki_Manager/MWStakeServices]]
* 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 ==
Line 272: Line 237:


# The [https://hub.docker.com/r/dataspects/mediawiki/tags?page=1&ordering=last_updated mediawiki container image] contains a [https://github.com/dataspects/dataspectsSystemBuilder/blob/master/docker-images/mediawiki/Dockerfile full MediaWiki installation].
# The [https://hub.docker.com/r/dataspects/mediawiki/tags?page=1&ordering=last_updated mediawiki container image] contains a [https://github.com/dataspects/dataspectsSystemBuilder/blob/master/docker-images/mediawiki/Dockerfile full MediaWiki installation].
# [https://github.com/dataspects/mediawiki-manager/blob/main/cli/install-system/initialize-persistent-mediawiki-service-volumes.sh 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.
# [https://github.com/dataspects/mediawiki-manager/blob/main/cli/install-system/initialize-persistent-mediawiki-service-volumes.sh initialize-persistent-mediawiki-service-volumes.sh] will copy persistence-relevant files/directories out to the host so they can be volumed in when starting the mediawiki container.
# This shall allow for [https://github.com/dataspects/mediawiki-manager/blob/main/cli/manage-system/start-SAFE-MODE.sh start-SAFE-MODE.sh].


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


=== ALapi: MWM API (Go) wrapping and parametrizing ALcli shell scripts and using MWAPI ===
=== ALapi: MWM API wrapping and parametrizing ALcli shell scripts and using MWAPI ===
 
https://github.com/dataspects/mwmapi


==== Unit Testing ====
==== Unit Testing ====


=== ALui: MWM UI (React/Material UI) using and parametrizing ALapi endpoints ===
=== ALui: MWM UI using and parametrizing ALapi endpoints ===
 
https://github.com/dataspects/mwmui


[[File:Mediawiki-manager-UI.png|MWM UI]]
[[File:Mediawiki-manager-UI.png|MWM UI]]


==== Integration Testing ====
==== Integration Testing ====
== Development Broadcasting ==
There are videos about MWStake MWM at [https://www.youtube.com/channel/UCoP-EgZJPhB0UE4WaKCHR1w dataspects' YouTube channel].
* [https://www.youtube.com/watch?v=MTYq2a2Xsls First glimpse at the idea of an MWStake MediaWiki Manager]

Latest revision as of 08:20, 22 April 2021

SUBPAGES

GitHub Repo Tag "CreateCampEMWCon2021"
Code Base at              https://github.com/dataspects/mediawiki-manager
Development Discussion at https://riot.im/app/#/room/#mwdeployment:matrix.org

Project Reasoning and Potential Goals

Facilitate managing all aspects and use cases regarding the operation of MediaWiki instance(s)
  1. Across set up modes and operating systems
  2. Targeting all user groups accordingly
  3. Conveying best practices
  4. Component monitoring and certification services
  5. Not integrated, but besides MediaWiki instance(s)
  6. Install/configure/upgrade system(s)
  7. Install/enable/disable/upgrade/configure extensions
    • MediaWiki Stakeholders Group Certified Extensions Service
  8. Backup/restore/clone/compare/consolidate system(s) (snapshots)
  9. Inject/extract/facet/edit/consolidate/import/export/remove apps/structures/ontologies
    • MediaWiki Stakeholders Group Certified Apps Service
  10. Script/automate/schedule tasks
  11. Package/move/archive/migrate system(s)
  12. ORTHOGONAL MODULARITY

Backlog

  • Permissions (owner, group, rwx, executing user, etc.)
  • Apache (SSL, configuration)
  • Certified extensions and apps catalog (selection, fields, mechanisms, policies, stewardship)
  • SSO
  • Search

MWM Implementation Aspects

How and Why?

  • Dissect system…
  • …into as few as possible but into as many as necessary interfacing components…
  • …in order to fulfill all intended use cases…
  • …in accordance with corresponding users' capabilities and needs.

Abstraction Layers

CLI <-- API <-- UI
  1. UI is GUI for API
  2. API wraps CLI
  3. CLI means bash scripts covering all use cases

Podman-managed MWM Kubernetes deploy manifest ("Containers")

  1. Pod "mwm"
  2. Container "mediawiki" + user volumes and config envs
  3. Container "mariadb" + config envs

Config envs

Pending: podman secret 

# my-new-system.env
export WG_DB_PASSWORD=8n65f%6n5
⇒ envsubst ⇒ 
# mediawiki-manager.yml
...
containers:
  - image: docker.io/dataspects/mediawiki:1.35.0-2104121740
    name: mediawiki
    env:
      - name: WG_DB_PASSWORD
        value: 8n65f%6n5
      - ...
...
⇒ 
# Localsettings.php
$wgDBpassword = getenv("WG_DB_PASSWORD");

Config database

<?php
# addToMWMSQLite.php

$name  = $argv[1];
$localsettingsdirectives = $argv[2];
$db = new SQLite3('mwmconfigdb.sqlite');

$stmt = $db->prepare('INSERT INTO extensions (name, localsettingsdirectives) VALUES ( :name, :localsettingsdirectives)');
$stmt->bindValue(':name', $name, SQLITE3_TEXT);
$stmt->bindValue(':localsettingsdirectives', $localsettingsdirectives, SQLITE3_TEXT);

$stmt->execute();
⇒ 
<?php
# updateMWMLocalSettings.php

$db = new SQLite3('mwmconfigdb.sqlite');
$stmt = $db->prepare('SELECT localsettingsdirectives FROM extensions');
$result = $stmt->execute();

$mwmLocalSettingsString = "";
while($res = $result->fetchArray(SQLITE3_ASSOC)){
    $mwmLocalSettingsString .= trim($res["localsettingsdirectives"])."\n";
}

$mwmLS = fopen("mwmLocalSettings.php", "w");
fwrite($mwmLS, "<?php\n".$mwmLocalSettingsString);
fclose($mwmLS);
⇒ 
# Localsettings.php
$mwmls = "../mwmLocalSettings.php";
# MWStake MediaWiki Manager
if(file_exists($mwmls)) {
	require_once($mwmls);
} else { 
	echo "ERROR: ".$mwmls." include not loaded.";
}

Target User Groups

Who can use the concepts in MWM how? Here I try to segregate target users into groups that share capabilities and needs.

User Group Point/Select/Type/Click CLI/SSH Scripting Edit configuration junior Edit configuration senior
Examples "Web Interface" Automate/schedule tasks
  • Edit LocalSettings.php
  • Run composer

PLUS

  • Interpret logs
  • Report bugs/feature request
  • Branch code, develop and PR
UGUI "WebAdmin" Yes - "Macro" style only from within UI
("Excel Record Macro Style") 		- -
UGAdmin "SysAdmin" Yes Yes Run/arrange .sh scripts Yes -
UGCoder "Developer" Yes Yes Run/arrange/compose/create/edit .sh scripts including API calls Yes Yes

Use Cases

Install/configure/upgrade/run/operate system(s)

  1. Favored path: Kubernetes-based only for mwmITLocal, mwmITIntra and mwmITCloud
Where How Why
mwmITLocal: locally on a single computer containerized for personal/private/development use
mwmITIntra: in an intranet

containerized

for corporate internal use
mwmITCloud: on the internet/in the cloud containerized for corporate internal/external/public use

Install/enable/disable/upgrade/configure extensions

MWStake MediaWiki Manager/MWStakeServices/ExtensionsCatalog

Backup/restore/clone/compare/consolidate system(s) (snapshots)

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

CLI (Bash)

https://github.com/dataspects/mediawiki-manager/tree/main/cli/manage-content

Scripting

CLI (Bash)

https://github.com/dataspects/mediawiki-manager/blob/main/cli/manage-extensions/tests.sh

Package system(s)

  1. mediawiki-apps.json

MWStake MWM Service Portfolio

MWStake_MediaWiki_Manager/MWStakeServices

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 persistence-relevant files/directories out to the host so they can be volumed in when starting the mediawiki container.

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

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

Unit Testing

ALui: MWM UI using and parametrizing ALapi endpoints

MWM UI

Integration Testing

Development Broadcasting

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

Retrieved from "https://mwstake.org/w/index.php?title=MWStake_MediaWiki_Manager&oldid=3036"