Docs/guide stubs (#35)

neicnordic · Jan 11, 2023 · 822fd47 · 822fd47
2 parents 7f21fae + 007d464
commit 822fd47
Show file tree

Hide file tree

Showing 9 changed files with 87 additions and 0 deletions.
diff --git a/docs/dictionary/wordlist.txt b/docs/dictionary/wordlist.txt
@@ -133,6 +133,7 @@ ou
 pacx
 pem
 pgvolume
+phenome
 pkcs
 png
 posix
@@ -172,6 +173,7 @@ tada
 testsuite
 thumbsup
 tls
+todo
 tryggve
 tsd
 ttl

diff --git a/docs/guides/authentication.md b/docs/guides/authentication.md
@@ -0,0 +1,9 @@
+# SDA Authentication
+
+This guide explains how users are authenticated, and how user permissions are
+propagated throughout the Sensitive Data Archive (SDA) system.
+
+> TODO:
+> This guide is a stub and has yet to be finished.
+> If you have feedback to give on the content you would like to see, please contact us on
+> [github](https://github.com/neicnordic/neic-sda)!
diff --git a/docs/guides/deploy-k8s.md b/docs/guides/deploy-k8s.md
@@ -0,0 +1,8 @@
+# Deploying on Kubernetes
+
+This guide explains how to deploy the Sensitive Data Archive (SDA) in kubernetes.
+
+> TODO:
+> This guide is a stub and has yet to be finished.
+> If you have feedback to give on the content you would like to see, please contact us on
+> [github](https://github.com/neicnordic/neic-sda)!
diff --git a/docs/guides/deploy-swarm.md b/docs/guides/deploy-swarm.md
@@ -0,0 +1,8 @@
+# Deploying on Docker Swarm
+
+This guide explains how to deploy the Sensitive Data Archive (SDA) in docker swarm.
+
+> TODO:
+> This guide is a stub and has yet to be finished.
+> If you have feedback to give on the content you would like to see, please contact us on
+> [github](https://github.com/neicnordic/neic-sda)!
diff --git a/docs/guides/deployment.md b/docs/guides/deployment.md
@@ -0,0 +1,16 @@
+# Deploying the Sensitive Data Archive
+
+> NOTE:
+> These guides are being continuously reworked and expanded.
+> If you have feedback to give on the content, please contact us on
+> [github](https://github.com/neicnordic/neic-sda)!
+
+Different nodes of the Federated EGA network, and projects using the standalone SDA
+have made different decisions in how to deploy the system.
+Adaptations needs to be made depending on the system to deploy on,
+as well as the requirements of your deployment.
+
+## Guides
+
+- [Deploying with Docker Swarm](guides/deploy-swarm.md)
+- [Deploying with Kubernetes](guides/deploy-k8s.md)
diff --git a/docs/guides/federated-or-standalone.md b/docs/guides/federated-or-standalone.md
@@ -0,0 +1,15 @@
+# Federated or Standalone Archive
+
+> TODO:
+> This guide is a stub and has yet to be finished.
+> If you have feedback to give on the content you would like to see, please contact us on
+> [github](https://github.com/neicnordic/neic-sda)!
+
+The Sensitive Data Archive (SDA) was developed as an extension of the
+[European phenome-Genome Archive (EGA)](https://ega-archive.org/),
+for federating storage of sensitive data.
+Federating storage has several benefits,
+especially for data that has legal requirements to stay in a certain country.
+
+Setting up the system to receive remote messages on how to behave will be called _federated_.
+Setting up the system with an internal message service will be called _standalone_.
diff --git a/docs/guides/secret-management.md b/docs/guides/secret-management.md
@@ -0,0 +1,10 @@
+# Secret Management
+
+> TODO:
+> This guide is a stub and has yet to be finished.
+> If you have feedback to give on the content you would like to see, please contact us on
+> [github](https://github.com/neicnordic/neic-sda)!
+
+While the archive data is encrypted at rest, the system also includes the secret key needed to decrypt it.
+This key, as well as TLS certificates and various other sensitive values are required to operate the system.
+Keeping these values secure is vital to protect the integrity of the data though.
diff --git a/docs/guides/tls.md b/docs/guides/tls.md
@@ -0,0 +1,10 @@
+# TLS encryption
+
+> NOTE:
+> This guide is under active development.
+> If you have feedback to give on the content, please contact us on
+> [github](https://github.com/neicnordic/neic-sda)!
+
+If you have spent time on the internet you have used tls encryption,
+which is the encryption used for https requests.
+Setting up TLS for a system can be a little bit tricky though.
diff --git a/docs/guides/troubleshooting.md b/docs/guides/troubleshooting.md
@@ -0,0 +1,9 @@
+# Troubleshooting SDA services
+
+> TODO:
+> This guide is a stub and has yet to be finished.
+> If you have feedback to give on the content you would like to see, please contact us on
+> [github](https://github.com/neicnordic/neic-sda)!
+
+Exactly what's happened when a service is acting up can be hard to pinpoint.
+In this guide we aim to give some general tips on how to troubleshoot and restore services to working order.