This is the main repository for documentation about the Compliant Kubernetes project. For Compliant Kubernetes 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.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
[!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 restartmike serve
after every file change, which is not really productive
mike deploy compliantkubernetes ck8s -t 'main'
and then mike serve
.make -C docs/img
. For simplicity, please commit generated figures. Prefer PNG (width == 1200px), to facilitate embedded logos.make -C docs/img preview
.docs/stylesheets/style.css
, please use sass extra_sass/style.css.scss > docs/stylesheets/style.css
.GitHub Actions will deploy the main
branch automatically.