From b3687582efd60b983fbcd02913bc4f71752fca58 Mon Sep 17 00:00:00 2001 From: Philip Schmid Date: Thu, 2 Nov 2023 08:49:59 +0100 Subject: [PATCH] Added usage example Signed-off-by: Philip Schmid --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index cbcf360..25b41f0 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,29 @@ An opinionated Terraform module that can be used to install and manage Tetragon on top of a Kubernetes cluster. +## Example Usage +```hcl +module "tetragon" { + source = "git::ssh://git@github.com:isovalent/terraform-k8s-tetragon.git?ref=" + + # Wait until Cilium CNI is done. + depends_on = [ + module.cilium + ] + + tetragon_helm_release_name = "tetragon" + tetragon_helm_values_file_path = var.tetragon_helm_values_file_path + tetragon_helm_version = var.tetragon_helm_version + tetragon_helm_chart = var.tetragon_helm_chart + tetragon_namespace = var.tetragon_namespace + path_to_kubeconfig_file = module.kubeadm_cluster.path_to_kubeconfig_file + tetragon_helm_values_override_file_path = var.tetragon_helm_values_override_file + post_tetragon_install_script = file("${path.module}/scripts/post-tetragon-install-script.sh") + extra_provisioner_environment_variables = local.extra_provisioner_environment_variables +} +``` + +## Terraform Module Doc ### Requirements