Skip to content

Commit

Permalink
[WIP] Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
timebertt committed Nov 22, 2023
1 parent 6ed4da7 commit 8a5cbab
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 10 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Kubernetes Controller Sharding

_Towards Horizontally Scalable Kubernetes Controllers_
_Horizontally Scalable Kubernetes Controllers_

## About

This study project is part of my master's studies in Computer Science at the [DHBW Center for Advanced Studies](https://www.cas.dhbw.de/) (CAS).
I started this project as part of my Master's studies in Computer Science at the [DHBW Center for Advanced Studies](https://www.cas.dhbw.de/) (CAS).
I completed a study project ("half-time thesis") about this topic. I'm currently working on my Master's thesis to evolve the project based on the first iteration.

You can download and read the full thesis belonging to this implementation here: [thesis-controller-sharding](https://github.com/timebertt/thesis-controller-sharding).
This repository contains the practical part of the thesis: a sample operator using the sharding implementation, a full monitoring setup, and some tools for demonstration and evaluation purposes.
- download and read the study project (first paper) here: [thesis-controller-sharding](https://github.com/timebertt/thesis-controller-sharding)
- download and read the Master's thesis (second paper) here (work in progress): [masters-thesis-controller-sharding](https://github.com/timebertt/masters-thesis-controller-sharding)

The controller sharding implementation itself is done generically in [controller-runtime](https://github.com/kubernetes-sigs/controller-runtime).
It is currently located in the `sharding` branch of my fork: https://github.com/timebertt/controller-runtime/tree/sharding.
This repository contains the practical part of the scientific work: the actual sharding implementation, a sample operator using the sharding implementation, a full monitoring setup, and some tools for demonstration and evaluation purposes.

## TL;DR

Expand Down
5 changes: 1 addition & 4 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,7 @@ To experience how they work, the webhosting-operator is deployed in the followin
While webhosting-operator is developed in the same repository, it only serves as an example.
Sharding support can be implemented in any other controller and programming language as well, so that it works well with the sharding components from this project.

> [!NOTE]
> The external sharding components are work in progress.
> While the following steps also deploy the new sharding components, they are not activated for now (no `ClusterRing` object is created).
> Instead, the existing sharding implementation in controller-runtime embedded in webhosting-operator is used.
TODO: document dummy shard implementation

## Quick Start

Expand Down

0 comments on commit 8a5cbab

Please sign in to comment.