diff --git a/01_networking/.terraform.lock.hcl b/01_networking/.terraform.lock.hcl index f48a2857..ef93af7e 100644 --- a/01_networking/.terraform.lock.hcl +++ b/01_networking/.terraform.lock.hcl @@ -32,37 +32,37 @@ provider "registry.terraform.io/hashicorp/null" { } provider "registry.terraform.io/oracle/oci" { - version = "6.25.0" - constraints = "6.25.0" + version = "6.26.0" + constraints = "6.26.0" hashes = [ - "h1:36jsalGcahABMlTHHnainyzxtWJB2UyRugBM7tVUKCs=", - "h1:438zbeb7zGbDKdf/zwaEajTpT4P6eZB0H79ZRj3q6Dw=", - "h1:7BIuk7roneNwFuFq9ITHHABv+T9f6fSgMAdvZC2Jgvc=", - "h1:NJqffhMNVUna62UcpHNO+MoEE3IZjYPk1DibSj5jcLE=", - "h1:OaWCgQfO5h/BJQpXmxdiLTrG9G5HfznBBI1MAYsTa9w=", - "h1:RpKrycLA0HUmYfE7o/D2ZzkNrN3gJjQ1oJyKocWgpz0=", - "h1:b9+boRGD854WWEsLBV3JpL2nbASTanYhfg/bQVFLIIM=", - "h1:cp0NwblK4WCSf06SPnfrs3IM9qoaRjsdHNMgrHwF2Ss=", - "h1:hnma57PpeF65LgV7bCyedmUkusG10VJDtGJnYb7NUiw=", - "h1:oxKX3PMpbyu2RPfezoFcJYxj9LEFW7q7gso5OEin/Zk=", - "h1:qHo92wXj5KIXHgzAd46vwvcQCHjBeEuz5uyafrdowfE=", - "h1:sBdxss3lEXCgP+HWSD82Hk1WK2a/kaZjHJoNJannZ8g=", - "h1:vBIEKY+Zcq6oe7Fyo0ivLe2GPmPXRev2nV3k2v5lRLM=", - "h1:vmYCKr/FXfrPOqCpm9EV9sO8dnUixwhfw/um+SIak0I=", - "zh:025a70306d8e64d9ca2b80403c6c3a66fbace10b0b14da152f847f8af39d2519", - "zh:1fc947735f2a5332d6fb0c15d54f010e6ba4077e030e8b8a3cb637c179c8a895", - "zh:3190adf0b76dba13b830a9d3de081bfea73e72a9e6142937df9e51a48abc8613", - "zh:3e0821e4d1505845c69738a539628d623c5785075fa77f0ce12b50bbebb19796", - "zh:42cce6c6f96103e37d78eecac10fa672533f24a9ef520d9ad47bc02b0c100c79", - "zh:435110feea29b44e1d47e5fd1f28811e59d2ca26f3e8c12e94e065977ed741a1", - "zh:48527d6fcf9d43c3e177d230d57ecbe56da9ef00b75d89d01dab84ed4ce3b7df", - "zh:660a292819f96a3aad55303dcea9360984735d112614074f0972fd8f5fae62fe", - "zh:6b680f1a745c33e90c491069e5b6495657765649e0ec0714ad03ecdd124c4f06", - "zh:7ef39b9f45dcbb3e0cb9200e906d2c9474863079d52d2d3beda814a1c30759f2", + "h1:4foHJdMh+0GvC/ihJ6a+w4MFRXs/YRbzbCP80TJTNBc=", + "h1:7RGXkdZod58flQ7EkZBUOXGuphMKe34tL+w90XsJwRA=", + "h1:BN+G2PylovCTR9SLm5pVKjaORZiBtX3k6dZhziLt9SQ=", + "h1:EQPmx6wlCMgAOjhAJzSJIuQW5mkUlOrdWmgnjBhjxys=", + "h1:Iu9cr+xusfqiT+17oyyCQuhCH2KdKoHyy+Xa/fjBSWk=", + "h1:LPSGm2gxQ1G2BALuCCTHSGE24YPOCcf9tAKft9KmYCA=", + "h1:P8/Rp9PqEYDg4ceiiktsIveE5ivCvD+WeZPDIK3kSVA=", + "h1:PJAp5OhQx/4QYJhW8cwX3H7VenYM8PL9hzvfIiIu/g4=", + "h1:Qqp3Z7AA0sG5/KUJWz16vBqW3oire6VT0MwViuggKnE=", + "h1:dY/U8aXSeYofo2ePy17ZpYpoWulNOg7yTyDzu9JPtZg=", + "h1:exhQ8oVwosfOiPXBGKB03x86shgUfh3WJCgYJJZiM+s=", + "h1:khnMy13oj7QUYylaWc3dkRI9+g5RsfivagPDeLDYQfk=", + "h1:mZGLT4c6ggNVzwcoLQy34TJNNUaJ8THcOTKF5CQCSsA=", + "h1:wv9unLmaFtrgrak4tiDX9S95clORgg9JAiIA+lszbls=", + "zh:0dab28657af41472622e755206ad9472a70fe5219cd75e6130a8c0bb862b4147", + "zh:2829e210cc26f26015501c04a173e9b128e497d38bbf9294ed3fcdaee40d454c", + "zh:34000b9ac3f7b84250cfc95b6bb472e2f8a3986e71b61085d2644a8e70a74ef7", + "zh:37166992034b70f191fa938a6a44bdf5358695cc966993cd296c6739a0353742", + "zh:499a0fa390c31af98418d2fad644db61a83c09c150d67d37761927249c5e01c1", + "zh:5c6e043b2a85724d4684c4a42b048defbd42a05ec19e2a04f7ed2c6c4c5039b2", + "zh:5c99626b22972df4c738553d6f9e895b7a6786eb14087a3af00c3af361321737", + "zh:68809c6cb1cabbba18b79fc9092c71f1b7d5cc8772c089f4b58fbd16a90db34a", "zh:9b12af85486a96aedd8d7984b0ff811a4b42e3d88dad1a3fb4c0b580d04fa425", - "zh:a85f9dde2129c1ebf6a573eb9c8cffecde606f7b176501e3a96af8314a62f002", - "zh:c53cc16f0636af8ca203d312b10ed774518e63666a5f51d0e7d7fd6741fa29b3", - "zh:cae377589f6d2c7e88d092cff65f7ec7ecbe046ee4243b2cd803f2d452513504", - "zh:e95c3c19c4db7bd2429828ac708813c448e79cdcbac15ec577617e517df9bc68", + "zh:9f02789e5acfdc44e27af0b65ac58d6cd97a56d672e32654fcaa8507a6ac67da", + "zh:ac2bdb47b94f471dbad5153f344fd8a572ccfc1eb6bf46b273ce3fe3179cc162", + "zh:cacbb48db1072db21676b170e68dd727fbb9e41722408a5a7e2757b0a42d0415", + "zh:d33383f6feff8274edc7aad434c68a77c63b9fa4037f47b48be9796f5e8af318", + "zh:ed20697d82913c00831323d1a922a175219fba62d56cf9e0d6cce1ac92ffeda5", + "zh:f17dfa6280f4096f26533cfb8248111d80799e32fc3d8e5fa0410e3209b7da54", ] } diff --git a/01_networking/README.md b/01_networking/README.md index e1c9a9b2..9449a83a 100644 --- a/01_networking/README.md +++ b/01_networking/README.md @@ -71,3 +71,68 @@ No modules. No outputs. + + +## Requirements + +| Name | Version | +|------|---------| +| [terraform](#requirement\_terraform) | >= 1.0 | +| [null](#requirement\_null) | 3.2.3 | +| [oci](#requirement\_oci) | 6.26.0 | + +## Providers + +| Name | Version | +|------|---------| +| [null](#provider\_null) | 3.2.3 | +| [oci](#provider\_oci) | 6.26.0 | + +## Modules + +No modules. + +## Resources + +| Name | Type | +|------|------| +| [null_resource.wait](https://registry.terraform.io/providers/hashicorp/null/3.2.3/docs/resources/resource) | resource | +| [oci_core_cpe.onprem_cpe](https://registry.terraform.io/providers/oracle/oci/6.26.0/docs/resources/core_cpe) | resource | +| [oci_core_drg.main_vcn_drg](https://registry.terraform.io/providers/oracle/oci/6.26.0/docs/resources/core_drg) | resource | +| [oci_core_drg_attachment.main_vcn_drg_attachment](https://registry.terraform.io/providers/oracle/oci/6.26.0/docs/resources/core_drg_attachment) | resource | +| [oci_core_internet_gateway.main_internet_gateway](https://registry.terraform.io/providers/oracle/oci/6.26.0/docs/resources/core_internet_gateway) | resource | +| [oci_core_ipsec.oci_ipsec_connection](https://registry.terraform.io/providers/oracle/oci/6.26.0/docs/resources/core_ipsec) | resource | +| [oci_core_ipsec_connection_tunnel_management.oci_ipsec_tunnel_1](https://registry.terraform.io/providers/oracle/oci/6.26.0/docs/resources/core_ipsec_connection_tunnel_management) | resource | +| [oci_core_ipsec_connection_tunnel_management.oci_ipsec_tunnel_2](https://registry.terraform.io/providers/oracle/oci/6.26.0/docs/resources/core_ipsec_connection_tunnel_management) | resource | +| [oci_core_route_table.main_route_table](https://registry.terraform.io/providers/oracle/oci/6.26.0/docs/resources/core_route_table) | resource | +| [oci_core_security_list.vm_sl](https://registry.terraform.io/providers/oracle/oci/6.26.0/docs/resources/core_security_list) | resource | +| [oci_core_subnet.vm_subnet](https://registry.terraform.io/providers/oracle/oci/6.26.0/docs/resources/core_subnet) | resource | +| [oci_core_vcn.main_vcn](https://registry.terraform.io/providers/oracle/oci/6.26.0/docs/resources/core_vcn) | resource | +| [oci_core_ipsec_connection_tunnels.oci_ipsec_connection_tunnels](https://registry.terraform.io/providers/oracle/oci/6.26.0/docs/data-sources/core_ipsec_connection_tunnels) | data source | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [compartment\_id](#input\_compartment\_id) | Compartment ID for Oracle Tenant | `string` | n/a | yes | +| [cpe\_display\_name](#input\_cpe\_display\_name) | Display name for the CPE | `string` | n/a | yes | +| [cpe\_ip\_address](#input\_cpe\_ip\_address) | IP address of the CPE | `string` | n/a | yes | +| [drg\_display\_name](#input\_drg\_display\_name) | Display name for the Dynamic Routing Gateway | `string` | n/a | yes | +| [internet\_gateway\_display\_name](#input\_internet\_gateway\_display\_name) | Display name for the Internet Gateway | `string` | n/a | yes | +| [ipsec\_connection\_display\_name](#input\_ipsec\_connection\_display\_name) | Display name of IPSec connection | `string` | n/a | yes | +| [ipsec\_secret\_tunnel\_1](#input\_ipsec\_secret\_tunnel\_1) | Secret for 1st IPSec tunnel | `string` | n/a | yes | +| [ipsec\_secret\_tunnel\_2](#input\_ipsec\_secret\_tunnel\_2) | Secret for 2nd IPsec tunnel | `string` | n/a | yes | +| [onprem\_subnet\_cidr\_1](#input\_onprem\_subnet\_cidr\_1) | Subnet CIDR of on premise network | `string` | n/a | yes | +| [onprem\_subnet\_cidr\_2](#input\_onprem\_subnet\_cidr\_2) | Subnet CIDR of on premise network | `string` | n/a | yes | +| [route\_table\_display\_name](#input\_route\_table\_display\_name) | Display name for the route table | `string` | n/a | yes | +| [tag\_environment](#input\_tag\_environment) | Tag Value for Environment | `string` | n/a | yes | +| [vcn\_cidr\_blocks](#input\_vcn\_cidr\_blocks) | CIDR formatted block for VCN | `list(string)` | n/a | yes | +| [vcn\_display\_name](#input\_vcn\_display\_name) | Display name for the VCN | `string` | n/a | yes | +| [vm\_sl\_name](#input\_vm\_sl\_name) | Display name for the VM subnet Security List | `string` | n/a | yes | +| [vm\_subnet\_cidr\_block](#input\_vm\_subnet\_cidr\_block) | CIDR formatted block for VM subnet | `string` | n/a | yes | +| [vm\_subnet\_display\_name](#input\_vm\_subnet\_display\_name) | Display name for the VM subnet | `string` | n/a | yes | + +## Outputs + +No outputs. + \ No newline at end of file diff --git a/01_networking/providers.tf b/01_networking/providers.tf index a0e5d1f6..1f5bcbce 100644 --- a/01_networking/providers.tf +++ b/01_networking/providers.tf @@ -2,7 +2,7 @@ terraform { required_providers { oci = { source = "oracle/oci" - version = "6.25.0" + version = "6.26.0" } null = { source = "hashicorp/null" diff --git a/01_networking/terraform.tfvars b/01_networking/terraform.tfvars index 18020b85..09b36286 100644 --- a/01_networking/terraform.tfvars +++ b/01_networking/terraform.tfvars @@ -1,6 +1,6 @@ tag_environment = "Production" compartment_id = "#{COMPARTMENT_ID}#" -vcn_cidr_blocks = [ "192.168.1.0/24" ] +vcn_cidr_blocks = ["192.168.1.0/24"] vcn_display_name = "vcn-prod-uk-01" internet_gateway_display_name = "ig-prod-uk-01" route_table_display_name = "rt-prod-uk-01" diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..ca43451e --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,21 @@ +# 0.1.0 (2025-02-12) + + +### Bug Fixes + +* add debug ([d9aa409](https://github.com/binary-braids/terraform-oracle/commit/d9aa40971d04fe8612f63d6a2710045eaa6f412f)) +* add k3s shape variable value ([5bf5cc2](https://github.com/binary-braids/terraform-oracle/commit/5bf5cc203e047828bcf63dfda694a0bef1e8b1e1)) +* add Terraform Cloud details to providers.tf ([700a985](https://github.com/binary-braids/terraform-oracle/commit/700a985e4bc8c38cce51f2ccb73a926ddb14468f)) +* add workflow name to manual approval action ([507678a](https://github.com/binary-braids/terraform-oracle/commit/507678af21913753ec5ea832e575ebef34409405)) +* change cache action key from sha to run_id ([124d5e0](https://github.com/binary-braids/terraform-oracle/commit/124d5e02dbf987a19dacf169332353068bc40c05)) +* change path ref for oci permissions fix ([17a3bb4](https://github.com/binary-braids/terraform-oracle/commit/17a3bb4bf471964e5a9e1e71de4151d82fefef16)) +* change provider configuration and workflows ([985aea7](https://github.com/binary-braids/terraform-oracle/commit/985aea7d81ed249b7feb1a4c39b8460c1983e536)) +* correct workflow files ([1d9e9d4](https://github.com/binary-braids/terraform-oracle/commit/1d9e9d4851a719484e339af4524b78f11e13363e)) +* move oci config before replace tokens task ([6930e33](https://github.com/binary-braids/terraform-oracle/commit/6930e33021685b8818673a174aaa7f2d17f78221)) +* remove file permissions fix action ([9c10066](https://github.com/binary-braids/terraform-oracle/commit/9c10066bb9cbea4351a5da768205af70e78866c8)) +* remove replace token entries to be public ([c2cf86e](https://github.com/binary-braids/terraform-oracle/commit/c2cf86eb3d4fab0836ad7ce522927e424238cc5c)) +* replace heredoc with interpolation ([0bcf693](https://github.com/binary-braids/terraform-oracle/commit/0bcf6932dc86b17d53cb38a3c97c3b0bdc054c30)) +* Update renovate configuration ([471a68e](https://github.com/binary-braids/terraform-oracle/commit/471a68e5e8e086fa7b514568b8f0987b646aefba)) + + + diff --git a/LICENSE b/LICENSE index 35a9cae9..39327c92 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2023 Cuan Leo +Copyright (c) 2018 The terraform-docs Authors. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index b205e401..97dd257a 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,431 @@ -[![terraform](https://img.shields.io/badge/Terraform-purple?style=for-the-badge&logo=terraform)](https://www.terraform.io/) -[![oracle-cloud](https://img.shields.io/badge/Oracle-cloud-red?style=for-the-badge&logo=oracle)](https://www.oracle.com/cloud/) -[![renovate](https://img.shields.io/badge/renovate-enabled-brightgreen?style=for-the-badge&logo=renovatebot)](https://github.com/renovatebot/renovate) +# terraform-docs -[![HitCount](https://hits.dwyl.com/data-tangles/terraform-oracle.svg?style=flat-square&show=unique)](http://hits.dwyl.com/data-tangles/terraform-oracle) +[![Build Status](https://github.com/terraform-docs/terraform-docs/workflows/ci/badge.svg)](https://github.com/terraform-docs/terraform-docs/actions) [![GoDoc](https://pkg.go.dev/badge/github.com/terraform-docs/terraform-docs)](https://pkg.go.dev/github.com/terraform-docs/terraform-docs) [![Go Report Card](https://goreportcard.com/badge/github.com/terraform-docs/terraform-docs)](https://goreportcard.com/report/github.com/terraform-docs/terraform-docs) [![Codecov Report](https://codecov.io/gh/terraform-docs/terraform-docs/branch/master/graph/badge.svg)](https://codecov.io/gh/terraform-docs/terraform-docs) [![License](https://img.shields.io/github/license/terraform-docs/terraform-docs)](https://github.com/terraform-docs/terraform-docs/blob/master/LICENSE) [![Latest release](https://img.shields.io/github/v/release/terraform-docs/terraform-docs)](https://github.com/terraform-docs/terraform-docs/releases) -# terraform-oracle -Collection of Terraform modules for Oracle Cloud +![terraform-docs-teaser](./images/terraform-docs-teaser.png) +## What is terraform-docs + +A utility to generate documentation from Terraform modules in various output formats. + +## Installation + +macOS users can install using [Homebrew]: + +```bash +brew install terraform-docs +``` + +or + +```bash +brew install terraform-docs/tap/terraform-docs +``` + +Windows users can install using [Scoop]: + +```bash +scoop bucket add terraform-docs https://github.com/terraform-docs/scoop-bucket +scoop install terraform-docs +``` + +or [Chocolatey]: + +```bash +choco install terraform-docs +``` + +Stable binaries are also available on the [releases] page. To install, download the +binary for your platform from "Assets" and place this into your `$PATH`: + +```bash +curl -Lo ./terraform-docs.tar.gz https://github.com/terraform-docs/terraform-docs/releases/download/v0.17.0/terraform-docs-v0.17.0-$(uname)-amd64.tar.gz +tar -xzf terraform-docs.tar.gz +chmod +x terraform-docs +mv terraform-docs /usr/local/bin/terraform-docs +``` + +**NOTE:** Windows releases are in `ZIP` format. + +The latest version can be installed using `go install` or `go get`: + +```bash +# go1.17+ +go install github.com/terraform-docs/terraform-docs@v0.17.0 +``` + +```bash +# go1.16 +GO111MODULE="on" go get github.com/terraform-docs/terraform-docs@v0.17.0 +``` + +**NOTE:** please use the latest Go to do this, minimum `go1.16` is required. + +This will put `terraform-docs` in `$(go env GOPATH)/bin`. If you encounter the error +`terraform-docs: command not found` after installation then you may need to either add +that directory to your `$PATH` as shown [here] or do a manual installation by cloning +the repo and run `make build` from the repository which will put `terraform-docs` in: + +```bash +$(go env GOPATH)/src/github.com/terraform-docs/terraform-docs/bin/$(uname | tr '[:upper:]' '[:lower:]')-amd64/terraform-docs +``` + +## Usage + +### Running the binary directly + +To run and generate documentation into README within a directory: + +```bash +terraform-docs markdown table --output-file README.md --output-mode inject /path/to/module +``` + +Check [`output`] configuration for more details and examples. + +### Using docker + +terraform-docs can be run as a container by mounting a directory with `.tf` +files in it and run the following command: + +```bash +docker run --rm --volume "$(pwd):/terraform-docs" -u $(id -u) quay.io/terraform-docs/terraform-docs:0.17.0 markdown /terraform-docs +``` + +If `output.file` is not enabled for this module, generated output can be redirected +back to a file: + +```bash +docker run --rm --volume "$(pwd):/terraform-docs" -u $(id -u) quay.io/terraform-docs/terraform-docs:0.17.0 markdown /terraform-docs > doc.md +``` + +**NOTE:** Docker tag `latest` refers to _latest_ stable released version and `edge` +refers to HEAD of `master` at any given point in time. + +### Using GitHub Actions + +To use terraform-docs GitHub Action, configure a YAML workflow file (e.g. +`.github/workflows/documentation.yml`) with the following: + +```yaml +name: Generate terraform docs +on: + - pull_request + +jobs: + docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + with: + ref: ${{ github.event.pull_request.head.ref }} + + - name: Render terraform docs and push changes back to PR + uses: terraform-docs/gh-actions@main + with: + working-dir: . + output-file: README.md + output-method: inject + git-push: "true" +``` + +Read more about [terraform-docs GitHub Action] and its configuration and +examples. + +### pre-commit hook + +With pre-commit, you can ensure your Terraform module documentation is kept +up-to-date each time you make a commit. + +First [install pre-commit] and then create or update a `.pre-commit-config.yaml` +in the root of your Git repo with at least the following content: + +```yaml +repos: + - repo: https://github.com/terraform-docs/terraform-docs + rev: "v0.17.0" + hooks: + - id: terraform-docs-go + args: ["markdown", "table", "--output-file", "README.md", "./mymodule/path"] +``` + +Then run: + +```bash +pre-commit install +pre-commit install-hooks +``` + +Further changes to your module's `.tf` files will cause an update to documentation +when you make a commit. + +## Configuration + +terraform-docs can be configured with a yaml file. The default name of this file is +`.terraform-docs.yml` and the path order for locating it is: + +1. root of module directory +1. `.config/` folder at root of module directory +1. current directory +1. `.config/` folder at current directory +1. `$HOME/.tfdocs.d/` + +```yaml +formatter: "" # this is required + +version: "" + +header-from: main.tf +footer-from: "" + +recursive: + enabled: false + path: modules + +sections: + hide: [] + show: [] + +content: "" + +output: + file: "" + mode: inject + template: |- + + {{ .Content }} + + +output-values: + enabled: false + from: "" + +sort: + enabled: true + by: name + +settings: + anchor: true + color: true + default: true + description: false + escape: true + hide-empty: false + html: true + indent: 2 + lockfile: true + read-comments: true + required: true + sensitive: true + type: true +``` + +## Content Template + +Generated content can be customized further away with `content` in configuration. +If the `content` is empty the default order of sections is used. + +Compatible formatters for customized content are `asciidoc` and `markdown`. `content` +will be ignored for other formatters. + +`content` is a Go template with following additional variables: + +- `{{ .Header }}` +- `{{ .Footer }}` +- `{{ .Inputs }}` +- `{{ .Modules }}` +- `{{ .Outputs }}` +- `{{ .Providers }}` +- `{{ .Requirements }}` +- `{{ .Resources }}` + +and following functions: + +- `{{ include "relative/path/to/file" }}` + +These variables are the generated output of individual sections in the selected +formatter. For example `{{ .Inputs }}` is Markdown Table representation of _inputs_ +when formatter is set to `markdown table`. + +Note that sections visibility (i.e. `sections.show` and `sections.hide`) takes +precedence over the `content`. + +Additionally there's also one extra special variable avaialble to the `content`: + +- `{{ .Module }}` + +As opposed to the other variables mentioned above, which are generated sections +based on a selected formatter, the `{{ .Module }}` variable is just a `struct` +representing a [Terraform module]. + +````yaml +content: |- + Any arbitrary text can be placed anywhere in the content + + {{ .Header }} + + and even in between sections + + {{ .Providers }} + + and they don't even need to be in the default order + + {{ .Outputs }} + + include any relative files + + {{ include "relative/path/to/file" }} + + {{ .Inputs }} + + # Examples + + ```hcl + {{ include "examples/foo/main.tf" }} + ``` + + ## Resources + + {{ range .Module.Resources }} + - {{ .GetMode }}.{{ .Spec }} ({{ .Position.Filename }}#{{ .Position.Line }}) + {{- end }} +```` + +## Build on top of terraform-docs + +terraform-docs primary use-case is to be utilized as a standalone binary, but +some parts of it is also available publicly and can be imported in your project +as a library. + +```go +import ( + "github.com/terraform-docs/terraform-docs/format" + "github.com/terraform-docs/terraform-docs/print" + "github.com/terraform-docs/terraform-docs/terraform" +) + +// buildTerraformDocs for module root `path` and provided content `tmpl`. +func buildTerraformDocs(path string, tmpl string) (string, error) { + config := print.DefaultConfig() + config.ModuleRoot = path // module root path (can be relative or absolute) + + module, err := terraform.LoadWithOptions(config) + if err != nil { + return "", err + } + + // Generate in Markdown Table format + formatter := format.NewMarkdownTable(config) + + if err := formatter.Generate(module); err != nil { + return "", err + } + + // // Note: if you don't intend to provide additional template for the generated + // // content, or the target format doesn't provide templating (e.g. json, yaml, + // // xml, or toml) you can use `Content()` function instead of `Render()`. + // // `Content()` returns all the sections combined with predefined order. + // return formatter.Content(), nil + + return formatter.Render(tmpl) +} +``` + +## Plugin + +Generated output can be heavily customized with [`content`], but if using that +is not enough for your use-case, you can write your own plugin. + +In order to install a plugin the following steps are needed: + +- download the plugin and place it in `~/.tfdocs.d/plugins` (or `./.tfdocs.d/plugins`) +- make sure the plugin file name is `tfdocs-format-` +- modify [`formatter`] of `.terraform-docs.yml` file to be `` + +**Important notes:** + +- if the plugin file name is different than the example above, terraform-docs won't +be able to to pick it up nor register it properly +- you can only use plugin thorough `.terraform-docs.yml` file and it cannot be used +with CLI arguments + +To create a new plugin create a new repository called `tfdocs-format-` with +following `main.go`: + +```go +package main + +import ( + _ "embed" //nolint + + "github.com/terraform-docs/terraform-docs/plugin" + "github.com/terraform-docs/terraform-docs/print" + "github.com/terraform-docs/terraform-docs/template" + "github.com/terraform-docs/terraform-docs/terraform" +) + +func main() { + plugin.Serve(&plugin.ServeOpts{ + Name: "", + Version: "0.1.0", + Printer: printerFunc, + }) +} + +//go:embed sections.tmpl +var tplCustom []byte + +// printerFunc the function being executed by the plugin client. +func printerFunc(config *print.Config, module *terraform.Module) (string, error) { + tpl := template.New(config, + &template.Item{Name: "custom", Text: string(tplCustom)}, + ) + + rendered, err := tpl.Render("custom", module) + if err != nil { + return "", err + } + + return rendered, nil +} +``` + +Please refer to [tfdocs-format-template] for more details. You can create a new +repository from it by clicking on `Use this template` button. + +## Documentation + +- **Users** + - Read the [User Guide] to learn how to use terraform-docs + - Read the [Formats Guide] to learn about different output formats of terraform-docs + - Refer to [Config File Reference] for all the available configuration options +- **Developers** + - Read [Contributing Guide] before submitting a pull request + +Visit [our website] for all documentation. + +## Community + +- Discuss terraform-docs on [Slack] + +## License + +MIT License - Copyright (c) 2021 The terraform-docs Authors. + +[Chocolatey]: https://www.chocolatey.org +[Config File Reference]: https://terraform-docs.io/user-guide/configuration/ +[`content`]: https://terraform-docs.io/user-guide/configuration/content/ +[Contributing Guide]: CONTRIBUTING.md +[Formats Guide]: https://terraform-docs.io/reference/terraform-docs/ +[`formatter`]: https://terraform-docs.io/user-guide/configuration/formatter/ +[here]: https://golang.org/doc/code.html#GOPATH +[Homebrew]: https://brew.sh +[install pre-commit]: https://pre-commit.com/#install +[`output`]: https://terraform-docs.io/user-guide/configuration/output/ +[releases]: https://github.com/terraform-docs/terraform-docs/releases +[Scoop]: https://scoop.sh/ +[Slack]: https://slack.terraform-docs.io/ +[terraform-docs GitHub Action]: https://github.com/terraform-docs/gh-actions +[Terraform module]: https://pkg.go.dev/github.com/terraform-docs/terraform-docs/terraform#Module +[tfdocs-format-template]: https://github.com/terraform-docs/tfdocs-format-template +[our website]: https://terraform-docs.io/ +[User Guide]: https://terraform-docs.io/user-guide/introduction/ diff --git a/core_instance/.terraform.lock.hcl b/core_instance/.terraform.lock.hcl index 88c389f2..d4c1a68f 100644 --- a/core_instance/.terraform.lock.hcl +++ b/core_instance/.terraform.lock.hcl @@ -2,37 +2,37 @@ # Manual edits may be lost in future updates. provider "registry.terraform.io/oracle/oci" { - version = "6.25.0" - constraints = "6.25.0" + version = "6.26.0" + constraints = "6.26.0" hashes = [ - "h1:36jsalGcahABMlTHHnainyzxtWJB2UyRugBM7tVUKCs=", - "h1:438zbeb7zGbDKdf/zwaEajTpT4P6eZB0H79ZRj3q6Dw=", - "h1:7BIuk7roneNwFuFq9ITHHABv+T9f6fSgMAdvZC2Jgvc=", - "h1:NJqffhMNVUna62UcpHNO+MoEE3IZjYPk1DibSj5jcLE=", - "h1:OaWCgQfO5h/BJQpXmxdiLTrG9G5HfznBBI1MAYsTa9w=", - "h1:RpKrycLA0HUmYfE7o/D2ZzkNrN3gJjQ1oJyKocWgpz0=", - "h1:b9+boRGD854WWEsLBV3JpL2nbASTanYhfg/bQVFLIIM=", - "h1:cp0NwblK4WCSf06SPnfrs3IM9qoaRjsdHNMgrHwF2Ss=", - "h1:hnma57PpeF65LgV7bCyedmUkusG10VJDtGJnYb7NUiw=", - "h1:oxKX3PMpbyu2RPfezoFcJYxj9LEFW7q7gso5OEin/Zk=", - "h1:qHo92wXj5KIXHgzAd46vwvcQCHjBeEuz5uyafrdowfE=", - "h1:sBdxss3lEXCgP+HWSD82Hk1WK2a/kaZjHJoNJannZ8g=", - "h1:vBIEKY+Zcq6oe7Fyo0ivLe2GPmPXRev2nV3k2v5lRLM=", - "h1:vmYCKr/FXfrPOqCpm9EV9sO8dnUixwhfw/um+SIak0I=", - "zh:025a70306d8e64d9ca2b80403c6c3a66fbace10b0b14da152f847f8af39d2519", - "zh:1fc947735f2a5332d6fb0c15d54f010e6ba4077e030e8b8a3cb637c179c8a895", - "zh:3190adf0b76dba13b830a9d3de081bfea73e72a9e6142937df9e51a48abc8613", - "zh:3e0821e4d1505845c69738a539628d623c5785075fa77f0ce12b50bbebb19796", - "zh:42cce6c6f96103e37d78eecac10fa672533f24a9ef520d9ad47bc02b0c100c79", - "zh:435110feea29b44e1d47e5fd1f28811e59d2ca26f3e8c12e94e065977ed741a1", - "zh:48527d6fcf9d43c3e177d230d57ecbe56da9ef00b75d89d01dab84ed4ce3b7df", - "zh:660a292819f96a3aad55303dcea9360984735d112614074f0972fd8f5fae62fe", - "zh:6b680f1a745c33e90c491069e5b6495657765649e0ec0714ad03ecdd124c4f06", - "zh:7ef39b9f45dcbb3e0cb9200e906d2c9474863079d52d2d3beda814a1c30759f2", + "h1:4foHJdMh+0GvC/ihJ6a+w4MFRXs/YRbzbCP80TJTNBc=", + "h1:7RGXkdZod58flQ7EkZBUOXGuphMKe34tL+w90XsJwRA=", + "h1:BN+G2PylovCTR9SLm5pVKjaORZiBtX3k6dZhziLt9SQ=", + "h1:EQPmx6wlCMgAOjhAJzSJIuQW5mkUlOrdWmgnjBhjxys=", + "h1:Iu9cr+xusfqiT+17oyyCQuhCH2KdKoHyy+Xa/fjBSWk=", + "h1:LPSGm2gxQ1G2BALuCCTHSGE24YPOCcf9tAKft9KmYCA=", + "h1:P8/Rp9PqEYDg4ceiiktsIveE5ivCvD+WeZPDIK3kSVA=", + "h1:PJAp5OhQx/4QYJhW8cwX3H7VenYM8PL9hzvfIiIu/g4=", + "h1:Qqp3Z7AA0sG5/KUJWz16vBqW3oire6VT0MwViuggKnE=", + "h1:dY/U8aXSeYofo2ePy17ZpYpoWulNOg7yTyDzu9JPtZg=", + "h1:exhQ8oVwosfOiPXBGKB03x86shgUfh3WJCgYJJZiM+s=", + "h1:khnMy13oj7QUYylaWc3dkRI9+g5RsfivagPDeLDYQfk=", + "h1:mZGLT4c6ggNVzwcoLQy34TJNNUaJ8THcOTKF5CQCSsA=", + "h1:wv9unLmaFtrgrak4tiDX9S95clORgg9JAiIA+lszbls=", + "zh:0dab28657af41472622e755206ad9472a70fe5219cd75e6130a8c0bb862b4147", + "zh:2829e210cc26f26015501c04a173e9b128e497d38bbf9294ed3fcdaee40d454c", + "zh:34000b9ac3f7b84250cfc95b6bb472e2f8a3986e71b61085d2644a8e70a74ef7", + "zh:37166992034b70f191fa938a6a44bdf5358695cc966993cd296c6739a0353742", + "zh:499a0fa390c31af98418d2fad644db61a83c09c150d67d37761927249c5e01c1", + "zh:5c6e043b2a85724d4684c4a42b048defbd42a05ec19e2a04f7ed2c6c4c5039b2", + "zh:5c99626b22972df4c738553d6f9e895b7a6786eb14087a3af00c3af361321737", + "zh:68809c6cb1cabbba18b79fc9092c71f1b7d5cc8772c089f4b58fbd16a90db34a", "zh:9b12af85486a96aedd8d7984b0ff811a4b42e3d88dad1a3fb4c0b580d04fa425", - "zh:a85f9dde2129c1ebf6a573eb9c8cffecde606f7b176501e3a96af8314a62f002", - "zh:c53cc16f0636af8ca203d312b10ed774518e63666a5f51d0e7d7fd6741fa29b3", - "zh:cae377589f6d2c7e88d092cff65f7ec7ecbe046ee4243b2cd803f2d452513504", - "zh:e95c3c19c4db7bd2429828ac708813c448e79cdcbac15ec577617e517df9bc68", + "zh:9f02789e5acfdc44e27af0b65ac58d6cd97a56d672e32654fcaa8507a6ac67da", + "zh:ac2bdb47b94f471dbad5153f344fd8a572ccfc1eb6bf46b273ce3fe3179cc162", + "zh:cacbb48db1072db21676b170e68dd727fbb9e41722408a5a7e2757b0a42d0415", + "zh:d33383f6feff8274edc7aad434c68a77c63b9fa4037f47b48be9796f5e8af318", + "zh:ed20697d82913c00831323d1a922a175219fba62d56cf9e0d6cce1ac92ffeda5", + "zh:f17dfa6280f4096f26533cfb8248111d80799e32fc3d8e5fa0410e3209b7da54", ] } diff --git a/core_instance/README.md b/core_instance/README.md index 2e49d956..19c3a756 100644 --- a/core_instance/README.md +++ b/core_instance/README.md @@ -64,3 +64,60 @@ No modules. No outputs. + + +## Requirements + +| Name | Version | +|------|---------| +| [terraform](#requirement\_terraform) | >= 1.0 | +| [oci](#requirement\_oci) | 6.26.0 | + +## Providers + +| Name | Version | +|------|---------| +| [oci](#provider\_oci) | 6.26.0 | + +## Modules + +No modules. + +## Resources + +| Name | Type | +|------|------| +| [oci_core_instance.linux_instance](https://registry.terraform.io/providers/oracle/oci/6.26.0/docs/resources/core_instance) | resource | +| [oci_core_instance.linux_instance_k3s_1](https://registry.terraform.io/providers/oracle/oci/6.26.0/docs/resources/core_instance) | resource | +| [oci_core_instance.linux_instance_k3s_2](https://registry.terraform.io/providers/oracle/oci/6.26.0/docs/resources/core_instance) | resource | +| [oci_core_instance.linux_management_instance](https://registry.terraform.io/providers/oracle/oci/6.26.0/docs/resources/core_instance) | resource | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [availability\_domain](#input\_availability\_domain) | Availability Domain for Core Instance | `string` | n/a | yes | +| [compartment\_id](#input\_compartment\_id) | Compartment ID for Oracle Tenant | `string` | n/a | yes | +| [docker\_instance\_display\_name](#input\_docker\_instance\_display\_name) | Name for Docker Core Instance | `string` | n/a | yes | +| [docker\_private\_ip](#input\_docker\_private\_ip) | Private IP for Docker instance | `string` | n/a | yes | +| [image\_source\_id](#input\_image\_source\_id) | Image source ID for Core Instance | `string` | n/a | yes | +| [instance\_shape\_config\_memory\_in\_gbs](#input\_instance\_shape\_config\_memory\_in\_gbs) | Memory for core instance | `string` | n/a | yes | +| [instance\_shape\_config\_ocpus](#input\_instance\_shape\_config\_ocpus) | CPU for core instance | `string` | n/a | yes | +| [k3s\_1\_instance\_display\_name](#input\_k3s\_1\_instance\_display\_name) | Display name for k3s instance 1 | `string` | n/a | yes | +| [k3s\_1\_private\_ip](#input\_k3s\_1\_private\_ip) | Private IP for k3s instance 1 | `string` | n/a | yes | +| [k3s\_2\_instance\_display\_name](#input\_k3s\_2\_instance\_display\_name) | Display name for k3s instance 2 | `string` | n/a | yes | +| [k3s\_2\_private\_ip](#input\_k3s\_2\_private\_ip) | Private IP for k3s instance 2 | `string` | n/a | yes | +| [k3s\_availability\_domain](#input\_k3s\_availability\_domain) | Availability Domain for the k3s Core Instance | `string` | n/a | yes | +| [k3s\_image\_source\_id](#input\_k3s\_image\_source\_id) | Image Source for k3s | `string` | n/a | yes | +| [k3s\_shape](#input\_k3s\_shape) | Shape of the k3s Core Instance | `string` | n/a | yes | +| [mgmt\_instance\_display\_name](#input\_mgmt\_instance\_display\_name) | Name for Management Core Instance | `string` | n/a | yes | +| [mgmt\_private\_ip](#input\_mgmt\_private\_ip) | Private IP for Management instance | `string` | n/a | yes | +| [shape](#input\_shape) | Shape for Core Instance | `string` | n/a | yes | +| [ssh\_public\_key](#input\_ssh\_public\_key) | SSH Public Key for auth to Core Instance | `string` | n/a | yes | +| [subnet\_id](#input\_subnet\_id) | Subnet ID for Core Instance | `string` | n/a | yes | +| [tag\_environment](#input\_tag\_environment) | Tag Value for Environment | `string` | n/a | yes | + +## Outputs + +No outputs. + \ No newline at end of file diff --git a/core_instance/providers.tf b/core_instance/providers.tf index 96f3752e..57638bbc 100644 --- a/core_instance/providers.tf +++ b/core_instance/providers.tf @@ -2,7 +2,7 @@ terraform { required_providers { oci = { source = "oracle/oci" - version = "6.25.0" + version = "6.26.0" } } backend "remote" { diff --git a/object_storage/.terraform.lock.hcl b/object_storage/.terraform.lock.hcl index 88c389f2..d4c1a68f 100644 --- a/object_storage/.terraform.lock.hcl +++ b/object_storage/.terraform.lock.hcl @@ -2,37 +2,37 @@ # Manual edits may be lost in future updates. provider "registry.terraform.io/oracle/oci" { - version = "6.25.0" - constraints = "6.25.0" + version = "6.26.0" + constraints = "6.26.0" hashes = [ - "h1:36jsalGcahABMlTHHnainyzxtWJB2UyRugBM7tVUKCs=", - "h1:438zbeb7zGbDKdf/zwaEajTpT4P6eZB0H79ZRj3q6Dw=", - "h1:7BIuk7roneNwFuFq9ITHHABv+T9f6fSgMAdvZC2Jgvc=", - "h1:NJqffhMNVUna62UcpHNO+MoEE3IZjYPk1DibSj5jcLE=", - "h1:OaWCgQfO5h/BJQpXmxdiLTrG9G5HfznBBI1MAYsTa9w=", - "h1:RpKrycLA0HUmYfE7o/D2ZzkNrN3gJjQ1oJyKocWgpz0=", - "h1:b9+boRGD854WWEsLBV3JpL2nbASTanYhfg/bQVFLIIM=", - "h1:cp0NwblK4WCSf06SPnfrs3IM9qoaRjsdHNMgrHwF2Ss=", - "h1:hnma57PpeF65LgV7bCyedmUkusG10VJDtGJnYb7NUiw=", - "h1:oxKX3PMpbyu2RPfezoFcJYxj9LEFW7q7gso5OEin/Zk=", - "h1:qHo92wXj5KIXHgzAd46vwvcQCHjBeEuz5uyafrdowfE=", - "h1:sBdxss3lEXCgP+HWSD82Hk1WK2a/kaZjHJoNJannZ8g=", - "h1:vBIEKY+Zcq6oe7Fyo0ivLe2GPmPXRev2nV3k2v5lRLM=", - "h1:vmYCKr/FXfrPOqCpm9EV9sO8dnUixwhfw/um+SIak0I=", - "zh:025a70306d8e64d9ca2b80403c6c3a66fbace10b0b14da152f847f8af39d2519", - "zh:1fc947735f2a5332d6fb0c15d54f010e6ba4077e030e8b8a3cb637c179c8a895", - "zh:3190adf0b76dba13b830a9d3de081bfea73e72a9e6142937df9e51a48abc8613", - "zh:3e0821e4d1505845c69738a539628d623c5785075fa77f0ce12b50bbebb19796", - "zh:42cce6c6f96103e37d78eecac10fa672533f24a9ef520d9ad47bc02b0c100c79", - "zh:435110feea29b44e1d47e5fd1f28811e59d2ca26f3e8c12e94e065977ed741a1", - "zh:48527d6fcf9d43c3e177d230d57ecbe56da9ef00b75d89d01dab84ed4ce3b7df", - "zh:660a292819f96a3aad55303dcea9360984735d112614074f0972fd8f5fae62fe", - "zh:6b680f1a745c33e90c491069e5b6495657765649e0ec0714ad03ecdd124c4f06", - "zh:7ef39b9f45dcbb3e0cb9200e906d2c9474863079d52d2d3beda814a1c30759f2", + "h1:4foHJdMh+0GvC/ihJ6a+w4MFRXs/YRbzbCP80TJTNBc=", + "h1:7RGXkdZod58flQ7EkZBUOXGuphMKe34tL+w90XsJwRA=", + "h1:BN+G2PylovCTR9SLm5pVKjaORZiBtX3k6dZhziLt9SQ=", + "h1:EQPmx6wlCMgAOjhAJzSJIuQW5mkUlOrdWmgnjBhjxys=", + "h1:Iu9cr+xusfqiT+17oyyCQuhCH2KdKoHyy+Xa/fjBSWk=", + "h1:LPSGm2gxQ1G2BALuCCTHSGE24YPOCcf9tAKft9KmYCA=", + "h1:P8/Rp9PqEYDg4ceiiktsIveE5ivCvD+WeZPDIK3kSVA=", + "h1:PJAp5OhQx/4QYJhW8cwX3H7VenYM8PL9hzvfIiIu/g4=", + "h1:Qqp3Z7AA0sG5/KUJWz16vBqW3oire6VT0MwViuggKnE=", + "h1:dY/U8aXSeYofo2ePy17ZpYpoWulNOg7yTyDzu9JPtZg=", + "h1:exhQ8oVwosfOiPXBGKB03x86shgUfh3WJCgYJJZiM+s=", + "h1:khnMy13oj7QUYylaWc3dkRI9+g5RsfivagPDeLDYQfk=", + "h1:mZGLT4c6ggNVzwcoLQy34TJNNUaJ8THcOTKF5CQCSsA=", + "h1:wv9unLmaFtrgrak4tiDX9S95clORgg9JAiIA+lszbls=", + "zh:0dab28657af41472622e755206ad9472a70fe5219cd75e6130a8c0bb862b4147", + "zh:2829e210cc26f26015501c04a173e9b128e497d38bbf9294ed3fcdaee40d454c", + "zh:34000b9ac3f7b84250cfc95b6bb472e2f8a3986e71b61085d2644a8e70a74ef7", + "zh:37166992034b70f191fa938a6a44bdf5358695cc966993cd296c6739a0353742", + "zh:499a0fa390c31af98418d2fad644db61a83c09c150d67d37761927249c5e01c1", + "zh:5c6e043b2a85724d4684c4a42b048defbd42a05ec19e2a04f7ed2c6c4c5039b2", + "zh:5c99626b22972df4c738553d6f9e895b7a6786eb14087a3af00c3af361321737", + "zh:68809c6cb1cabbba18b79fc9092c71f1b7d5cc8772c089f4b58fbd16a90db34a", "zh:9b12af85486a96aedd8d7984b0ff811a4b42e3d88dad1a3fb4c0b580d04fa425", - "zh:a85f9dde2129c1ebf6a573eb9c8cffecde606f7b176501e3a96af8314a62f002", - "zh:c53cc16f0636af8ca203d312b10ed774518e63666a5f51d0e7d7fd6741fa29b3", - "zh:cae377589f6d2c7e88d092cff65f7ec7ecbe046ee4243b2cd803f2d452513504", - "zh:e95c3c19c4db7bd2429828ac708813c448e79cdcbac15ec577617e517df9bc68", + "zh:9f02789e5acfdc44e27af0b65ac58d6cd97a56d672e32654fcaa8507a6ac67da", + "zh:ac2bdb47b94f471dbad5153f344fd8a572ccfc1eb6bf46b273ce3fe3179cc162", + "zh:cacbb48db1072db21676b170e68dd727fbb9e41722408a5a7e2757b0a42d0415", + "zh:d33383f6feff8274edc7aad434c68a77c63b9fa4037f47b48be9796f5e8af318", + "zh:ed20697d82913c00831323d1a922a175219fba62d56cf9e0d6cce1ac92ffeda5", + "zh:f17dfa6280f4096f26533cfb8248111d80799e32fc3d8e5fa0410e3209b7da54", ] } diff --git a/object_storage/README.md b/object_storage/README.md index 42e43b30..1dc89071 100644 --- a/object_storage/README.md +++ b/object_storage/README.md @@ -43,3 +43,41 @@ No modules. No outputs. + + +## Requirements + +| Name | Version | +|------|---------| +| [terraform](#requirement\_terraform) | >= 1.0 | +| [oci](#requirement\_oci) | 6.26.0 | + +## Providers + +| Name | Version | +|------|---------| +| [oci](#provider\_oci) | 6.26.0 | + +## Modules + +No modules. + +## Resources + +| Name | Type | +|------|------| +| [oci_objectstorage_bucket.oci_k3s_bucket](https://registry.terraform.io/providers/oracle/oci/6.26.0/docs/resources/objectstorage_bucket) | resource | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [bucket\_name](#input\_bucket\_name) | Name of the OCI Bucket Object Storage | `string` | n/a | yes | +| [bucket\_namespace](#input\_bucket\_namespace) | Namespace of the OCI Bucket Object Storage | `string` | n/a | yes | +| [compartment\_id](#input\_compartment\_id) | Compartment ID for Oracle Tenant | `string` | n/a | yes | +| [tag\_environment](#input\_tag\_environment) | Tag Value for Environment | `string` | n/a | yes | + +## Outputs + +No outputs. + \ No newline at end of file diff --git a/object_storage/providers.tf b/object_storage/providers.tf index 3ad4396c..9ba43f28 100644 --- a/object_storage/providers.tf +++ b/object_storage/providers.tf @@ -2,7 +2,7 @@ terraform { required_providers { oci = { source = "oracle/oci" - version = "6.25.0" + version = "6.26.0" } } backend "remote" { diff --git a/object_storage/terraform.tfvars b/object_storage/terraform.tfvars index 6c9bff04..9c10f4d0 100644 --- a/object_storage/terraform.tfvars +++ b/object_storage/terraform.tfvars @@ -1,4 +1,4 @@ -tag_environment = "Production" -compartment_id = "#{COMPARTMENT_ID}#" -bucket_name = "osb-prod-kube-uk-01" -bucket_namespace = "#{BUCKET_NAMESPACE}#" \ No newline at end of file +tag_environment = "Production" +compartment_id = "#{COMPARTMENT_ID}#" +bucket_name = "osb-prod-kube-uk-01" +bucket_namespace = "#{BUCKET_NAMESPACE}#" \ No newline at end of file diff --git a/package.yaml b/package.yaml new file mode 100644 index 00000000..5593cd80 --- /dev/null +++ b/package.yaml @@ -0,0 +1 @@ +version: 0.1.0 diff --git a/terraform-docs.tar.gz b/terraform-docs.tar.gz new file mode 100644 index 00000000..45f9b04b Binary files /dev/null and b/terraform-docs.tar.gz differ