Operations grimoire/Etherpad - Revision history

Dereckson: /* Missing plugins */

2024-01-07T00:43:48Z

Missing plugins

← Older revision		Revision as of 00:43, 7 January 2024
Line 61:		Line 61:
	* ep_author_neat2		* ep_author_neat2

	~~They~~ are included in the nasqueron/etherpad image.		The plugins are now are included in the nasqueron/etherpad:production image.

	=== API key issue ===		=== API key issue ===

Dereckson: /* Upgrade */

2024-01-07T00:03:11Z

Upgrade

← Older revision		Revision as of 00:03, 7 January 2024
Line 8:		Line 8:

	You can also upgrade code in the live container, updating Git code then restarting Node.		You can also upgrade code in the live container, updating Git code then restarting Node.

			=== Procedure A - spin a new container ===
			Build a new nasqueron/etherpad:production image.

			Pull it on docker-002, run <code>deploy-container etherpad</code> to run Salt states.

	=== Procedure B - upgrade code ===		=== Procedure B - upgrade code ===

Dereckson: /* Procedure A - upgrade container */ remove procedure as we don't use .ok files anymore and paths changed

2024-01-07T00:02:01Z

Procedure A - upgrade container: remove procedure as we don't use .ok files anymore and paths changed

← Older revision		Revision as of 00:02, 7 January 2024
Line 8:		Line 8:

	You can also upgrade code in the live container, updating Git code then restarting Node.		You can also upgrade code in the live container, updating Git code then restarting Node.

	~~=== Procedure A - upgrade container ===~~
	~~First, pull new image and remove old container on Equatower:~~
	~~<syntaxhighlight lang="console">~~
	~~$ docker pull nasqueron/etherpad~~
	~~$ docker stop pad~~
	~~$ docker rm pad~~
	$ rm /srv/etherpad/.ok*
	~~</syntaxhighlight>~~

	~~Then, on the Salt master, spin the new container:~~

	~~<syntaxhighlight lang="console">~~
	~~$ cd /opt/salt/nasqueron-operations~~
	~~$ salt docker-002 state.apply roles/paas-docker/containers/etherpad~~
	~~</syntaxhighlight>~~

	~~If something weird happens after the update:~~
	* if you forget to remove /srv/etherpad/.ok-plugins, plugins won't be reinstalled
	* if you forget to remove /srv/etherpad/.ok-apikey, you'll get an API key issue (see below)
	* if you forget to remove /srv/etherpad/.ok-abiword, abiword won't be reinstalled

	~~To use `rm /srv/etherpad/.ok*` on Equatower and then repplay the roles/paas-docker/containers/etherpad state works to fix the situation, as those three steps can be done when the container is live.~~

	=== Procedure B - upgrade code ===		=== Procedure B - upgrade code ===

Dereckson: /* API key issue */

2023-03-02T17:16:41Z

API key issue

← Older revision		Revision as of 17:16, 2 March 2023
Line 90:		Line 90:
	Both are provisioned from Vault:		Both are provisioned from Vault:
	<syntaxhighlight>		<syntaxhighlight>
			salt docker-002 state.sls roles/paas-docker/containers/etherpad
			ssh docker-002 docker restart pad
			salt ysul state.sls roles/webserver-content/org/wolfplex/api
	</syntaxhighlight>		</syntaxhighlight>

	~~{{Vault secrets migration}}~~

Dereckson at 17:15, 2 March 2023

2023-03-02T17:15:00Z

