docs: generated module docs
This commit is contained in:
78
9p-persistent-volume/README.md
Normal file
78
9p-persistent-volume/README.md
Normal file
@@ -0,0 +1,78 @@
|
||||
## Requirements
|
||||
|
||||
The following requirements are needed by this module:
|
||||
|
||||
- <a name="requirement_kubernetes"></a> [kubernetes](#requirement\_kubernetes) (~> 2.11)
|
||||
|
||||
## Providers
|
||||
|
||||
The following providers are used by this module:
|
||||
|
||||
- <a name="provider_kubernetes"></a> [kubernetes](#provider\_kubernetes) (~> 2.11)
|
||||
|
||||
## Modules
|
||||
|
||||
No modules.
|
||||
|
||||
## Resources
|
||||
|
||||
The following resources are used by this module:
|
||||
|
||||
- [kubernetes_persistent_volume.this](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/persistent_volume) (resource)
|
||||
- [kubernetes_persistent_volume_claim.this](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/persistent_volume_claim) (resource)
|
||||
|
||||
## Required Inputs
|
||||
|
||||
The following input variables are required:
|
||||
|
||||
### <a name="input_name"></a> [name](#input\_name)
|
||||
|
||||
Description: The name of the volume
|
||||
|
||||
Type: `string`
|
||||
|
||||
### <a name="input_namespace"></a> [namespace](#input\_namespace)
|
||||
|
||||
Description: The namespace for the persistent volume claim
|
||||
|
||||
Type: `string`
|
||||
|
||||
## Optional Inputs
|
||||
|
||||
The following input variables are optional (have default values):
|
||||
|
||||
### <a name="input_volume_storage_capacity"></a> [volume\_storage\_capacity](#input\_volume\_storage\_capacity)
|
||||
|
||||
Description: Size of the persistent volume reported to Kubernetes
|
||||
|
||||
Type: `string`
|
||||
|
||||
Default: `"1Gi"`
|
||||
|
||||
## Outputs
|
||||
|
||||
The following outputs are exported:
|
||||
|
||||
### <a name="output_host_path"></a> [host\_path](#output\_host\_path)
|
||||
|
||||
Description: n/a
|
||||
|
||||
### <a name="output_namespace"></a> [namespace](#output\_namespace)
|
||||
|
||||
Description: n/a
|
||||
|
||||
### <a name="output_persistent_volume"></a> [persistent\_volume](#output\_persistent\_volume)
|
||||
|
||||
Description: n/a
|
||||
|
||||
### <a name="output_persistent_volume_claim"></a> [persistent\_volume\_claim](#output\_persistent\_volume\_claim)
|
||||
|
||||
Description: n/a
|
||||
|
||||
### <a name="output_pv_name"></a> [pv\_name](#output\_pv\_name)
|
||||
|
||||
Description: n/a
|
||||
|
||||
### <a name="output_pvc_name"></a> [pvc\_name](#output\_pvc\_name)
|
||||
|
||||
Description: n/a
|
||||
Reference in New Issue
Block a user