From 2ea2ece9da9137375eb9b5c18a327d46ab6fdfde Mon Sep 17 00:00:00 2001 From: Roi Kramer Date: Sun, 25 Feb 2024 12:00:36 +0200 Subject: [PATCH] test --- .github/workflows/terraform_docs.yml | 1 + .terraform-docs.yml | 51 ------------------------ README.md | 2 + example/values-file-installation/main.tf | 1 + 4 files changed, 4 insertions(+), 51 deletions(-) delete mode 100644 .terraform-docs.yml diff --git a/.github/workflows/terraform_docs.yml b/.github/workflows/terraform_docs.yml index 05abfb9..92dbec2 100644 --- a/.github/workflows/terraform_docs.yml +++ b/.github/workflows/terraform_docs.yml @@ -17,4 +17,5 @@ jobs: working-dir: . output-file: README.md output-method: inject + config-file: .terraform-docs.yml git-push: "true" diff --git a/.terraform-docs.yml b/.terraform-docs.yml deleted file mode 100644 index a0a51f3..0000000 --- a/.terraform-docs.yml +++ /dev/null @@ -1,51 +0,0 @@ -content: |- - # Spot Ocean Kubernetes Controller Terraform Module - - A Terraform module to install the Ocean Controller on Kubernetes. - - ## Usage - - ```hcl - module "ocean-kubernetes-controller" { - source = "spotinst/ocean-kubernetes-controller/spotinst" - - # Credentials. - spotinst_token = var.spotinst_token - spotinst_account = var.spotinst_account - - # Configuration. - cluster_identifier = var.cluster_identifier - } - ``` - - ## Examples - - - [Backwards Compatible Installation](https://github.com/spotinst/terraform-ocean-kubernetes-controller/tree/main/example/backwards-compatible-installation) - - [Values File Installation](https://github.com/spotinst/terraform-spotinst-ocean-controller/tree/main/example/values-file-installation) - - {{ .Content }} - - ## Documentation - - If you're new to [Spot](https://spot.io/) and want to get started, please checkout our [Getting Started](https://docs.spot.io/connect-your-cloud-provider/) guide, available on the [Spot Documentation](https://docs.spot.io/) website. - - ## Getting Help - - We use GitHub issues for tracking bugs and feature requests. Please use these community resources for getting help: - - - Ask a question on [Stack Overflow](https://stackoverflow.com/) and tag it with [terraform-spotinst](https://stackoverflow.com/questions/tagged/terraform-spotinst/). - - Join our [Spot](https://spot.io/) community on [Slack](http://slack.spot.io/). - - Open an issue. - - ## Community - - - [Slack](http://slack.spot.io/) - - [Twitter](https://twitter.com/spot_hq/) - - ## Contributing - - Please see the [contribution guidelines](.github/CONTRIBUTING.md). - - ## License - - Code is licensed under the [Apache License 2.0](LICENSE). diff --git a/README.md b/README.md index 920c4f9..d3aadc4 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,7 @@ module "ocean-kubernetes-controller" { - [Backwards Compatible Installation](https://github.com/spotinst/terraform-ocean-kubernetes-controller/tree/main/example/backwards-compatible-installation) - [Values File Installation](https://github.com/spotinst/terraform-spotinst-ocean-controller/tree/main/example/values-file-installation) + ## Requirements | Name | Version | @@ -79,6 +80,7 @@ No modules. ## Outputs No outputs. + ## Documentation diff --git a/example/values-file-installation/main.tf b/example/values-file-installation/main.tf index 6b281b3..6b8ceb7 100644 --- a/example/values-file-installation/main.tf +++ b/example/values-file-installation/main.tf @@ -10,4 +10,5 @@ module "ocean_controller" { release_name = "test-terraform" values_file = "./values.yaml" + }