sysadm docs: Move relevant and public doc from intranet to swh-docs
After discussion the following structure emerged as proposal for the sysadm pages. After the sprint, the arborescence evolved a bit but the gist of it remains. We want to migrate the existing intranet pages to the sphinx instance.
A new page [1] to add the documentation site. This could be publicly linked from the main page [2] (or not). This will be publicly exposed as other repositories already exposed the same kind of information anyway (source code repositories, puppet, ...).
-
Getting started
-
Puppet setup -
Check puppet manifests with vagranta -
Provision new vms -
Access to the Credential store -
link to the phabricator tuto in devel doc - ...
-
-
How to
-
Debian packaging (could be cross-linked maybe) -
Database upgrade -
Database deployment -
Deploy a new swh module in staging/production -
Upgrade swh service -
Deploying a lister -
Keycloak -
Connect to a database -
Onboarding -
Outboarding -
Configure the vpn
-
-
Explanation
- Infrastructure
-
Production -
Staging environment
-
-
Network configuration -
Source of truth -> Inventory
- Infrastructure
Pros/cons
pros
- code review ahead of time available (one could always skip it if they don't want to)
- tool unification (sphinx rst, git, ...)
cons
No cons that I can see (well the migration per say but that can be done incrementally :)
Remaining pages to redispatch eventually
-
Backups -
Database inventory -
IDRAC (credentials moved to credential store first) -
Jenkins -> actually to devel docs -
IRC -
Pglogical replication - ...
Migrated from T3154 (view on Phabricator)
Edited by Antoine R. Dumont