Skip to content

Commit

Permalink
terraform-docs: automated action
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Sep 7, 2024
1 parent 167025b commit 8abd82d
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 10 deletions.
13 changes: 7 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,15 +99,16 @@ This terraform module was developed by **Marcel Lupo** as part of a project to e

| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.7.0 |
| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | ~> 3.114.0 |
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.9.5 |
| <a name="requirement_azurerm"></a> [azurerm](#requirement\_azurerm) | ~> 4.1.0 |
| <a name="requirement_random"></a> [random](#requirement\_random) | ~> 3.1.0 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_azurerm"></a> [azurerm](#provider\_azurerm) | ~> 3.114.0 |
| <a name="provider_random"></a> [random](#provider\_random) | n/a |
| <a name="provider_azurerm"></a> [azurerm](#provider\_azurerm) | ~> 4.1.0 |
| <a name="provider_random"></a> [random](#provider\_random) | ~> 3.1.0 |

## Modules

Expand Down Expand Up @@ -216,14 +217,14 @@ No modules.
| <a name="input_oai_fqdns"></a> [oai\_fqdns](#input\_oai\_fqdns) | A list of FQDNs to be used for token-based authentication. Changing this forces a new resource to be created. | `list(string)` | `[]` | no |
| <a name="input_oai_identity"></a> [oai\_identity](#input\_oai\_identity) | type = object({<br> type = (Required) The type of the Identity. Possible values are `SystemAssigned`, `UserAssigned`, `SystemAssigned, UserAssigned`.<br> identity\_ids = (Optional) Specifies a list of User Assigned Managed Identity IDs to be assigned to this OpenAI Account.<br>}) | <pre>object({<br> type = string<br> identity_ids = optional(list(string))<br> })</pre> | <pre>{<br> "type": "SystemAssigned"<br>}</pre> | no |
| <a name="input_oai_local_auth_enabled"></a> [oai\_local\_auth\_enabled](#input\_oai\_local\_auth\_enabled) | Whether local authentication methods is enabled for the Cognitive Account. Defaults to `true`. | `bool` | `true` | no |
| <a name="input_oai_model_deployment"></a> [oai\_model\_deployment](#input\_oai\_model\_deployment) | type = list(object({<br> deployment\_id = (Required) The name of the Cognitive Services Account `Model Deployment`. Changing this forces a new resource to be created.<br> model\_name = {<br> model\_format = (Required) The format of the Cognitive Services Account Deployment model. Changing this forces a new resource to be created. Possible value is OpenAI.<br> model\_name = (Required) The name of the Cognitive Services Account Deployment model. Changing this forces a new resource to be created.<br> model\_version = (Required) The version of Cognitive Services Account Deployment model.<br> }<br> scale = {<br> scale\_type = (Required) Deployment scale type. Possible value is Standard. Changing this forces a new resource to be created.<br> scale\_tier = (Optional) Possible values are Free, Basic, Standard, Premium, Enterprise. Changing this forces a new resource to be created.<br> scale\_size = (Optional) The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. Changing this forces a new resource to be created.<br> scale\_family = (Optional) If the service has different generations of hardware, for the same SKU, then that can be captured here. Changing this forces a new resource to be created.<br> scale\_capacity = (Optional) Tokens-per-Minute (TPM). If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. Default value is 1. Changing this forces a new resource to be created.<br> }<br> rai\_policy\_name = (Optional) The name of RAI policy. Changing this forces a new resource to be created.<br>})) | <pre>list(object({<br> deployment_id = string<br> model_name = string<br> model_format = string<br> model_version = string<br> scale_type = string<br> scale_tier = optional(string)<br> scale_size = optional(number)<br> scale_family = optional(string)<br> scale_capacity = optional(number)<br> rai_policy_name = optional(string)<br> }))</pre> | `[]` | no |
| <a name="input_oai_model_deployment"></a> [oai\_model\_deployment](#input\_oai\_model\_deployment) | type = list(object({<br> deployment\_id = (Required) The name of the Cognitive Services Account `Model Deployment`. Changing this forces a new resource to be created.<br> model\_name = {<br> model\_format = (Required) The format of the Cognitive Services Account Deployment model. Changing this forces a new resource to be created. Possible value is OpenAI.<br> model\_name = (Required) The name of the Cognitive Services Account Deployment model. Changing this forces a new resource to be created.<br> model\_version = (Required) The version of Cognitive Services Account Deployment model.<br> }<br> sku = {<br> sku\_name = (Required) The name of the SKU. Possible values include Standard, GlobalBatch, GlobalStandard and ProvisionedManaged.<br> sku\_tier = (Optional) Possible values are Free, Basic, Standard, Premium, Enterprise. Changing this forces a new resource to be created.<br> sku\_size = (Optional) The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. Changing this forces a new resource to be created.<br> sku\_family = (Optional) If the service has different generations of hardware, for the same SKU, then that can be captured here. Changing this forces a new resource to be created.<br> sku\_capacity = (Optional) Tokens-per-Minute (TPM). If the SKU supports sku out/in then the capacity integer should be included. If sku out/in is not possible for the resource this may be omitted. Default value is 1. Changing this forces a new resource to be created.<br> }<br> rai\_policy\_name = (Optional) The name of RAI policy. Changing this forces a new resource to be created.<br>})) | <pre>list(object({<br> deployment_id = string<br> model_name = string<br> model_format = string<br> model_version = string<br> sku_name = string<br> sku_tier = optional(string)<br> sku_size = optional(number)<br> sku_family = optional(string)<br> sku_capacity = optional(number)<br> rai_policy_name = optional(string)<br> }))</pre> | `[]` | no |
| <a name="input_oai_network_acls"></a> [oai\_network\_acls](#input\_oai\_network\_acls) | type = set(object({<br> default\_action = (Required) The Default Action to use when no rules match from ip\_rules / virtual\_network\_rules. Possible values are `Allow` and `Deny`.<br> ip\_rules = (Optional) One or more IP Addresses, or CIDR Blocks which should be able to access the Cognitive Account.<br> virtual\_network\_rules = optional(set(object({<br> subnet\_id = (Required) The ID of a Subnet which should be able to access the OpenAI Account.<br> ignore\_missing\_vnet\_service\_endpoint = (Optional) Whether ignore missing vnet service endpoint or not. Default to `false`.<br> })))<br>})) | <pre>set(object({<br> default_action = string<br> ip_rules = optional(set(string))<br> virtual_network_rules = optional(set(object({<br> subnet_id = string<br> ignore_missing_vnet_service_endpoint = optional(bool, false)<br> })))<br> }))</pre> | `null` | no |
| <a name="input_oai_outbound_network_access_restricted"></a> [oai\_outbound\_network\_access\_restricted](#input\_oai\_outbound\_network\_access\_restricted) | Whether or not outbound network access is restricted. Defaults to `false`. | `bool` | `false` | no |
| <a name="input_oai_public_network_access_enabled"></a> [oai\_public\_network\_access\_enabled](#input\_oai\_public\_network\_access\_enabled) | Whether or not public network access is enabled. Defaults to `false`. | `bool` | `true` | no |
| <a name="input_oai_sku_name"></a> [oai\_sku\_name](#input\_oai\_sku\_name) | SKU name of the OpenAI service. | `string` | `"S0"` | no |
| <a name="input_oai_storage"></a> [oai\_storage](#input\_oai\_storage) | type = list(object({<br> storage\_account\_id = (Required) Full resource id of a Microsoft.Storage resource.<br> identity\_client\_id = (Optional) The client ID of the managed identity associated with the storage resource.<br>})) | <pre>list(object({<br> storage_account_id = string<br> identity_client_id = optional(string)<br> }))</pre> | `[]` | no |
| <a name="input_resource_group_name"></a> [resource\_group\_name](#input\_resource\_group\_name) | Name of the resource group to create the OpenAI service / or where an existing service is hosted. | `string` | n/a | yes |
| <a name="input_subnet_config"></a> [subnet\_config](#input\_subnet\_config) | A list of subnet configuration objects to create subnets in the virtual network. | <pre>object({<br> subnet_name = string<br> subnet_address_space = list(string)<br> service_endpoints = list(string)<br> private_endpoint_network_policies_enabled = bool<br> private_link_service_network_policies_enabled = bool<br> subnets_delegation_settings = map(list(object({<br> name = string<br> actions = list(string)<br> })))<br> })</pre> | <pre>{<br> "private_endpoint_network_policies_enabled": false,<br> "private_link_service_network_policies_enabled": false,<br> "service_endpoints": [<br> "Microsoft.AzureCosmosDB",<br> "Microsoft.Web"<br> ],<br> "subnet_address_space": [<br> "10.4.0.0/24"<br> ],<br> "subnet_name": "app-cosmos-sub",<br> "subnets_delegation_settings": {<br> "app-service-plan": [<br> {<br> "actions": [<br> "Microsoft.Network/virtualNetworks/subnets/action"<br> ],<br> "name": "Microsoft.Web/serverFarms"<br> }<br> ]<br> }<br>}</pre> | no |
| <a name="input_subnet_config"></a> [subnet\_config](#input\_subnet\_config) | A list of subnet configuration objects to create subnets in the virtual network. | <pre>object({<br> subnet_name = string<br> subnet_address_space = list(string)<br> service_endpoints = list(string)<br> private_endpoint_network_policies_enabled = string<br> private_link_service_network_policies_enabled = bool<br> subnets_delegation_settings = map(list(object({<br> name = string<br> actions = list(string)<br> })))<br> })</pre> | <pre>{<br> "private_endpoint_network_policies_enabled": "Enabled",<br> "private_link_service_network_policies_enabled": false,<br> "service_endpoints": [<br> "Microsoft.AzureCosmosDB",<br> "Microsoft.Web"<br> ],<br> "subnet_address_space": [<br> "10.4.0.0/24"<br> ],<br> "subnet_name": "app-cosmos-sub",<br> "subnets_delegation_settings": {<br> "app-service-plan": [<br> {<br> "actions": [<br> "Microsoft.Network/virtualNetworks/subnets/action"<br> ],<br> "name": "Microsoft.Web/serverFarms"<br> }<br> ]<br> }<br>}</pre> | no |
| <a name="input_tags"></a> [tags](#input\_tags) | A map of key value pairs that is used to tag resources created. | `map(string)` | `{}` | no |
| <a name="input_use_cosmosdb_free_tier"></a> [use\_cosmosdb\_free\_tier](#input\_use\_cosmosdb\_free\_tier) | Whether to enable the free tier for the Cosmos DB account. This needs to be false if another instance already uses free tier. | `bool` | `true` | no |
| <a name="input_virtual_network_name"></a> [virtual\_network\_name](#input\_virtual\_network\_name) | Name of the virtual network where resources are attached. | `string` | `"openai-vnet-9000"` | no |
Expand Down
Loading

0 comments on commit 8abd82d

Please sign in to comment.