diff --git a/docs/.pages b/docs/.pages index f7bc630e..02ccfe90 100644 --- a/docs/.pages +++ b/docs/.pages @@ -1,5 +1,5 @@ arrange: - index.md - - commands.md - - defaults.md - - faq.md \ No newline at end of file + - usage + - internals + - faq \ No newline at end of file diff --git a/docs/faq/.pages b/docs/faq/.pages new file mode 100644 index 00000000..e42573fe --- /dev/null +++ b/docs/faq/.pages @@ -0,0 +1,3 @@ +title: FAQ +arrange: + - faq.md \ No newline at end of file diff --git a/docs/faq.md b/docs/faq/faq.md similarity index 100% rename from docs/faq.md rename to docs/faq/faq.md diff --git a/docs/internals/.pages b/docs/internals/.pages new file mode 100644 index 00000000..91ea14b8 --- /dev/null +++ b/docs/internals/.pages @@ -0,0 +1,4 @@ +title: Internals +arrange: + - defaults.md + - networking.md \ No newline at end of file diff --git a/docs/defaults.md b/docs/internals/defaults.md similarity index 100% rename from docs/defaults.md rename to docs/internals/defaults.md diff --git a/docs/internals/networking.md b/docs/internals/networking.md new file mode 100644 index 00000000..690f5d65 --- /dev/null +++ b/docs/internals/networking.md @@ -0,0 +1,28 @@ +# Networking + +- Related issues: + - [rancher/k3d #220](https://github.com/rancher/k3d/issues/220) + +## Introduction + +By default, k3d creates a new (docker) network for every new cluster. +Using the `--network STRING` flag upon creation to connect to an existing network. +Existing networks won't be managed by k3d together with the cluster lifecycle. + +## Connecting to docker "internal"/pre-defined networks + +### `host` network + +When using the `--network` flag to connect to the host network (i.e. `k3d create cluster --network host`), +you won't be able to create more than **one master node**. +An edge case would be one master node (with agent disabled) and one worker node. + +### `bridge` network + +By default, every network that k3d creates is working in `bridge` mode. +But when you try to use `--network bridge` to connect to docker's internal `bridge` network, you may +run into issues with grabbing certificates from the API-Server. Single-Node clusters should work though. + +### `none` "network" + +Well.. this doesn't really make sense for k3d anyway ¯\_(ツ)_/¯ diff --git a/docs/usage/.pages b/docs/usage/.pages new file mode 100644 index 00000000..038b94c2 --- /dev/null +++ b/docs/usage/.pages @@ -0,0 +1,4 @@ +title: Usage +arrange: + - commands.md + - guides \ No newline at end of file diff --git a/docs/commands.md b/docs/usage/commands.md similarity index 100% rename from docs/commands.md rename to docs/usage/commands.md diff --git a/docs/examples/.pages b/docs/usage/guides/.pages similarity index 76% rename from docs/examples/.pages rename to docs/usage/guides/.pages index 06f50571..586db808 100644 --- a/docs/examples/.pages +++ b/docs/usage/guides/.pages @@ -1,4 +1,4 @@ -title: Examples +title: Guides arrange: - exposing_services.md - registries.md \ No newline at end of file diff --git a/docs/examples/exposing_services.md b/docs/usage/guides/exposing_services.md similarity index 100% rename from docs/examples/exposing_services.md rename to docs/usage/guides/exposing_services.md diff --git a/docs/examples/registries.md b/docs/usage/guides/registries.md similarity index 100% rename from docs/examples/registries.md rename to docs/usage/guides/registries.md