Skip to content

Commit

Permalink
Merge pull request #60 from equinix-labs/create-pull-request/patch-16…
Browse files Browse the repository at this point in the history
…78210601

generate-terraform-docs: automated action
  • Loading branch information
ocobles authored Mar 7, 2023
2 parents 395c3c9 + c7a78e1 commit b5b6881
Show file tree
Hide file tree
Showing 3 changed files with 79 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ No providers.
| Name | Source | Version |
|------|--------|---------|
| <a name="module_cloud_provider_equinix_metal"></a> [cloud\_provider\_equinix\_metal](#module\_cloud\_provider\_equinix\_metal) | ./modules/cloud_provider_equinix_metal | n/a |
| <a name="module_kube_vip"></a> [kube\_vip](#module\_kube\_vip) | ./modules/kube-vip | n/a |
| <a name="module_longhorn"></a> [longhorn](#module\_longhorn) | ./modules/longhorn | n/a |
| <a name="module_metallb"></a> [metallb](#module\_metallb) | ./modules/metallb | n/a |
| <a name="module_portworx"></a> [portworx](#module\_portworx) | ./modules/portworx | n/a |
Expand All @@ -67,13 +68,15 @@ No resources.
|------|-------------|------|---------|:--------:|
| <a name="input_cloud_provider_equinix_metal_config"></a> [cloud\_provider\_equinix\_metal\_config](#input\_cloud\_provider\_equinix\_metal\_config) | Configuration for cloudproviderequinixmetal add-on | `any` | `{}` | no |
| <a name="input_enable_cloud_provider_equinix_metal"></a> [enable\_cloud\_provider\_equinix\_metal](#input\_enable\_cloud\_provider\_equinix\_metal) | Enable cloudproviderequinixmetal add-on | `bool` | `false` | no |
| <a name="input_enable_kube_vip"></a> [enable\_kube\_vip](#input\_enable\_kube\_vip) | Enable Kube-vip add-on | `bool` | `false` | no |
| <a name="input_enable_longhorn"></a> [enable\_longhorn](#input\_enable\_longhorn) | Enable Longhorn add-on | `bool` | `false` | no |
| <a name="input_enable_metallb"></a> [enable\_metallb](#input\_enable\_metallb) | Enable Metallb add-on | `bool` | `false` | no |
| <a name="input_enable_portworx"></a> [enable\_portworx](#input\_enable\_portworx) | Enable Portworx add-on | `bool` | `false` | no |
| <a name="input_enable_portworx_data_services"></a> [enable\_portworx\_data\_services](#input\_enable\_portworx\_data\_services) | Enable Portworx\_data\_services add-on | `bool` | `false` | no |
| <a name="input_enable_rook"></a> [enable\_rook](#input\_enable\_rook) | Enable Rook add-on | `bool` | `false` | no |
| <a name="input_equinix_metro"></a> [equinix\_metro](#input\_equinix\_metro) | Equinix metro code | `string` | `null` | no |
| <a name="input_equinix_project"></a> [equinix\_project](#input\_equinix\_project) | Equinix project | `string` | `null` | no |
| <a name="input_kube_vip_config"></a> [kube\_vip\_config](#input\_kube\_vip\_config) | Configuration for Kube-vip add-on | `any` | `{}` | no |
| <a name="input_kubeconfig_local_path"></a> [kubeconfig\_local\_path](#input\_kubeconfig\_local\_path) | Depending on your setup, you may need to specify the path to the kubeconfig file locally | `string` | `null` | no |
| <a name="input_kubeconfig_remote_path"></a> [kubeconfig\_remote\_path](#input\_kubeconfig\_remote\_path) | Depending on your setup, you may need to specify the path to the kubeconfig file hosted on the remote server | `string` | `null` | no |
| <a name="input_longhorn_config"></a> [longhorn\_config](#input\_longhorn\_config) | Configuration for Longhorn add-on | `any` | `null` | no |
Expand All @@ -92,6 +95,7 @@ No resources.
|------|-------------|
| <a name="output_cloud_provider_equinix_metal"></a> [cloud\_provider\_equinix\_metal](#output\_cloud\_provider\_equinix\_metal) | Cloud Provider Equinix Metal add-on outputs |
| <a name="output_cloud_provider_equinix_metal_prerequisites"></a> [cloud\_provider\_equinix\_metal\_prerequisites](#output\_cloud\_provider\_equinix\_metal\_prerequisites) | Cloud Provider Equinix Metal add-on prerequisites for device provisioning |
| <a name="output_kube_vip"></a> [kube\_vip](#output\_kube\_vip) | Map of attributes available for the Kube-vip addon |
| <a name="output_metallb"></a> [metallb](#output\_metallb) | MetaLB addon outputs |
| <a name="output_portworx"></a> [portworx](#output\_portworx) | Portworx add-on outputs |
| <a name="output_portworx_data_services"></a> [portworx\_data\_services](#output\_portworx\_data\_services) | Map of attributes available for the Portworx\_data\_services addon |
Expand Down
39 changes: 39 additions & 0 deletions modules/kube-vip/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,43 @@ is not yet supported here.

<!-- TEMPLATE: Please do not remove BEGIN_TF_DOCS/END_TF_DOCS comments below -->
<!-- BEGIN_TF_DOCS -->
### Requirements

| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0 |
| <a name="requirement_http"></a> [http](#requirement\_http) | >=3.1.0 |
| <a name="requirement_kubectl"></a> [kubectl](#requirement\_kubectl) | >= 1.7.0 |

### Providers

| Name | Version |
|------|---------|
| <a name="provider_http"></a> [http](#provider\_http) | >=3.1.0 |
| <a name="provider_kubectl"></a> [kubectl](#provider\_kubectl) | >= 1.7.0 |

### Modules

No modules.

### Resources

| Name | Type |
|------|------|
| [kubectl_manifest.kube_vip](https://registry.terraform.io/providers/gavinbunney/kubectl/latest/docs/resources/manifest) | resource |
| [http_http.releases](https://registry.terraform.io/providers/hashicorp/http/latest/docs/data-sources/http) | data source |

### Inputs

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_addon_context"></a> [addon\_context](#input\_addon\_context) | Input context for the addon | <pre>object({<br> equinix_project = string<br> kubeconfig_local_path = string<br> })</pre> | n/a | yes |
| <a name="input_kube_vip_config"></a> [kube\_vip\_config](#input\_kube\_vip\_config) | Add-on configuration for Kube-vip | `any` | `{}` | no |

### Outputs

| Name | Description |
|------|-------------|
| <a name="output_daemonset_name"></a> [daemonset\_name](#output\_daemonset\_name) | kube-vip daemonset name |
| <a name="output_daemonset_namespace"></a> [daemonset\_namespace](#output\_daemonset\_namespace) | kube-vip daemonset namespace |
<!-- END_TF_DOCS -->
36 changes: 36 additions & 0 deletions modules/kube-vip/examples/simple/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,40 @@ terraform apply

<!-- TEMPLATE: Please do not remove BEGIN_TF_DOCS/END_TF_DOCS comments below -->
<!-- BEGIN_TF_DOCS -->
### Requirements

| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0.0 |
| <a name="requirement_http"></a> [http](#requirement\_http) | >=3.1.0 |
| <a name="requirement_kubectl"></a> [kubectl](#requirement\_kubectl) | >= 1.7.0 |

### Providers

No providers.

### Modules

| Name | Source | Version |
|------|--------|---------|
| <a name="module_equinix_kubernetes_addons"></a> [equinix\_kubernetes\_addons](#module\_equinix\_kubernetes\_addons) | ../../../../ | n/a |

### Resources

No resources.

### Inputs

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_kubeconfig_local_path"></a> [kubeconfig\_local\_path](#input\_kubeconfig\_local\_path) | Local path to your kubeconfig file. Checkout https://registry.terraform.io/providers/gavinbunney/kubectl/latest/docs<br>for other auth/configuration options | `string` | n/a | yes |
| <a name="input_metal_auth_token"></a> [metal\_auth\_token](#input\_metal\_auth\_token) | Equinix Metal API key. Required only if cpem\_installed is `false` | `string` | n/a | yes |
| <a name="input_metal_project_id"></a> [metal\_project\_id](#input\_metal\_project\_id) | Equinix Metal project ID. Required only if cpem\_installed is `false` | `string` | n/a | yes |
| <a name="input_cpem_installed"></a> [cpem\_installed](#input\_cpem\_installed) | set `false` if cloud-provider-equinix-metal addon is NOT being enabled in the equinix\_kubernetes\_addons<br>module or CPEM is NOT already running on the kubernetes cluster | `bool` | `false` | no |

### Outputs

| Name | Description |
|------|-------------|
| <a name="output_equinix_kubernetes_addons_kube_vip"></a> [equinix\_kubernetes\_addons\_kube\_vip](#output\_equinix\_kubernetes\_addons\_kube\_vip) | Map of attributes available for the Kube-vip addon |
<!-- END_TF_DOCS -->

0 comments on commit b5b6881

Please sign in to comment.