Refactor deployment documentation structure and headings
This commit is contained in:
@ -2,7 +2,7 @@ To start up the HTWK MOOC platform there are a few steps to follow, which will b
|
||||
|
||||
**For a quick installation, all necessary instructions are printed in bold. The text gives a detailed explanation of the steps.**
|
||||
|
||||
== Installation of Nomad ==
|
||||
=== Installation of Nomad ===
|
||||
**To install Nomad there should be a guide on the HashiCorp website: link:https://developer.hashicorp.com/nomad/docs/install[Nomad Installation Instructions]**.
|
||||
After a successful installation (for example using a package repository), Nomad needs to be running on localhost using port 4646. Additionally, when enabled as systemd service it should be started automatically on system boot. Both should be set up by default.
|
||||
|
||||
@ -22,7 +22,7 @@ curl -X POST -d '{"SchedulerAlgorithm": "spread", "MemoryOversubscriptionEnabled
|
||||
|
||||
This command is automatically executed when the Docker containers are started, so it is not necessary if the platform is started with Docker Compose.
|
||||
|
||||
== Pulling the CodeContender repository ==
|
||||
=== Pulling the CodeContender repository ===
|
||||
The repository for the HTWK MOOC platform is hosted on the GitLab instance of the faculty DIT. It consists of submodules for Poseidon and Codeocean, which have to be initialized after cloning the repository.
|
||||
|
||||
**The repository can be cloned with the following commands:**
|
||||
@ -35,7 +35,7 @@ git submodule update --init
|
||||
|
||||
Because the HPI repositories contain additional submodules, that are for internal use only and not necessary for the HTWK platform, the init command does not need to be recursive.
|
||||
|
||||
== Deployment with Docker Compose ==
|
||||
=== Deployment with Docker Compose ===
|
||||
|
||||
To build and start the platform, Docker Compose is used. Default username and password for the admin can be changed in the `codeocean/docker-compose.yml` file. The default values are `support@htwkalender.de` and `htwkalender`.
|
||||
**The following command downloads the necessary images, builds the containers and starts them:**
|
||||
@ -52,11 +52,11 @@ All data used by CodeOcean is stored in a Postgres database which is mounted
|
||||
|
||||
The rest seems to be left unchanged...
|
||||
|
||||
=== Checking access to CodeOcean ===
|
||||
==== Checking access to CodeOcean ====
|
||||
|
||||
After starting up the Docker containers, the platform should be running on port 443 of the host system. This can be checked by navigating to https://localhost in a web browser on the host machine.
|
||||
|
||||
== Installing openEdx ==
|
||||
=== Installing openEdx ===
|
||||
|
||||
The openEdx platform itself is not containerized, but there is a containerized distribution called Tutor, which can be deployed to a Kubernetes. Following the short installation process for a local deployment. Kubernetes instructions are following in the next section.
|
||||
|
||||
|
@ -1,5 +1,3 @@
|
||||
== Kubernetes vs. Nomad: Ein Vergleich der Container-Orchestrierungssysteme
|
||||
|
||||
Kubernetes und Nomad sind beides Plattformen für das Management und die Orchestrierung von Containern, aber sie haben unterschiedliche Konzepte und Architekturen. Um die beiden Systeme zu vergleichen, insbesondere in Bezug auf Begriffe wie Deployment, Job, Pod, und deren Umsetzung in beiden Systemen, ist es wichtig, die jeweilige Architektur und Konzepte im Detail zu verstehen.
|
||||
|
||||
=== 1. Grundlegende Architektur
|
||||
|
@ -117,7 +117,11 @@ include::{includedir}/existing_solutions.asciidoc[]
|
||||
|
||||
include::{includedir}/edX.asciidoc[]
|
||||
|
||||
=== Kubernetes vs. Nomad ===
|
||||
== edX Kubernetes Deployment ==
|
||||
|
||||
include::{includedir}/edX-k8s.asciidoc[]
|
||||
|
||||
== Kubernetes vs. Nomad ==
|
||||
|
||||
include::{includedir}/kubernetes-nomad.asciidoc[]
|
||||
|
||||
@ -129,14 +133,10 @@ include::{includedir}/dockerization-codeocean.asciidoc[]
|
||||
|
||||
include::{includedir}/deployment.asciidoc[]
|
||||
|
||||
=== CodeOcean Docker Images ===
|
||||
== CodeOcean Docker Images ==
|
||||
|
||||
include::{includedir}/codeocean-dockerimages.asciidoc[]
|
||||
|
||||
=== edX Kubernetes Deployment ===
|
||||
|
||||
include::{includedir}/edX-k8s.asciidoc[]
|
||||
|
||||
== Sources ==
|
||||
|
||||
include::{includedir}/sources.asciidoc[]
|
||||
|
Reference in New Issue
Block a user