compliantkubernetes
compliantkubernetes copied to clipboard
Documentation for the Compliant Kubernetes project
Compliant Kubernetes Documentation
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.
Prerequisites
pip3 install -r requirements.txt
For generating figures, please install:
sudo apt-get install graphviz make
Usage
- To view locally:
mkdocs 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
.
Tech Stack
Deployment
GitHub Actions will deploy the main
branch automatically.