← Older revision		Revision as of 17:15, 2 March 2023
Line 11:		Line 11:
	=== Procedure A - upgrade container ===		=== Procedure A - upgrade container ===
	First, pull new image and remove old container on Equatower:		First, pull new image and remove old container on Equatower:
	<~~source~~ lang="console">		<syntaxhighlight lang="console">
	$ docker pull nasqueron/etherpad		$ docker pull nasqueron/etherpad
	$ docker stop pad		$ docker stop pad
	$ docker rm pad		$ docker rm pad
	$ rm /srv/etherpad/.ok*		$ rm /srv/etherpad/.ok*
	</~~source~~>		</syntaxhighlight>

	Then, on the Salt master, spin the new container:		Then, on the Salt master, spin the new container:

	<~~source~~ lang="console">		<syntaxhighlight lang="console">
	$ cd /opt/salt/nasqueron-operations		$ cd /opt/salt/nasqueron-operations
	$ salt docker-002 state.apply roles/paas-docker/containers/etherpad		$ salt docker-002 state.apply roles/paas-docker/containers/etherpad
	</~~source~~>		</syntaxhighlight>

	If something weird happens after the update:		If something weird happens after the update:
Line 33:		Line 33:

	=== Procedure B - upgrade code ===		=== Procedure B - upgrade code ===
	<~~source~~ lang="console">		<syntaxhighlight lang="console">
	$ docker exec -it pad bash		$ docker exec -it pad bash
	$ git pull		$ git pull
Line 44:		Line 44:
	…		…
	[2016-08-25 00:40:24.711] [INFO] console - Your Etherpad version is 1.6.0 (45266f9)		[2016-08-25 00:40:24.711] [INFO] console - Your Etherpad version is 1.6.0 (45266f9)
	</~~source~~>		</syntaxhighlight>

	Check the two versions match.		Check the two versions match.
Line 69:		Line 69:
	This has been fixed by switching database to utf8mb4_bin:		This has been fixed by switching database to utf8mb4_bin:

	<~~source~~ lang="mysql">		<syntaxhighlight lang="mysql">
	ALTER DATABASE `etherpad` CHARACTER SET utf8mb4 COLLATE utf8mb4_bin;		ALTER DATABASE `etherpad` CHARACTER SET utf8mb4 COLLATE utf8mb4_bin;
	ALTER TABLE `etherpad.store` CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_bin;		ALTER TABLE `etherpad.store` CONVERT TO CHARACTER SET utf8mb4 COLLATE utf8mb4_bin;
	</~~source~~>		</syntaxhighlight>

	=== Missing plugins ===		=== Missing plugins ===
Line 87:		Line 87:

	On the Docker engine, API key should be available at /srv/pad/APIKEY.txt</code>		On the Docker engine, API key should be available at /srv/pad/APIKEY.txt</code>

			Both are provisioned from Vault:
			<syntaxhighlight>
			</syntaxhighlight>

	{{Vault secrets migration}}		{{Vault secrets migration}}

Dereckson: /* API key issue */ Path update to /var/dataroot

2023-03-02T11:03:06Z

API key issue: Path update to /var/dataroot

← Older revision		Revision as of 11:03, 2 March 2023
Line 84:		Line 84:
	http://www.wolfplex.be/pad/ could be empty. When that occurs, the API key on this site diverges from ours.		http://www.wolfplex.be/pad/ could be empty. When that occurs, the API key on this site diverges from ours.

	They store their API on Ysul at <code>/var/~~wwwroot~~/wolfplex~~.be/.dat~~/secrets~~-api~~.json</code>.		They store their API on Ysul at <code>/var/dataroot/wolfplex/secrets.json</code>.

	On the Docker engine, API key should be available at /srv/pad/APIKEY.txt</code>		On the Docker engine, API key should be available at /srv/pad/APIKEY.txt</code>

	{{Vault secrets migration}}		{{Vault secrets migration}}

Dereckson at 10:59, 2 March 2023

2023-03-02T10:59:42Z

← Older revision		Revision as of 10:59, 2 March 2023
Line 22:		Line 22:
	<source lang="console">		<source lang="console">
	$ cd /opt/salt/nasqueron-operations		$ cd /opt/salt/nasqueron-operations
	$ salt ~~equatower~~ state.apply roles/paas-docker/containers/etherpad		$ salt docker-002 state.apply roles/paas-docker/containers/etherpad
	</source>		</source>

