docs: add installation section to homepage

pull/212/head
iwilltry42 4 years ago
parent de9ee91083
commit 48b8e6801a
No known key found for this signature in database
GPG Key ID: 7BA57AD1CFF16110
  1. 9
      docs/index.md
  2. 2
      thoughts.md

@ -4,6 +4,15 @@ k3d is a lightweight wrapper to run [k3s](https://github.com/rancher/k3s) (Ranch
k3d makes it very easy to create single- and multi-node [k3s](https://github.com/rancher/k3s) clusters in docker, e.g. for local development on Kubernetes.
## Installation
- Install via brew (homebrew/linuxbrew): `brew install k3d`
- Install via script:
- wget: `wget -q -O - https://raw.githubusercontent.com/rancher/k3d/master/install.sh | bash`
- curl: `curl -s https://raw.githubusercontent.com/rancher/k3d/master/install.sh | bash`
- Grab a release from the [release tab](https://github.com/rancher/k3d/releases) and install it yourself.
- Get via go: `go install github.com/rancher/k3d` (**Note**: this will give you unreleased/bleeding-edge changes)
## Quick Start
Create a cluster named `mycluster` with just a single master node:

@ -108,7 +108,7 @@
- list -> dropped, implemented as `k3d get clusters`
- get-kubeconfig -> `k3d get kubeconfig CLUSTERNAME`
- --name -> dropped, implemented as arg
- --all -> planned
- --all -> implemented
- --overwrite -> implemented
- import-images -> `k3d load image [--cluster CLUSTERNAME] [--keep] IMAGES`
- --name -> implemented as `--cluster`

Loading…
Cancel
Save