Welkin Documentation

This is the main repository for documentation about the Welkin project. For Welkin code, please refer to:

• compliantkubernetes-kubespray for setting up a vanilla Kubernetes cluster on top of a compliant cloud provider;
• compliantkubernetes-apps for augmenting a vanilla Kubernetes cluster with security and observability.

Prerequisites

Python 3. You can check that it is already present on your Linux/macOS as follows:

python3 --version

For generating figures, please install:

sudo apt-get install graphviz make

For generating docs/stylesheets/style.css, please install:

npm install -g sass

Usage

Note

For Mac users, you might have to install cairo: brew install cairo

To view locally:

python3 -m venv .venv
source .venv/bin/activate
pip3 install -r requirements.txt

mkdocs serve

Caution

The command mike serve also works to preview a page, but it does not seem to support live preview. This means that you need to restart mike serve after every file change, which is not really productive

• To view locally: mike deploy welkin -t 'main' and then mike serve.
• To re-generate figures: make -C docs/img. For simplicity, please commit generated figures. Prefer PNG (width == 1200px), to facilitate embedded logos.
• For continuous preview of figures: make -C docs/img preview.
• To generate docs/stylesheets/style.css, please use sass extra_sass/style.css.scss > docs/stylesheets/style.css.

Tech Stack

• mkdocs
• mkdocs-material
• GitHub Pages
• Graphviz
• mike
• sass

Deployment

GitHub Actions will deploy the main branch automatically.