Skip to content

Commit 9f21adf

Browse files
chore(docs): update Terraform docs
1 parent 860d90f commit 9f21adf

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

USAGE.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<!-- BEGIN_TF_DOCS -->
2+
## Requirements
3+
4+
| Name | Version |
5+
|------|---------|
6+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
7+
| <a name="requirement_oci"></a> [oci](#requirement\_oci) | 4.72.0 |
8+
9+
## Modules
10+
11+
No modules.
12+
13+
## Resources
14+
15+
No resources.
16+
17+
## Inputs
18+
19+
| Name | Description | Type | Default | Required |
20+
|------|-------------|------|---------|:--------:|
21+
| <a name="input_namespace"></a> [namespace](#input\_namespace) | Project name that will be use to identifiy the resources | `string` | `"my-project"` | no |
22+
| <a name="input_stage"></a> [stage](#input\_stage) | Stage/environment name to tag and suffix the infrastructure composants | `string` | `"dev"` | no |
23+
| <a name="input_tenancy_ocid"></a> [tenancy\_ocid](#input\_tenancy\_ocid) | Tenancy OCID | `string` | `null` | no |
24+
| <a name="input_user_ocid"></a> [user\_ocid](#input\_user\_ocid) | User OCID | `string` | `null` | no |
25+
| <a name="input_fingerprint"></a> [fingerprint](#input\_fingerprint) | Fingerprint | `string` | `null` | no |
26+
| <a name="input_private_key"></a> [private\_key](#input\_private\_key) | Private Key content | `string` | `null` | no |
27+
| <a name="input_region"></a> [region](#input\_region) | Default Region | `string` | `"uk-london-1"` | no |
28+
| <a name="input_labels"></a> [labels](#input\_labels) | Default labels to associate to these resources | `map(string)` | <pre>{<br> "businessunit": "mycompany",<br> "project": "VSCode Server",<br> "team": "devops",<br> "terraform": "true"<br>}</pre> | no |
29+
30+
## Outputs
31+
32+
No outputs.
33+
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)