From 9654027a6bd940ed818cd1f3b00477ee0d9c3a27 Mon Sep 17 00:00:00 2001 From: iwilltry42 Date: Sun, 26 Apr 2020 19:52:26 +0200 Subject: [PATCH] init mkdocs --- README.md | 3 ++- docs/commands.md | 25 +++++++++++++++++++++++++ docs/{documentation.md => defaults.md} | 6 +----- docs/index.md | 25 +++++++++++++++++++++++++ mkdocs.yml | 22 ++++++++++++++++++++++ 5 files changed, 75 insertions(+), 6 deletions(-) create mode 100644 docs/commands.md rename docs/{documentation.md => defaults.md} (94%) create mode 100644 docs/index.md create mode 100644 mkdocs.yml diff --git a/README.md b/README.md index 77d81317..03d2edc1 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,8 @@ Check out the [examples here](docs/examples.md). ### More Information -- [Further documentation](docs/documentation.md) +- [Command Tree](docs/commands.md) +- [Default Behavior](docs/defaults.md) - [Usage examples](docs/examples.md) - [Frequently asked questions and nice-to-know facts](docs/faq.md) - [Design/Architecture Thoughts, Plans, Unsorted Ideas and more](thoughts.md) diff --git a/docs/commands.md b/docs/commands.md new file mode 100644 index 00000000..127c7df7 --- /dev/null +++ b/docs/commands.md @@ -0,0 +1,25 @@ +# Command Tree + +```bash +k3d + create + cluster CLUSTERNAME + node NODENAME + delete + cluster CLUSTERNAME + node + start + cluster CLUSTERNAME + node + stop + cluster CLUSTERNAME + node + get + cluster CLUSTERNAME + node + kubeconfig CLUSTERNAME + load + completion + version + help +``` diff --git a/docs/documentation.md b/docs/defaults.md similarity index 94% rename from docs/documentation.md rename to docs/defaults.md index ffbbd170..482b18ca 100644 --- a/docs/documentation.md +++ b/docs/defaults.md @@ -1,8 +1,4 @@ -# Documentation - -## Functionality - -### Defaults +# Defaults * multiple master nodes * by default, when `--master` > 1 and no `--datastore-x` option is set, the first master node (master-0) will be the initializing master node diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..d2e9bf05 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,25 @@ +# k3d + +k3d is a lightweight wrapper to run k3s (Rancher Lab's minimal Kubernetes distribution) in docker. + +k3d makes it very easy to create single- and multi-node k3s clusters in docker, e.g. for local development on Kubernetes. + +## Quick Start + +Create a cluster named `mycluster` with just a single master node: + +```bash +k3d create cluster mycluster +``` + +Get the new cluster's connection details merged into your default kubeconfig (usually specified using the `KUBECONFIG` environment variable or the default path `$HOME/.kube/config`) and directly switch to the new context: + +```bash +k3d get kubeconfig mycluster --switch +``` + +Use the new cluster with [`kubectl`](https://kubernetes.io/docs/tasks/tools/install-kubectl/), e.g.: + +```bash +kubectl get nodes +``` diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..2db52beb --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,22 @@ +# Project information +site_name: k3d +site_description: Little helper to run Rancher Lab's k3s in Docker +site_url: https://k3d.io/ + +copyright: "Copyright © 2020 k3d Authors" + +# Repo Information +repo_url: https://github.com/rancher/k3d +strict: True + +# Theme +theme: + name: material + +# Navigation +nav: + - Overview: index.md + - Command Tree: commands.md + - Defaults: defaults.md + - Examples: examples.md + - FAQ: faq.md