Add farm management support #88

chl178 · 2023-06-16T17:42:53Z

Related Issue: #57

Background:

Our previous discussions have highlighted the need to provide more flexibility and efficiency in managing wiki farms in Canasta, which is a Docker-based MediaWiki distribution. The initial implementation included the ability to run multiple wikis (or a wiki farm) within a single container, which was a significant stride towards our project's goal. However, for even more user-friendly and effective management of wiki farms, the enhancement of Canasta's CLI became evident.

Summary

This PR introduces two new commands to the CLI for managing wiki farms: add and remove. Furthermore, we've updated the create command to directly create a wiki farm in a Canasta instance using a wikis.yaml file.

Importantly, our design philosophy in adding wiki farm support ensures the continuity of the original functionality. If you choose not to use the wiki farm related features, all other command operations will work as before. This makes the adoption of wiki farm features completely optional, allowing you to continue using the CLI in the way you're familiar with if desired.

Enhancements

create

Description: Creates a Canasta installation. Enhanced to support wiki farm setup with the -f flag.

Usage:
sudo go run canasta.go create [flags]

-p, --path: Canasta directory.
-o, --orchestrator: Orchestrator to use for installation (default: "docker-compose").
-i, --id: Canasta instance ID.
-w, --wiki: Name of the wiki.
-n, --domain-name: Domain name (default: "localhost").
-a, --WikiSysop: Initial wiki admin username.
-s, --password: Initial wiki admin password.
-f, --yamlfile: Initial wiki yaml file for wiki farm setup.
-k, --keep-config: Keep the config files on installation failure.

YAML Format for Wiki Farm:
To create a wiki farm, you need to provide a YAML file with the following format:

wikis:
  - id: [WIKI_ID] # Example: "wiki1"
    url: [WIKI_URL] # Example: "mywiki1.example.com"
    name: [WIKI_SITENAME] # Example: "mywiki1"

sudo go run canasta.go create -f [yamlfile] # Example: "wikis.yaml

extension

Description: Manage Canasta extensions. Enhanced to target a specific wiki within the farm using the -w flag.

Subcommands:

list: Lists all the installed Canasta extensions.
enable: Enables specified extensions.
disable: Disables specified extensions.

Usage:
sudo go run canasta.go extension [subcommand] [flags]
Flags:

-i, --id: Specifies the Canasta instance ID.
-p, --path: Specifies the Canasta installation directory.
-w, --wiki: Specifies the ID of a specific wiki within the Canasta farm.
-v, --verbose: Enables verbose output.

New Commands

add

Description: Adds a new wiki to a Canasta instance.

Usage:
sudo go run canasta.go add [flags]
Flags:

-w, --wiki: ID of the new wiki.
-u, --url: URL of the new wiki.
-s, --site-name: Name of the new wiki site.
-p, --path: Path to the new wiki.
-i, --id: Canasta instance ID.
-o, --orchestrator: Orchestrator to use for installation (default: "docker-compose").
-d, --database: Path to the existing database dump.

remove

Description: Removes a wiki from a Canasta instance.

Usage:
sudo go run canasta.go remove [flags]
Flags:

-w, --wiki: ID of the wiki to be removed.
-p, --path: Path to the wiki.
-i, --id: Canasta instance ID.

Docker-Compose Structure

Our current docker compose structure is as follows:

config/
	CommonSettings.php
	Caddyfile
	CanastaFooterIcon.php
	composer.local.json
	default.vcl
        wikis.yaml
  	settings/
                *.php
  	wiki1/
		Settings.php
    		*.php
  	wiki2/
    		Settings.php
    		*.php
images/
        wiki1/
  	wiki2/

Each wiki's settings file is contained within a directory of their name under the config directory. These settings include a CommonSettings.php file.
Eache wiki's images are stored in their corresponding file under images/[WIKIID].

In the new version, we consider all Canasta instances as wiki farms, even if there is only one wiki in that instance.Therefore, manual imports of settings and images must be placed in the corresponding wiki ID's folder.

Version Migration

To make it more convenient for users to migrate to the new version, the new Canasta CLI will automatically detect when used, and then create configuration files such as YAML, images folder, etc. If the number of wikis in the farm is more than 1, then the LocalSettings.php will be renamed to CommonSettings.php.

Next Steps:

we will initiate server tests to evaluate the practicality and performance of these updates. Your support and collaboration in this testing phase will be crucial to ensure that our modifications not only align with technical specifications but also cater to real-world usage scenarios.

olsonjaredm · 2023-06-22T18:51:22Z

