Skip to content

Commit b63067e

Browse files
amend docs with project goal
1 parent 3372b56 commit b63067e

File tree

3 files changed

+19
-5
lines changed

3 files changed

+19
-5
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@
22

33
<a href="https://codeclimate.com/github/scott-the-programmer/terraform-provider-minikube/maintainability"><img src="https://api.codeclimate.com/v1/badges/dd45aac40e7019502245/maintainability" /></a>
44

5-
*CURRENTLY IN PROGRESS*
6-
75
A terraform provider for [minikube!](https://minikube.sigs.k8s.io/docs/)
86

7+
The goal of this project is to allow developers to create minikube clusters and integrate it with common kubernetes terraform providers such as [hashicorp/kubernetes](https://registry.terraform.io/providers/hashicorp/kubernetes/2.12.1) and [hashicorp/helm](https://registry.terraform.io/providers/hashicorp/helm/2.6.0) all within the comfort of Minikube!
8+
9+
You can learn more about how to use the provider at https://registry.terraform.io/providers/scott-the-programmer/minikube/latest/docs
10+
911
## Installing your preferred driver
1012

1113
If you don't have minikube installed, or have never run minikube before, you'll need to install your corresponding driver first
@@ -25,7 +27,7 @@ minikube --driver=docker --download-only
2527
You can find the drivers published in the [minikube releases section](https://github.com/kubernetes/minikube/releases). Simply download the
2628
preferred driver and copy it to your .minikube/bin folder and ensure the current user has sufficient access
2729

28-
### Living dangerously
30+
### Living dangerously (discouraged)
2931

3032
```bash
3133
#x86_64

docs/index.md

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

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

11+
The goal of this project is to allow developers to create minikube clusters and integrate it with common kubernetes terraform providers such as [hashicorp/kubernetes](https://registry.terraform.io/providers/hashicorp/kubernetes/2.12.1) and [hashicorp/helm](https://registry.terraform.io/providers/hashicorp/helm/2.6.0) all within the comfort of Minikube!
12+
1113
## Installing your preferred driver
1214

1315
If you don't have minikube installed, or have never run minikube before, you'll need to install your corresponding driver first
@@ -26,7 +28,11 @@ minikube --driver=docker --download-only
2628
You can find the drivers published in the [minikube releases section](https://github.com/kubernetes/minikube/releases). Simply download the
2729
preferred driver and copy it to your .minikube/bin folder and ensure the current user has sufficient access
2830

29-
### Living dangerously
31+
### Automatic Install (discouraged)
32+
33+
You can invoke a simple bootstrap script called [install-driver.sh](https://github.com/scott-the-programmer/terraform-provider-minikube/blob/main/bootstrap/install-driver.sh)
34+
35+
Please review the script contents running
3036

3137
```bash
3238
#x86_64

templates/index.md.tmpl

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

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

11+
The goal of this project is to allow developers to create minikube clusters and integrate it with common kubernetes terraform providers such as [hashicorp/kubernetes](https://registry.terraform.io/providers/hashicorp/kubernetes/2.12.1) and [hashicorp/helm](https://registry.terraform.io/providers/hashicorp/helm/2.6.0) all within the comfort of Minikube!
12+
1113
## Installing your preferred driver
1214

1315
If you don't have minikube installed, or have never run minikube before, you'll need to install your corresponding driver first
@@ -26,7 +28,11 @@ minikube --driver=docker --download-only
2628
You can find the drivers published in the [minikube releases section](https://github.com/kubernetes/minikube/releases). Simply download the
2729
preferred driver and copy it to your .minikube/bin folder and ensure the current user has sufficient access
2830

29-
### Living dangerously
31+
### Automatic Install (discouraged)
32+
33+
You can invoke a simple bootstrap script called [install-driver.sh](https://github.com/scott-the-programmer/terraform-provider-minikube/blob/main/bootstrap/install-driver.sh)
34+
35+
Please review the script contents running
3036

3137
```bash
3238
#x86_64

0 commit comments

Comments
 (0)