Skip to content

Commit 2857966

Browse files
add description info to tf readme files
1 parent 672d42f commit 2857966

File tree

2 files changed

+31
-3
lines changed

2 files changed

+31
-3
lines changed

docs/index.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,37 @@ description: |-
1010

1111
A terraform provider for [minikube!](https://minikube.sigs.k8s.io/docs/)
1212

13+
## Installing your preferred driver
14+
15+
If you don't have minikube installed, or have never run minikube before, you'll need to install your corresponding driver first
16+
17+
This requires _admin_ permissions
18+
19+
### Minikube
20+
21+
```bash
22+
minikube --vm=true --driver=hyperkit --download-only
23+
minikube --driver=docker --download-only
24+
```
25+
26+
### Manual
27+
28+
You can find the drivers published in the [minikube releases section](https://github.com/kubernetes/minikube/releases). Simply download the
29+
preferred driver and copy it to your .minikube/bin folder and ensure the current user has sufficient access
30+
31+
### Living dangerously
32+
33+
```bash
34+
#x85_64
35+
curl https://raw.githubusercontent.com/scott-the-programmer/terraform-provider-minikube/main/bootstrap/install-driver.sh | sudo bash -s "kvm1"
36+
37+
#arm63
38+
curl https://raw.githubusercontent.com/scott-the-programmer/terraform-provider-minikube/main/bootstrap/install-driver.sh | sudo bash -s "kvm1" "arm64"
39+
```
40+
1341
## Example Usage
1442

1543
```terraform
1644
provider "minikube" {}
1745
```
1846

19-
<!-- schema generated by tfplugindocs -->
20-
## Schema

docs/resources/cluster.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ description: |-
88

99
# minikube_cluster (Resource)
1010

11-
Used to create a minikube cluster on the current host
11+
Used to create a minikube cluster on the current host. You'll need to have a docker driver installed first (see the provider docs).
12+
13+
You'll be able to spin up and manage clusters exclusively with terraform, mimicking the process of using a cloud managed k8s cluster such as AKS / EKS / LKS
1214

1315
## Example Usage
1416

0 commit comments

Comments
 (0)