swh-docs: Add storage sites documentation
AbandonedPublic
Actions

Authored by ftigeot on Oct 15 2019, 12:02 PM.

Details

Reviewers

None

Group Reviewers

Reviewers

Summary

Add storage sites documentation [wip]

Indicate where Softwareheritage stores its data, organize by
big storage locations:

Also link to the existing Elasticsearch document

Repository

rDDOC Development documentation

Branch

swh-docs-82c568f3f51c2bcd69454ca9b4852f02dba0eceb

Lint

No Linters Available

Unit

No Unit Test Coverage

Build Status

Buildable 8455
Build 12264: arc lint + arc unit

ardumont added inline comments.

docs/storage_site_azure_euwest.rst
20	`0euwestswh`
29	It's the vault's cooked archive for the vault server running in azure.
docs/storage_site_rocquencourt_physical.rst
27	swh-lister database as well.
27	it's a dash: `softwareheritage-scheduler`

docs/storage_site_rocquencourt_physical.rst
30	There is a wiki page about it btw [1] [1] https://intranet.softwareheritage.org/wiki/Databases_inventory#cluster:_secondary:5434

That's off to a good start, thanks.

Maybe add a directory under "docs/" to store those documentation, maybe "admin-sys" or "sysadmin" or something like that.

And then also, you need to add the indice references to the index (within the docs/index.rst file) about those new pages.

docs/storage_site_azure_euwest.rst
6	it's a somerset replica (softwareheritage db)
7	indexer replica db (from somerset)
10	storage0 is a node which serves swh-storage, swh-objstorage and swh-indexer-storage's api servers. Plugged to the dbreplica0 (storage db) and dbreplica1 (indexer-storage db) nodes.
11	vault api server service and db
12	That's a webapp like server which we don't use much...
13	worker01 to 10 and 13 are the indexer workers worker11-12 are vault cookers