Skip to content
This repository has been archived by the owner on May 29, 2024. It is now read-only.

Commit

Permalink
generate docs from hcl files
Browse files Browse the repository at this point in the history
  • Loading branch information
MGTheTrain committed Apr 27, 2024
1 parent 45f3ce9 commit d43c3d2
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 6 deletions.
2 changes: 1 addition & 1 deletion terraform/envs/sbx-k8s-configuration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ No resources.
| <a name="input_acr_password"></a> [acr\_password](#input\_acr\_password) | Sets an ACR password. | `string` | `"TBD"` | no |
| <a name="input_acr_username"></a> [acr\_username](#input\_acr\_username) | Sets an ACR user name. | `string` | `"TBD"` | no |
| <a name="input_environment"></a> [environment](#input\_environment) | The environment. | `string` | `"sbx"` | no |
| <a name="input_ml_ops_tool"></a> [ml\_ops\_tool](#input\_ml\_ops\_tool) | String determining whether to install Argo CD or FluxCD. Viable options: [ kubeflow, fluxcd ] | `string` | `"kubeflow"` | no |
| <a name="input_ml_ops_tool"></a> [ml\_ops\_tool](#input\_ml\_ops\_tool) | String determining whether to install mlflow or none. Viable options: [ mlflow, kubeflow, none ]. The installation of Kubeflow will be managed externally through the continuous deployment (CD) workflow, as Terraform modules and kubernetes provider are either outdated or difficult to setup | `string` | `"none"` | no |

## Outputs

Expand Down
12 changes: 10 additions & 2 deletions terraform/envs/sbx-k8s-deployment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ No requirements.

| Name | Source | Version |
|------|--------|---------|
| <a name="module_acr"></a> [acr](#module\_acr) | ../../modules/acr | n/a |
| <a name="module_az"></a> [az](#module\_az) | git::https://github.com/MGTheTrain/gitops-ftw.git//terraform/modules/az | main |

## Resources
Expand All @@ -17,16 +18,20 @@ No resources.

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_acr_admin_enabled"></a> [acr\_admin\_enabled](#input\_acr\_admin\_enabled) | Flag to enable admin user for the Azure Container Registry | `bool` | `true` | no |
| <a name="input_acr_sku"></a> [acr\_sku](#input\_acr\_sku) | SKU for the Azure Container Registry | `string` | `"Basic"` | no |
| <a name="input_aks_admin_username"></a> [aks\_admin\_username](#input\_aks\_admin\_username) | The AKS admin username | `string` | `"azureuser"` | no |
| <a name="input_aks_enable_auto_scaling"></a> [aks\_enable\_auto\_scaling](#input\_aks\_enable\_auto\_scaling) | Whether to allow the AKS cluster to automatically adjust the number of nodes in a node pool | `bool` | `true` | no |
| <a name="input_aks_max_node_count"></a> [aks\_max\_node\_count](#input\_aks\_max\_node\_count) | The AKS max node count | `number` | `2` | no |
| <a name="input_aks_node_count"></a> [aks\_node\_count](#input\_aks\_node\_count) | The AKS node count | `number` | `1` | no |
| <a name="input_aks_os_disk_size_gb"></a> [aks\_os\_disk\_size\_gb](#input\_aks\_os\_disk\_size\_gb) | The AKS Agent Operating System disk size in GB | `string` | `"128"` | no |
| <a name="input_aks_vm_size"></a> [aks\_vm\_size](#input\_aks\_vm\_size) | The AKS vm size. Other option is Standard\_B2s. See https://learn.microsoft.com/en-us/azure/virtual-machines/sizes, https://azureprice.net/ | `string` | `"Standard_B8ms"` | no |
| <a name="input_digital_product_affix"></a> [digital\_product\_affix](#input\_digital\_product\_affix) | The digital product affix. | `string` | `"mlopsftw"` | no |
| <a name="input_digital_product_affix_acr_module"></a> [digital\_product\_affix\_acr\_module](#input\_digital\_product\_affix\_acr\_module) | The digital product affix of the acr module. | `string` | `"mlopsftwacr"` | no |
| <a name="input_digital_product_affix_az_module"></a> [digital\_product\_affix\_az\_module](#input\_digital\_product\_affix\_az\_module) | The digital product affix of the az module. | `string` | `"mlopsftwaz"` | no |
| <a name="input_environment"></a> [environment](#input\_environment) | The environment. | `string` | `"sbx"` | no |
| <a name="input_location"></a> [location](#input\_location) | The geographic location in which to deploy. | `string` | `"West Europe"` | no |
| <a name="input_number_of_aks"></a> [number\_of\_aks](#input\_number\_of\_aks) | The total number of AKses to deploy. | `number` | `1` | no |
| <a name="input_number_of_container_registries"></a> [number\_of\_container\_registries](#input\_number\_of\_container\_registries) | The total number of Azure Container registries to deploy. | `number` | `1` | no |
| <a name="input_resource_instance_number"></a> [resource\_instance\_number](#input\_resource\_instance\_number) | The resource instance number. | `string` | `"001"` | no |
| <a name="input_team"></a> [team](#input\_team) | The team used for tagging resource groups and resources. | `string` | `"MG Innovators"` | no |
| <a name="input_virtual_network_address_space"></a> [virtual\_network\_address\_space](#input\_virtual\_network\_address\_space) | The virtual network address space. E.g. 2^(32-16)=65536 private ips in Vnet. | `list(string)` | <pre>[<br> "10.1.0.0/16"<br>]</pre> | no |
Expand All @@ -37,6 +42,9 @@ No resources.
|------|-------------|
| <a name="output_aks_kube_config_list"></a> [aks\_kube\_config\_list](#output\_aks\_kube\_config\_list) | n/a |
| <a name="output_aks_name_list"></a> [aks\_name\_list](#output\_aks\_name\_list) | n/a |
| <a name="output_aks_tls_private_key"></a> [aks\_tls\_private\_key](#output\_aks\_tls\_private\_key) | n/a |
| <a name="output_aks_tls_private_key"></a> [aks\_tls\_private\_key](#output\_aks\_tls\_private\_key) | AKS |
| <a name="output_container_registry_admin_password_list"></a> [container\_registry\_admin\_password\_list](#output\_container\_registry\_admin\_password\_list) | n/a |
| <a name="output_container_registry_admin_username_list"></a> [container\_registry\_admin\_username\_list](#output\_container\_registry\_admin\_username\_list) | ACR |
| <a name="output_container_registry_login_server_list"></a> [container\_registry\_login\_server\_list](#output\_container\_registry\_login\_server\_list) | n/a |
| <a name="output_resource_group_name"></a> [resource\_group\_name](#output\_resource\_group\_name) | n/a |
<!-- END_TF_DOCS -->
4 changes: 1 addition & 3 deletions terraform/modules/k8s/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,8 @@ No modules.
| [helm_release.mlflow](https://registry.terraform.io/providers/helm/latest/docs/resources/release) | resource |
| [helm_release.nginx_ingress_controller](https://registry.terraform.io/providers/helm/latest/docs/resources/release) | resource |
| [kubernetes_ingress_v1.ml_ops_ftw_ingress](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/ingress_v1) | resource |
| [kubernetes_manifest.install_kubeflow_operator](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/manifest) | resource |
| [kubernetes_namespace.ml_ops_ftw_namespace](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/namespace) | resource |
| [kubernetes_secret.acr_secret](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/secret) | resource |
| [null_resource.install_olm](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) | resource |

## Inputs

Expand All @@ -29,7 +27,7 @@ No modules.
| <a name="input_acr_password"></a> [acr\_password](#input\_acr\_password) | Sets an ACR password. | `string` | `"TBD"` | no |
| <a name="input_acr_username"></a> [acr\_username](#input\_acr\_username) | Sets an ACR user name. | `string` | `"TBD"` | no |
| <a name="input_environment"></a> [environment](#input\_environment) | The environment. | `string` | `"sbx"` | no |
| <a name="input_ml_ops_tool"></a> [ml\_ops\_tool](#input\_ml\_ops\_tool) | String determining whether to install kubeflow or mlflow. Viable options: [ kubeflow, mlflow ] | `string` | `"kubeflow"` | no |
| <a name="input_ml_ops_tool"></a> [ml\_ops\_tool](#input\_ml\_ops\_tool) | String determining whether to install mlflow or none. Viable options: [ mlflow, kubeflow, none ]. The installation of Kubeflow will be managed externally through the continuous deployment (CD) workflow, as Terraform modules and kubernetes provider are either outdated or difficult to setup | `string` | `"none"` | no |

## Outputs

Expand Down

0 comments on commit d43c3d2

Please sign in to comment.