Line 49:		Line 49:

	Note most recent code lives in the develop branch, not the master one.		Note most recent code lives in the develop branch, not the master one.

	~~== Launch container ==~~
	~~<code>run-pad</code>~~

	~~Source script available at https://devcentral.nasqueron.org/P210.~~

	== Maintenance tasks ==		== Maintenance tasks ==
Line 82:		Line 77:
	The installation requires two plugins, provided as npm packages:		The installation requires two plugins, provided as npm packages:
	* ep_ether-o-meter		* ep_ether-o-meter
	* ~~ep_author_neat~~		* ep_author_neat2

	~~We now install them~~ in ~~<code>run-pad<~~/~~code>:~~		They are included in the nasqueron/etherpad image.

	~~<source lang="bash">~~
	~~PLUGINS="ep_ether-o-meter ep_author_neat"~~

	~~for plugin in $PLUGINS; do~~
	~~docker exec $INSTANCE npm install $plugin~~
	~~done~~
	~~</source>~~

	=== API key issue ===		=== API key issue ===
Line 99:		Line 86:
	They store their API on Ysul at <code>/var/wwwroot/wolfplex.be/.dat/secrets-api.json</code>.		They store their API on Ysul at <code>/var/wwwroot/wolfplex.be/.dat/secrets-api.json</code>.

	~~Normally~~, ~~this is now handled by the following line from run-pad script:~~		On the Docker engine, API key should be available at /srv/pad/APIKEY.txt</code>
	~~<code>docker cp~~ /~~data~~/~~etherpad/APIKEY.txt $INSTANCE:opt/etherpad-lite~~/APIKEY.txt</code>

	{{Vault secrets migration}}		{{Vault secrets migration}}

Dereckson: /* Repair */

2018-10-10T11:08:38Z

Repair

← Older revision		Revision as of 11:08, 10 October 2018
Line 66:		Line 66:
	There are scripts to delete a pad or to repair a corrupted pad.		There are scripts to delete a pad or to repair a corrupted pad.

	~~There~~ are documented at https://github.com/ether/etherpad-lite/wiki/Getting-to-know-the-tools-in-bin		Those are documented at https://github.com/ether/etherpad-lite/wiki/Getting-to-know-the-tools-in-bin

	== Past known issues ==		== Past known issues ==

Dereckson: /* Delete a pad */

2018-10-10T11:08:12Z

Delete a pad

← Older revision		Revision as of 11:08, 10 October 2018
Line 57:		Line 57:
	== Maintenance tasks ==		== Maintenance tasks ==
	=== Delete a pad ===		=== Delete a pad ===
	Send a request to https://pad.wolfplex.be/api/1/deletePad?apikey=APIKEY&padID=PADTODELETE		As no admin dashboard plugin is installed, there are two methods to delete a pad:
			* Send manually a request to https://pad.wolfplex.be/api/1/deletePad?apikey=APIKEY&padID=PADTODELETE
			* Use the {{Ops file\|roles/paas-docker/wrappers/files/pad-delete.py}} script fo send the request:<br><code>ssh equatower pad-delete $PADTODELETE</code>.

			In the past, the few delete pad requests occurred for privacy reasons. Privacy is an acceptable justification to delete a pad.

	=== Repair ===		=== Repair ===

Dereckson: How to delete a pad

2018-10-10T10:34:43Z

How to delete a pad

← Older revision		Revision as of 10:34, 10 October 2018
Line 55:		Line 55:
	Source script available at https://devcentral.nasqueron.org/P210.		Source script available at https://devcentral.nasqueron.org/P210.

	== Maintenance ~~scripts~~ ==		== Maintenance tasks ==
			=== Delete a pad ===
			Send a request to https://pad.wolfplex.be/api/1/deletePad?apikey=APIKEY&padID=PADTODELETE

			=== Repair ===
	There are scripts to delete a pad or to repair a corrupted pad.		There are scripts to delete a pad or to repair a corrupted pad.