Skip to content

Commit

Permalink
amend docs with project goal
Browse files Browse the repository at this point in the history
  • Loading branch information
scott-the-programmer committed Aug 17, 2022
1 parent 3372b56 commit b63067e
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 5 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@

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

*CURRENTLY IN PROGRESS*

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

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!

You can learn more about how to use the provider at https://registry.terraform.io/providers/scott-the-programmer/minikube/latest/docs

## Installing your preferred driver

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

### Living dangerously
### Living dangerously (discouraged)

```bash
#x86_64
Expand Down
8 changes: 7 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ description: |-

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

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!

## Installing your preferred driver

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

### Living dangerously
### Automatic Install (discouraged)

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)

Please review the script contents running

```bash
#x86_64
Expand Down
8 changes: 7 additions & 1 deletion templates/index.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ description: |-

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

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!

## Installing your preferred driver

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

### Living dangerously
### Automatic Install (discouraged)

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)

Please review the script contents running

```bash
#x86_64
Expand Down

0 comments on commit b63067e

Please sign in to comment.