From ecea1547352dde428d5a890e9dccccdb4a092308 Mon Sep 17 00:00:00 2001 From: iwilltry42 Date: Mon, 4 May 2020 18:27:35 +0200 Subject: [PATCH] docs: add website link --- README.md | 31 +++++++++---------------------- cmd/root.go | 5 +++-- 2 files changed, 12 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 03d2edc1..479ce733 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,14 @@ -# k3d +# [k3d](https://k3d.io) [![Build Status](https://travis-ci.com/rancher/k3d.svg?branch=master)](https://travis-ci.com/rancher/k3d) [![Go Report Card](https://goreportcard.com/badge/github.com/rancher/k3d)](https://goreportcard.com/report/github.com/rancher/k3d) -## k3s in docker +## [k3s in docker](https://k3d.io) k3s is the lightweight Kubernetes distribution by Rancher: [rancher/k3s](https://github.com/rancher/k3s) k3d creates containerized k3s clusters. This means, that you can spin up a multi-node k3s cluster on a single machine using docker. -This repository is based on [@zeerorg](https://github.com/zeerorg/)'s [zeerorg/k3s-in-docker](https://github.com/zeerorg/k3s-in-docker), reimplemented in Go by [@iwilltry42](https://github.com/iwilltry42/) in [iwilltry42/k3d](https://github.com/iwilltry42/k3d), which got adopted by Rancher in[rancher/k3d](https://github.com/rancher/k3d). - ## Requirements - [docker](https://docs.docker.com/install/) @@ -40,32 +38,21 @@ or... ## Usage -Check out what you can do via `k3d help` +Check out what you can do via `k3d help` or check the docs @ [k3d.io](https://k3d.io) Example Workflow: Create a new cluster and use it with `kubectl` 1. `k3d create cluster CLUSTER_NAME` to create a new single-node cluster (= 1 container running k3s) -2. `export KUBECONFIG=$(k3d get kubeconfig CLUSTER_NAME)` to make `kubectl` to use the kubeconfig for that cluster +2. `k3d get kubeconfig CLUSTER_NAME --switch` to update your default kubeconfig and switch the current-context to the new one 3. execute some commands like `kubectl get pods --all-namespaces` 4. `k3d delete cluster CLUSTER_NAME` 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? - -### More Information - -- [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) - -### Connect +## Connect 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 + +## History + +This repository is based on [@zeerorg](https://github.com/zeerorg/)'s [zeerorg/k3s-in-docker](https://github.com/zeerorg/k3s-in-docker), reimplemented in Go by [@iwilltry42](https://github.com/iwilltry42/) in [iwilltry42/k3d](https://github.com/iwilltry42/k3d), which got adopted by Rancher in[rancher/k3d](https://github.com/rancher/k3d). diff --git a/cmd/root.go b/cmd/root.go index 06a2b7f7..c1eb8122 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -57,8 +57,9 @@ var flags = RootFlags{} // rootCmd represents the base command when called without any subcommands var rootCmd = &cobra.Command{ Use: "k3d", - Short: "Run k3s in Docker!", - Long: `k3d is a wrapper CLI that helps you to easily create k3s clusters inside docker. + Short: "https://k3d.io/ -> Run k3s in Docker!", + Long: `https://k3d.io/ +k3d is a wrapper CLI that helps you to easily create k3s clusters inside docker. Nodes of a k3d cluster are docker containers running a k3s image. All Nodes of a k3d cluster are part of the same docker network.`, }