diff --git a/README.md b/README.md index 18fbf2c..9b9b336 100644 --- a/README.md +++ b/README.md @@ -29,4 +29,56 @@ plugin in a woodpecker ci pipeline. # Terraform Docs +## Requirements + +| Name | Version | +|------|---------| +| [terraform](#requirement\_terraform) | ~> 1.8.0 | +| [oci](#requirement\_oci) | ~> 5.42.0 | + +## Providers + +| Name | Version | +|------|---------| +| [oci](#provider\_oci) | 5.42.0 | +| [terraform](#provider\_terraform) | n/a | + +## Modules + +No modules. + +## Resources + +| Name | Type | +|------|------| +| [oci_identity_customer_secret_key.woodpecker_cache](https://registry.terraform.io/providers/oracle/oci/latest/docs/resources/identity_customer_secret_key) | resource | +| [oci_identity_group.woodpecker_cache](https://registry.terraform.io/providers/oracle/oci/latest/docs/resources/identity_group) | resource | +| [oci_identity_policy.woodpecker_cache](https://registry.terraform.io/providers/oracle/oci/latest/docs/resources/identity_policy) | resource | +| [oci_identity_user.woodpecker_cache](https://registry.terraform.io/providers/oracle/oci/latest/docs/resources/identity_user) | resource | +| [oci_identity_user_capabilities_management.woodpecker_cache](https://registry.terraform.io/providers/oracle/oci/latest/docs/resources/identity_user_capabilities_management) | resource | +| [oci_identity_user_group_membership.woodpecker_cache](https://registry.terraform.io/providers/oracle/oci/latest/docs/resources/identity_user_group_membership) | resource | +| [oci_objectstorage_bucket.woodpecker_cache](https://registry.terraform.io/providers/oracle/oci/latest/docs/resources/objectstorage_bucket) | resource | +| [oci_objectstorage_object_lifecycle_policy.woodpecker_cache](https://registry.terraform.io/providers/oracle/oci/latest/docs/resources/objectstorage_object_lifecycle_policy) | resource | +| [oci_objectstorage_namespace.ns](https://registry.terraform.io/providers/oracle/oci/latest/docs/data-sources/objectstorage_namespace) | data source | +| [terraform_remote_state.base](https://registry.terraform.io/providers/hashicorp/terraform/latest/docs/data-sources/remote_state) | data source | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [oci\_region](#input\_oci\_region) | n/a | `string` | n/a | yes | +| [remote\_state\_config](#input\_remote\_state\_config) | The configuration of the remote state backend to fetch the compartment\_id from | `any` | n/a | yes | +| [remote\_state\_type](#input\_remote\_state\_type) | The type of the remote state backend to fetch the compartment\_id from | `string` | n/a | yes | +| [iac\_component](#input\_iac\_component) | Component name of the iac config. used in various tags and metadata. | `string` | `"oci-woodpecker-cache"` | no | +| [iac\_source](#input\_iac\_source) | Source of the iac config. used in various tags and metadata. | `string` | `"git@git.bdeshi.space:bdeshi/terraform-oci-woodpecker-cache.git"` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| [s3\_accss\_key\_id](#output\_s3\_accss\_key\_id) | n/a | +| [s3\_bucket\_name](#output\_s3\_bucket\_name) | n/a | +| [s3\_endpoint](#output\_s3\_endpoint) | n/a | +| [s3\_secret\_access\_key](#output\_s3\_secret\_access\_key) | n/a | +| [s3\_use\_path\_style](#output\_s3\_use\_path\_style) | Use path style access for S3. This is necessary for OCI object storage. |