From 7f87e04ecfac04c0a1c096bd480f0976723d6c88 Mon Sep 17 00:00:00 2001 From: iwilltry42 Date: Tue, 9 Jul 2019 11:14:36 +0200 Subject: [PATCH] update README --- README.md | 7 ++++++- docs/documentation.md | 4 ++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2bbedcfc..61304219 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,11 @@ Example Workflow: Create a new cluster and use it with `kubectl` 3. execute some commands like `kubectl get pods --all-namespaces` 4. `k3d delete` to delete the default cluster +### Exposing Services + +If you want to access your services from the outside (e.g. via Ingress), you need to map the ports (e.g. port 80 for Ingress) using the `--publish` flag (or aliases). +Check out the [examples here](docs/examples.md). + ## What now? Find more details under the following Links: @@ -58,4 +63,4 @@ Find more details under the following Links: 1. Join the Rancher community on slack via [slack.rancher.io](https://slack.rancher.io/) 2. Go to [rancher-users.slack.com](https://rancher-users.slack.com) and join our channel #k3d -3. Start chatting \ No newline at end of file +3. Start chatting diff --git a/docs/documentation.md b/docs/documentation.md index 13e6f28b..4ab6b72b 100644 --- a/docs/documentation.md +++ b/docs/documentation.md @@ -5,6 +5,7 @@ ```shell COMMANDS: check-tools, ct Check if docker is running + shell Start a subshell for a cluster create, c Create a single- or multi-node k3s cluster in docker containers delete, d, del Delete cluster stop Stop cluster @@ -19,7 +20,6 @@ GLOBAL OPTIONS: --version, -v print the version ``` - ## Compatibility with `k3s` functionality/options -... under construction ... \ No newline at end of file +... under construction ...