From 00a73b90f87360d068850f3dedbc817544cb0a23 Mon Sep 17 00:00:00 2001 From: Scott Murray <scott@murray.kiwi> Date: Sat, 23 Dec 2023 13:33:52 +1300 Subject: [PATCH] document cluster outputs for integrating with other providers --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index d86e143..d531db0 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,29 @@ You can use `minikube` to verify the cluster is up & running |----------------------------------------|-----------|---------|---------------|------|---------|---------|-------| ``` +## Outputs + +In order to integrate the minikube providers with other k8s providers, you can reference the following outputs + +- `client_certificate` (string, sensitive) client certificate used in cluster +- `client_key` (string, sensitive) client key for cluster +- `cluster_ca_certificate` (string, sensitive) certificate authority for cluster +- `host` (string) the host name for the cluster + +These outputs are consistent across supported by all minikube cluster types + +i.e. + +```terraform +provider "kubernetes" { + host = minikube_cluster.cluster.host + + client_certificate = minikube_cluster.cluster.client_certificate + client_key = minikube_cluster.cluster.client_key + cluster_ca_certificate = minikube_cluster.cluster.cluster_ca_certificate +} +``` + ## Want to help out? See [the contributing doc](./contributing.md) if you wish to get into the details of this terraform minikube provider!