added edX documentation

This commit is contained in:
Elmar Kresse
2024-07-22 14:59:03 +02:00
parent 6aaa02afff
commit d56772616f
5 changed files with 224 additions and 5 deletions

4
README.asciidoc Normal file
View File

@ -0,0 +1,4 @@
:doctype: book
ifndef::imagesdir[:imagesdir: ./doku/media]
include::./doku/main.asciidoc[]

View File

@ -0,0 +1,19 @@
// image base directory::media/
ifndef::imagesdir[:imagesdir: ../media]
=== Kubernetes Cluster Setup for edX
This document describes the steps to set up a Kubernetes cluster for hosting the edX platform. Kubernetes is an open-source container orchestration platform that automates the deployment, scaling, and management of containerized applications.
The repository with all informations and the helm charts is available at link:https://github.com/openedx/openedx-k8s-harmony[openedx/openedx-k8s-harmony].
In particular, this project aims to provide the following benefits to Open edX operators:
* Ease of use and rapid deployment: This project aims to provide an Open edX hosting environment that just works out of the box, that can be easily upgraded, and that follows best practices for monitoring, security, etc.
* Lower costs by sharing resources where it makes sense. For example, by default Tutor's k8s feature will deploy a separate load balancer and ingress controller for each Open edX instance, instead of a shared ingress controller for all the instances in the cluster. Likewise for MySQL, MongoDB, ElasticSearch, and other resources. By using shared resources by default, costs can be dramatically reduced and operational monitoring and maintenance is greatly simplified.
** For setups with many small instances, this shared approach provides a huge cost savings with virtually no decrease in performance.
** For larger instances on the cluster that need dedicated resources, they can easily be configured to do so.
* Scalable hosting for instances of any size. This means for example that the default configuration includes autoscaling of LMS pods to handle increased traffic.
* Flexibility: this project aims to be "batteries included" and to support setting up all the resources that you need, with useful default configurations, but it is carefully designed so that operators can configure, replace, or disable any components as needed.
image:edX-k8s.drawio.svg[edX-K8s Deployment,align=center]

View File

@ -1,3 +1,6 @@
// image base directory::media/
ifndef::imagesdir[:imagesdir: ../media]
### Allgemeine Informationen zur Open-Source-Lernplattform edX
**Gründung und Geschichte:**
@ -28,7 +31,7 @@ edX wurde im Jahr 2012 von der Harvard University und dem Massachusetts Institut
- **APIs:** Umfangreiche RESTful APIs zur Integration und Erweiterung der Plattform.
- **Scalability:** Nutzung von Cloud-Diensten zur Skalierung und Verwaltung von Benutzerlasten.
image::../media/edx-architecture.png[edX-Architektur]
image::edx-architecture.png[edX-Architektur]
Hauptkomponenten:

View File

@ -1,9 +1,16 @@
# CodeContender
:author: Christoph Walther, Elmar Kresse
:toc: left
:toc-title: Table of Contents
:sectnums:
:toclevels: 2
:data-uri:
ifndef::imagesdir[:imagesdir: ./media]
= CodeContender
CodeContender is a platform for learning and practicing coding. It is a web application that provides a set of coding courses with diffrend tasks and questions. Content is divided into different categories and levels. Users get information in form of text, images, and videos. They can also practice coding in an online code editor. The platform is designed to be user-friendly and easy to use. It is suitable for beginners as well as advanced users.
Goal after finishing a course is to pass a final test and get a certificate.
## Problem Analysis
== Problem Analysis
Software Setup:
* is a cluster already running wtih the required software? (e.g. docker, kubernetes, etc.)
@ -13,7 +20,7 @@ Software Setup:
* Configuration files for the cluster
### Requirements
=== Requirements
* Authentication, Authorization, User Management
@ -61,7 +68,7 @@ Software Setup:
## Architecture
image::media/codeContender.png[]
image::codeContender.png[]
### Components
@ -102,3 +109,12 @@ Repositorys need to be secured and limited in size. That users can't upload larg
## Existing Solutions
include::content/existing_solutions.asciidoc[]
## edX Platform
include::content/edx.asciidoc[]
### edX Kubernetes Deployment
include::content/edx-k8s.asciidoc[]

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 211 KiB