I like using add/remove for the commands (I can't come up with any better terms).

As far as PHP file structure I'd say default to CommonSettings.php for the upper level with the expectation that for single-wiki 'farms' this file is a stub and ignored by admins.
Then each of the subfolders for individual wikis contain their own LocalSettings.php. I also like the idea of it concatenating all PHP files in the folders so admins can rename them what they like.

jeffw16 · 2023-07-21T05:08:06Z

cmd/add/add.go

+		return err
+	}
+
+	fmt.Println("Successfully Added the Wiki '" + name + "in Canasta instance '" + instance.Id + "'...")


shouldn't there be a space between name +" and in Canasta?

jeffw16 · 2023-07-21T05:08:53Z

cmd/add/add.go

+}
+
+// addWiki accepts the Canasta instance ID, the name, domain and path of the new wiki, and the initial admin info, then creates a new wiki in the instance.
+func AddWiki(name, domain, wikipath, siteName, databasePath string, instance config.Installation) error {


Is it possible for any of these params to be non-null but empty? If so, how is that handled?

jeffw16 · 2023-07-21T05:09:52Z

cmd/remove/remove.go

+}
+
+// addWiki accepts the Canasta instance ID, the name, domain and path of the new wiki, and the initial admin info, then creates a new wiki in the instance.
+func RemoveWiki(name string, instance config.Installation) error {


What happens if this is removing the last wiki in the Canasta instance?

jeffw16 · 2023-07-21T05:10:36Z

internal/canasta/canasta.go

@@ -27,13 +28,15 @@ func CloneStackRepo(orchestrator, canastaId string, path *string) error {
 	*path += "/" + canastaId
 	logging.Print(fmt.Sprintf("Cloning the %s stack repo to %s \n", orchestrator, *path))
 	repo := orchestrators.GetRepoLink(orchestrator)
-	err := git.Clone(repo, *path)
+	err := git.Cloneb(repo, *path, "CLI")


What is git.Cloneb? Is it a typo or is it different than git.Clone?

internal/canasta/canasta.go

jeffw16 · 2023-07-21T05:13:06Z

internal/canasta/canasta.go

+}
+
+func RewriteSettings(path string, WikiNames []string) error {
+	for _, name := range WikiNames {


Is name always guaranteed to be nonempty?

chl178 added 8 commits March 15, 2023 14:20

Add propagating verbose to external subcommands(CanastaWiki#61)

4076120

Add propagating verbose to external subcommands(CanastaWiki#61)

4250d8f

Add propagating verbose to external subcommands(CanastaWiki#61)

60b6d3c

Merge branch 'CanastaWiki:main' into main

3acc92d

enhanced create and add for wiki farm

4d06c16

added add and remove wiki in the Canasta container feature

3427473

updated farmsettings.go

7d6dd39

cleaned the code

406778a

chl178 changed the title ~~Daft PR for CLI farm management support~~ Draft PR for CLI farm management support Jun 16, 2023

structure 0.1

9ebf24d

chl178 added 2 commits June 28, 2023 09:34

structure 0.2

6e6b9ab

midterm version

8d5d731

jeffw16 requested changes Jul 21, 2023

View reviewed changes

chl178 added 6 commits August 13, 2023 15:35

Add documentation

ecc33c8

Add documentation

e8de292

test version

450867e

Merge branch 'main' into farm

11d3f30

Update with HTTPS

1a5c75c

Canasta-CLI 2.0 adding wiki farm support

23b3f62

yaronkoren changed the base branch from main to gsoc-wiki-farm November 3, 2023 16:46

yaronkoren changed the title ~~Draft PR for CLI farm management support~~ Add farm management support Nov 3, 2023

yaronkoren merged commit 81d2a71 into CanastaWiki:gsoc-wiki-farm Nov 3, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add farm management support #88

Add farm management support #88

chl178 commented Jun 16, 2023 •

edited

Loading

olsonjaredm commented Jun 22, 2023

jeffw16 Jul 21, 2023

jeffw16 Jul 21, 2023

jeffw16 Jul 21, 2023

jeffw16 Jul 21, 2023

jeffw16 Jul 21, 2023

Add farm management support #88

Add farm management support #88

Conversation

chl178 commented Jun 16, 2023 • edited Loading

Related Issue: #57

Background:

Summary

Table of Contents

Enhancements

create

extension

New Commands

add

remove

Docker-Compose Structure

Version Migration

Next Steps:

olsonjaredm commented Jun 22, 2023

jeffw16 Jul 21, 2023

Choose a reason for hiding this comment

jeffw16 Jul 21, 2023

Choose a reason for hiding this comment

jeffw16 Jul 21, 2023

Choose a reason for hiding this comment

jeffw16 Jul 21, 2023

Choose a reason for hiding this comment

jeffw16 Jul 21, 2023

Choose a reason for hiding this comment

chl178 commented Jun 16, 2023 •

edited

Loading