rancher
/
terraform-provider-file
mirror of https://github.com/rancher/terraform-provider-file.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
terraform-provider-file/examples
History
github-actions[bot] 6a781ea7fd
feat!: Add local directory management (#201) (#204) 
* feat: add local directory management
* fix: update all resources to use the "local" path
---------


(cherry picked from commit a1147e54ec)

Signed-off-by: matttrach <matt.trachier@suse.com>
Co-authored-by: Matt Trachier <matt.trachier@suse.com>
 		2025-10-01 13:31:36 -05:00
..
data-sources feat!: Add local directory management (#201) (#204) 2025-10-01 13:31:36 -05:00
provider feat: add data sources and organize code (#148) 2025-09-04 00:02:33 -05:00
resources feat!: Add local directory management (#201) (#204) 2025-10-01 13:31:36 -05:00
use-cases feat!: Add local directory management (#201) (#204) 2025-10-01 13:31:36 -05:00
README.md feat: add snapshots (#153) 2025-09-10 13:46:42 -05:00

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. Note that the resource class must be imported to the provider and listed under the provider "Resources" function before the doc tools will look for them.

  • 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/