b0b84c1409
* feat: add data sources and organize code * fix: ignore unused data source example * fix: add ignore to docs * fix: update CI test to new location * fix: update CI to run acceptance tests * fix: run tests in nix * fix: switch terraform version based on matrix * fix: remove equal sign --------- Signed-off-by: matttrach <matt.trachier@suse.com> |
||
|---|---|---|
| .. | ||
| data-sources/file_local | ||
| provider | ||
| resources/file_local | ||
| use-cases/local | ||
| README.md | ||
README.md
Examples
This directory contains examples that are used for documentation, and can be run/tested via the Terraform CLI. The use-cases directory is full of examples that we test automatically before release.
The document generation tool looks for files in the following locations by default. All other *.tf files besides the ones mentioned below are ignored by the documentation tool. This is useful for creating examples that can run and/or are testable even if some parts are not relevant for the documentation.
- provider/provider.tf example file for the provider index page
- data-sources/
full data source name/data-source.tf example file for the named data source page - resources/
full resource name/resource.tf example file for the named data source page
Use cases
The examples in the following location show full working solutions using the provider. The idea is to both give context to the resources involved and to give real tested examples of how to use the provider.
- use-cases/
arbitrary name/