diff --git a/docs/data-sources/ai_cluster.md b/docs/data-sources/ai_cluster.md index c6c485a0..4c6ef451 100644 --- a/docs/data-sources/ai_cluster.md +++ b/docs/data-sources/ai_cluster.md @@ -37,6 +37,7 @@ output "view" { ``` + ## Schema ### Required @@ -73,6 +74,7 @@ output "view" { - `volume` (Set of Object) List of volumes attached to the cluster (see [below for nested schema](#nestedatt--volume)) + ### Nested Schema for `interface` Read-Only: @@ -82,8 +84,8 @@ Read-Only: - `subnet_id` (String) - `type` (String) - + ### Nested Schema for `poplar_servers` Read-Only: @@ -105,6 +107,7 @@ Read-Only: - `volumes` (Set of Object) (see [below for nested schema](#nestedobjatt--poplar_servers--volumes)) + ### Nested Schema for `poplar_servers.addresses` Read-Only: @@ -113,6 +116,7 @@ Read-Only: - `network_name` (String) + ### Nested Schema for `poplar_servers.addresses.address` Read-Only: @@ -120,17 +124,16 @@ Read-Only: - `addr` (String) - `type` (String) - - + ### Nested Schema for `poplar_servers.security_groups` Read-Only: - `name` (String) - + ### Nested Schema for `poplar_servers.volumes` Read-Only: @@ -138,17 +141,16 @@ Read-Only: - `delete_on_termination` (Boolean) - `id` (String) - - + ### Nested Schema for `security_group` Read-Only: - `id` (String) - + ### Nested Schema for `volume` Read-Only: @@ -167,6 +169,7 @@ Read-Only: - `volume_type` (String) + ### Nested Schema for `volume.attachments` Read-Only: diff --git a/docs/data-sources/ddos_profile_template.md b/docs/data-sources/ddos_profile_template.md index 38cc65e1..5b0826a2 100644 --- a/docs/data-sources/ddos_profile_template.md +++ b/docs/data-sources/ddos_profile_template.md @@ -37,6 +37,7 @@ output "view" { ``` + ## Schema ### Optional @@ -55,6 +56,7 @@ output "view" { - `id` (String) The ID of this resource. + ### Nested Schema for `fields` Read-Only: diff --git a/docs/data-sources/faas_function.md b/docs/data-sources/faas_function.md index 5e109594..9417f804 100644 --- a/docs/data-sources/faas_function.md +++ b/docs/data-sources/faas_function.md @@ -38,6 +38,7 @@ output "view" { ``` + ## Schema ### Required diff --git a/docs/data-sources/faas_key.md b/docs/data-sources/faas_key.md index c4c70f5a..e33967f2 100644 --- a/docs/data-sources/faas_key.md +++ b/docs/data-sources/faas_key.md @@ -37,6 +37,7 @@ output "view" { ``` + ## Schema ### Required @@ -60,6 +61,7 @@ output "view" { - `status` (String) + ### Nested Schema for `functions` Read-Only: diff --git a/docs/data-sources/faas_namespace.md b/docs/data-sources/faas_namespace.md index ce746846..6ad5407b 100644 --- a/docs/data-sources/faas_namespace.md +++ b/docs/data-sources/faas_namespace.md @@ -37,6 +37,7 @@ output "view" { ``` + ## Schema ### Required diff --git a/docs/data-sources/floatingip.md b/docs/data-sources/floatingip.md index 0cec056a..b92bbe36 100644 --- a/docs/data-sources/floatingip.md +++ b/docs/data-sources/floatingip.md @@ -43,6 +43,7 @@ output "view" { ``` + ## Schema ### Optional @@ -65,6 +66,7 @@ output "view" { - `status` (String) + ### Nested Schema for `metadata_read_only` Read-Only: diff --git a/docs/data-sources/image.md b/docs/data-sources/image.md index aee92d28..fdec1c9a 100644 --- a/docs/data-sources/image.md +++ b/docs/data-sources/image.md @@ -37,6 +37,7 @@ output "view" { ``` + ## Schema ### Required @@ -64,6 +65,7 @@ output "view" { - `os_version` (String) + ### Nested Schema for `metadata_read_only` Read-Only: diff --git a/docs/data-sources/instance.md b/docs/data-sources/instance.md index afa7e402..1c984daf 100644 --- a/docs/data-sources/instance.md +++ b/docs/data-sources/instance.md @@ -37,6 +37,7 @@ output "view" { ``` + ## Schema ### Required @@ -64,6 +65,7 @@ output "view" { - `volume` (Set of Object) (see [below for nested schema](#nestedatt--volume)) + ### Nested Schema for `addresses` Read-Only: @@ -71,6 +73,7 @@ Read-Only: - `net` (List of Object) (see [below for nested schema](#nestedobjatt--addresses--net)) + ### Nested Schema for `addresses.net` Read-Only: @@ -78,9 +81,8 @@ Read-Only: - `addr` (String) - `type` (String) - - + ### Nested Schema for `interface` Read-Only: @@ -90,8 +92,8 @@ Read-Only: - `port_id` (String) - `subnet_id` (String) - + ### Nested Schema for `metadata` Read-Only: @@ -99,16 +101,16 @@ Read-Only: - `key` (String) - `value` (String) - + ### Nested Schema for `security_group` Read-Only: - `name` (String) - + ### Nested Schema for `volume` Read-Only: diff --git a/docs/data-sources/k8sv2.md b/docs/data-sources/k8sv2.md index 47adeddf..06414b91 100644 --- a/docs/data-sources/k8sv2.md +++ b/docs/data-sources/k8sv2.md @@ -37,6 +37,7 @@ output "view" { ``` + ## Schema ### Required @@ -68,14 +69,15 @@ output "view" { - `version` (String) + ### Nested Schema for `cni` Required: - `provider` (String) - + ### Nested Schema for `pools` Read-Only: diff --git a/docs/data-sources/laas_hosts.md b/docs/data-sources/laas_hosts.md index 4fd85c9b..42e2c09e 100644 --- a/docs/data-sources/laas_hosts.md +++ b/docs/data-sources/laas_hosts.md @@ -36,6 +36,7 @@ output "view" { ``` + ## Schema ### Optional diff --git a/docs/data-sources/laas_status.md b/docs/data-sources/laas_status.md index 4f5e3dd3..2d732a6e 100644 --- a/docs/data-sources/laas_status.md +++ b/docs/data-sources/laas_status.md @@ -36,6 +36,7 @@ output "view" { ``` + ## Schema ### Optional diff --git a/docs/data-sources/lblistener.md b/docs/data-sources/lblistener.md index 7b6f3bc5..5b90d673 100644 --- a/docs/data-sources/lblistener.md +++ b/docs/data-sources/lblistener.md @@ -8,8 +8,6 @@ description: |- # gcore_lblistener (Data Source) - - ## Example Usage ```terraform @@ -38,6 +36,7 @@ output "view" { ``` + ## Schema ### Required diff --git a/docs/data-sources/lbpool.md b/docs/data-sources/lbpool.md index 399c0f91..413129f3 100644 --- a/docs/data-sources/lbpool.md +++ b/docs/data-sources/lbpool.md @@ -8,8 +8,6 @@ description: |- # gcore_lbpool (Data Source) - - ## Example Usage ```terraform @@ -37,6 +35,7 @@ output "view" { ``` + ## Schema ### Required @@ -61,6 +60,7 @@ output "view" { - `session_persistence` (List of Object) (see [below for nested schema](#nestedatt--session_persistence)) + ### Nested Schema for `health_monitor` Read-Only: @@ -75,8 +75,8 @@ Read-Only: - `type` (String) - `url_path` (String) - + ### Nested Schema for `session_persistence` Read-Only: diff --git a/docs/data-sources/loadbalancer.md b/docs/data-sources/loadbalancer.md index e0906ae9..8b4abf90 100644 --- a/docs/data-sources/loadbalancer.md +++ b/docs/data-sources/loadbalancer.md @@ -8,8 +8,6 @@ description: |- # gcore_loadbalancer (Data Source) - - ## Example Usage ```terraform @@ -37,6 +35,7 @@ output "view" { ``` + ## Schema ### Required @@ -61,6 +60,7 @@ output "view" { - `vip_port_id` (String) + ### Nested Schema for `listener` Read-Only: @@ -70,8 +70,8 @@ Read-Only: - `protocol` (String) - `protocol_port` (Number) - + ### Nested Schema for `metadata_read_only` Read-Only: diff --git a/docs/data-sources/loadbalancerv2.md b/docs/data-sources/loadbalancerv2.md index 96da0894..6838e59c 100644 --- a/docs/data-sources/loadbalancerv2.md +++ b/docs/data-sources/loadbalancerv2.md @@ -8,8 +8,6 @@ description: |- # gcore_loadbalancerv2 (Data Source) - - ## Example Usage ```terraform @@ -37,6 +35,7 @@ output "view" { ``` + ## Schema ### Required @@ -62,6 +61,7 @@ output "view" { - `vrrp_ips` (List of Object) (see [below for nested schema](#nestedatt--vrrp_ips)) + ### Nested Schema for `metadata_read_only` Read-Only: @@ -70,8 +70,8 @@ Read-Only: - `read_only` (Boolean) - `value` (String) - + ### Nested Schema for `vrrp_ips` Read-Only: diff --git a/docs/data-sources/network.md b/docs/data-sources/network.md index 4a865e03..7d30b45a 100644 --- a/docs/data-sources/network.md +++ b/docs/data-sources/network.md @@ -37,6 +37,7 @@ output "view" { ``` + ## Schema ### Required @@ -62,6 +63,7 @@ output "view" { - `type` (String) 'vlan' or 'vxlan' network type is allowed. Default value is 'vxlan' + ### Nested Schema for `metadata_read_only` Read-Only: diff --git a/docs/data-sources/project.md b/docs/data-sources/project.md index ff74ed02..037534da 100644 --- a/docs/data-sources/project.md +++ b/docs/data-sources/project.md @@ -23,6 +23,7 @@ data "gcore_project" "pr" { ``` + ## Schema ### Required diff --git a/docs/data-sources/region.md b/docs/data-sources/region.md index 77ecacad..8b3d83f0 100644 --- a/docs/data-sources/region.md +++ b/docs/data-sources/region.md @@ -23,6 +23,7 @@ data "gcore_region" "rg" { ``` + ## Schema ### Required diff --git a/docs/data-sources/reservedfixedip.md b/docs/data-sources/reservedfixedip.md index 8a0809ba..9a14bf28 100644 --- a/docs/data-sources/reservedfixedip.md +++ b/docs/data-sources/reservedfixedip.md @@ -37,6 +37,7 @@ output "view" { ``` + ## Schema ### Required @@ -61,6 +62,7 @@ output "view" { - `subnet_id` (String) + ### Nested Schema for `allowed_address_pairs` Read-Only: diff --git a/docs/data-sources/router.md b/docs/data-sources/router.md index 5f2218a8..026962c8 100644 --- a/docs/data-sources/router.md +++ b/docs/data-sources/router.md @@ -8,8 +8,6 @@ description: |- # gcore_router (Data Source) - - ## Example Usage ```terraform @@ -37,6 +35,7 @@ output "view" { ``` + ## Schema ### Required @@ -59,6 +58,7 @@ output "view" { - `status` (String) + ### Nested Schema for `external_gateway_info` Read-Only: @@ -68,6 +68,7 @@ Read-Only: - `network_id` (String) + ### Nested Schema for `external_gateway_info.external_fixed_ips` Read-Only: @@ -75,9 +76,8 @@ Read-Only: - `ip_address` (String) - `subnet_id` (String) - - + ### Nested Schema for `interfaces` Read-Only: @@ -89,8 +89,8 @@ Read-Only: - `subnet_id` (String) - `type` (String) - + ### Nested Schema for `routes` Read-Only: diff --git a/docs/data-sources/secret.md b/docs/data-sources/secret.md index 4478d2c2..081a798e 100644 --- a/docs/data-sources/secret.md +++ b/docs/data-sources/secret.md @@ -37,6 +37,7 @@ output "view" { ``` + ## Schema ### Required diff --git a/docs/data-sources/securitygroup.md b/docs/data-sources/securitygroup.md index 5c8e4d83..e662d152 100644 --- a/docs/data-sources/securitygroup.md +++ b/docs/data-sources/securitygroup.md @@ -37,6 +37,7 @@ output "view" { ``` + ## Schema ### Required @@ -60,6 +61,7 @@ output "view" { - `security_group_rules` (Set of Object) Firewall rules control what inbound(ingress) and outbound(egress) traffic is allowed to enter or leave a Instance. At least one 'egress' rule should be set (see [below for nested schema](#nestedatt--security_group_rules)) + ### Nested Schema for `metadata_read_only` Read-Only: @@ -68,8 +70,8 @@ Read-Only: - `read_only` (Boolean) - `value` (String) - + ### Nested Schema for `security_group_rules` Read-Only: diff --git a/docs/data-sources/servergroup.md b/docs/data-sources/servergroup.md index 102c33fd..fd152b48 100644 --- a/docs/data-sources/servergroup.md +++ b/docs/data-sources/servergroup.md @@ -37,6 +37,7 @@ output "view" { ``` + ## Schema ### Required @@ -57,6 +58,7 @@ output "view" { - `policy` (String) Server group policy. Available value is 'affinity', 'anti-affinity' + ### Nested Schema for `instances` Read-Only: diff --git a/docs/data-sources/storage_s3.md b/docs/data-sources/storage_s3.md index eceb25fe..14e11781 100644 --- a/docs/data-sources/storage_s3.md +++ b/docs/data-sources/storage_s3.md @@ -23,6 +23,7 @@ data "gcore_storage_s3" "example_s3" { ``` + ## Schema ### Optional diff --git a/docs/data-sources/storage_s3_bucket.md b/docs/data-sources/storage_s3_bucket.md index 82cda08a..f0ba8652 100644 --- a/docs/data-sources/storage_s3_bucket.md +++ b/docs/data-sources/storage_s3_bucket.md @@ -24,6 +24,7 @@ data "gcore_storage_s3_bucket" "example_s3_bucket" { ``` + ## Schema ### Required diff --git a/docs/data-sources/storage_sftp.md b/docs/data-sources/storage_sftp.md index 309a452d..8172ca98 100644 --- a/docs/data-sources/storage_sftp.md +++ b/docs/data-sources/storage_sftp.md @@ -23,6 +23,7 @@ data "gcore_storage_sftp" "example_sftp" { ``` + ## Schema ### Optional diff --git a/docs/data-sources/storage_sftp_key.md b/docs/data-sources/storage_sftp_key.md index 48cf881c..51043ec7 100644 --- a/docs/data-sources/storage_sftp_key.md +++ b/docs/data-sources/storage_sftp_key.md @@ -23,6 +23,7 @@ data "gcore_storage_sftp_key" "example_key" { ``` + ## Schema ### Required diff --git a/docs/data-sources/subnet.md b/docs/data-sources/subnet.md index 43a55b89..25f6f455 100644 --- a/docs/data-sources/subnet.md +++ b/docs/data-sources/subnet.md @@ -8,8 +8,6 @@ description: |- # gcore_subnet (Data Source) - - ## Example Usage ```terraform @@ -37,6 +35,7 @@ output "view" { ``` + ## Schema ### Required @@ -65,6 +64,7 @@ output "view" { - `metadata_read_only` (List of Object) (see [below for nested schema](#nestedatt--metadata_read_only)) + ### Nested Schema for `host_routes` Read-Only: @@ -72,8 +72,8 @@ Read-Only: - `destination` (String) - `nexthop` (String) - + ### Nested Schema for `metadata_read_only` Read-Only: diff --git a/docs/data-sources/volume.md b/docs/data-sources/volume.md index 5a733ae4..4d14a3ab 100644 --- a/docs/data-sources/volume.md +++ b/docs/data-sources/volume.md @@ -37,6 +37,7 @@ output "view" { ``` + ## Schema ### Required @@ -60,6 +61,7 @@ output "view" { - `type_name` (String) Available value is 'standard', 'ssd_hiiops', 'cold', 'ultra'. Defaults to standard + ### Nested Schema for `metadata_read_only` Read-Only: diff --git a/docs/index.md b/docs/index.md index e27ffd62..fba27e01 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,8 +8,6 @@ description: |- # gcore Provider - - ## Example Usage ```terraform @@ -213,6 +211,7 @@ resource "gcore_lbmember" "lbm2" { ``` + ## Schema ### Optional diff --git a/docs/resources/ai_cluster.md b/docs/resources/ai_cluster.md index ea8ce3b3..f839b769 100644 --- a/docs/resources/ai_cluster.md +++ b/docs/resources/ai_cluster.md @@ -46,6 +46,7 @@ resource "gcore_ai_cluster" "cluster1" { ``` + ## Schema ### Required @@ -81,6 +82,7 @@ resource "gcore_ai_cluster" "cluster1" { - `task_status` (String) Task status + ### Nested Schema for `interface` Optional: @@ -90,16 +92,16 @@ Optional: - `subnet_id` (String) Port is assigned to IP address from the subnet - `type` (String) Network type - + ### Nested Schema for `security_group` Optional: - `id` (String) Security group ID - + ### Nested Schema for `volume` Optional: @@ -121,6 +123,7 @@ Read-Only: - `volume_image_metadata` (Map of String) Image information for volumes that were created from image + ### Nested Schema for `volume.attachments` Read-Only: @@ -132,9 +135,8 @@ Read-Only: - `server_id` (String) Instance ID - `volume_id` (String) Volume ID - - + ### Nested Schema for `poplar_servers` Read-Only: @@ -156,6 +158,7 @@ Read-Only: - `volumes` (Set of Object) (see [below for nested schema](#nestedobjatt--poplar_servers--volumes)) + ### Nested Schema for `poplar_servers.addresses` Read-Only: @@ -164,6 +167,7 @@ Read-Only: - `network_name` (String) + ### Nested Schema for `poplar_servers.addresses.address` Read-Only: @@ -171,17 +175,16 @@ Read-Only: - `addr` (String) - `type` (String) - - + ### Nested Schema for `poplar_servers.security_groups` Read-Only: - `name` (String) - + ### Nested Schema for `poplar_servers.volumes` Read-Only: diff --git a/docs/resources/baremetal.md b/docs/resources/baremetal.md index 84390613..22926f8f 100644 --- a/docs/resources/baremetal.md +++ b/docs/resources/baremetal.md @@ -41,6 +41,7 @@ resource "gcore_baremetal" "bm" { ``` + ## Schema ### Required @@ -78,6 +79,7 @@ resource "gcore_baremetal" "bm" { - `vm_state` (String) + ### Nested Schema for `interface` Required: @@ -92,11 +94,11 @@ Optional: - `is_parent` (Boolean) If not set will be calculated after creation. Trunk interface always attached first. Can't detach interface if is_parent true. Fields affect only on creation - `network_id` (String) required if type is 'subnet' or 'any_subnet' - `order` (Number) Order of attaching interface. Trunk interface always attached first, fields affect only on creation -- `port_id` (String) required if type is 'reserved_fixed_ip' +- `port_id` (String) required if type is 'reserved_fixed_ip' - `subnet_id` (String) required if type is 'subnet' - + ### Nested Schema for `metadata` Required: @@ -104,16 +106,16 @@ Required: - `key` (String) - `value` (String) - + ### Nested Schema for `timeouts` Optional: - `create` (String) - + ### Nested Schema for `addresses` Read-Only: @@ -121,6 +123,7 @@ Read-Only: - `net` (List of Object) (see [below for nested schema](#nestedobjatt--addresses--net)) + ### Nested Schema for `addresses.net` Read-Only: diff --git a/docs/resources/cdn_origingroup.md b/docs/resources/cdn_origingroup.md index f1de5435..11ae0beb 100644 --- a/docs/resources/cdn_origingroup.md +++ b/docs/resources/cdn_origingroup.md @@ -33,6 +33,7 @@ resource "gcore_cdn_origingroup" "origin_group_1" { ``` + ## Schema ### Required @@ -46,6 +47,7 @@ resource "gcore_cdn_origingroup" "origin_group_1" { - `id` (String) The ID of this resource. + ### Nested Schema for `origin` Required: diff --git a/docs/resources/cdn_resource.md b/docs/resources/cdn_resource.md index 05121ed8..6d96f3ad 100644 --- a/docs/resources/cdn_resource.md +++ b/docs/resources/cdn_resource.md @@ -79,6 +79,7 @@ resource "gcore_cdn_resource" "cdn_example_com" { ``` + ## Schema ### Required @@ -103,6 +104,7 @@ resource "gcore_cdn_resource" "cdn_example_com" { - `status` (String) Status of a CDN resource content availability. Possible values are: Active, Suspended, Processed. + ### Nested Schema for `options` Optional: @@ -153,6 +155,7 @@ Optional: - `websockets` (Block List, Max: 1) WebSockets option allows WebSockets connections to an origin server. (see [below for nested schema](#nestedblock--options--websockets)) + ### Nested Schema for `options.allowed_http_methods` Required: @@ -163,8 +166,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.brotli_compression` Required: @@ -175,8 +178,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.browser_cache_settings` Optional: @@ -184,8 +187,8 @@ Optional: - `enabled` (Boolean) - `value` (String) Use '0s' to disable caching. The value applies for a response with codes 200, 201, 204, 206, 301, 302, 303, 304, 307, 308. - + ### Nested Schema for `options.cache_http_headers` Required: @@ -196,8 +199,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.cors` Required: @@ -209,8 +212,8 @@ Optional: - `always` (Boolean) Specify if the Access-Control-Allow-Origin header should be added to a response from CDN regardless of response code. - `enabled` (Boolean) - + ### Nested Schema for `options.country_acl` Required: @@ -222,8 +225,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.disable_cache` Required: @@ -234,8 +237,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.disable_proxy_force_ranges` Required: @@ -246,8 +249,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.edge_cache_settings` Optional: @@ -257,8 +260,8 @@ Optional: - `enabled` (Boolean) - `value` (String) Specify caching time for the response with codes 200, 206, 301, 302. Responses with codes 4xx, 5xx will not be cached. Use '0s' to disable caching. Use custom_values field to specify a custom caching time for a response with specific codes. - + ### Nested Schema for `options.fetch_compressed` Required: @@ -269,8 +272,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.follow_origin_redirect` Required: @@ -281,8 +284,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.force_return` Required: @@ -294,8 +297,8 @@ Optional: - `body` (String) Response text or URL if you're going to set up redirection. Max length = 100. - `enabled` (Boolean) - + ### Nested Schema for `options.forward_host_header` Required: @@ -306,8 +309,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.gzip_on` Required: @@ -318,8 +321,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.host_header` Required: @@ -330,8 +333,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.http3_enabled` Required: @@ -342,8 +345,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.ignore_cookie` Required: @@ -354,8 +357,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.ignore_query_string` Required: @@ -366,8 +369,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.image_stack` Required: @@ -381,8 +384,8 @@ Optional: - `png_lossless` (Boolean) Represents compression without quality loss for PNG format. - `webp_enabled` (Boolean) If enabled, JPG and PNG images automatically convert to WebP format when supported by the end users browser. - + ### Nested Schema for `options.ip_address_acl` Required: @@ -394,8 +397,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.limit_bandwidth` Required: @@ -408,8 +411,8 @@ Optional: - `enabled` (Boolean) - `speed` (Number) Maximum download speed per connection. Must be greater than 0. - + ### Nested Schema for `options.proxy_cache_methods_set` Required: @@ -420,8 +423,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.query_params_blacklist` Required: @@ -432,8 +435,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.query_params_whitelist` Required: @@ -444,8 +447,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.redirect_http_to_https` Required: @@ -456,8 +459,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.redirect_https_to_http` Required: @@ -468,8 +471,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.referrer_acl` Required: @@ -481,8 +484,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.request_limiter` Required: @@ -496,8 +499,8 @@ Optional: - `enabled` (Boolean) - `rate_unit` (String) - + ### Nested Schema for `options.response_headers_hiding_policy` Required: @@ -509,8 +512,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.rewrite` Required: @@ -522,8 +525,8 @@ Optional: - `enabled` (Boolean) - `flag` (String) Define flag for the Rewrite option. Possible values: last, break, redirect, permanent. - + ### Nested Schema for `options.secure_key` Required: @@ -535,8 +538,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.slice` Required: @@ -547,8 +550,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.sni` Optional: @@ -557,8 +560,8 @@ Optional: - `enabled` (Boolean) - `sni_type` (String) Specify SNI type. Possible values: dynamic, custom. dynamic - SNI hostname depends on the hostHeader and the forward_host_header options. custom - custom SNI hostname. - + ### Nested Schema for `options.stale` Required: @@ -569,8 +572,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.static_headers` Required: @@ -581,8 +584,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.static_request_headers` Required: @@ -593,8 +596,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.static_response_headers` Required: @@ -606,6 +609,7 @@ Optional: - `enabled` (Boolean) + ### Nested Schema for `options.static_response_headers.value` Required: @@ -617,9 +621,8 @@ Optional: - `always` (Boolean) Specifies if the header will be added to a response from CDN regardless of response code. - - + ### Nested Schema for `options.tls_versions` Required: @@ -630,8 +633,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.use_default_le_chain` Required: @@ -642,8 +645,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.use_rsa_le_cert` Required: @@ -654,8 +657,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.user_agent_acl` Required: @@ -667,8 +670,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.waf` Required: @@ -679,8 +682,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.webp` Required: @@ -693,8 +696,8 @@ Optional: - `enabled` (Boolean) - `png_lossless` (Boolean) - + ### Nested Schema for `options.websockets` Required: diff --git a/docs/resources/cdn_rule.md b/docs/resources/cdn_rule.md index df87e0bb..78f5d827 100644 --- a/docs/resources/cdn_rule.md +++ b/docs/resources/cdn_rule.md @@ -119,6 +119,7 @@ resource "gcore_cdn_resource" "cdn_example_com" { ``` + ## Schema ### Required @@ -141,6 +142,7 @@ resource "gcore_cdn_resource" "cdn_example_com" { - `id` (String) The ID of this resource. + ### Nested Schema for `options` Optional: @@ -191,6 +193,7 @@ Optional: - `websockets` (Block List, Max: 1) WebSockets option allows WebSockets connections to an origin server. (see [below for nested schema](#nestedblock--options--websockets)) + ### Nested Schema for `options.allowed_http_methods` Required: @@ -201,8 +204,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.brotli_compression` Required: @@ -213,8 +216,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.browser_cache_settings` Optional: @@ -222,8 +225,8 @@ Optional: - `enabled` (Boolean) - `value` (String) Use '0s' to disable caching. The value applies for a response with codes 200, 201, 204, 206, 301, 302, 303, 304, 307, 308. - + ### Nested Schema for `options.cache_http_headers` Required: @@ -234,8 +237,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.cors` Required: @@ -247,8 +250,8 @@ Optional: - `always` (Boolean) Specify if the Access-Control-Allow-Origin header should be added to a response from CDN regardless of response code. - `enabled` (Boolean) - + ### Nested Schema for `options.country_acl` Required: @@ -260,8 +263,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.disable_cache` Required: @@ -272,8 +275,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.disable_proxy_force_ranges` Required: @@ -284,8 +287,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.edge_cache_settings` Optional: @@ -295,8 +298,8 @@ Optional: - `enabled` (Boolean) - `value` (String) Specify caching time for the response with codes 200, 206, 301, 302. Responses with codes 4xx, 5xx will not be cached. Use '0s' to disable caching. Use custom_values field to specify a custom caching time for a response with specific codes. - + ### Nested Schema for `options.fetch_compressed` Required: @@ -307,8 +310,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.follow_origin_redirect` Required: @@ -319,8 +322,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.force_return` Required: @@ -332,8 +335,8 @@ Optional: - `body` (String) Response text or URL if you're going to set up redirection. Max length = 100. - `enabled` (Boolean) - + ### Nested Schema for `options.forward_host_header` Required: @@ -344,8 +347,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.gzip_on` Required: @@ -356,8 +359,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.host_header` Required: @@ -368,8 +371,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.http3_enabled` Required: @@ -380,8 +383,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.ignore_cookie` Required: @@ -392,8 +395,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.ignore_query_string` Required: @@ -404,8 +407,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.image_stack` Required: @@ -419,8 +422,8 @@ Optional: - `png_lossless` (Boolean) Represents compression without quality loss for PNG format. - `webp_enabled` (Boolean) If enabled, JPG and PNG images automatically convert to WebP format when supported by the end users browser. - + ### Nested Schema for `options.ip_address_acl` Required: @@ -432,8 +435,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.limit_bandwidth` Required: @@ -446,8 +449,8 @@ Optional: - `enabled` (Boolean) - `speed` (Number) Maximum download speed per connection. Must be greater than 0. - + ### Nested Schema for `options.proxy_cache_methods_set` Required: @@ -458,8 +461,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.query_params_blacklist` Required: @@ -470,8 +473,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.query_params_whitelist` Required: @@ -482,8 +485,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.redirect_http_to_https` Required: @@ -494,8 +497,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.redirect_https_to_http` Required: @@ -506,8 +509,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.referrer_acl` Required: @@ -519,8 +522,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.request_limiter` Required: @@ -534,8 +537,8 @@ Optional: - `enabled` (Boolean) - `rate_unit` (String) - + ### Nested Schema for `options.response_headers_hiding_policy` Required: @@ -547,8 +550,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.rewrite` Required: @@ -560,8 +563,8 @@ Optional: - `enabled` (Boolean) - `flag` (String) Define flag for the Rewrite option. Possible values: last, break, redirect, permanent. - + ### Nested Schema for `options.secure_key` Required: @@ -573,8 +576,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.slice` Required: @@ -585,8 +588,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.sni` Optional: @@ -595,8 +598,8 @@ Optional: - `enabled` (Boolean) - `sni_type` (String) Specify SNI type. Possible values: dynamic, custom. dynamic - SNI hostname depends on the hostHeader and the forward_host_header options. custom - custom SNI hostname. - + ### Nested Schema for `options.stale` Required: @@ -607,8 +610,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.static_headers` Required: @@ -619,8 +622,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.static_request_headers` Required: @@ -631,8 +634,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.static_response_headers` Required: @@ -644,6 +647,7 @@ Optional: - `enabled` (Boolean) + ### Nested Schema for `options.static_response_headers.value` Required: @@ -655,9 +659,8 @@ Optional: - `always` (Boolean) Specifies if the header will be added to a response from CDN regardless of response code. - - + ### Nested Schema for `options.tls_versions` Required: @@ -668,8 +671,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.use_default_le_chain` Required: @@ -680,8 +683,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.use_rsa_le_cert` Required: @@ -692,8 +695,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.user_agent_acl` Required: @@ -705,8 +708,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.waf` Required: @@ -717,8 +720,8 @@ Optional: - `enabled` (Boolean) - + ### Nested Schema for `options.webp` Required: @@ -731,8 +734,8 @@ Optional: - `enabled` (Boolean) - `png_lossless` (Boolean) - + ### Nested Schema for `options.websockets` Required: diff --git a/docs/resources/cdn_sslcert.md b/docs/resources/cdn_sslcert.md index 66712add..6deec2a6 100644 --- a/docs/resources/cdn_sslcert.md +++ b/docs/resources/cdn_sslcert.md @@ -8,8 +8,6 @@ description: |- # gcore_cdn_sslcert (Resource) - - ## Example Usage ```terraform @@ -40,6 +38,7 @@ resource "gcore_cdn_sslcert" "lets_encrypt_cert" { ``` + ## Schema ### Required diff --git a/docs/resources/ddos_protection.md b/docs/resources/ddos_protection.md index a6ab8202..99deaf6c 100644 --- a/docs/resources/ddos_protection.md +++ b/docs/resources/ddos_protection.md @@ -10,9 +10,8 @@ description: |- Represents DDoS protection profile - - + ## Schema ### Required @@ -39,6 +38,7 @@ Represents DDoS protection profile - `site` (String) + ### Nested Schema for `fields` Required: @@ -60,8 +60,8 @@ Read-Only: - `required` (Boolean) - `validation_schema` (String) Json schema to validate field_values - + ### Nested Schema for `protocols` Read-Only: diff --git a/docs/resources/dns_zone.md b/docs/resources/dns_zone.md index 2a1fb052..16b153d7 100644 --- a/docs/resources/dns_zone.md +++ b/docs/resources/dns_zone.md @@ -23,6 +23,7 @@ resource "gcore_dns_zone" "example_zone" { ``` + ## Schema ### Required @@ -38,6 +39,7 @@ resource "gcore_dns_zone" "example_zone" { - `id` (String) The ID of this resource. + ### Nested Schema for `timeouts` Optional: diff --git a/docs/resources/dns_zone_record.md b/docs/resources/dns_zone_record.md index eb963f4f..c965363f 100644 --- a/docs/resources/dns_zone_record.md +++ b/docs/resources/dns_zone_record.md @@ -149,6 +149,7 @@ resource "gcore_dns_zone_record" "examplezone_failover" { ``` + ## Schema ### Required @@ -170,6 +171,7 @@ resource "gcore_dns_zone_record" "examplezone_failover" { - `id` (String) The ID of this resource. + ### Nested Schema for `resource_record` Required: @@ -182,6 +184,7 @@ Optional: - `meta` (Block Set, Max: 1) (see [below for nested schema](#nestedblock--resource_record--meta)) + ### Nested Schema for `resource_record.meta` Optional: @@ -198,9 +201,8 @@ Optional: - `notes` (String) A notes meta (eg. Miami DC) of DNS Zone Record resource. - `weight` (Number) A weight for this record - - + ### Nested Schema for `filter` Required: @@ -212,8 +214,8 @@ Optional: - `limit` (Number) A DNS Zone Record filter option that describe how many records will be percolated. - `strict` (Boolean) A DNS Zone Record filter option that describe possibility to return answers if no records were percolated through filter. - + ### Nested Schema for `meta` Optional: @@ -222,6 +224,7 @@ Optional: - `healthchecks` (Block Set) Failover meta (eg. {"frequency": 60,"host": "www.gcore.com","http_status_code": null,"method": "GET","port": 80,"protocol": "HTTP","regexp": "","timeout": 10,"tls": false,"url": "/"}). (see [below for nested schema](#nestedblock--meta--healthchecks)) + ### Nested Schema for `meta.healthchecks` Required: @@ -241,9 +244,8 @@ Optional: - `tls` (Boolean) TLS/HTTPS enabled if protocol=HTTP, must be empty for non-HTTP. - `url` (String) URL path to check required if protocol=HTTP, must be empty for non-HTTP. - - + ### Nested Schema for `timeouts` Optional: diff --git a/docs/resources/faas_function.md b/docs/resources/faas_function.md index 47d8c7e0..392415c6 100644 --- a/docs/resources/faas_function.md +++ b/docs/resources/faas_function.md @@ -47,6 +47,7 @@ EOF ``` + ## Schema ### Required diff --git a/docs/resources/faas_key.md b/docs/resources/faas_key.md index 0207e0d3..cd1c6df0 100644 --- a/docs/resources/faas_key.md +++ b/docs/resources/faas_key.md @@ -32,6 +32,7 @@ output "secret" { ``` + ## Schema ### Required @@ -56,6 +57,7 @@ output "secret" { - `status` (String) + ### Nested Schema for `functions` Required: diff --git a/docs/resources/faas_namespace.md b/docs/resources/faas_namespace.md index 72df59f5..db4eb0c0 100644 --- a/docs/resources/faas_namespace.md +++ b/docs/resources/faas_namespace.md @@ -29,6 +29,7 @@ resource "gcore_faas_namespace" "ns" { ``` + ## Schema ### Required diff --git a/docs/resources/floatingip.md b/docs/resources/floatingip.md index 92a93dcd..b9375285 100644 --- a/docs/resources/floatingip.md +++ b/docs/resources/floatingip.md @@ -26,6 +26,7 @@ resource "gcore_floatingip" "floating_ip" { ``` + ## Schema ### Optional @@ -50,6 +51,7 @@ resource "gcore_floatingip" "floating_ip" { - `updated_at` (String) + ### Nested Schema for `metadata_read_only` Read-Only: diff --git a/docs/resources/instance.md b/docs/resources/instance.md index eb419443..9d60e054 100644 --- a/docs/resources/instance.md +++ b/docs/resources/instance.md @@ -158,6 +158,7 @@ resource "gcore_instance" "v" { ``` + ## Schema ### Required @@ -197,6 +198,7 @@ resource "gcore_instance" "v" { - `security_group` (List of Object) Firewalls list (see [below for nested schema](#nestedatt--security_group)) + ### Nested Schema for `interface` Optional: @@ -206,13 +208,13 @@ Optional: - `ip_address` (String) - `network_id` (String) required if type is 'subnet' or 'any_subnet' - `order` (Number) Order of attaching interface -- `port_id` (String) required if type is 'reserved_fixed_ip' +- `port_id` (String) required if type is 'reserved_fixed_ip' - `security_groups` (List of String) list of security group IDs - `subnet_id` (String) required if type is 'subnet' - `type` (String) Available value is 'subnet', 'any_subnet', 'external', 'reserved_fixed_ip' - + ### Nested Schema for `addresses` Required: @@ -220,6 +222,7 @@ Required: - `net` (Block List, Min: 1) (see [below for nested schema](#nestedblock--addresses--net)) + ### Nested Schema for `addresses.net` Required: @@ -227,9 +230,8 @@ Required: - `addr` (String) - `type` (String) - - + ### Nested Schema for `configuration` Required: @@ -237,8 +239,8 @@ Required: - `key` (String) - `value` (String) - + ### Nested Schema for `metadata` Required: @@ -246,8 +248,8 @@ Required: - `key` (String) - `value` (String) - + ### Nested Schema for `volume` Required: @@ -269,8 +271,8 @@ Read-Only: - `id` (String) The ID of this resource. - + ### Nested Schema for `security_group` Read-Only: diff --git a/docs/resources/k8sv2.md b/docs/resources/k8sv2.md index f26c9919..9e83a85b 100644 --- a/docs/resources/k8sv2.md +++ b/docs/resources/k8sv2.md @@ -37,6 +37,7 @@ resource "gcore_k8sv2" "cl" { ``` + ## Schema ### Required @@ -72,6 +73,7 @@ resource "gcore_k8sv2" "cl" { - `task_id` (String) + ### Nested Schema for `pool` Required: @@ -94,16 +96,16 @@ Read-Only: - `node_count` (Number) Current node count in the cluster pool. - `status` (String) Cluster pool status. - + ### Nested Schema for `cni` Required: - `provider` (String) - + ### Nested Schema for `timeouts` Optional: diff --git a/docs/resources/keypair.md b/docs/resources/keypair.md index dd0a066c..c25e0c4e 100644 --- a/docs/resources/keypair.md +++ b/docs/resources/keypair.md @@ -29,6 +29,7 @@ output "kp" { ``` + ## Schema ### Required diff --git a/docs/resources/laas_topic.md b/docs/resources/laas_topic.md index b47212b3..0f7f5e73 100644 --- a/docs/resources/laas_topic.md +++ b/docs/resources/laas_topic.md @@ -26,6 +26,7 @@ resource "gcore_laas_topic" "test" { ``` + ## Schema ### Required diff --git a/docs/resources/lblistener.md b/docs/resources/lblistener.md index c4cc5630..35a7b63b 100644 --- a/docs/resources/lblistener.md +++ b/docs/resources/lblistener.md @@ -35,6 +35,7 @@ resource "gcore_lblistener" "listener" { ``` + ## Schema ### Required @@ -68,6 +69,7 @@ resource "gcore_lblistener" "listener" { - `provisioning_status` (String) + ### Nested Schema for `timeouts` Optional: diff --git a/docs/resources/lbmember.md b/docs/resources/lbmember.md index cb2f985a..d3b4f0ef 100644 --- a/docs/resources/lbmember.md +++ b/docs/resources/lbmember.md @@ -60,6 +60,7 @@ resource "gcore_lbmember" "lbm" { ``` + ## Schema ### Required @@ -86,6 +87,7 @@ resource "gcore_lbmember" "lbm" { - `operating_status` (String) + ### Nested Schema for `timeouts` Optional: diff --git a/docs/resources/lbpool.md b/docs/resources/lbpool.md index 79daef0f..b89f51d1 100644 --- a/docs/resources/lbpool.md +++ b/docs/resources/lbpool.md @@ -51,6 +51,7 @@ resource "gcore_lbpool" "pl" { ``` + ## Schema ### Required @@ -77,6 +78,7 @@ resource "gcore_lbpool" "pl" { - `id` (String) The ID of this resource. + ### Nested Schema for `health_monitor` Required: @@ -97,8 +99,8 @@ Read-Only: - `id` (String) The ID of this resource. - + ### Nested Schema for `session_persistence` Required: @@ -111,8 +113,8 @@ Optional: - `persistence_granularity` (String) - `persistence_timeout` (Number) - + ### Nested Schema for `timeouts` Optional: diff --git a/docs/resources/lifecyclepolicy.md b/docs/resources/lifecyclepolicy.md index cea7e09c..4a1224a5 100644 --- a/docs/resources/lifecyclepolicy.md +++ b/docs/resources/lifecyclepolicy.md @@ -46,6 +46,7 @@ resource "gcore_lifecyclepolicy" "lp" { ``` + ## Schema ### Required @@ -69,6 +70,7 @@ resource "gcore_lifecyclepolicy" "lp" { - `user_id` (Number) + ### Nested Schema for `schedule` Required: @@ -88,6 +90,7 @@ Read-Only: - `type` (String) + ### Nested Schema for `schedule.cron` Optional: @@ -100,8 +103,8 @@ Optional: - `timezone` (String) - `week` (String) Either single asterisk or comma-separated list of integers (1-53) - + ### Nested Schema for `schedule.interval` Optional: @@ -111,8 +114,8 @@ Optional: - `minutes` (Number) Number of minutes to wait between actions - `weeks` (Number) Number of weeks to wait between actions - + ### Nested Schema for `schedule.retention_time` Optional: @@ -122,9 +125,8 @@ Optional: - `minutes` (Number) Number of minutes to wait before deleting snapshot - `weeks` (Number) Number of weeks to wait before deleting snapshot - - + ### Nested Schema for `volume` Read-Only: diff --git a/docs/resources/loadbalancer.md b/docs/resources/loadbalancer.md index 5d923d13..9f6d556b 100644 --- a/docs/resources/loadbalancer.md +++ b/docs/resources/loadbalancer.md @@ -35,6 +35,7 @@ resource "gcore_loadbalancer" "lb" { ``` + ## Schema ### Required @@ -62,6 +63,7 @@ resource "gcore_loadbalancer" "lb" { - `vip_address` (String) Load balancer IP address + ### Nested Schema for `listener` Required: @@ -83,8 +85,8 @@ Read-Only: - `id` (String) The ID of this resource. - + ### Nested Schema for `timeouts` Optional: @@ -92,8 +94,8 @@ Optional: - `create` (String) - `delete` (String) - + ### Nested Schema for `metadata_read_only` Read-Only: diff --git a/docs/resources/loadbalancerv2.md b/docs/resources/loadbalancerv2.md index 1a93dd44..e0c68692 100644 --- a/docs/resources/loadbalancerv2.md +++ b/docs/resources/loadbalancerv2.md @@ -12,20 +12,70 @@ Represent load balancer without nested listener ## Example Usage +#### Prerequisite + ```terraform provider gcore { - permanent_api_token = "251$d3361.............1b35f26d8" + permanent_api_token = "8712$25...65b" +} + +data "gcore_project" "project" { + name = "Default" +} + +data "gcore_region" "region" { + name = "Luxembourg-2" +} +``` + +### Creating Private Load Balancer + +```terraform +resource "gcore_loadbalancerv2" "public_lb" { + project_id = data.gcore_project.project.id + region_id = data.gcore_region.region.id + name = "My first public load balancer" + flavor = "lb1-1-2" +} + +output "public_lb_ip" { + value = gcore_loadbalancerv2.public_lb.vip_address +} +``` + +### Creating Public Load Balancer + +```terraform +resource "gcore_network" "private" { + project_id = data.gcore_project.project.id + region_id = data.gcore_region.region.id + name = "my-private-network" +} + +resource "gcore_subnet" "private_1" { + project_id = data.gcore_project.project.id + region_id = data.gcore_region.region.id + cidr = "10.0.0.0/24" + name = "my-private-network-subnet-1" + network_id = gcore_network.private.id } -resource "gcore_loadbalancerv2" "lb" { - project_id = 1 - region_id = 1 - name = "test" +resource "gcore_loadbalancerv2" "private_lb" { + project_id = data.gcore_project.project.id + region_id = data.gcore_region.region.id + name = "My first private load balancer" flavor = "lb1-1-2" + vip_network_id = gcore_network.private.id + vip_subnet_id = gcore_subnet.private_1.id +} + +output "private_lb_ip" { + value = gcore_loadbalancerv2.private_lb.vip_address } ``` + ## Schema ### Required @@ -54,6 +104,7 @@ resource "gcore_loadbalancerv2" "lb" { - `vip_port_id` (String) Load balancer Port ID + ### Nested Schema for `timeouts` Optional: @@ -61,8 +112,8 @@ Optional: - `create` (String) - `delete` (String) - + ### Nested Schema for `metadata_read_only` Read-Only: diff --git a/docs/resources/network.md b/docs/resources/network.md index 76e8c568..98b112a3 100644 --- a/docs/resources/network.md +++ b/docs/resources/network.md @@ -26,6 +26,7 @@ resource "gcore_network" "network" { ``` + ## Schema ### Required @@ -50,6 +51,7 @@ resource "gcore_network" "network" { - `mtu` (Number) + ### Nested Schema for `metadata_read_only` Read-Only: diff --git a/docs/resources/reservedfixedip.md b/docs/resources/reservedfixedip.md index afceb583..81a664e4 100644 --- a/docs/resources/reservedfixedip.md +++ b/docs/resources/reservedfixedip.md @@ -26,6 +26,7 @@ resource "gcore_reservedfixedip" "fixed_ip" { ``` + ## Schema ### Required @@ -52,6 +53,7 @@ resource "gcore_reservedfixedip" "fixed_ip" { - `status` (String) + ### Nested Schema for `allowed_address_pairs` Optional: diff --git a/docs/resources/router.md b/docs/resources/router.md index 516b7b10..eca107b0 100644 --- a/docs/resources/router.md +++ b/docs/resources/router.md @@ -54,6 +54,7 @@ resource "gcore_router" "router" { ``` + ## Schema ### Required @@ -76,6 +77,7 @@ resource "gcore_router" "router" { - `id` (String) The ID of this resource. + ### Nested Schema for `external_gateway_info` Optional: @@ -89,6 +91,7 @@ Read-Only: - `external_fixed_ips` (List of Object) (see [below for nested schema](#nestedatt--external_gateway_info--external_fixed_ips)) + ### Nested Schema for `external_gateway_info.external_fixed_ips` Read-Only: @@ -96,9 +99,8 @@ Read-Only: - `ip_address` (String) - `subnet_id` (String) - - + ### Nested Schema for `interfaces` Required: @@ -113,8 +115,8 @@ Read-Only: - `network_id` (String) - `port_id` (String) - + ### Nested Schema for `routes` Required: diff --git a/docs/resources/secret.md b/docs/resources/secret.md index d6f107e8..93f50bc0 100644 --- a/docs/resources/secret.md +++ b/docs/resources/secret.md @@ -30,6 +30,7 @@ resource "gcore_secret" "lb_https" { ``` + ## Schema ### Required diff --git a/docs/resources/securitygroup.md b/docs/resources/securitygroup.md index ba785096..24ec9d4f 100644 --- a/docs/resources/securitygroup.md +++ b/docs/resources/securitygroup.md @@ -47,6 +47,7 @@ resource "gcore_securitygroup" "sg" { ``` + ## Schema ### Required @@ -70,6 +71,7 @@ resource "gcore_securitygroup" "sg" { - `metadata_read_only` (List of Object) (see [below for nested schema](#nestedatt--metadata_read_only)) + ### Nested Schema for `security_group_rules` Required: @@ -91,8 +93,8 @@ Read-Only: - `id` (String) The ID of this resource. - `updated_at` (String) - + ### Nested Schema for `metadata_read_only` Read-Only: diff --git a/docs/resources/servergroup.md b/docs/resources/servergroup.md index 44d6aea5..9de1e514 100644 --- a/docs/resources/servergroup.md +++ b/docs/resources/servergroup.md @@ -26,6 +26,7 @@ resource "gcore_servergroup" "default" { ``` + ## Schema ### Required @@ -46,6 +47,7 @@ resource "gcore_servergroup" "default" { - `instances` (List of Object) Instances in this server group (see [below for nested schema](#nestedatt--instances)) + ### Nested Schema for `instances` Read-Only: diff --git a/docs/resources/snapshot.md b/docs/resources/snapshot.md index 6f50b539..b7983315 100644 --- a/docs/resources/snapshot.md +++ b/docs/resources/snapshot.md @@ -8,8 +8,6 @@ description: |- # gcore_snapshot (Resource) - - ## Example Usage ```terraform @@ -30,6 +28,7 @@ resource "gcore_snapshot" "snapshot" { ``` + ## Schema ### Required diff --git a/docs/resources/storage_s3.md b/docs/resources/storage_s3.md index fb837d5a..f97291d7 100644 --- a/docs/resources/storage_s3.md +++ b/docs/resources/storage_s3.md @@ -24,6 +24,7 @@ resource "gcore_storage_s3" "example_s3" { ``` + ## Schema ### Required diff --git a/docs/resources/storage_s3_bucket.md b/docs/resources/storage_s3_bucket.md index 60d4cff1..2e57fcfa 100644 --- a/docs/resources/storage_s3_bucket.md +++ b/docs/resources/storage_s3_bucket.md @@ -24,6 +24,7 @@ resource "gcore_storage_s3_bucket" "example_s3_bucket" { ``` + ## Schema ### Required diff --git a/docs/resources/storage_sftp.md b/docs/resources/storage_sftp.md index 99a377fd..29570a21 100644 --- a/docs/resources/storage_sftp.md +++ b/docs/resources/storage_sftp.md @@ -25,6 +25,7 @@ resource "gcore_storage_sftp" "example_sftp" { ``` + ## Schema ### Required diff --git a/docs/resources/storage_sftp_key.md b/docs/resources/storage_sftp_key.md index 225a9f3f..bc558521 100644 --- a/docs/resources/storage_sftp_key.md +++ b/docs/resources/storage_sftp_key.md @@ -24,6 +24,7 @@ resource "gcore_storage_sftp_key" "terraform_test_key" { ``` + ## Schema ### Required diff --git a/docs/resources/subnet.md b/docs/resources/subnet.md index ce992dc6..36c76d87 100644 --- a/docs/resources/subnet.md +++ b/docs/resources/subnet.md @@ -46,6 +46,7 @@ resource "gcore_subnet" "subnet" { ``` + ## Schema ### Required @@ -74,6 +75,7 @@ resource "gcore_subnet" "subnet" { - `metadata_read_only` (List of Object) (see [below for nested schema](#nestedatt--metadata_read_only)) + ### Nested Schema for `host_routes` Required: @@ -81,8 +83,8 @@ Required: - `destination` (String) - `nexthop` (String) IPv4 address to forward traffic to if it's destination IP matches 'destination' CIDR - + ### Nested Schema for `metadata_read_only` Read-Only: diff --git a/docs/resources/volume.md b/docs/resources/volume.md index e51ba10b..e5620795 100644 --- a/docs/resources/volume.md +++ b/docs/resources/volume.md @@ -27,6 +27,7 @@ resource "gcore_volume" "volume" { ``` + ## Schema ### Required @@ -52,6 +53,7 @@ resource "gcore_volume" "volume" { - `metadata_read_only` (List of Object) (see [below for nested schema](#nestedatt--metadata_read_only)) + ### Nested Schema for `metadata_read_only` Read-Only: diff --git a/examples/resources/gcore_loadbalancerv2/main.tf b/examples/resources/gcore_loadbalancerv2/main.tf new file mode 100644 index 00000000..c9e79df9 --- /dev/null +++ b/examples/resources/gcore_loadbalancerv2/main.tf @@ -0,0 +1,11 @@ +provider gcore { + permanent_api_token = "8712$25...65b" +} + +data "gcore_project" "project" { + name = "Default" +} + +data "gcore_region" "region" { + name = "Luxembourg-2" +} \ No newline at end of file diff --git a/examples/resources/gcore_loadbalancerv2/private-lb.tf b/examples/resources/gcore_loadbalancerv2/private-lb.tf new file mode 100644 index 00000000..bb89380c --- /dev/null +++ b/examples/resources/gcore_loadbalancerv2/private-lb.tf @@ -0,0 +1,26 @@ +resource "gcore_network" "private" { + project_id = data.gcore_project.project.id + region_id = data.gcore_region.region.id + name = "my-private-network" +} + +resource "gcore_subnet" "private_1" { + project_id = data.gcore_project.project.id + region_id = data.gcore_region.region.id + cidr = "10.0.0.0/24" + name = "my-private-network-subnet-1" + network_id = gcore_network.private.id +} + +resource "gcore_loadbalancerv2" "private_lb" { + project_id = data.gcore_project.project.id + region_id = data.gcore_region.region.id + name = "My first private load balancer" + flavor = "lb1-1-2" + vip_network_id = gcore_network.private.id + vip_subnet_id = gcore_subnet.private_1.id +} + +output "private_lb_ip" { + value = gcore_loadbalancerv2.private_lb.vip_address +} diff --git a/examples/resources/gcore_loadbalancerv2/public-lb.tf b/examples/resources/gcore_loadbalancerv2/public-lb.tf new file mode 100644 index 00000000..efdf4780 --- /dev/null +++ b/examples/resources/gcore_loadbalancerv2/public-lb.tf @@ -0,0 +1,10 @@ +resource "gcore_loadbalancerv2" "public_lb" { + project_id = data.gcore_project.project.id + region_id = data.gcore_region.region.id + name = "My first public load balancer" + flavor = "lb1-1-2" +} + +output "public_lb_ip" { + value = gcore_loadbalancerv2.public_lb.vip_address +} diff --git a/templates/data-sources/ai_cluster.md.tmpl b/templates/data-sources/ai_cluster.md.tmpl new file mode 100644 index 00000000..42083ef0 --- /dev/null +++ b/templates/data-sources/ai_cluster.md.tmpl @@ -0,0 +1,164 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_ai_cluster Data Source - terraform-provider-gcore" +subcategory: "" +description: |- + Represent AI Cluster +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_ai_cluster (Data Source) + +Represent AI Cluster + +## Example Usage + +{{tffile "examples/data-sources/ai_cluster/example_1.tf"}} + + + +## Schema + +### Required + +- `cluster_id` (String) AI Cluster ID + +### Optional + +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `cluster_metadata` (Map of String) Cluster metadata (simple key-value pairs) +- `cluster_name` (String) AI Cluster Name +- `cluster_status` (String) AI Cluster status +- `created_at` (String) Datetime when the cluster was created +- `creator_task_id` (String) Task that created this entity +- `flavor` (String) Flavor ID (name) +- `id` (String) The ID of this resource. +- `image_id` (String) Image ID +- `image_name` (String) Image name +- `interface` (List of Object) Networks managed by user and associated with the cluster (see [below for nested schema](#nestedatt--interface)) +- `keypair_name` (String) Ssh keypair name +- `password` (String) A password for baremetal instance. This parameter is used to set a password for the Admin user on a Windows instance, a default user or a new user on a Linux instance +- `poplar_servers` (List of Object) Poplar servers (see [below for nested schema](#nestedatt--poplar_servers)) +- `security_group` (Set of Object) Security groups attached to the cluster (see [below for nested schema](#nestedatt--security_group)) +- `task_id` (String) Task ID associated with the cluster +- `task_status` (String) Task status +- `user_data` (String) String in base64 format. Must not be passed together with 'username' or 'password'. Examples of the user_data: https://cloudinit.readthedocs.io/en/latest/topics/examples.html +- `username` (String) A name of a new user in the Linux instance. It may be passed with a 'password' parameter +- `volume` (Set of Object) List of volumes attached to the cluster (see [below for nested schema](#nestedatt--volume)) + + + +### Nested Schema for `interface` + +Read-Only: + +- `network_id` (String) +- `port_id` (String) +- `subnet_id` (String) +- `type` (String) + + + +### Nested Schema for `poplar_servers` + +Read-Only: + +- `addresses` (Set of Object) (see [below for nested schema](#nestedobjatt--poplar_servers--addresses)) +- `creator_task_id` (String) +- `flavor` (Map of String) +- `flavor_id` (String) +- `instance_created` (String) +- `instance_description` (String) +- `instance_id` (String) +- `instance_name` (String) +- `metadata` (Map of String) +- `security_groups` (Set of Object) (see [below for nested schema](#nestedobjatt--poplar_servers--security_groups)) +- `status` (String) +- `task_id` (String) +- `task_state` (String) +- `vm_state` (String) +- `volumes` (Set of Object) (see [below for nested schema](#nestedobjatt--poplar_servers--volumes)) + + + +### Nested Schema for `poplar_servers.addresses` + +Read-Only: + +- `address` (List of Object) (see [below for nested schema](#nestedobjatt--poplar_servers--addresses--address)) +- `network_name` (String) + + + +### Nested Schema for `poplar_servers.addresses.address` + +Read-Only: + +- `addr` (String) +- `type` (String) + + + +### Nested Schema for `poplar_servers.security_groups` + +Read-Only: + +- `name` (String) + + + +### Nested Schema for `poplar_servers.volumes` + +Read-Only: + +- `delete_on_termination` (Boolean) +- `id` (String) + + + +### Nested Schema for `security_group` + +Read-Only: + +- `id` (String) + + + +### Nested Schema for `volume` + +Read-Only: + +- `attachments` (Set of Object) (see [below for nested schema](#nestedobjatt--volume--attachments)) +- `created_at` (String) +- `creator_task_id` (String) +- `image_id` (String) +- `name` (String) +- `size` (Number) +- `source` (String) +- `status` (String) +- `updated_at` (String) +- `volume_id` (String) +- `volume_image_metadata` (Map of String) +- `volume_type` (String) + + + +### Nested Schema for `volume.attachments` + +Read-Only: + +- `attached_at` (String) +- `attachment_id` (String) +- `device` (String) +- `instance_name` (String) +- `server_id` (String) +- `volume_id` (String) diff --git a/templates/data-sources/ddos_profile_template.md.tmpl b/templates/data-sources/ddos_profile_template.md.tmpl new file mode 100644 index 00000000..5b9df388 --- /dev/null +++ b/templates/data-sources/ddos_profile_template.md.tmpl @@ -0,0 +1,52 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_ddos_profile_template Data Source - terraform-provider-gcore" +subcategory: "" +description: |- + Represents list of available DDoS protection profile templates +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_ddos_profile_template (Data Source) + +Represents list of available DDoS protection profile templates + +## Example Usage + +{{tffile "examples/data-sources/ddos_profile_template/example_1.tf"}} + + + +## Schema + +### Optional + +- `name` (String) Template name +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) +- `template_id` (Number) Template id + +### Read-Only + +- `description` (String) Template description +- `fields` (List of Object) Additional fields (see [below for nested schema](#nestedatt--fields)) +- `id` (String) The ID of this resource. + + + +### Nested Schema for `fields` + +Read-Only: + +- `default` (String) +- `description` (String) +- `field_type` (String) +- `id` (Number) +- `name` (String) +- `required` (Boolean) +- `validation_schema` (String) diff --git a/templates/data-sources/faas_function.md.tmpl b/templates/data-sources/faas_function.md.tmpl new file mode 100644 index 00000000..3418413c --- /dev/null +++ b/templates/data-sources/faas_function.md.tmpl @@ -0,0 +1,58 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_faas_function Data Source - terraform-provider-gcore" +subcategory: "" +description: |- + Represent FaaS function +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_faas_function (Data Source) + +Represent FaaS function + +## Example Usage + +{{tffile "examples/data-sources/faas_function/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) +- `namespace` (String) Namespace of the function + +### Optional + +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `build_message` (String) +- `build_status` (String) +- `code_text` (String) +- `created_at` (String) +- `dependencies` (String) Function dependencies to install +- `deploy_status` (Map of Number) +- `description` (String) +- `disabled` (Boolean) Set to true if function is disabled +- `enable_api_key` (Boolean) Enable/Disable api key authorization +- `endpoint` (String) +- `envs` (Map of String) +- `flavor` (String) +- `id` (String) The ID of this resource. +- `keys` (List of String) List of used api keys +- `main_method` (String) Main startup method name +- `max_instances` (Number) Autoscaling max number of instances +- `min_instances` (Number) Autoscaling min number of instances +- `runtime` (String) +- `status` (String) +- `timeout` (Number) diff --git a/templates/data-sources/faas_key.md.tmpl b/templates/data-sources/faas_key.md.tmpl new file mode 100644 index 00000000..9ddf5c5f --- /dev/null +++ b/templates/data-sources/faas_key.md.tmpl @@ -0,0 +1,52 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_faas_key Data Source - terraform-provider-gcore" +subcategory: "" +description: |- + Represent FaaS API keys +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_faas_key (Data Source) + +Represent FaaS API keys + +## Example Usage + +{{tffile "examples/data-sources/faas_key/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) + +### Optional + +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `created_at` (String) +- `description` (String) +- `expire` (String) +- `functions` (List of Object) (see [below for nested schema](#nestedatt--functions)) +- `id` (String) The ID of this resource. +- `status` (String) + + + +### Nested Schema for `functions` + +Read-Only: + +- `name` (String) +- `namespace` (String) diff --git a/templates/data-sources/faas_namespace.md.tmpl b/templates/data-sources/faas_namespace.md.tmpl new file mode 100644 index 00000000..395ba678 --- /dev/null +++ b/templates/data-sources/faas_namespace.md.tmpl @@ -0,0 +1,42 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_faas_namespace Data Source - terraform-provider-gcore" +subcategory: "" +description: |- + Represent FaaS namespace +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_faas_namespace (Data Source) + +Represent FaaS namespace + +## Example Usage + +{{tffile "examples/data-sources/faas_namespace/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) + +### Optional + +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `created_at` (String) +- `description` (String) +- `envs` (Map of String) +- `id` (String) The ID of this resource. +- `status` (String) diff --git a/templates/data-sources/floatingip.md.tmpl b/templates/data-sources/floatingip.md.tmpl new file mode 100644 index 00000000..9dce7cbe --- /dev/null +++ b/templates/data-sources/floatingip.md.tmpl @@ -0,0 +1,52 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_floatingip Data Source - terraform-provider-gcore" +subcategory: "" +description: |- + A floating IP is a static IP address that points to one of your Instances. It allows you to redirect network traffic to any of your Instances in the same datacenter. +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_floatingip (Data Source) + +A floating IP is a static IP address that points to one of your Instances. It allows you to redirect network traffic to any of your Instances in the same datacenter. + +## Example Usage + +{{tffile "examples/data-sources/floatingip/example_1.tf"}} + + + +## Schema + +### Optional + +- `fixed_ip_address` (String) +- `floating_ip_address` (String) +- `metadata_k` (String) +- `metadata_kv` (Map of String) +- `port_id` (String) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `id` (String) The ID of this resource. +- `metadata_read_only` (List of Object) (see [below for nested schema](#nestedatt--metadata_read_only)) +- `router_id` (String) +- `status` (String) + + + +### Nested Schema for `metadata_read_only` + +Read-Only: + +- `key` (String) +- `read_only` (Boolean) +- `value` (String) diff --git a/templates/data-sources/image.md.tmpl b/templates/data-sources/image.md.tmpl new file mode 100644 index 00000000..6e10bb06 --- /dev/null +++ b/templates/data-sources/image.md.tmpl @@ -0,0 +1,57 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_image Data Source - terraform-provider-gcore" +subcategory: "" +description: |- + Represent image data +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_image (Data Source) + +Represent image data + +## Example Usage + +{{tffile "examples/data-sources/image/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) use 'os-version', for example 'ubuntu-20.04' + +### Optional + +- `is_baremetal` (Boolean) set to true if need to get baremetal image +- `metadata_k` (String) +- `metadata_kv` (Map of String) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `description` (String) +- `id` (String) The ID of this resource. +- `metadata_read_only` (List of Object) (see [below for nested schema](#nestedatt--metadata_read_only)) +- `min_disk` (Number) +- `min_ram` (Number) +- `os_distro` (String) +- `os_version` (String) + + + +### Nested Schema for `metadata_read_only` + +Read-Only: + +- `key` (String) +- `read_only` (Boolean) +- `value` (String) diff --git a/templates/data-sources/instance.md.tmpl b/templates/data-sources/instance.md.tmpl new file mode 100644 index 00000000..561466d2 --- /dev/null +++ b/templates/data-sources/instance.md.tmpl @@ -0,0 +1,101 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_instance Data Source - terraform-provider-gcore" +subcategory: "" +description: |- + Represent instance. Could be used with baremetal also +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_instance (Data Source) + +Represent instance. Could be used with baremetal also + +## Example Usage + +{{tffile "examples/data-sources/instance/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) + +### Optional + +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `addresses` (List of Object) (see [below for nested schema](#nestedatt--addresses)) +- `flavor` (Map of String) +- `flavor_id` (String) +- `id` (String) The ID of this resource. +- `interface` (List of Object) (see [below for nested schema](#nestedatt--interface)) +- `metadata` (List of Object) (see [below for nested schema](#nestedatt--metadata)) +- `security_group` (List of Object) Firewalls list (see [below for nested schema](#nestedatt--security_group)) +- `status` (String) +- `vm_state` (String) +- `volume` (Set of Object) (see [below for nested schema](#nestedatt--volume)) + + + +### Nested Schema for `addresses` + +Read-Only: + +- `net` (List of Object) (see [below for nested schema](#nestedobjatt--addresses--net)) + + + +### Nested Schema for `addresses.net` + +Read-Only: + +- `addr` (String) +- `type` (String) + + + +### Nested Schema for `interface` + +Read-Only: + +- `ip_address` (String) +- `network_id` (String) +- `port_id` (String) +- `subnet_id` (String) + + + +### Nested Schema for `metadata` + +Read-Only: + +- `key` (String) +- `value` (String) + + + +### Nested Schema for `security_group` + +Read-Only: + +- `name` (String) + + + +### Nested Schema for `volume` + +Read-Only: + +- `delete_on_termination` (Boolean) +- `volume_id` (String) diff --git a/templates/data-sources/k8sv2.md.tmpl b/templates/data-sources/k8sv2.md.tmpl new file mode 100644 index 00000000..b1623937 --- /dev/null +++ b/templates/data-sources/k8sv2.md.tmpl @@ -0,0 +1,77 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_k8sv2 Data Source - terraform-provider-gcore" +subcategory: "" +description: |- + Represent k8s cluster with one default pool. +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_k8sv2 (Data Source) + +Represent k8s cluster with one default pool. + +## Example Usage + +{{tffile "examples/data-sources/k8sv2/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) + +### Optional + +- `cni` (Block List) (see [below for nested schema](#nestedblock--cni)) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `created_at` (String) +- `creator_task_id` (String) +- `fixed_network` (String) +- `fixed_subnet` (String) +- `flavor_id` (String) +- `id` (String) The ID of this resource. +- `is_public` (Boolean) +- `keypair` (String) +- `node_count` (Number) +- `pools` (List of Object) (see [below for nested schema](#nestedatt--pools)) +- `status` (String) +- `task_id` (String) +- `version` (String) + + + +### Nested Schema for `cni` + +Required: + +- `provider` (String) + + + +### Nested Schema for `pools` + +Read-Only: + +- `auto_healing_enabled` (Boolean) +- `boot_volume_size` (Number) +- `boot_volume_type` (String) +- `created_at` (String) +- `flavor_id` (String) +- `is_public_ipv4` (Boolean) +- `max_node_count` (Number) +- `min_node_count` (Number) +- `name` (String) +- `node_count` (Number) +- `status` (String) diff --git a/templates/data-sources/laas_hosts.md.tmpl b/templates/data-sources/laas_hosts.md.tmpl new file mode 100644 index 00000000..9be415ff --- /dev/null +++ b/templates/data-sources/laas_hosts.md.tmpl @@ -0,0 +1,36 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_laas_hosts Data Source - terraform-provider-gcore" +subcategory: "" +description: |- + Represent LaaS hosts +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_laas_hosts (Data Source) + +Represent LaaS hosts + +## Example Usage + +{{tffile "examples/data-sources/laas_hosts/example_1.tf"}} + + + +## Schema + +### Optional + +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `id` (String) The ID of this resource. +- `kafka` (List of String) +- `opensearch` (List of String) diff --git a/templates/data-sources/laas_status.md.tmpl b/templates/data-sources/laas_status.md.tmpl new file mode 100644 index 00000000..310a2e0d --- /dev/null +++ b/templates/data-sources/laas_status.md.tmpl @@ -0,0 +1,36 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_laas_status Data Source - terraform-provider-gcore" +subcategory: "" +description: |- + Represent LaaS hosts +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_laas_status (Data Source) + +Represent LaaS hosts + +## Example Usage + +{{tffile "examples/data-sources/laas_status/example_1.tf"}} + + + +## Schema + +### Optional + +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `id` (String) The ID of this resource. +- `is_initialized` (Boolean) +- `namespace` (String) diff --git a/templates/data-sources/lblistener.md.tmpl b/templates/data-sources/lblistener.md.tmpl new file mode 100644 index 00000000..fed0b97f --- /dev/null +++ b/templates/data-sources/lblistener.md.tmpl @@ -0,0 +1,46 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_lblistener Data Source - terraform-provider-gcore" +subcategory: "" +description: |- + +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_lblistener (Data Source) + +## Example Usage + +{{tffile "examples/data-sources/lblistener/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) + +### Optional + +- `connection_limit` (Number) +- `loadbalancer_id` (String) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) +- `timeout_client_data` (Number) +- `timeout_member_connect` (Number) +- `timeout_member_data` (Number) + +### Read-Only + +- `id` (String) The ID of this resource. +- `operating_status` (String) +- `pool_count` (Number) +- `protocol` (String) Available values is 'HTTP', 'HTTPS', 'TCP', 'UDP' +- `protocol_port` (Number) +- `provisioning_status` (String) diff --git a/templates/data-sources/lbpool.md.tmpl b/templates/data-sources/lbpool.md.tmpl new file mode 100644 index 00000000..2f873a1f --- /dev/null +++ b/templates/data-sources/lbpool.md.tmpl @@ -0,0 +1,69 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_lbpool Data Source - terraform-provider-gcore" +subcategory: "" +description: |- + +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_lbpool (Data Source) + +## Example Usage + +{{tffile "examples/data-sources/lbpool/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) + +### Optional + +- `listener_id` (String) +- `loadbalancer_id` (String) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `health_monitor` (List of Object) (see [below for nested schema](#nestedatt--health_monitor)) +- `id` (String) The ID of this resource. +- `lb_algorithm` (String) Available values is 'ROUND_ROBIN', 'LEAST_CONNECTIONS', 'SOURCE_IP', 'SOURCE_IP_PORT' +- `protocol` (String) Available values is 'HTTP' (currently work, other do not work on ed-8), 'HTTPS', 'TCP', 'UDP' +- `session_persistence` (List of Object) (see [below for nested schema](#nestedatt--session_persistence)) + + + +### Nested Schema for `health_monitor` + +Read-Only: + +- `delay` (Number) +- `expected_codes` (String) +- `http_method` (String) +- `id` (String) +- `max_retries` (Number) +- `max_retries_down` (Number) +- `timeout` (Number) +- `type` (String) +- `url_path` (String) + + + +### Nested Schema for `session_persistence` + +Read-Only: + +- `cookie_name` (String) +- `persistence_granularity` (String) +- `persistence_timeout` (Number) +- `type` (String) diff --git a/templates/data-sources/loadbalancer.md.tmpl b/templates/data-sources/loadbalancer.md.tmpl new file mode 100644 index 00000000..7f4f6203 --- /dev/null +++ b/templates/data-sources/loadbalancer.md.tmpl @@ -0,0 +1,63 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_loadbalancer Data Source - terraform-provider-gcore" +subcategory: "" +description: |- + +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_loadbalancer (Data Source) + +## Example Usage + +{{tffile "examples/data-sources/loadbalancer/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) + +### Optional + +- `metadata_k` (String) +- `metadata_kv` (Map of String) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `id` (String) The ID of this resource. +- `listener` (List of Object) (see [below for nested schema](#nestedatt--listener)) +- `metadata_read_only` (List of Object) (see [below for nested schema](#nestedatt--metadata_read_only)) +- `vip_address` (String) +- `vip_port_id` (String) + + + +### Nested Schema for `listener` + +Read-Only: + +- `id` (String) +- `name` (String) +- `protocol` (String) +- `protocol_port` (Number) + + + +### Nested Schema for `metadata_read_only` + +Read-Only: + +- `key` (String) +- `read_only` (Boolean) +- `value` (String) diff --git a/templates/data-sources/loadbalancerv2.md.tmpl b/templates/data-sources/loadbalancerv2.md.tmpl new file mode 100644 index 00000000..7dee3f8b --- /dev/null +++ b/templates/data-sources/loadbalancerv2.md.tmpl @@ -0,0 +1,62 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_loadbalancerv2 Data Source - terraform-provider-gcore" +subcategory: "" +description: |- + +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_loadbalancerv2 (Data Source) + +## Example Usage + +{{tffile "examples/data-sources/loadbalancerv2/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) + +### Optional + +- `metadata_k` (String) +- `metadata_kv` (Map of String) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) +- `vip_ip_family` (String) + +### Read-Only + +- `id` (String) The ID of this resource. +- `metadata_read_only` (List of Object) (see [below for nested schema](#nestedatt--metadata_read_only)) +- `vip_address` (String) +- `vip_port_id` (String) +- `vrrp_ips` (List of Object) (see [below for nested schema](#nestedatt--vrrp_ips)) + + + +### Nested Schema for `metadata_read_only` + +Read-Only: + +- `key` (String) +- `read_only` (Boolean) +- `value` (String) + + + +### Nested Schema for `vrrp_ips` + +Read-Only: + +- `ip_address` (String) +- `subnet_id` (String) diff --git a/templates/data-sources/network.md.tmpl b/templates/data-sources/network.md.tmpl new file mode 100644 index 00000000..83211ce0 --- /dev/null +++ b/templates/data-sources/network.md.tmpl @@ -0,0 +1,55 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_network Data Source - terraform-provider-gcore" +subcategory: "" +description: |- + Represent network. A network is a software-defined network in a cloud computing infrastructure +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_network (Data Source) + +Represent network. A network is a software-defined network in a cloud computing infrastructure + +## Example Usage + +{{tffile "examples/data-sources/network/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) + +### Optional + +- `metadata_k` (String) +- `metadata_kv` (Map of String) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `external` (Boolean) +- `id` (String) The ID of this resource. +- `metadata_read_only` (List of Object) (see [below for nested schema](#nestedatt--metadata_read_only)) +- `mtu` (Number) +- `shared` (Boolean) +- `type` (String) 'vlan' or 'vxlan' network type is allowed. Default value is 'vxlan' + + + +### Nested Schema for `metadata_read_only` + +Read-Only: + +- `key` (String) +- `read_only` (Boolean) +- `value` (String) diff --git a/templates/data-sources/project.md.tmpl b/templates/data-sources/project.md.tmpl new file mode 100644 index 00000000..f3ffeb6a --- /dev/null +++ b/templates/data-sources/project.md.tmpl @@ -0,0 +1,31 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_project Data Source - terraform-provider-gcore" +subcategory: "" +description: |- + Represent project data +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_project (Data Source) + +Represent project data + +## Example Usage + +{{tffile "examples/data-sources/project/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) Displayed project name + +### Read-Only + +- `id` (String) The ID of this resource. diff --git a/templates/data-sources/region.md.tmpl b/templates/data-sources/region.md.tmpl new file mode 100644 index 00000000..76cbe963 --- /dev/null +++ b/templates/data-sources/region.md.tmpl @@ -0,0 +1,31 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_region Data Source - terraform-provider-gcore" +subcategory: "" +description: |- + Represent region data +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_region (Data Source) + +Represent region data + +## Example Usage + +{{tffile "examples/data-sources/region/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) Displayed region name + +### Read-Only + +- `id` (String) The ID of this resource. diff --git a/templates/data-sources/reservedfixedip.md.tmpl b/templates/data-sources/reservedfixedip.md.tmpl new file mode 100644 index 00000000..fecd2388 --- /dev/null +++ b/templates/data-sources/reservedfixedip.md.tmpl @@ -0,0 +1,53 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_reservedfixedip Data Source - terraform-provider-gcore" +subcategory: "" +description: |- + Represent reserved ips +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_reservedfixedip (Data Source) + +Represent reserved ips + +## Example Usage + +{{tffile "examples/data-sources/reservedfixedip/example_1.tf"}} + + + +## Schema + +### Required + +- `fixed_ip_address` (String) + +### Optional + +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `allowed_address_pairs` (List of Object) (see [below for nested schema](#nestedatt--allowed_address_pairs)) +- `id` (String) The ID of this resource. +- `is_vip` (Boolean) +- `network_id` (String) +- `port_id` (String) ID of the port_id underlying the reserved fixed IP +- `status` (String) +- `subnet_id` (String) + + + +### Nested Schema for `allowed_address_pairs` + +Read-Only: + +- `ip_address` (String) +- `mac_address` (String) diff --git a/templates/data-sources/router.md.tmpl b/templates/data-sources/router.md.tmpl new file mode 100644 index 00000000..878c09d8 --- /dev/null +++ b/templates/data-sources/router.md.tmpl @@ -0,0 +1,81 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_router Data Source - terraform-provider-gcore" +subcategory: "" +description: |- + +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_router (Data Source) + +## Example Usage + +{{tffile "examples/data-sources/router/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) + +### Optional + +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `external_gateway_info` (List of Object) (see [below for nested schema](#nestedatt--external_gateway_info)) +- `id` (String) The ID of this resource. +- `interfaces` (List of Object) (see [below for nested schema](#nestedatt--interfaces)) +- `routes` (List of Object) (see [below for nested schema](#nestedatt--routes)) +- `status` (String) + + + +### Nested Schema for `external_gateway_info` + +Read-Only: + +- `enable_snat` (Boolean) +- `external_fixed_ips` (List of Object) (see [below for nested schema](#nestedobjatt--external_gateway_info--external_fixed_ips)) +- `network_id` (String) + + + +### Nested Schema for `external_gateway_info.external_fixed_ips` + +Read-Only: + +- `ip_address` (String) +- `subnet_id` (String) + + + +### Nested Schema for `interfaces` + +Read-Only: + +- `ip_address` (String) +- `mac_address` (String) +- `network_id` (String) +- `port_id` (String) +- `subnet_id` (String) +- `type` (String) + + + +### Nested Schema for `routes` + +Read-Only: + +- `destination` (String) +- `nexthop` (String) diff --git a/templates/data-sources/secret.md.tmpl b/templates/data-sources/secret.md.tmpl new file mode 100644 index 00000000..75fe9b49 --- /dev/null +++ b/templates/data-sources/secret.md.tmpl @@ -0,0 +1,45 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_secret Data Source - terraform-provider-gcore" +subcategory: "" +description: |- + Represent secret +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_secret (Data Source) + +Represent secret + +## Example Usage + +{{tffile "examples/data-sources/secret/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) + +### Optional + +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `algorithm` (String) +- `bit_length` (Number) +- `content_types` (Map of String) +- `created` (String) Datetime when the secret was created. The format is 2025-12-28T19:14:44.180394 +- `expiration` (String) Datetime when the secret will expire. The format is 2025-12-28T19:14:44.180394 +- `id` (String) The ID of this resource. +- `mode` (String) +- `status` (String) diff --git a/templates/data-sources/securitygroup.md.tmpl b/templates/data-sources/securitygroup.md.tmpl new file mode 100644 index 00000000..b0af9f9e --- /dev/null +++ b/templates/data-sources/securitygroup.md.tmpl @@ -0,0 +1,70 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_securitygroup Data Source - terraform-provider-gcore" +subcategory: "" +description: |- + Represent SecurityGroups(Firewall) +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_securitygroup (Data Source) + +Represent SecurityGroups(Firewall) + +## Example Usage + +{{tffile "examples/data-sources/securitygroup/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) + +### Optional + +- `metadata_k` (String) +- `metadata_kv` (Map of String) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `description` (String) +- `id` (String) The ID of this resource. +- `metadata_read_only` (List of Object) (see [below for nested schema](#nestedatt--metadata_read_only)) +- `security_group_rules` (Set of Object) Firewall rules control what inbound(ingress) and outbound(egress) traffic is allowed to enter or leave a Instance. At least one 'egress' rule should be set (see [below for nested schema](#nestedatt--security_group_rules)) + + + +### Nested Schema for `metadata_read_only` + +Read-Only: + +- `key` (String) +- `read_only` (Boolean) +- `value` (String) + + + +### Nested Schema for `security_group_rules` + +Read-Only: + +- `created_at` (String) +- `description` (String) +- `direction` (String) +- `ethertype` (String) +- `id` (String) +- `port_range_max` (Number) +- `port_range_min` (Number) +- `protocol` (String) +- `remote_ip_prefix` (String) +- `updated_at` (String) diff --git a/templates/data-sources/servergroup.md.tmpl b/templates/data-sources/servergroup.md.tmpl new file mode 100644 index 00000000..b152ae3b --- /dev/null +++ b/templates/data-sources/servergroup.md.tmpl @@ -0,0 +1,49 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_servergroup Data Source - terraform-provider-gcore" +subcategory: "" +description: |- + Represent server group data +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_servergroup (Data Source) + +Represent server group data + +## Example Usage + +{{tffile "examples/data-sources/servergroup/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) Displayed server group name + +### Optional + +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `id` (String) The ID of this resource. +- `instances` (List of Object) Instances in this server group (see [below for nested schema](#nestedatt--instances)) +- `policy` (String) Server group policy. Available value is 'affinity', 'anti-affinity' + + + +### Nested Schema for `instances` + +Read-Only: + +- `instance_id` (String) +- `instance_name` (String) diff --git a/templates/data-sources/storage_s3.md.tmpl b/templates/data-sources/storage_s3.md.tmpl new file mode 100644 index 00000000..8f936486 --- /dev/null +++ b/templates/data-sources/storage_s3.md.tmpl @@ -0,0 +1,37 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_storage_s3 Data Source - terraform-provider-gcore" +subcategory: "" +description: |- + Represent s3 storage resource. https://storage.gcore.com/storage/list +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_storage_s3 (Data Source) + +Represent s3 storage resource. https://storage.gcore.com/storage/list + +## Example Usage + +{{tffile "examples/data-sources/storage_s3/example_1.tf"}} + + + +## Schema + +### Optional + +- `name` (String) A name of new storage resource. +- `storage_id` (Number) An id of new storage resource. + +### Read-Only + +- `client_id` (Number) An client id of new storage resource. +- `generated_endpoint` (String) A s3 entry point for new storage resource. +- `generated_http_endpoint` (String) A http s3 entry point for new storage resource. +- `generated_s3_endpoint` (String) A s3 endpoint for new storage resource. +- `id` (String) The ID of this resource. +- `location` (String) A location of new storage resource. One of (s-ed1, s-darz1, s-ws1, s-dt2, s-drc2) diff --git a/templates/data-sources/storage_s3_bucket.md.tmpl b/templates/data-sources/storage_s3_bucket.md.tmpl new file mode 100644 index 00000000..d14c0cba --- /dev/null +++ b/templates/data-sources/storage_s3_bucket.md.tmpl @@ -0,0 +1,32 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_storage_s3_bucket Data Source - terraform-provider-gcore" +subcategory: "" +description: |- + Represent storage s3 bucket resource. +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_storage_s3_bucket (Data Source) + +Represent storage s3 bucket resource. + +## Example Usage + +{{tffile "examples/data-sources/storage_s3_bucket/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) A name of storage bucket resource. +- `storage_id` (Number) An id of existing storage resource. + +### Read-Only + +- `id` (String) The ID of this resource. diff --git a/templates/data-sources/storage_sftp.md.tmpl b/templates/data-sources/storage_sftp.md.tmpl new file mode 100644 index 00000000..99660800 --- /dev/null +++ b/templates/data-sources/storage_sftp.md.tmpl @@ -0,0 +1,39 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_storage_sftp Data Source - terraform-provider-gcore" +subcategory: "" +description: |- + Represent sftp storage resource. https://storage.gcore.com/storage/list +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_storage_sftp (Data Source) + +Represent sftp storage resource. https://storage.gcore.com/storage/list + +## Example Usage + +{{tffile "examples/data-sources/storage_sftp/example_1.tf"}} + + + +## Schema + +### Optional + +- `name` (String) A name of storage resource. +- `storage_id` (Number) An id of storage resource. + +### Read-Only + +- `client_id` (Number) An client id of storage resource. +- `generated_http_endpoint` (String) A http sftp entry point for new storage resource. +- `generated_sftp_endpoint` (String) A ssh sftp entry point for new storage resource. +- `http_expires_header_value` (String) A expires date of storage resource. +- `http_servername_alias` (String) An alias of storage resource. +- `id` (String) The ID of this resource. +- `location` (String) A location of new storage resource. One of (ams, sin, fra, mia) +- `ssh_key_id` (List of Number) An ssh keys IDs to link with new sftp storage resource only. https://storage.gcore.com/ssh-key/list diff --git a/templates/data-sources/storage_sftp_key.md.tmpl b/templates/data-sources/storage_sftp_key.md.tmpl new file mode 100644 index 00000000..0669e50d --- /dev/null +++ b/templates/data-sources/storage_sftp_key.md.tmpl @@ -0,0 +1,32 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_storage_sftp_key Data Source - terraform-provider-gcore" +subcategory: "" +description: |- + Represent storage key resource. https://storage.gcore.com/ssh-key/list +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_storage_sftp_key (Data Source) + +Represent storage key resource. https://storage.gcore.com/ssh-key/list + +## Example Usage + +{{tffile "examples/data-sources/storage_sftp_key/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) A name of storage key resource. + +### Read-Only + +- `id` (String) The ID of this resource. +- `key_id` (Number) An id of of storage key resource. diff --git a/templates/data-sources/subnet.md.tmpl b/templates/data-sources/subnet.md.tmpl new file mode 100644 index 00000000..dc99ef94 --- /dev/null +++ b/templates/data-sources/subnet.md.tmpl @@ -0,0 +1,65 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_subnet Data Source - terraform-provider-gcore" +subcategory: "" +description: |- + +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_subnet (Data Source) + +## Example Usage + +{{tffile "examples/data-sources/subnet/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) + +### Optional + +- `metadata_k` (String) +- `metadata_kv` (Map of String) +- `network_id` (String) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `cidr` (String) +- `connect_to_network_router` (Boolean) +- `dns_nameservers` (List of String) +- `enable_dhcp` (Boolean) +- `gateway_ip` (String) +- `host_routes` (List of Object) (see [below for nested schema](#nestedatt--host_routes)) +- `id` (String) The ID of this resource. +- `metadata_read_only` (List of Object) (see [below for nested schema](#nestedatt--metadata_read_only)) + + + +### Nested Schema for `host_routes` + +Read-Only: + +- `destination` (String) +- `nexthop` (String) + + + +### Nested Schema for `metadata_read_only` + +Read-Only: + +- `key` (String) +- `read_only` (Boolean) +- `value` (String) diff --git a/templates/data-sources/volume.md.tmpl b/templates/data-sources/volume.md.tmpl new file mode 100644 index 00000000..6ca76ccb --- /dev/null +++ b/templates/data-sources/volume.md.tmpl @@ -0,0 +1,53 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_volume Data Source - terraform-provider-gcore" +subcategory: "" +description: |- + Represent volume. A volume is a file storage which is similar to SSD and HDD hard disks +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_volume (Data Source) + +Represent volume. A volume is a file storage which is similar to SSD and HDD hard disks + +## Example Usage + +{{tffile "examples/data-sources/volume/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) + +### Optional + +- `metadata_k` (String) +- `metadata_kv` (Map of String) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `id` (String) The ID of this resource. +- `metadata_read_only` (List of Object) (see [below for nested schema](#nestedatt--metadata_read_only)) +- `size` (Number) +- `type_name` (String) Available value is 'standard', 'ssd_hiiops', 'cold', 'ultra'. Defaults to standard + + + +### Nested Schema for `metadata_read_only` + +Read-Only: + +- `key` (String) +- `read_only` (Boolean) +- `value` (String) diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl new file mode 100644 index 00000000..61ddd3bb --- /dev/null +++ b/templates/index.md.tmpl @@ -0,0 +1,37 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore Provider" +subcategory: "" +description: |- + +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore Provider + +## Example Usage + +{{tffile "examples/example_1.tf"}} + + + +## Schema + +### Optional + +- `api_endpoint` (String) A single API endpoint for all products. Will be used when specific product API url is not defined. +- `gcore_api` (String, Deprecated) Region API +- `gcore_cdn_api` (String) CDN API (define only if you want to override CDN API endpoint) +- `gcore_client_id` (String) Client id +- `gcore_cloud_api` (String) Region API (define only if you want to override Region API endpoint) +- `gcore_dns_api` (String) DNS API (define only if you want to override DNS API endpoint) +- `gcore_platform` (String, Deprecated) Platform URL is used for generate JWT +- `gcore_platform_api` (String) Platform URL is used for generate JWT (define only if you want to override Platform API endpoint) +- `gcore_storage_api` (String) Storage API (define only if you want to override Storage API endpoint) +- `ignore_creds_auth_error` (Boolean, Deprecated) Should be set to true when you are gonna to use storage resource with permanent API-token only. +- `password` (String, Deprecated) +- `permanent_api_token` (String, Sensitive) A permanent [API-token](https://gcore.com/docs/account-settings/create-use-or-delete-a-permanent-api-token) +- `user_name` (String, Deprecated) diff --git a/templates/resources/ai_cluster.md.tmpl b/templates/resources/ai_cluster.md.tmpl new file mode 100644 index 00000000..a102c250 --- /dev/null +++ b/templates/resources/ai_cluster.md.tmpl @@ -0,0 +1,175 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_ai_cluster Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent instance +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_ai_cluster (Resource) + +Represent instance + +## Example Usage + +{{tffile "examples/resources/ai_cluster/example_1.tf"}} + + + +## Schema + +### Required + +- `cluster_name` (String) AI Cluster Name +- `flavor` (String) Flavor ID (name) +- `image_id` (String) Image ID +- `interface` (Block List, Min: 1) Networks managed by user and associated with the cluster (see [below for nested schema](#nestedblock--interface)) + +### Optional + +- `cluster_metadata` (Map of String) Cluster metadata (simple key-value pairs) +- `cluster_status` (String) AI Cluster status +- `keypair_name` (String) Ssh keypair name +- `password` (String) A password for baremetal instance. This parameter is used to set a password for the Admin user on a Windows instance, a default user or a new user on a Linux instance +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) +- `security_group` (Block Set) Security groups attached to the cluster (see [below for nested schema](#nestedblock--security_group)) +- `user_data` (String) String in base64 format. Must not be passed together with 'username' or 'password'. Examples of the user_data: https://cloudinit.readthedocs.io/en/latest/topics/examples.html +- `username` (String) A name of a new user in the Linux instance. It may be passed with a 'password' parameter +- `volume` (Block Set) List of volumes attached to the cluster (see [below for nested schema](#nestedblock--volume)) + +### Read-Only + +- `created_at` (String) Datetime when the cluster was created +- `creator_task_id` (String) Task that created this entity +- `id` (String) The ID of this resource. +- `image_name` (String) Image name +- `poplar_servers` (List of Object) Poplar servers (see [below for nested schema](#nestedatt--poplar_servers)) +- `task_id` (String) Task ID associated with the cluster +- `task_status` (String) Task status + + + +### Nested Schema for `interface` + +Optional: + +- `network_id` (String) Network ID +- `port_id` (String) Network ID the subnet belongs to. Port will be plugged in this network +- `subnet_id` (String) Port is assigned to IP address from the subnet +- `type` (String) Network type + + + +### Nested Schema for `security_group` + +Optional: + +- `id` (String) Security group ID + + + +### Nested Schema for `volume` + +Optional: + +- `image_id` (String) Volume ID. Mandatory if volume is pre-existing volume +- `name` (String) Volume name +- `size` (Number) Volume size, GiB +- `source` (String) Currently available only value +- `volume_id` (String) Volume ID +- `volume_type` (String) Volume type + +Read-Only: + +- `attachments` (Block Set) Attachment list (see [below for nested schema](#nestedblock--volume--attachments)) +- `created_at` (String) Datetime when the volume was created +- `creator_task_id` (String) Task that created this entity +- `status` (String) Volume status +- `updated_at` (String) Datetime when the volume was last updated +- `volume_image_metadata` (Map of String) Image information for volumes that were created from image + + + +### Nested Schema for `volume.attachments` + +Read-Only: + +- `attached_at` (String) Attachment creation datetime +- `attachment_id` (String) ID of attachment object +- `device` (String) Block device name in guest +- `instance_name` (String) Instance name (if attached and server name is known) +- `server_id` (String) Instance ID +- `volume_id` (String) Volume ID + + + +### Nested Schema for `poplar_servers` + +Read-Only: + +- `addresses` (Set of Object) (see [below for nested schema](#nestedobjatt--poplar_servers--addresses)) +- `creator_task_id` (String) +- `flavor` (Map of String) +- `flavor_id` (String) +- `instance_created` (String) +- `instance_description` (String) +- `instance_id` (String) +- `instance_name` (String) +- `metadata` (Map of String) +- `security_groups` (Set of Object) (see [below for nested schema](#nestedobjatt--poplar_servers--security_groups)) +- `status` (String) +- `task_id` (String) +- `task_state` (String) +- `vm_state` (String) +- `volumes` (Set of Object) (see [below for nested schema](#nestedobjatt--poplar_servers--volumes)) + + + +### Nested Schema for `poplar_servers.addresses` + +Read-Only: + +- `address` (List of Object) (see [below for nested schema](#nestedobjatt--poplar_servers--addresses--address)) +- `network_name` (String) + + + +### Nested Schema for `poplar_servers.addresses.address` + +Read-Only: + +- `addr` (String) +- `type` (String) + + + +### Nested Schema for `poplar_servers.security_groups` + +Read-Only: + +- `name` (String) + + + +### Nested Schema for `poplar_servers.volumes` + +Read-Only: + +- `delete_on_termination` (Boolean) +- `id` (String) + +## Import + +Import is supported using the following syntax: + +```shell +# import using :: format +terraform import gcore_ai_cluster.cluster1 1:6:447d2959-8ae0-4ca0-8d47-9f050a3637d7 +``` diff --git a/templates/resources/baremetal.md.tmpl b/templates/resources/baremetal.md.tmpl new file mode 100644 index 00000000..87b71596 --- /dev/null +++ b/templates/resources/baremetal.md.tmpl @@ -0,0 +1,119 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_baremetal Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent baremetal instance +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_baremetal (Resource) + +Represent baremetal instance + +## Example Usage + +{{tffile "examples/resources/baremetal/example_1.tf"}} + + + +## Schema + +### Required + +- `flavor_id` (String) +- `interface` (Block List, Min: 1) (see [below for nested schema](#nestedblock--interface)) + +### Optional + +- `app_config` (Map of String) +- `apptemplate_id` (String) +- `image_id` (String) +- `keypair_name` (String) +- `last_updated` (String) +- `metadata` (Block List, Deprecated) (see [below for nested schema](#nestedblock--metadata)) +- `metadata_map` (Map of String) +- `name` (String) +- `name_template` (String) +- `name_templates` (List of String, Deprecated) +- `password` (String) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) +- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) +- `user_data` (String) +- `username` (String) + +### Read-Only + +- `addresses` (List of Object) (see [below for nested schema](#nestedatt--addresses)) +- `flavor` (Map of String) +- `id` (String) The ID of this resource. +- `status` (String) +- `vm_state` (String) + + + +### Nested Schema for `interface` + +Required: + +- `type` (String) Available value is 'subnet', 'any_subnet', 'external', 'reserved_fixed_ip' + +Optional: + +- `existing_fip_id` (String) +- `fip_source` (String) +- `ip_address` (String) +- `is_parent` (Boolean) If not set will be calculated after creation. Trunk interface always attached first. Can't detach interface if is_parent true. Fields affect only on creation +- `network_id` (String) required if type is 'subnet' or 'any_subnet' +- `order` (Number) Order of attaching interface. Trunk interface always attached first, fields affect only on creation +- `port_id` (String) required if type is 'reserved_fixed_ip' +- `subnet_id` (String) required if type is 'subnet' + + + +### Nested Schema for `metadata` + +Required: + +- `key` (String) +- `value` (String) + + + +### Nested Schema for `timeouts` + +Optional: + +- `create` (String) + + + +### Nested Schema for `addresses` + +Read-Only: + +- `net` (List of Object) (see [below for nested schema](#nestedobjatt--addresses--net)) + + + +### Nested Schema for `addresses.net` + +Read-Only: + +- `addr` (String) +- `type` (String) + +## Import + +Import is supported using the following syntax: + +```shell +# import using :: format +terraform import gcore_baremetal.instance1 1:6:447d2959-8ae0-4ca0-8d47-9f050a3637d7 +``` diff --git a/templates/resources/cdn_origingroup.md.tmpl b/templates/resources/cdn_origingroup.md.tmpl new file mode 100644 index 00000000..f4c956ea --- /dev/null +++ b/templates/resources/cdn_origingroup.md.tmpl @@ -0,0 +1,46 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_cdn_origingroup Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent origin group +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_cdn_origingroup (Resource) + +Represent origin group + +## Example Usage + +{{tffile "examples/resources/cdn_origingroup/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) Name of the origin group +- `origin` (Block Set, Min: 1) Contains information about all IP address or Domain names of your origin and the port if custom (see [below for nested schema](#nestedblock--origin)) +- `use_next` (Boolean) This options have two possible values: true — The option is active. In case the origin responds with 4XX or 5XX codes, use the next origin from the list. false — The option is disabled. + +### Read-Only + +- `id` (String) The ID of this resource. + + + +### Nested Schema for `origin` + +Required: + +- `source` (String) IP address or Domain name of your origin and the port if custom + +Optional: + +- `backup` (Boolean) true — The option is active. The origin will not be used until one of active origins become unavailable. false — The option is disabled. +- `enabled` (Boolean) The setting allows to enable or disable an Origin source in the Origins group diff --git a/templates/resources/cdn_resource.md.tmpl b/templates/resources/cdn_resource.md.tmpl new file mode 100644 index 00000000..13c07927 --- /dev/null +++ b/templates/resources/cdn_resource.md.tmpl @@ -0,0 +1,649 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_cdn_resource Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent CDN resource +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_cdn_resource (Resource) + +Represent CDN resource + +## Example Usage + +{{tffile "examples/resources/cdn_resource/example_1.tf"}} + + + +## Schema + +### Required + +- `cname` (String) A CNAME that will be used to deliver content though a CDN. If you update this field new resource will be created. + +### Optional + +- `active` (Boolean) The setting allows to enable or disable a CDN Resource +- `description` (String) Custom client description of the resource. +- `options` (Block List, Max: 1) Each option in CDN resource settings. Each option added to CDN resource settings should have the following mandatory request fields: enabled, value. (see [below for nested schema](#nestedblock--options)) +- `origin` (String) A domain name or IP of your origin source. Specify a port if custom. You can use either 'origin' parameter or 'originGroup' in the resource definition. +- `origin_group` (Number) ID of the Origins Group. Use one of your Origins Group or create a new one. You can use either 'origin' parameter or 'originGroup' in the resource definition. +- `origin_protocol` (String) This option defines the protocol that will be used by CDN servers to request content from an origin source. If not specified, we will use HTTP to connect to an origin server. Possible values are: HTTPS, HTTP, MATCH. +- `secondary_hostnames` (Set of String) List of additional CNAMEs. +- `ssl_data` (Number) Specify the SSL Certificate ID which should be used for the CDN Resource. +- `ssl_enabled` (Boolean) Use HTTPS protocol for content delivery. + +### Read-Only + +- `id` (String) The ID of this resource. +- `status` (String) Status of a CDN resource content availability. Possible values are: Active, Suspended, Processed. + + + +### Nested Schema for `options` + +Optional: + +- `allowed_http_methods` (Block List, Max: 1) Specify allowed HTTP methods. (see [below for nested schema](#nestedblock--options--allowed_http_methods)) +- `brotli_compression` (Block List, Max: 1) Brotli compression option allows to compress content with brotli on the CDN's end. CDN servers will request only uncompressed content from the origin. (see [below for nested schema](#nestedblock--options--brotli_compression)) +- `browser_cache_settings` (Block List, Max: 1) Specify the cache expiration time for customers' browsers in seconds. (see [below for nested schema](#nestedblock--options--browser_cache_settings)) +- `cache_http_headers` (Block List, Max: 1) Legacy option. Use the response_headers_hiding_policy option instead. (see [below for nested schema](#nestedblock--options--cache_http_headers)) +- `cors` (Block List, Max: 1) CORS header support option adds the Access-Control-Allow-Origin header to responses from CDN servers. (see [below for nested schema](#nestedblock--options--cors)) +- `country_acl` (Block List, Max: 1) Country access policy enables control access to content for specified countries. (see [below for nested schema](#nestedblock--options--country_acl)) +- `disable_cache` (Block List, Max: 1) Option enables browser caching. When enabled, content caching is completely disabled. (see [below for nested schema](#nestedblock--options--disable_cache)) +- `disable_proxy_force_ranges` (Block List, Max: 1) The option allows getting 206 responses regardless settings of an origin source. Enabled by default. (see [below for nested schema](#nestedblock--options--disable_proxy_force_ranges)) +- `edge_cache_settings` (Block List, Max: 1) The cache expiration time for CDN servers. (see [below for nested schema](#nestedblock--options--edge_cache_settings)) +- `fetch_compressed` (Block List, Max: 1) Option allows to enable fetch compressed. CDN request and cache already compressed content. Your server should support compression. CDN servers will not ungzip your content even if a user's browser doesn't accept compression (nowadays almost all browsers support it). (see [below for nested schema](#nestedblock--options--fetch_compressed)) +- `follow_origin_redirect` (Block List, Max: 1) Enable redirection from origin. If the origin server returns a redirect, the option allows the CDN to pull the requested content from the origin server that was returned in the redirect. (see [below for nested schema](#nestedblock--options--follow_origin_redirect)) +- `force_return` (Block List, Max: 1) Allows to apply custom HTTP code to the CDN content. Specify HTTP-code you need and text or URL if you are going to set up redirect. (see [below for nested schema](#nestedblock--options--force_return)) +- `forward_host_header` (Block List, Max: 1) When a CDN requests content from an origin server, the option allows to forward the Host header used in the request made to a CDN. (see [below for nested schema](#nestedblock--options--forward_host_header)) +- `gzip_on` (Block List, Max: 1) GZip compression option allows to compress content with gzip on the CDN`s end. CDN servers will request only uncompressed content from the origin. (see [below for nested schema](#nestedblock--options--gzip_on)) +- `host_header` (Block List, Max: 1) Option allows to set Host header that CDN servers use when request content from an origin server. Your server must be able to process requests with the chosen header. If the option is NULL, Host Header value is taken from the parent CDN resource's value. (see [below for nested schema](#nestedblock--options--host_header)) +- `http3_enabled` (Block List, Max: 1) Use HTTP/3 protocol for content delivery if supported by the end users browser. (see [below for nested schema](#nestedblock--options--http3_enabled)) +- `ignore_cookie` (Block List, Max: 1) By default, files pulled from an origin source with cookies are not cached in a CDN. Enable this option to cache such objects. (see [below for nested schema](#nestedblock--options--ignore_cookie)) +- `ignore_query_string` (Block List, Max: 1) Ignore query string option determines how files with different query strings will be cached: either as one object (option is enabled) or as different objects (option is disabled). (see [below for nested schema](#nestedblock--options--ignore_query_string)) +- `image_stack` (Block List, Max: 1) Image stack option allows transforming JPG and PNG images (such as resizing or cropping) and automatically converting them to WebP or AVIF format. It is a paid option. (see [below for nested schema](#nestedblock--options--image_stack)) +- `ip_address_acl` (Block List, Max: 1) IP access policy option allows to control access to the CDN Resource content for specific IP addresses. (see [below for nested schema](#nestedblock--options--ip_address_acl)) +- `limit_bandwidth` (Block List, Max: 1) The option allows to control the download speed per connection. (see [below for nested schema](#nestedblock--options--limit_bandwidth)) +- `proxy_cache_methods_set` (Block List, Max: 1) Allows caching for GET, HEAD and POST requests. (see [below for nested schema](#nestedblock--options--proxy_cache_methods_set)) +- `query_params_blacklist` (Block List, Max: 1) Specify list of query strings. Files with those query strings will be cached as one object. (see [below for nested schema](#nestedblock--options--query_params_blacklist)) +- `query_params_whitelist` (Block List, Max: 1) Specify list of query strings. Files with those query strings will be cached as different objects. (see [below for nested schema](#nestedblock--options--query_params_whitelist)) +- `redirect_http_to_https` (Block List, Max: 1) When enabled, HTTP requests are redirected to HTTPS. (see [below for nested schema](#nestedblock--options--redirect_http_to_https)) +- `redirect_https_to_http` (Block List, Max: 1) When enabled, HTTPS requests are redirected to HTTP. (see [below for nested schema](#nestedblock--options--redirect_https_to_http)) +- `referrer_acl` (Block List, Max: 1) Referrer access policy option allows to control access to the CDN Resource content for specified domain names. (see [below for nested schema](#nestedblock--options--referrer_acl)) +- `request_limiter` (Block List, Max: 1) It allows to limit the amount of HTTP requests (see [below for nested schema](#nestedblock--options--request_limiter)) +- `response_headers_hiding_policy` (Block List, Max: 1) Define HTTP headers (specified at an origin server) that a CDN server hides from the response. (see [below for nested schema](#nestedblock--options--response_headers_hiding_policy)) +- `rewrite` (Block List, Max: 1) Rewrite option changes and redirects the requests from the CDN to the origin. It operates according to the Nginx configuration. (see [below for nested schema](#nestedblock--options--rewrite)) +- `secure_key` (Block List, Max: 1) The option allows configuring an access with tokenized URLs. It makes impossible to access content without a valid (unexpired) hash key. When enabled, you need to specify a key that you use to generate a token. (see [below for nested schema](#nestedblock--options--secure_key)) +- `slice` (Block List, Max: 1) When enabled, files larger than 10 MB are requested and cached in parts (no larger than 10 MB each). It reduces time to first byte. The origin must support HTTP Range requests. (see [below for nested schema](#nestedblock--options--slice)) +- `sni` (Block List, Max: 1) Specify the SNI (Server Name Indication). SNI (Server Name Indication) is generally only required if your origin is using shared hosting or does not have a dedicated IP address. If the origin server presents multiple certificates, SNI allows the origin server to know which certificate to use for the connection. The option works only if originProtocol parameter is HTTPS or MATCH. (see [below for nested schema](#nestedblock--options--sni)) +- `stale` (Block List, Max: 1) The list of errors which Always Online option is applied for. (see [below for nested schema](#nestedblock--options--stale)) +- `static_headers` (Block List, Max: 1) Legacy option. Use the static_response_headers option instead. (see [below for nested schema](#nestedblock--options--static_headers)) +- `static_request_headers` (Block List, Max: 1) Specify custom HTTP Headers for a CDN server to add to request. (see [below for nested schema](#nestedblock--options--static_request_headers)) +- `static_response_headers` (Block List, Max: 1) Specify custom HTTP Headers that a CDN server adds to a response. (see [below for nested schema](#nestedblock--options--static_response_headers)) +- `tls_versions` (Block List, Max: 1) The option specifies a list of allowed SSL/TLS protocol versions. The list cannot be empty. By default, the option is disabled (all protocols versions are allowed). (see [below for nested schema](#nestedblock--options--tls_versions)) +- `use_default_le_chain` (Block List, Max: 1) The option allows choosing a Let's Encrypt certificate chain. The specified chain will be used during the next Let's Encrypt certificate issue or renewal. (see [below for nested schema](#nestedblock--options--use_default_le_chain)) +- `use_rsa_le_cert` (Block List, Max: 1) The option allows choosing the RSA Let's Encrypt certificate type for the resource. (see [below for nested schema](#nestedblock--options--use_rsa_le_cert)) +- `user_agent_acl` (Block List, Max: 1) User agents policy option allows to control access to the content for specified user-agent. (see [below for nested schema](#nestedblock--options--user_agent_acl)) +- `waf` (Block List, Max: 1) Option allows to enable Basic WAF to protect you against the most common threats. (see [below for nested schema](#nestedblock--options--waf)) +- `webp` (Block List, Max: 1) Legacy option. Use the image_stack option instead. (see [below for nested schema](#nestedblock--options--webp)) +- `websockets` (Block List, Max: 1) WebSockets option allows WebSockets connections to an origin server. (see [below for nested schema](#nestedblock--options--websockets)) + + + +### Nested Schema for `options.allowed_http_methods` + +Required: + +- `value` (Set of String) Available methods: GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS. + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.brotli_compression` + +Required: + +- `value` (Set of String) Specify the content-type for each type of content you wish to have compressed. + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.browser_cache_settings` + +Optional: + +- `enabled` (Boolean) +- `value` (String) Use '0s' to disable caching. The value applies for a response with codes 200, 201, 204, 206, 301, 302, 303, 304, 307, 308. + + + +### Nested Schema for `options.cache_http_headers` + +Required: + +- `value` (Set of String) List HTTP Headers that must be included in the response. + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.cors` + +Required: + +- `value` (Set of String) Specify a value of the Access-Control-Allow-Origin header. Possible values: '*', '$http_origin', 'example.com'. + +Optional: + +- `always` (Boolean) Specify if the Access-Control-Allow-Origin header should be added to a response from CDN regardless of response code. +- `enabled` (Boolean) + + + +### Nested Schema for `options.country_acl` + +Required: + +- `excepted_values` (Set of String) List of countries according to ISO-3166-1. +- `policy_type` (String) Possible values: allow, deny. + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.disable_cache` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.disable_proxy_force_ranges` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.edge_cache_settings` + +Optional: + +- `custom_values` (Map of String) Specify caching time in seconds ('0s', '600s' for example) for a response with specific response code ('304', '404' for example). Use 'any' to specify caching time for all response codes. Use '0s' to disable caching for a specific response code. These settings have a higher priority than the value field. +- `default` (String) Content will be cached according to origin cache settings. The value applies for a response with codes 200, 201, 204, 206, 301, 302, 303, 304, 307, 308, if an origin server does not have caching HTTP headers. Responses with other codes will not be cached. +- `enabled` (Boolean) +- `value` (String) Specify caching time for the response with codes 200, 206, 301, 302. Responses with codes 4xx, 5xx will not be cached. Use '0s' to disable caching. Use custom_values field to specify a custom caching time for a response with specific codes. + + + +### Nested Schema for `options.fetch_compressed` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.follow_origin_redirect` + +Required: + +- `codes` (Set of Number) Specify the redirect status code that the origin server returns. Possible values: 301, 302, 303, 307, 308. + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.force_return` + +Required: + +- `code` (Number) HTTP response status code. Available codes: 100 <= value <= 599. Reserved codes: 408, 444, 477, 494, 495, 496, 497, 499 + +Optional: + +- `body` (String) Response text or URL if you're going to set up redirection. Max length = 100. +- `enabled` (Boolean) + + + +### Nested Schema for `options.forward_host_header` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.gzip_on` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.host_header` + +Required: + +- `value` (String) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.http3_enabled` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.ignore_cookie` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.ignore_query_string` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.image_stack` + +Required: + +- `quality` (Number) Quality settings for JPG and PNG images. Specify a value from 1 to 100. The higher the value, the better the image quality and the larger the file size after conversion. + +Optional: + +- `avif_enabled` (Boolean) If enabled, JPG and PNG images automatically convert to AVIF format when supported by the end users browser. +- `enabled` (Boolean) +- `png_lossless` (Boolean) Represents compression without quality loss for PNG format. +- `webp_enabled` (Boolean) If enabled, JPG and PNG images automatically convert to WebP format when supported by the end users browser. + + + +### Nested Schema for `options.ip_address_acl` + +Required: + +- `excepted_values` (Set of String) Specify list of IP address with a subnet mask. +- `policy_type` (String) Possible values: allow, deny. + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.limit_bandwidth` + +Required: + +- `limit_type` (String) The way of controlling the download speed per each connection. Possible values are: static, dynamic. + +Optional: + +- `buffer` (Number) Amount of downloaded data after which the user will be rate limited. +- `enabled` (Boolean) +- `speed` (Number) Maximum download speed per connection. Must be greater than 0. + + + +### Nested Schema for `options.proxy_cache_methods_set` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.query_params_blacklist` + +Required: + +- `value` (Set of String) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.query_params_whitelist` + +Required: + +- `value` (Set of String) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.redirect_http_to_https` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.redirect_https_to_http` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.referrer_acl` + +Required: + +- `excepted_values` (Set of String) Specify list of domain names or wildcard domains (without http:// or https://). For example, example.com or *.example.com. +- `policy_type` (String) Possible values: allow, deny. + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.request_limiter` + +Required: + +- `burst` (Number) +- `rate` (Number) + +Optional: + +- `delay` (Number) +- `enabled` (Boolean) +- `rate_unit` (String) + + + +### Nested Schema for `options.response_headers_hiding_policy` + +Required: + +- `excepted` (Set of String) List of HTTP headers. The following required headers cannot be hidden from response: Connection, Content-Length, Content-Type, Date, Server. +- `mode` (String) Specify a mode of hiding HTTP headers from the response. Possible values are: hide, show. + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.rewrite` + +Required: + +- `body` (String) The pattern for Rewrite. At least one group should be specified. For Example: /rewrite_from/(.*) /rewrite_to/$1 + +Optional: + +- `enabled` (Boolean) +- `flag` (String) Define flag for the Rewrite option. Possible values: last, break, redirect, permanent. + + + +### Nested Schema for `options.secure_key` + +Required: + +- `key` (String) A key generated on your side that will be used for URL signing. +- `type` (Number) Specify the type of URL Signing. It can be either 0 or 2. Type 0 - includes end user's IP to secure token generation. Type 2 - excludes end user's IP from secure token generation. + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.slice` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.sni` + +Optional: + +- `custom_hostname` (String) Custom SNI hostname. Required if sni_type is set to 'custom'. +- `enabled` (Boolean) +- `sni_type` (String) Specify SNI type. Possible values: dynamic, custom. dynamic - SNI hostname depends on the hostHeader and the forward_host_header options. custom - custom SNI hostname. + + + +### Nested Schema for `options.stale` + +Required: + +- `value` (Set of String) Possible values: error, http_403, http_404, http_429, http_500, http_502, http_503, http_504, invalid_header, timeout, updating. + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.static_headers` + +Required: + +- `value` (Map of String) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.static_request_headers` + +Required: + +- `value` (Map of String) Header name is restricted to 255 symbols and can contain latin letters (A-Z, a-z), numbers (0-9), dashes, and underscores. Header value is restricted to 512 symbols and can contain latin letters (a-z), numbers (0-9), spaces, underscores and symbols (-/.:). Space can be used only between words. + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.static_response_headers` + +Required: + +- `value` (Block List, Min: 1) (see [below for nested schema](#nestedblock--options--static_response_headers--value)) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.static_response_headers.value` + +Required: + +- `name` (String) Header name. +- `value` (Set of String) Header value. + +Optional: + +- `always` (Boolean) Specifies if the header will be added to a response from CDN regardless of response code. + + + +### Nested Schema for `options.tls_versions` + +Required: + +- `value` (Set of String) Possible values (case sensitive): SSLv3, TLSv1, TLSv1.1, TLSv1.2, TLSv1.3. + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.use_default_le_chain` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.use_rsa_le_cert` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.user_agent_acl` + +Required: + +- `excepted_values` (Set of String) List of User-Agents. Use "" to allow/deny access when the User-Agent header is empty. +- `policy_type` (String) Possible values: allow, deny. + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.waf` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.webp` + +Required: + +- `jpg_quality` (Number) +- `png_quality` (Number) + +Optional: + +- `enabled` (Boolean) +- `png_lossless` (Boolean) + + + +### Nested Schema for `options.websockets` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) diff --git a/templates/resources/cdn_rule.md.tmpl b/templates/resources/cdn_rule.md.tmpl new file mode 100644 index 00000000..3a23a580 --- /dev/null +++ b/templates/resources/cdn_rule.md.tmpl @@ -0,0 +1,647 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_cdn_rule Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent cdn resource rule +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_cdn_rule (Resource) + +Represent cdn resource rule + +## Example Usage + +{{tffile "examples/resources/cdn_rule/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) Rule name +- `resource_id` (Number) +- `rule` (String) A pattern that defines when the rule is triggered. By default, we add a leading forward slash to any rule pattern. Specify a pattern without a forward slash. +- `rule_type` (Number) Type of rule. The rule is applied if the requested URI matches the rule pattern. It has two possible values: Type 0 — RegEx. Must start with '^/' or '/'. Type 1 — RegEx. Legacy type. Note that for this rule type we automatically add / to each rule pattern before your regular expression. Please use Type 0. + +### Optional + +- `active` (Boolean) The setting allows to enable or disable a Rule. If not specified, it will be enabled. +- `options` (Block List, Max: 1) Each option in CDN resource settings. Each option added to CDN resource settings should have the following mandatory request fields: enabled, value. (see [below for nested schema](#nestedblock--options)) +- `origin_group` (Number) ID of the Origins Group. Use one of your Origins Group or create a new one. You can use either 'origin' parameter or 'originGroup' in the resource definition. +- `origin_protocol` (String) This option defines the protocol that will be used by CDN servers to request content from an origin source. If not specified, it will be inherit from resource. Possible values are: HTTPS, HTTP, MATCH. +- `weight` (Number) Rule weight that determines rule execution order: from the smallest (0) to the highest. + +### Read-Only + +- `id` (String) The ID of this resource. + + + +### Nested Schema for `options` + +Optional: + +- `allowed_http_methods` (Block List, Max: 1) Specify allowed HTTP methods. (see [below for nested schema](#nestedblock--options--allowed_http_methods)) +- `brotli_compression` (Block List, Max: 1) Brotli compression option allows to compress content with brotli on the CDN's end. CDN servers will request only uncompressed content from the origin. (see [below for nested schema](#nestedblock--options--brotli_compression)) +- `browser_cache_settings` (Block List, Max: 1) Specify the cache expiration time for customers' browsers in seconds. (see [below for nested schema](#nestedblock--options--browser_cache_settings)) +- `cache_http_headers` (Block List, Max: 1) Legacy option. Use the response_headers_hiding_policy option instead. (see [below for nested schema](#nestedblock--options--cache_http_headers)) +- `cors` (Block List, Max: 1) CORS header support option adds the Access-Control-Allow-Origin header to responses from CDN servers. (see [below for nested schema](#nestedblock--options--cors)) +- `country_acl` (Block List, Max: 1) Country access policy enables control access to content for specified countries. (see [below for nested schema](#nestedblock--options--country_acl)) +- `disable_cache` (Block List, Max: 1) Option enables browser caching. When enabled, content caching is completely disabled. (see [below for nested schema](#nestedblock--options--disable_cache)) +- `disable_proxy_force_ranges` (Block List, Max: 1) The option allows getting 206 responses regardless settings of an origin source. Enabled by default. (see [below for nested schema](#nestedblock--options--disable_proxy_force_ranges)) +- `edge_cache_settings` (Block List, Max: 1) The cache expiration time for CDN servers. (see [below for nested schema](#nestedblock--options--edge_cache_settings)) +- `fetch_compressed` (Block List, Max: 1) Option allows to enable fetch compressed. CDN request and cache already compressed content. Your server should support compression. CDN servers will not ungzip your content even if a user's browser doesn't accept compression (nowadays almost all browsers support it). (see [below for nested schema](#nestedblock--options--fetch_compressed)) +- `follow_origin_redirect` (Block List, Max: 1) Enable redirection from origin. If the origin server returns a redirect, the option allows the CDN to pull the requested content from the origin server that was returned in the redirect. (see [below for nested schema](#nestedblock--options--follow_origin_redirect)) +- `force_return` (Block List, Max: 1) Allows to apply custom HTTP code to the CDN content. Specify HTTP-code you need and text or URL if you are going to set up redirect. (see [below for nested schema](#nestedblock--options--force_return)) +- `forward_host_header` (Block List, Max: 1) When a CDN requests content from an origin server, the option allows to forward the Host header used in the request made to a CDN. (see [below for nested schema](#nestedblock--options--forward_host_header)) +- `gzip_on` (Block List, Max: 1) GZip compression option allows to compress content with gzip on the CDN`s end. CDN servers will request only uncompressed content from the origin. (see [below for nested schema](#nestedblock--options--gzip_on)) +- `host_header` (Block List, Max: 1) Option allows to set Host header that CDN servers use when request content from an origin server. Your server must be able to process requests with the chosen header. If the option is NULL, Host Header value is taken from the parent CDN resource's value. (see [below for nested schema](#nestedblock--options--host_header)) +- `http3_enabled` (Block List, Max: 1) Use HTTP/3 protocol for content delivery if supported by the end users browser. (see [below for nested schema](#nestedblock--options--http3_enabled)) +- `ignore_cookie` (Block List, Max: 1) By default, files pulled from an origin source with cookies are not cached in a CDN. Enable this option to cache such objects. (see [below for nested schema](#nestedblock--options--ignore_cookie)) +- `ignore_query_string` (Block List, Max: 1) Ignore query string option determines how files with different query strings will be cached: either as one object (option is enabled) or as different objects (option is disabled). (see [below for nested schema](#nestedblock--options--ignore_query_string)) +- `image_stack` (Block List, Max: 1) Image stack option allows transforming JPG and PNG images (such as resizing or cropping) and automatically converting them to WebP or AVIF format. It is a paid option. (see [below for nested schema](#nestedblock--options--image_stack)) +- `ip_address_acl` (Block List, Max: 1) IP access policy option allows to control access to the CDN Resource content for specific IP addresses. (see [below for nested schema](#nestedblock--options--ip_address_acl)) +- `limit_bandwidth` (Block List, Max: 1) The option allows to control the download speed per connection. (see [below for nested schema](#nestedblock--options--limit_bandwidth)) +- `proxy_cache_methods_set` (Block List, Max: 1) Allows caching for GET, HEAD and POST requests. (see [below for nested schema](#nestedblock--options--proxy_cache_methods_set)) +- `query_params_blacklist` (Block List, Max: 1) Specify list of query strings. Files with those query strings will be cached as one object. (see [below for nested schema](#nestedblock--options--query_params_blacklist)) +- `query_params_whitelist` (Block List, Max: 1) Specify list of query strings. Files with those query strings will be cached as different objects. (see [below for nested schema](#nestedblock--options--query_params_whitelist)) +- `redirect_http_to_https` (Block List, Max: 1) When enabled, HTTP requests are redirected to HTTPS. (see [below for nested schema](#nestedblock--options--redirect_http_to_https)) +- `redirect_https_to_http` (Block List, Max: 1) When enabled, HTTPS requests are redirected to HTTP. (see [below for nested schema](#nestedblock--options--redirect_https_to_http)) +- `referrer_acl` (Block List, Max: 1) Referrer access policy option allows to control access to the CDN Resource content for specified domain names. (see [below for nested schema](#nestedblock--options--referrer_acl)) +- `request_limiter` (Block List, Max: 1) It allows to limit the amount of HTTP requests (see [below for nested schema](#nestedblock--options--request_limiter)) +- `response_headers_hiding_policy` (Block List, Max: 1) Define HTTP headers (specified at an origin server) that a CDN server hides from the response. (see [below for nested schema](#nestedblock--options--response_headers_hiding_policy)) +- `rewrite` (Block List, Max: 1) Rewrite option changes and redirects the requests from the CDN to the origin. It operates according to the Nginx configuration. (see [below for nested schema](#nestedblock--options--rewrite)) +- `secure_key` (Block List, Max: 1) The option allows configuring an access with tokenized URLs. It makes impossible to access content without a valid (unexpired) hash key. When enabled, you need to specify a key that you use to generate a token. (see [below for nested schema](#nestedblock--options--secure_key)) +- `slice` (Block List, Max: 1) When enabled, files larger than 10 MB are requested and cached in parts (no larger than 10 MB each). It reduces time to first byte. The origin must support HTTP Range requests. (see [below for nested schema](#nestedblock--options--slice)) +- `sni` (Block List, Max: 1) Specify the SNI (Server Name Indication). SNI (Server Name Indication) is generally only required if your origin is using shared hosting or does not have a dedicated IP address. If the origin server presents multiple certificates, SNI allows the origin server to know which certificate to use for the connection. The option works only if originProtocol parameter is HTTPS or MATCH. (see [below for nested schema](#nestedblock--options--sni)) +- `stale` (Block List, Max: 1) The list of errors which Always Online option is applied for. (see [below for nested schema](#nestedblock--options--stale)) +- `static_headers` (Block List, Max: 1) Legacy option. Use the static_response_headers option instead. (see [below for nested schema](#nestedblock--options--static_headers)) +- `static_request_headers` (Block List, Max: 1) Specify custom HTTP Headers for a CDN server to add to request. (see [below for nested schema](#nestedblock--options--static_request_headers)) +- `static_response_headers` (Block List, Max: 1) Specify custom HTTP Headers that a CDN server adds to a response. (see [below for nested schema](#nestedblock--options--static_response_headers)) +- `tls_versions` (Block List, Max: 1) The option specifies a list of allowed SSL/TLS protocol versions. The list cannot be empty. By default, the option is disabled (all protocols versions are allowed). (see [below for nested schema](#nestedblock--options--tls_versions)) +- `use_default_le_chain` (Block List, Max: 1) The option allows choosing a Let's Encrypt certificate chain. The specified chain will be used during the next Let's Encrypt certificate issue or renewal. (see [below for nested schema](#nestedblock--options--use_default_le_chain)) +- `use_rsa_le_cert` (Block List, Max: 1) The option allows choosing the RSA Let's Encrypt certificate type for the resource. (see [below for nested schema](#nestedblock--options--use_rsa_le_cert)) +- `user_agent_acl` (Block List, Max: 1) User agents policy option allows to control access to the content for specified user-agent. (see [below for nested schema](#nestedblock--options--user_agent_acl)) +- `waf` (Block List, Max: 1) Option allows to enable Basic WAF to protect you against the most common threats. (see [below for nested schema](#nestedblock--options--waf)) +- `webp` (Block List, Max: 1) Legacy option. Use the image_stack option instead. (see [below for nested schema](#nestedblock--options--webp)) +- `websockets` (Block List, Max: 1) WebSockets option allows WebSockets connections to an origin server. (see [below for nested schema](#nestedblock--options--websockets)) + + + +### Nested Schema for `options.allowed_http_methods` + +Required: + +- `value` (Set of String) Available methods: GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS. + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.brotli_compression` + +Required: + +- `value` (Set of String) Specify the content-type for each type of content you wish to have compressed. + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.browser_cache_settings` + +Optional: + +- `enabled` (Boolean) +- `value` (String) Use '0s' to disable caching. The value applies for a response with codes 200, 201, 204, 206, 301, 302, 303, 304, 307, 308. + + + +### Nested Schema for `options.cache_http_headers` + +Required: + +- `value` (Set of String) List HTTP Headers that must be included in the response. + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.cors` + +Required: + +- `value` (Set of String) Specify a value of the Access-Control-Allow-Origin header. Possible values: '*', '$http_origin', 'example.com'. + +Optional: + +- `always` (Boolean) Specify if the Access-Control-Allow-Origin header should be added to a response from CDN regardless of response code. +- `enabled` (Boolean) + + + +### Nested Schema for `options.country_acl` + +Required: + +- `excepted_values` (Set of String) List of countries according to ISO-3166-1. +- `policy_type` (String) Possible values: allow, deny. + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.disable_cache` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.disable_proxy_force_ranges` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.edge_cache_settings` + +Optional: + +- `custom_values` (Map of String) Specify caching time in seconds ('0s', '600s' for example) for a response with specific response code ('304', '404' for example). Use 'any' to specify caching time for all response codes. Use '0s' to disable caching for a specific response code. These settings have a higher priority than the value field. +- `default` (String) Content will be cached according to origin cache settings. The value applies for a response with codes 200, 201, 204, 206, 301, 302, 303, 304, 307, 308, if an origin server does not have caching HTTP headers. Responses with other codes will not be cached. +- `enabled` (Boolean) +- `value` (String) Specify caching time for the response with codes 200, 206, 301, 302. Responses with codes 4xx, 5xx will not be cached. Use '0s' to disable caching. Use custom_values field to specify a custom caching time for a response with specific codes. + + + +### Nested Schema for `options.fetch_compressed` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.follow_origin_redirect` + +Required: + +- `codes` (Set of Number) Specify the redirect status code that the origin server returns. Possible values: 301, 302, 303, 307, 308. + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.force_return` + +Required: + +- `code` (Number) HTTP response status code. Available codes: 100 <= value <= 599. Reserved codes: 408, 444, 477, 494, 495, 496, 497, 499 + +Optional: + +- `body` (String) Response text or URL if you're going to set up redirection. Max length = 100. +- `enabled` (Boolean) + + + +### Nested Schema for `options.forward_host_header` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.gzip_on` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.host_header` + +Required: + +- `value` (String) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.http3_enabled` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.ignore_cookie` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.ignore_query_string` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.image_stack` + +Required: + +- `quality` (Number) Quality settings for JPG and PNG images. Specify a value from 1 to 100. The higher the value, the better the image quality and the larger the file size after conversion. + +Optional: + +- `avif_enabled` (Boolean) If enabled, JPG and PNG images automatically convert to AVIF format when supported by the end users browser. +- `enabled` (Boolean) +- `png_lossless` (Boolean) Represents compression without quality loss for PNG format. +- `webp_enabled` (Boolean) If enabled, JPG and PNG images automatically convert to WebP format when supported by the end users browser. + + + +### Nested Schema for `options.ip_address_acl` + +Required: + +- `excepted_values` (Set of String) Specify list of IP address with a subnet mask. +- `policy_type` (String) Possible values: allow, deny. + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.limit_bandwidth` + +Required: + +- `limit_type` (String) The way of controlling the download speed per each connection. Possible values are: static, dynamic. + +Optional: + +- `buffer` (Number) Amount of downloaded data after which the user will be rate limited. +- `enabled` (Boolean) +- `speed` (Number) Maximum download speed per connection. Must be greater than 0. + + + +### Nested Schema for `options.proxy_cache_methods_set` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.query_params_blacklist` + +Required: + +- `value` (Set of String) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.query_params_whitelist` + +Required: + +- `value` (Set of String) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.redirect_http_to_https` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.redirect_https_to_http` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.referrer_acl` + +Required: + +- `excepted_values` (Set of String) Specify list of domain names or wildcard domains (without http:// or https://). For example, example.com or *.example.com. +- `policy_type` (String) Possible values: allow, deny. + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.request_limiter` + +Required: + +- `burst` (Number) +- `rate` (Number) + +Optional: + +- `delay` (Number) +- `enabled` (Boolean) +- `rate_unit` (String) + + + +### Nested Schema for `options.response_headers_hiding_policy` + +Required: + +- `excepted` (Set of String) List of HTTP headers. The following required headers cannot be hidden from response: Connection, Content-Length, Content-Type, Date, Server. +- `mode` (String) Specify a mode of hiding HTTP headers from the response. Possible values are: hide, show. + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.rewrite` + +Required: + +- `body` (String) The pattern for Rewrite. At least one group should be specified. For Example: /rewrite_from/(.*) /rewrite_to/$1 + +Optional: + +- `enabled` (Boolean) +- `flag` (String) Define flag for the Rewrite option. Possible values: last, break, redirect, permanent. + + + +### Nested Schema for `options.secure_key` + +Required: + +- `key` (String) A key generated on your side that will be used for URL signing. +- `type` (Number) Specify the type of URL Signing. It can be either 0 or 2. Type 0 - includes end user's IP to secure token generation. Type 2 - excludes end user's IP from secure token generation. + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.slice` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.sni` + +Optional: + +- `custom_hostname` (String) Custom SNI hostname. Required if sni_type is set to 'custom'. +- `enabled` (Boolean) +- `sni_type` (String) Specify SNI type. Possible values: dynamic, custom. dynamic - SNI hostname depends on the hostHeader and the forward_host_header options. custom - custom SNI hostname. + + + +### Nested Schema for `options.stale` + +Required: + +- `value` (Set of String) Possible values: error, http_403, http_404, http_429, http_500, http_502, http_503, http_504, invalid_header, timeout, updating. + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.static_headers` + +Required: + +- `value` (Map of String) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.static_request_headers` + +Required: + +- `value` (Map of String) Header name is restricted to 255 symbols and can contain latin letters (A-Z, a-z), numbers (0-9), dashes, and underscores. Header value is restricted to 512 symbols and can contain latin letters (a-z), numbers (0-9), spaces, underscores and symbols (-/.:). Space can be used only between words. + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.static_response_headers` + +Required: + +- `value` (Block List, Min: 1) (see [below for nested schema](#nestedblock--options--static_response_headers--value)) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.static_response_headers.value` + +Required: + +- `name` (String) Header name. +- `value` (Set of String) Header value. + +Optional: + +- `always` (Boolean) Specifies if the header will be added to a response from CDN regardless of response code. + + + +### Nested Schema for `options.tls_versions` + +Required: + +- `value` (Set of String) Possible values (case sensitive): SSLv3, TLSv1, TLSv1.1, TLSv1.2, TLSv1.3. + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.use_default_le_chain` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.use_rsa_le_cert` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.user_agent_acl` + +Required: + +- `excepted_values` (Set of String) List of User-Agents. Use "" to allow/deny access when the User-Agent header is empty. +- `policy_type` (String) Possible values: allow, deny. + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.waf` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) + + + +### Nested Schema for `options.webp` + +Required: + +- `jpg_quality` (Number) +- `png_quality` (Number) + +Optional: + +- `enabled` (Boolean) +- `png_lossless` (Boolean) + + + +### Nested Schema for `options.websockets` + +Required: + +- `value` (Boolean) + +Optional: + +- `enabled` (Boolean) diff --git a/templates/resources/cdn_sslcert.md.tmpl b/templates/resources/cdn_sslcert.md.tmpl new file mode 100644 index 00000000..1f80cd5c --- /dev/null +++ b/templates/resources/cdn_sslcert.md.tmpl @@ -0,0 +1,36 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_cdn_sslcert Resource - terraform-provider-gcore" +subcategory: "" +description: |- + +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_cdn_sslcert (Resource) + +## Example Usage + +{{tffile "examples/resources/cdn_sslcert/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) Name of the SSL certificate. Must be unique. + +### Optional + +- `automated` (Boolean) The way SSL certificate was issued. +- `cert` (String, Sensitive) The public part of the SSL certificate. All chain of the SSL certificate should be added. +- `private_key` (String, Sensitive) The private key of the SSL certificate. + +### Read-Only + +- `has_related_resources` (Boolean) It shows if the SSL certificate is used by a CDN resource. +- `id` (String) The ID of this resource. diff --git a/templates/resources/ddos_protection.md.tmpl b/templates/resources/ddos_protection.md.tmpl new file mode 100644 index 00000000..e28506fd --- /dev/null +++ b/templates/resources/ddos_protection.md.tmpl @@ -0,0 +1,74 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_ddos_protection Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represents DDoS protection profile +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_ddos_protection (Resource) + +Represents DDoS protection profile + + + +## Schema + +### Required + +- `bm_instance_id` (String) +- `ip_address` (String) IP address +- `profile_template` (Number) Profile template ID + +### Optional + +- `active` (Boolean) Activate profile +- `bgp` (Boolean) Activate BGP protocol +- `fields` (Block List) (see [below for nested schema](#nestedblock--fields)) +- `last_updated` (String) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `id` (String) The ID of this resource. +- `protocols` (List of Object) List of protocols (see [below for nested schema](#nestedatt--protocols)) +- `site` (String) + + + +### Nested Schema for `fields` + +Required: + +- `base_field` (Number) + +Optional: + +- `field_value` (String) Complex value. Only one of 'value' or 'field_value' must be specified. +- `value` (String) Basic type value. Only one of 'value' or 'field_value' must be specified. + +Read-Only: + +- `default` (String) +- `description` (String) Field description +- `field_type` (String) +- `id` (Number) The ID of this resource. +- `name` (String) +- `required` (Boolean) +- `validation_schema` (String) Json schema to validate field_values + + + +### Nested Schema for `protocols` + +Read-Only: + +- `port` (String) +- `protocols` (List of String) diff --git a/templates/resources/dns_zone.md.tmpl b/templates/resources/dns_zone.md.tmpl new file mode 100644 index 00000000..539fcb82 --- /dev/null +++ b/templates/resources/dns_zone.md.tmpl @@ -0,0 +1,53 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_dns_zone Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent DNS zone resource. https://dns.gcore.com/zones +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_dns_zone (Resource) + +Represent DNS zone resource. https://dns.gcore.com/zones + +## Example Usage + +{{tffile "examples/resources/dns_zone/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) A name of DNS Zone resource. + +### Optional + +- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) + +### Read-Only + +- `id` (String) The ID of this resource. + + + +### Nested Schema for `timeouts` + +Optional: + +- `create` (String) +- `delete` (String) + +## Import + +Import is supported using the following syntax: + +```shell +# import using zone name format +terraform import gcore_dns_zone.example_zone example_zone.com +``` diff --git a/templates/resources/dns_zone_record.md.tmpl b/templates/resources/dns_zone_record.md.tmpl new file mode 100644 index 00000000..3af86f45 --- /dev/null +++ b/templates/resources/dns_zone_record.md.tmpl @@ -0,0 +1,133 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_dns_zone_record Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent DNS Zone Record resource. https://dns.gcore.com/zones +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_dns_zone_record (Resource) + +Represent DNS Zone Record resource. https://dns.gcore.com/zones + +## Example Usage + +{{tffile "examples/resources/dns_zone_record/example_1.tf"}} + + + +## Schema + +### Required + +- `domain` (String) A domain of DNS Zone Record resource. +- `resource_record` (Block Set, Min: 1) An array of contents with meta of DNS Zone Record resource. (see [below for nested schema](#nestedblock--resource_record)) +- `type` (String) A type of DNS Zone Record resource. +- `zone` (String) A zone of DNS Zone Record resource. + +### Optional + +- `filter` (Block List) (see [below for nested schema](#nestedblock--filter)) +- `meta` (Block Set) (see [below for nested schema](#nestedblock--meta)) +- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) +- `ttl` (Number) A ttl of DNS Zone Record resource. + +### Read-Only + +- `id` (String) The ID of this resource. + + + +### Nested Schema for `resource_record` + +Required: + +- `content` (String) A content of DNS Zone Record resource. (TXT: 'anyString', MX: '50 mail.company.io.', CAA: '0 issue "company.org; account=12345"') + +Optional: + +- `enabled` (Boolean) Manage of public appearing of DNS Zone Record resource. +- `meta` (Block Set, Max: 1) (see [below for nested schema](#nestedblock--resource_record--meta)) + + + +### Nested Schema for `resource_record.meta` + +Optional: + +- `asn` (List of Number) An asn meta (eg. 12345) of DNS Zone Record resource. +- `backup` (Boolean) Set as backup record +- `continents` (List of String) Continents meta (eg. Asia) of DNS Zone Record resource. +- `countries` (List of String) Countries meta (eg. USA) of DNS Zone Record resource. +- `default` (Boolean) Fallback meta equals true marks records which are used as a default answer (when nothing was selected by specified meta fields). +- `failover` (Map of String) Computed UUID of failover healtcheck property +- `fallback` (Boolean) Set as fallback record +- `ip` (List of String) An ip meta (eg. 127.0.0.0) of DNS Zone Record resource. +- `latlong` (List of Number) A latlong meta (eg. 27.988056, 86.925278) of DNS Zone Record resource. +- `notes` (String) A notes meta (eg. Miami DC) of DNS Zone Record resource. +- `weight` (Number) A weight for this record + + + +### Nested Schema for `filter` + +Required: + +- `type` (String) A DNS Zone Record filter option that describe a name of filter. + +Optional: + +- `limit` (Number) A DNS Zone Record filter option that describe how many records will be percolated. +- `strict` (Boolean) A DNS Zone Record filter option that describe possibility to return answers if no records were percolated through filter. + + + +### Nested Schema for `meta` + +Optional: + +- `geodns_link` (String) Geodns link (domain, or cl-) of DNS Zone RRSet resource. +- `healthchecks` (Block Set) Failover meta (eg. {"frequency": 60,"host": "www.gcore.com","http_status_code": null,"method": "GET","port": 80,"protocol": "HTTP","regexp": "","timeout": 10,"tls": false,"url": "/"}). (see [below for nested schema](#nestedblock--meta--healthchecks)) + + + +### Nested Schema for `meta.healthchecks` + +Required: + +- `frequency` (Number) Frequency in seconds (10-3600). +- `protocol` (String) Protocol, possible value: HTTP, TCP, UDP, ICMP. +- `timeout` (Number) Timeout in seconds (1-10). + +Optional: + +- `command` (String) Command to send if protocol=TCP/UDP, maximum length: 255. +- `host` (String) Request host/virtualhost to send if protocol=HTTP, must be empty for non-HTTP +- `http_status_code` (Number) Expected status code if protocol=HTTP, must be empty for non-HTTP. +- `method` (String) HTTP Method required if protocol=HTTP, must be empty for non-HTTP. +- `port` (Number) Port to check (1-65535). +- `regexp` (String) HTTP body or response payload to check if protocol<>ICMP, must be empty for ICMP. +- `tls` (Boolean) TLS/HTTPS enabled if protocol=HTTP, must be empty for non-HTTP. +- `url` (String) URL path to check required if protocol=HTTP, must be empty for non-HTTP. + + + +### Nested Schema for `timeouts` + +Optional: + +- `create` (String) +- `delete` (String) + +## Import + +Import is supported using the following syntax: + +```shell +# import using zone:domain:type format +terraform import gcore_dns_zone_record.example_rrset0 example.com:domain.example.com:A +``` diff --git a/templates/resources/faas_function.md.tmpl b/templates/resources/faas_function.md.tmpl new file mode 100644 index 00000000..52125496 --- /dev/null +++ b/templates/resources/faas_function.md.tmpl @@ -0,0 +1,67 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_faas_function Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent FaaS function +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_faas_function (Resource) + +Represent FaaS function + +## Example Usage + +{{tffile "examples/resources/faas_function/example_1.tf"}} + + + +## Schema + +### Required + +- `code_text` (String) +- `flavor` (String) +- `main_method` (String) Main startup method name +- `max_instances` (Number) Autoscaling max number of instances +- `min_instances` (Number) Autoscaling min number of instances +- `name` (String) +- `namespace` (String) Namespace of the function +- `runtime` (String) +- `timeout` (Number) + +### Optional + +- `dependencies` (String) Function dependencies to install +- `description` (String) +- `disabled` (Boolean) Set to true if function is disabled +- `enable_api_key` (Boolean) Enable/Disable api key authorization +- `envs` (Map of String) +- `keys` (List of String) List of used api keys +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `build_message` (String) +- `build_status` (String) +- `created_at` (String) +- `deploy_status` (Map of Number) +- `endpoint` (String) +- `id` (String) The ID of this resource. +- `status` (String) + +## Import + +Import is supported using the following syntax: + +```shell +# import using :: format +terraform import gcore_faas_function.test 1:6:ns:test_func +``` diff --git a/templates/resources/faas_key.md.tmpl b/templates/resources/faas_key.md.tmpl new file mode 100644 index 00000000..ad44ba1f --- /dev/null +++ b/templates/resources/faas_key.md.tmpl @@ -0,0 +1,62 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_faas_key Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represents FaaS API key +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_faas_key (Resource) + +Represents FaaS API key + +## Example Usage + +{{tffile "examples/resources/faas_key/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) + +### Optional + +- `description` (String) +- `expire` (String) +- `functions` (Block List) (see [below for nested schema](#nestedblock--functions)) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `created_at` (String) +- `id` (String) The ID of this resource. +- `secret` (String, Sensitive) API key secret +- `status` (String) + + + +### Nested Schema for `functions` + +Required: + +- `name` (String) +- `namespace` (String) + +## Import + +Import is supported using the following syntax: + +```shell +# import using :: format +terraform import gcore_faas_key.test 1:6:test_key +``` diff --git a/templates/resources/faas_namespace.md.tmpl b/templates/resources/faas_namespace.md.tmpl new file mode 100644 index 00000000..3971e286 --- /dev/null +++ b/templates/resources/faas_namespace.md.tmpl @@ -0,0 +1,51 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_faas_namespace Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represents FaaS namespace +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_faas_namespace (Resource) + +Represents FaaS namespace + +## Example Usage + +{{tffile "examples/resources/faas_namespace/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) + +### Optional + +- `description` (String) +- `envs` (Map of String) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `created_at` (String) +- `id` (String) The ID of this resource. +- `status` (String) + +## Import + +Import is supported using the following syntax: + +```shell +# import using :: format +terraform import gcore_faas_namespace.test 1:6:ns +``` diff --git a/templates/resources/floatingip.md.tmpl b/templates/resources/floatingip.md.tmpl new file mode 100644 index 00000000..4f9fa61b --- /dev/null +++ b/templates/resources/floatingip.md.tmpl @@ -0,0 +1,63 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_floatingip Resource - terraform-provider-gcore" +subcategory: "" +description: |- + A floating IP is a static IP address that points to one of your Instances. It allows you to redirect network traffic to any of your Instances in the same datacenter. +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_floatingip (Resource) + +A floating IP is a static IP address that points to one of your Instances. It allows you to redirect network traffic to any of your Instances in the same datacenter. + +## Example Usage + +{{tffile "examples/resources/floatingip/example_1.tf"}} + + + +## Schema + +### Optional + +- `fixed_ip_address` (String) +- `last_updated` (String) +- `metadata_map` (Map of String) +- `port_id` (String) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `created_at` (String) +- `floating_ip_address` (String) +- `id` (String) The ID of this resource. +- `metadata_read_only` (List of Object) (see [below for nested schema](#nestedatt--metadata_read_only)) +- `router_id` (String) +- `status` (String) +- `updated_at` (String) + + + +### Nested Schema for `metadata_read_only` + +Read-Only: + +- `key` (String) +- `read_only` (Boolean) +- `value` (String) + +## Import + +Import is supported using the following syntax: + +```shell +# import using :: format +terraform import gcore_floatingip.fip1 1:6:447d2959-8ae0-4ca0-8d47-9f050a3637d7 +``` diff --git a/templates/resources/instance.md.tmpl b/templates/resources/instance.md.tmpl new file mode 100644 index 00000000..6742e926 --- /dev/null +++ b/templates/resources/instance.md.tmpl @@ -0,0 +1,151 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_instance Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent instance +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_instance (Resource) + +Represent instance + +## Example Usage + +{{tffile "examples/resources/instance/example_1.tf"}} + + + +## Schema + +### Required + +- `flavor_id` (String) +- `interface` (Block List, Min: 1) (see [below for nested schema](#nestedblock--interface)) + +### Optional + +- `addresses` (Block List) (see [below for nested schema](#nestedblock--addresses)) +- `allow_app_ports` (Boolean) +- `configuration` (Block List) (see [below for nested schema](#nestedblock--configuration)) +- `flavor` (Map of String) +- `keypair_name` (String) +- `last_updated` (String) +- `metadata` (Block List, Deprecated) (see [below for nested schema](#nestedblock--metadata)) +- `metadata_map` (Map of String) +- `name` (String) +- `name_template` (String) +- `name_templates` (List of String, Deprecated) +- `password` (String) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) +- `server_group` (String) +- `status` (String) +- `user_data` (String) +- `userdata` (String, Deprecated) **Deprecated** +- `username` (String) +- `vm_state` (String) Current vm state, use stopped to stop vm and active to start +- `volume` (Block Set) (see [below for nested schema](#nestedblock--volume)) + +### Read-Only + +- `id` (String) The ID of this resource. +- `security_group` (List of Object) Firewalls list (see [below for nested schema](#nestedatt--security_group)) + + + +### Nested Schema for `interface` + +Optional: + +- `existing_fip_id` (String) +- `fip_source` (String) +- `ip_address` (String) +- `network_id` (String) required if type is 'subnet' or 'any_subnet' +- `order` (Number) Order of attaching interface +- `port_id` (String) required if type is 'reserved_fixed_ip' +- `security_groups` (List of String) list of security group IDs +- `subnet_id` (String) required if type is 'subnet' +- `type` (String) Available value is 'subnet', 'any_subnet', 'external', 'reserved_fixed_ip' + + + +### Nested Schema for `addresses` + +Required: + +- `net` (Block List, Min: 1) (see [below for nested schema](#nestedblock--addresses--net)) + + + +### Nested Schema for `addresses.net` + +Required: + +- `addr` (String) +- `type` (String) + + + +### Nested Schema for `configuration` + +Required: + +- `key` (String) +- `value` (String) + + + +### Nested Schema for `metadata` + +Required: + +- `key` (String) +- `value` (String) + + + +### Nested Schema for `volume` + +Required: + +- `source` (String) Currently available only 'existing-volume' value + +Optional: + +- `attachment_tag` (String) +- `boot_index` (Number) If boot_index==0 volumes can not detached +- `delete_on_termination` (Boolean) +- `image_id` (String) +- `name` (String) +- `size` (Number) +- `type_name` (String) +- `volume_id` (String) + +Read-Only: + +- `id` (String) The ID of this resource. + + + +### Nested Schema for `security_group` + +Read-Only: + +- `id` (String) +- `name` (String) + +## Import + +Import is supported using the following syntax: + +```shell +# import using :: format +terraform import gcore_instance.instance1 1:6:447d2959-8ae0-4ca0-8d47-9f050a3637d7 +``` diff --git a/templates/resources/k8sv2.md.tmpl b/templates/resources/k8sv2.md.tmpl new file mode 100644 index 00000000..95c1a641 --- /dev/null +++ b/templates/resources/k8sv2.md.tmpl @@ -0,0 +1,105 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_k8sv2 Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent k8s cluster with one default pool. +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_k8sv2 (Resource) + +Represent k8s cluster with one default pool. + +## Example Usage + +{{tffile "examples/resources/k8sv2/example_1.tf"}} + + + +## Schema + +### Required + +- `keypair` (String) Name of the keypair used for SSH access to nodes. +- `name` (String) Cluster name. +- `pool` (Block List, Min: 1) (see [below for nested schema](#nestedblock--pool)) +- `version` (String) Kubernetes version. + +### Optional + +- `cni` (Block List, Max: 1) (see [below for nested schema](#nestedblock--cni)) +- `fixed_network` (String) Fixed network used to allocate network addresses for cluster nodes. +- `fixed_subnet` (String) Fixed subnet used to allocate network addresses for cluster nodes. Subnet should have a router. +- `is_ipv6` (Boolean) Enable public IPv6 address. +- `pods_ip_pool` (String) Pods IPv4 IP pool in CIDR notation. +- `pods_ipv6_pool` (String) Pods IPv6 IP pool in CIDR notation. +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) +- `services_ip_pool` (String) Services IPv4 IP pool in CIDR notation. +- `services_ipv6_pool` (String) Services IPv6 IP pool in CIDR notation. +- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) + +### Read-Only + +- `created_at` (String) Cluster creation date. +- `creator_task_id` (String) +- `id` (String) The ID of this resource. +- `is_public` (Boolean) True if the cluster is public. +- `status` (String) Cluster status. +- `task_id` (String) + + + +### Nested Schema for `pool` + +Required: + +- `flavor_id` (String) Cluster pool node flavor ID. Changing the value of this attribute will trigger recreation of the cluster pool. +- `min_node_count` (Number) Minimum number of nodes in the cluster pool. +- `name` (String) Cluster pool name. Changing the value of this attribute will trigger recreation of the cluster pool. + +Optional: + +- `auto_healing_enabled` (Boolean) Enable/disable auto healing of cluster pool nodes. +- `boot_volume_size` (Number) Cluster pool boot volume size. Must be set only for VM pools. Changing the value of this attribute will trigger recreation of the cluster pool. +- `boot_volume_type` (String) Cluster pool boot volume type. Must be set only for VM pools. Available values are 'standard', 'ssd_hiiops', 'cold', 'ultra'. Changing the value of this attribute will trigger recreation of the cluster pool. +- `is_public_ipv4` (Boolean) Assign public IPv4 address to nodes in this pool. Changing the value of this attribute will trigger recreation of the cluster pool. +- `max_node_count` (Number) Maximum number of nodes in the cluster pool. + +Read-Only: + +- `created_at` (String) Cluster pool creation date. +- `node_count` (Number) Current node count in the cluster pool. +- `status` (String) Cluster pool status. + + + +### Nested Schema for `cni` + +Required: + +- `provider` (String) + + + +### Nested Schema for `timeouts` + +Optional: + +- `create` (String) +- `update` (String) + +## Import + +Import is supported using the following syntax: + +```shell +# import using :: format +terraform import gcore_k8sv2.cluster1 1:6:cluster1 +``` diff --git a/templates/resources/keypair.md.tmpl b/templates/resources/keypair.md.tmpl new file mode 100644 index 00000000..593bd09e --- /dev/null +++ b/templates/resources/keypair.md.tmpl @@ -0,0 +1,39 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_keypair Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent a ssh key, do not depends on region +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_keypair (Resource) + +Represent a ssh key, do not depends on region + +## Example Usage + +{{tffile "examples/resources/keypair/example_1.tf"}} + + + +## Schema + +### Required + +- `public_key` (String) +- `sshkey_name` (String) + +### Optional + +- `project_id` (Number) +- `project_name` (String) + +### Read-Only + +- `fingerprint` (String) +- `id` (String) The ID of this resource. +- `sshkey_id` (String) diff --git a/templates/resources/laas_topic.md.tmpl b/templates/resources/laas_topic.md.tmpl new file mode 100644 index 00000000..d069c2de --- /dev/null +++ b/templates/resources/laas_topic.md.tmpl @@ -0,0 +1,47 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_laas_topic Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent LaaS topic +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_laas_topic (Resource) + +Represent LaaS topic + +## Example Usage + +{{tffile "examples/resources/laas_topic/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) + +### Optional + +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `id` (String) The ID of this resource. + +## Import + +Import is supported using the following syntax: + +```shell +# import using :: format +terraform import gcore_laas_topic.test 1:6:test_topic +``` diff --git a/templates/resources/lblistener.md.tmpl b/templates/resources/lblistener.md.tmpl new file mode 100644 index 00000000..fa76cf79 --- /dev/null +++ b/templates/resources/lblistener.md.tmpl @@ -0,0 +1,71 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_lblistener Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent load balancer listener. Can not be created without load balancer. A listener is a process that checks for connection requests, using the protocol and port that you configure +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_lblistener (Resource) + +Represent load balancer listener. Can not be created without load balancer. A listener is a process that checks for connection requests, using the protocol and port that you configure + +## Example Usage + +{{tffile "examples/resources/lblistener/example_1.tf"}} + + + +## Schema + +### Required + +- `loadbalancer_id` (String) +- `name` (String) +- `protocol` (String) Available values are 'HTTP', 'HTTPS', 'TCP', 'UDP', 'TERMINATED_HTTPS', 'PROMETHEUS' +- `protocol_port` (Number) + +### Optional + +- `connection_limit` (Number) +- `insert_x_forwarded` (Boolean) Insert *-forwarded headers +- `last_updated` (String) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) +- `secret_id` (String) +- `sni_secret_id` (List of String) +- `timeout_client_data` (Number) +- `timeout_member_connect` (Number) +- `timeout_member_data` (Number) +- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) + +### Read-Only + +- `id` (String) The ID of this resource. +- `operating_status` (String) +- `pool_count` (Number) +- `provisioning_status` (String) + + + +### Nested Schema for `timeouts` + +Optional: + +- `create` (String) +- `delete` (String) + +## Import + +Import is supported using the following syntax: + +```shell +# import using ::: format +terraform import gcore_lblistener.lblistener1 1:6:a775dd94-4e9c-4da7-9f0e-ffc9ae34446b:447d2959-8ae0-4ca0-8d47-9f050a3637d7 +``` diff --git a/templates/resources/lbmember.md.tmpl b/templates/resources/lbmember.md.tmpl new file mode 100644 index 00000000..32c788fa --- /dev/null +++ b/templates/resources/lbmember.md.tmpl @@ -0,0 +1,64 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_lbmember Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent load balancer member +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_lbmember (Resource) + +Represent load balancer member + +## Example Usage + +{{tffile "examples/resources/lbmember/example_1.tf"}} + + + +## Schema + +### Required + +- `address` (String) +- `pool_id` (String) +- `protocol_port` (Number) + +### Optional + +- `instance_id` (String) +- `last_updated` (String) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) +- `subnet_id` (String) +- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) +- `weight` (Number) Value between 0 and 256 + +### Read-Only + +- `id` (String) The ID of this resource. +- `operating_status` (String) + + + +### Nested Schema for `timeouts` + +Optional: + +- `create` (String) +- `delete` (String) + +## Import + +Import is supported using the following syntax: + +```shell +# import using ::: format +terraform import gcore_lbmember.lbmember1 1:6:a775dd94-4e9c-4da7-9f0e-ffc9ae34446b:447d2959-8ae0-4ca0-8d47-9f050a3637d7 +``` diff --git a/templates/resources/lbpool.md.tmpl b/templates/resources/lbpool.md.tmpl new file mode 100644 index 00000000..2236ac67 --- /dev/null +++ b/templates/resources/lbpool.md.tmpl @@ -0,0 +1,100 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_lbpool Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent load balancer listener pool. A pool is a list of virtual machines to which the listener will redirect incoming traffic +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_lbpool (Resource) + +Represent load balancer listener pool. A pool is a list of virtual machines to which the listener will redirect incoming traffic + +## Example Usage + +{{tffile "examples/resources/lbpool/example_1.tf"}} + + + +## Schema + +### Required + +- `lb_algorithm` (String) Available values is 'ROUND_ROBIN', 'LEAST_CONNECTIONS', 'SOURCE_IP', 'SOURCE_IP_PORT' +- `name` (String) +- `protocol` (String) Available values are 'HTTP' (currently work, other do not work on ed-8), 'HTTPS', 'TCP', 'UDP', 'PROXY' + +### Optional + +- `health_monitor` (Block List, Max: 1) (see [below for nested schema](#nestedblock--health_monitor)) +- `last_updated` (String) +- `listener_id` (String) +- `loadbalancer_id` (String) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) +- `session_persistence` (Block List, Max: 1) (see [below for nested schema](#nestedblock--session_persistence)) +- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) + +### Read-Only + +- `id` (String) The ID of this resource. + + + +### Nested Schema for `health_monitor` + +Required: + +- `delay` (Number) +- `max_retries` (Number) +- `timeout` (Number) +- `type` (String) Available values is 'HTTP', 'HTTPS', 'PING', 'TCP', 'TLS-HELLO', 'UDP-CONNECT + +Optional: + +- `expected_codes` (String) +- `http_method` (String) +- `max_retries_down` (Number) +- `url_path` (String) + +Read-Only: + +- `id` (String) The ID of this resource. + + + +### Nested Schema for `session_persistence` + +Required: + +- `type` (String) + +Optional: + +- `cookie_name` (String) +- `persistence_granularity` (String) +- `persistence_timeout` (Number) + + + +### Nested Schema for `timeouts` + +Optional: + +- `create` (String) +- `delete` (String) + +## Import + +Import is supported using the following syntax: + +```shell +# import using :: format +terraform import gcore_lbpool.lbpool1 1:6:447d2959-8ae0-4ca0-8d47-9f050a3637d7 +``` diff --git a/templates/resources/lifecyclepolicy.md.tmpl b/templates/resources/lifecyclepolicy.md.tmpl new file mode 100644 index 00000000..86ad895b --- /dev/null +++ b/templates/resources/lifecyclepolicy.md.tmpl @@ -0,0 +1,117 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_lifecyclepolicy Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent lifecycle policy. Use to periodically take snapshots +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_lifecyclepolicy (Resource) + +Represent lifecycle policy. Use to periodically take snapshots + +## Example Usage + +{{tffile "examples/resources/lifecyclepolicy/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) + +### Optional + +- `action` (String) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) +- `schedule` (Block List) (see [below for nested schema](#nestedblock--schedule)) +- `status` (String) +- `volume` (Block Set) List of managed volumes (see [below for nested schema](#nestedblock--volume)) + +### Read-Only + +- `id` (String) The ID of this resource. +- `user_id` (Number) + + + +### Nested Schema for `schedule` + +Required: + +- `max_quantity` (Number) Maximum number of stored resources + +Optional: + +- `cron` (Block List, Max: 1) Use for taking actions at specified moments of time. Exactly one of interval and cron blocks should be provided (see [below for nested schema](#nestedblock--schedule--cron)) +- `interval` (Block List, Max: 1) Use for taking actions with equal time intervals between them. Exactly one of interval and cron blocks should be provided (see [below for nested schema](#nestedblock--schedule--interval)) +- `resource_name_template` (String) Used to name snapshots. {volume_id} is substituted with volume.id on creation +- `retention_time` (Block List, Max: 1) If it is set, new resource will be deleted after time (see [below for nested schema](#nestedblock--schedule--retention_time)) + +Read-Only: + +- `id` (String) The ID of this resource. +- `type` (String) + + + +### Nested Schema for `schedule.cron` + +Optional: + +- `day` (String) Either single asterisk or comma-separated list of integers (1-31) +- `day_of_week` (String) Either single asterisk or comma-separated list of integers (0-6) +- `hour` (String) Either single asterisk or comma-separated list of integers (0-23) +- `minute` (String) Either single asterisk or comma-separated list of integers (0-59) +- `month` (String) Either single asterisk or comma-separated list of integers (1-12) +- `timezone` (String) +- `week` (String) Either single asterisk or comma-separated list of integers (1-53) + + + +### Nested Schema for `schedule.interval` + +Optional: + +- `days` (Number) Number of days to wait between actions +- `hours` (Number) Number of hours to wait between actions +- `minutes` (Number) Number of minutes to wait between actions +- `weeks` (Number) Number of weeks to wait between actions + + + +### Nested Schema for `schedule.retention_time` + +Optional: + +- `days` (Number) Number of days to wait before deleting snapshot +- `hours` (Number) Number of hours to wait before deleting snapshot +- `minutes` (Number) Number of minutes to wait before deleting snapshot +- `weeks` (Number) Number of weeks to wait before deleting snapshot + + + +### Nested Schema for `volume` + +Read-Only: + +- `id` (String) The ID of this resource. +- `name` (String) + +## Import + +Import is supported using the following syntax: + +```shell +# import using :: format +terraform import gcore_lifecyclepolicy.lifecyclepolicy1 1:6:447d2959-8ae0-4ca0-8d47-9f050a3637d7 +``` diff --git a/templates/resources/loadbalancer.md.tmpl b/templates/resources/loadbalancer.md.tmpl new file mode 100644 index 00000000..28074925 --- /dev/null +++ b/templates/resources/loadbalancer.md.tmpl @@ -0,0 +1,98 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_loadbalancer Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent load balancer +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_loadbalancer (Resource) + +Represent load balancer + +## Example Usage + +{{tffile "examples/resources/loadbalancer/example_1.tf"}} + + + +## Schema + +### Required + +- `listener` (Block List, Min: 1, Max: 1) (see [below for nested schema](#nestedblock--listener)) +- `name` (String) + +### Optional + +- `flavor` (String) +- `last_updated` (String) +- `metadata_map` (Map of String) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) +- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) +- `vip_network_id` (String) +- `vip_subnet_id` (String) + +### Read-Only + +- `id` (String) The ID of this resource. +- `metadata_read_only` (List of Object) (see [below for nested schema](#nestedatt--metadata_read_only)) +- `vip_address` (String) Load balancer IP address + + + +### Nested Schema for `listener` + +Required: + +- `name` (String) +- `protocol` (String) Available values is 'HTTP' (currently work, other do not work on ed-8), 'HTTPS', 'TCP', 'UDP' +- `protocol_port` (Number) + +Optional: + +- `certificate` (String) +- `certificate_chain` (String) +- `insert_x_forwarded` (Boolean) +- `private_key` (String) +- `secret_id` (String) +- `sni_secret_id` (List of String) + +Read-Only: + +- `id` (String) The ID of this resource. + + + +### Nested Schema for `timeouts` + +Optional: + +- `create` (String) +- `delete` (String) + + + +### Nested Schema for `metadata_read_only` + +Read-Only: + +- `key` (String) +- `read_only` (Boolean) +- `value` (String) + +## Import + +Import is supported using the following syntax: + +```shell +# import using ::: format, listener_id - nested listener id +terraform import gcore_loadbalancer.loadbalancer1 1:6:447d2959-8ae0-4ca0-8d47-9f050a3637d7:a336f28c-fbb0-4256-9545-e905bed9f48f +``` diff --git a/templates/resources/loadbalancerv2.md.tmpl b/templates/resources/loadbalancerv2.md.tmpl new file mode 100644 index 00000000..e72837fa --- /dev/null +++ b/templates/resources/loadbalancerv2.md.tmpl @@ -0,0 +1,86 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_loadbalancerv2 Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent load balancer without nested listener +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_loadbalancerv2 (Resource) + +Represent load balancer without nested listener + +## Example Usage + +#### Prerequisite + +{{tffile "examples/resources/gcore_loadbalancerv2/main.tf"}} + +### Creating Private Load Balancer + +{{tffile "examples/resources/gcore_loadbalancerv2/public-lb.tf"}} + +### Creating Public Load Balancer + +{{tffile "examples/resources/gcore_loadbalancerv2/private-lb.tf"}} + + + +## Schema + +### Required + +- `name` (String) + +### Optional + +- `flavor` (String) +- `last_updated` (String) +- `metadata_map` (Map of String) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) +- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) +- `vip_ip_family` (String) Available values are 'ipv4', 'ipv6', 'dual' +- `vip_network_id` (String) Note: add all created `gcore_subnet` resources within the network with this id to the `depends_on` to be sure that `gcore_loadbalancerv2` will be destroyed first +- `vip_subnet_id` (String) + +### Read-Only + +- `id` (String) The ID of this resource. +- `metadata_read_only` (List of Object) (see [below for nested schema](#nestedatt--metadata_read_only)) +- `vip_address` (String) Load balancer IP address +- `vip_port_id` (String) Load balancer Port ID + + + +### Nested Schema for `timeouts` + +Optional: + +- `create` (String) +- `delete` (String) + + + +### Nested Schema for `metadata_read_only` + +Read-Only: + +- `key` (String) +- `read_only` (Boolean) +- `value` (String) + +## Import + +Import is supported using the following syntax: + +```shell +# import using :: format +terraform import gcore_loadbalancer.loadbalancer1 1:6:447d2959-8ae0-4ca0-8d47-9f050a3637d7 +``` diff --git a/templates/resources/network.md.tmpl b/templates/resources/network.md.tmpl new file mode 100644 index 00000000..72d14292 --- /dev/null +++ b/templates/resources/network.md.tmpl @@ -0,0 +1,63 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_network Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent network. A network is a software-defined network in a cloud computing infrastructure +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_network (Resource) + +Represent network. A network is a software-defined network in a cloud computing infrastructure + +## Example Usage + +{{tffile "examples/resources/network/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) + +### Optional + +- `create_router` (Boolean) Create external router to the network, default true +- `last_updated` (String) +- `metadata_map` (Map of String) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) +- `type` (String) 'vlan' or 'vxlan' network type is allowed. Default value is 'vxlan' + +### Read-Only + +- `id` (String) The ID of this resource. +- `metadata_read_only` (List of Object) (see [below for nested schema](#nestedatt--metadata_read_only)) +- `mtu` (Number) + + + +### Nested Schema for `metadata_read_only` + +Read-Only: + +- `key` (String) +- `read_only` (Boolean) +- `value` (String) + +## Import + +Import is supported using the following syntax: + +```shell +# import using :: format +terraform import gcore_network.metwork1 1:6:447d2959-8ae0-4ca0-8d47-9f050a3637d7 +``` diff --git a/templates/resources/reservedfixedip.md.tmpl b/templates/resources/reservedfixedip.md.tmpl new file mode 100644 index 00000000..ae920bec --- /dev/null +++ b/templates/resources/reservedfixedip.md.tmpl @@ -0,0 +1,64 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_reservedfixedip Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent reserved ips +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_reservedfixedip (Resource) + +Represent reserved ips + +## Example Usage + +{{tffile "examples/resources/reservedfixedip/example_1.tf"}} + + + +## Schema + +### Required + +- `is_vip` (Boolean) +- `type` (String) Available values is 'external', 'subnet', 'any_subnet', 'ip_address' + +### Optional + +- `allowed_address_pairs` (Block List) Group of IP addresses that share the current IP as VIP (see [below for nested schema](#nestedblock--allowed_address_pairs)) +- `fixed_ip_address` (String) +- `last_updated` (String) +- `network_id` (String) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) +- `subnet_id` (String) + +### Read-Only + +- `id` (String) The ID of this resource. +- `port_id` (String) ID of the port_id underlying the reserved fixed IP +- `status` (String) + + + +### Nested Schema for `allowed_address_pairs` + +Optional: + +- `ip_address` (String) +- `mac_address` (String) + +## Import + +Import is supported using the following syntax: + +```shell +# import using :: format +terraform import gcore_reservedfixedip.reservedfixedip1 1:6:447d2959-8ae0-4ca0-8d47-9f050a3637d7 +``` diff --git a/templates/resources/router.md.tmpl b/templates/resources/router.md.tmpl new file mode 100644 index 00000000..09c0ac2e --- /dev/null +++ b/templates/resources/router.md.tmpl @@ -0,0 +1,99 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_router Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent router. Router enables you to dynamically exchange routes between networks +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_router (Resource) + +Represent router. Router enables you to dynamically exchange routes between networks + +## Example Usage + +{{tffile "examples/resources/router/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) + +### Optional + +- `external_gateway_info` (Block List, Max: 1) (see [below for nested schema](#nestedblock--external_gateway_info)) +- `interfaces` (Block Set) (see [below for nested schema](#nestedblock--interfaces)) +- `last_updated` (String) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) +- `routes` (Block List) (see [below for nested schema](#nestedblock--routes)) + +### Read-Only + +- `id` (String) The ID of this resource. + + + +### Nested Schema for `external_gateway_info` + +Optional: + +- `enable_snat` (Boolean) +- `network_id` (String) Id of the external network +- `type` (String) Must be 'manual' or 'default' + +Read-Only: + +- `external_fixed_ips` (List of Object) (see [below for nested schema](#nestedatt--external_gateway_info--external_fixed_ips)) + + + +### Nested Schema for `external_gateway_info.external_fixed_ips` + +Read-Only: + +- `ip_address` (String) +- `subnet_id` (String) + + + +### Nested Schema for `interfaces` + +Required: + +- `subnet_id` (String) Subnet for router interface must have a gateway IP +- `type` (String) must be 'subnet' + +Read-Only: + +- `ip_address` (String) +- `mac_address` (String) +- `network_id` (String) +- `port_id` (String) + + + +### Nested Schema for `routes` + +Required: + +- `destination` (String) +- `nexthop` (String) IPv4 address to forward traffic to if it's destination IP matches 'destination' CIDR + +## Import + +Import is supported using the following syntax: + +```shell +# import using :: format +terraform import gcore_router.router1 1:6:447d2959-8ae0-4ca0-8d47-9f050a3637d7 +``` diff --git a/templates/resources/secret.md.tmpl b/templates/resources/secret.md.tmpl new file mode 100644 index 00000000..2db3ecd2 --- /dev/null +++ b/templates/resources/secret.md.tmpl @@ -0,0 +1,57 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_secret Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent secret +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_secret (Resource) + +Represent secret + +## Example Usage + +{{tffile "examples/resources/secret/example_1.tf"}} + + + +## Schema + +### Required + +- `certificate` (String) SSL certificate in PEM format +- `certificate_chain` (String) SSL certificate chain of intermediates and root certificates in PEM format +- `name` (String) +- `private_key` (String) SSL private key in PEM format + +### Optional + +- `expiration` (String) Datetime when the secret will expire. The format is 2025-12-28T19:14:44 +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `algorithm` (String) +- `bit_length` (Number) +- `content_types` (Map of String) +- `created` (String) Datetime when the secret was created. The format is 2025-12-28T19:14:44.180394 +- `id` (String) The ID of this resource. +- `mode` (String) +- `status` (String) + +## Import + +Import is supported using the following syntax: + +```shell +# import using :: format +terraform import gcore_secret.secret_id 1:6:447d2959-8ae0-4ca0-8d47-9f050a3637d7 +``` diff --git a/templates/resources/securitygroup.md.tmpl b/templates/resources/securitygroup.md.tmpl new file mode 100644 index 00000000..c67d9709 --- /dev/null +++ b/templates/resources/securitygroup.md.tmpl @@ -0,0 +1,85 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_securitygroup Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent SecurityGroups(Firewall) +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_securitygroup (Resource) + +Represent SecurityGroups(Firewall) + +## Example Usage + +{{tffile "examples/resources/securitygroup/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) +- `security_group_rules` (Block Set, Min: 1) Firewall rules control what inbound(ingress) and outbound(egress) traffic is allowed to enter or leave a Instance. At least one 'egress' rule should be set (see [below for nested schema](#nestedblock--security_group_rules)) + +### Optional + +- `description` (String) +- `last_updated` (String) +- `metadata_map` (Map of String) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `id` (String) The ID of this resource. +- `metadata_read_only` (List of Object) (see [below for nested schema](#nestedatt--metadata_read_only)) + + + +### Nested Schema for `security_group_rules` + +Required: + +- `direction` (String) Available value is 'ingress', 'egress' +- `ethertype` (String) Available value is 'IPv4', 'IPv6' +- `protocol` (String) Available value is udp,tcp,any,ipv6-icmp,ipv6-route,ipv6-opts,ipv6-nonxt,ipv6-frag,ipv6-encap,icmp,ah,dccp,egp,esp,gre,igmp,ospf,pgm,rsvp,sctp,udplite,vrrp,51,50,112,0,4,ipip,ipencap + +Optional: + +- `description` (String) +- `port_range_max` (Number) +- `port_range_min` (Number) +- `remote_ip_prefix` (String) + +Read-Only: + +- `created_at` (String) +- `id` (String) The ID of this resource. +- `updated_at` (String) + + + +### Nested Schema for `metadata_read_only` + +Read-Only: + +- `key` (String) +- `read_only` (Boolean) +- `value` (String) + +## Import + +Import is supported using the following syntax: + +```shell +# import using :: format +terraform import gcore_securitygroup.securitygroup1 1:6:447d2959-8ae0-4ca0-8d47-9f050a3637d7 +``` diff --git a/templates/resources/servergroup.md.tmpl b/templates/resources/servergroup.md.tmpl new file mode 100644 index 00000000..0a583b8a --- /dev/null +++ b/templates/resources/servergroup.md.tmpl @@ -0,0 +1,58 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_servergroup Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent server group resource +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_servergroup (Resource) + +Represent server group resource + +## Example Usage + +{{tffile "examples/resources/servergroup/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) Displayed server group name +- `policy` (String) Server group policy. Available value is 'affinity', 'anti-affinity' + +### Optional + +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `id` (String) The ID of this resource. +- `instances` (List of Object) Instances in this server group (see [below for nested schema](#nestedatt--instances)) + + + +### Nested Schema for `instances` + +Read-Only: + +- `instance_id` (String) +- `instance_name` (String) + +## Import + +Import is supported using the following syntax: + +```shell +# import using :: format +terraform import gcore_servergroup.servergroup1 1:6:447d2959-8ae0-4ca0-8d47-9f050a3637d7 +``` diff --git a/templates/resources/snapshot.md.tmpl b/templates/resources/snapshot.md.tmpl new file mode 100644 index 00000000..bfb8fe22 --- /dev/null +++ b/templates/resources/snapshot.md.tmpl @@ -0,0 +1,51 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_snapshot Resource - terraform-provider-gcore" +subcategory: "" +description: |- + +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_snapshot (Resource) + +## Example Usage + +{{tffile "examples/resources/snapshot/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) +- `volume_id` (String) + +### Optional + +- `description` (String) +- `last_updated` (String) +- `metadata` (Map of String) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `id` (String) The ID of this resource. +- `size` (Number) +- `status` (String) + +## Import + +Import is supported using the following syntax: + +```shell +# import using :: format +terraform import gcore_snapshot.snapshot1 1:6:447d2959-8ae0-4ca0-8d47-9f050a3637d7 +``` diff --git a/templates/resources/storage_s3.md.tmpl b/templates/resources/storage_s3.md.tmpl new file mode 100644 index 00000000..5f2cea63 --- /dev/null +++ b/templates/resources/storage_s3.md.tmpl @@ -0,0 +1,42 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_storage_s3 Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent s3 storage resource. https://storage.gcore.com/storage/list +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_storage_s3 (Resource) + +Represent s3 storage resource. https://storage.gcore.com/storage/list + +## Example Usage + +{{tffile "examples/resources/storage_s3/example_1.tf"}} + + + +## Schema + +### Required + +- `location` (String) A location of new storage resource. One of (s-ed1, s-darz1, s-ws1, s-dt2, s-drc2) +- `name` (String) A name of new storage resource. + +### Optional + +- `client_id` (Number) An client id of new storage resource. +- `generated_access_key` (String) A s3 access key for new storage resource. +- `generated_endpoint` (String) A s3 entry point for new storage resource. +- `generated_http_endpoint` (String) A http s3 entry point for new storage resource. +- `generated_s3_endpoint` (String) A s3 endpoint for new storage resource. +- `generated_secret_key` (String) A s3 secret key for new storage resource. +- `storage_id` (Number) An id of new storage resource. + +### Read-Only + +- `id` (String) The ID of this resource. diff --git a/templates/resources/storage_s3_bucket.md.tmpl b/templates/resources/storage_s3_bucket.md.tmpl new file mode 100644 index 00000000..f520c28f --- /dev/null +++ b/templates/resources/storage_s3_bucket.md.tmpl @@ -0,0 +1,32 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_storage_s3_bucket Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent s3 storage bucket resource. https://storage.gcore.com/storage/list +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_storage_s3_bucket (Resource) + +Represent s3 storage bucket resource. https://storage.gcore.com/storage/list + +## Example Usage + +{{tffile "examples/resources/storage_s3_bucket/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) A name of new storage bucket resource. +- `storage_id` (Number) An id of existing storage resource. + +### Read-Only + +- `id` (String) The ID of this resource. diff --git a/templates/resources/storage_sftp.md.tmpl b/templates/resources/storage_sftp.md.tmpl new file mode 100644 index 00000000..eccda889 --- /dev/null +++ b/templates/resources/storage_sftp.md.tmpl @@ -0,0 +1,45 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_storage_sftp Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent sftp storage resource. https://storage.gcore.com/storage/list +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_storage_sftp (Resource) + +Represent sftp storage resource. https://storage.gcore.com/storage/list + +## Example Usage + +{{tffile "examples/resources/storage_sftp/example_1.tf"}} + + + +## Schema + +### Required + +- `location` (String) A location of new storage resource. One of (ams, sin, fra, mia) +- `name` (String) A name of new storage resource. + +### Optional + +- `client_id` (Number) An client id of new storage resource. +- `generated_http_endpoint` (String) A http sftp entry point for new storage resource. +- `generated_password` (Boolean) An auto generated sftp password for new storage resource. +- `generated_sftp_endpoint` (String) A ssh sftp entry point for new storage resource. +- `http_expires_header_value` (String) A expires date of storage resource. +- `http_servername_alias` (String) An alias of storage resource. +- `password` (String) A sftp password for new storage resource. +- `ssh_key_id` (List of Number) An ssh keys IDs to link with new sftp storage resource only. https://storage.gcore.com/ssh-key/list +- `storage_id` (Number) An id of new storage resource. +- `update_after_create` (Boolean) A temporary flag. An internal cheat, to skip update ssh keys. Skip it. + +### Read-Only + +- `id` (String) The ID of this resource. diff --git a/templates/resources/storage_sftp_key.md.tmpl b/templates/resources/storage_sftp_key.md.tmpl new file mode 100644 index 00000000..7bdbef58 --- /dev/null +++ b/templates/resources/storage_sftp_key.md.tmpl @@ -0,0 +1,36 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_storage_sftp_key Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent storage key resource. https://storage.gcore.com/ssh-key/list +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_storage_sftp_key (Resource) + +Represent storage key resource. https://storage.gcore.com/ssh-key/list + +## Example Usage + +{{tffile "examples/resources/storage_sftp_key/example_1.tf"}} + + + +## Schema + +### Required + +- `key` (String) A body of of new storage key resource. +- `name` (String) A name of new storage key resource. + +### Optional + +- `key_id` (Number) An id of of new storage key resource. + +### Read-Only + +- `id` (String) The ID of this resource. diff --git a/templates/resources/subnet.md.tmpl b/templates/resources/subnet.md.tmpl new file mode 100644 index 00000000..f36fb2cd --- /dev/null +++ b/templates/resources/subnet.md.tmpl @@ -0,0 +1,76 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_subnet Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent subnets. Subnetwork is a range of IP addresses in a cloud network. Addresses from this range will be assigned to machines in the cloud +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_subnet (Resource) + +Represent subnets. Subnetwork is a range of IP addresses in a cloud network. Addresses from this range will be assigned to machines in the cloud + +## Example Usage + +{{tffile "examples/resources/subnet/example_1.tf"}} + + + +## Schema + +### Required + +- `cidr` (String) +- `name` (String) +- `network_id` (String) + +### Optional + +- `connect_to_network_router` (Boolean) True if the network's router should get a gateway in this subnet. Must be explicitly 'false' when gateway_ip is null. Default true. +- `dns_nameservers` (List of String) +- `enable_dhcp` (Boolean) +- `gateway_ip` (String) +- `host_routes` (Block List) (see [below for nested schema](#nestedblock--host_routes)) +- `last_updated` (String) +- `metadata_map` (Map of String) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) + +### Read-Only + +- `id` (String) The ID of this resource. +- `metadata_read_only` (List of Object) (see [below for nested schema](#nestedatt--metadata_read_only)) + + + +### Nested Schema for `host_routes` + +Required: + +- `destination` (String) +- `nexthop` (String) IPv4 address to forward traffic to if it's destination IP matches 'destination' CIDR + + + +### Nested Schema for `metadata_read_only` + +Read-Only: + +- `key` (String) +- `read_only` (Boolean) +- `value` (String) + +## Import + +Import is supported using the following syntax: + +```shell +# import using :: format +terraform import gcore_subnet.subnet1 1:6:447d2959-8ae0-4ca0-8d47-9f050a3637d7 +``` diff --git a/templates/resources/volume.md.tmpl b/templates/resources/volume.md.tmpl new file mode 100644 index 00000000..8dd69be6 --- /dev/null +++ b/templates/resources/volume.md.tmpl @@ -0,0 +1,64 @@ +--- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "gcore_volume Resource - terraform-provider-gcore" +subcategory: "" +description: |- + Represent volume. A volume is a file storage which is similar to SSD and HDD hard disks but located in the cloud +--- + +{{/* This template serves as a starting point for documentation generation, and can be customized with hardcoded values and/or doc gen templates. + +For example, the {{ .SchemaMarkdown }} template can be used to replace manual schema documentation if descriptions of schema attributes are added in the provider source code. */ -}} + +# gcore_volume (Resource) + +Represent volume. A volume is a file storage which is similar to SSD and HDD hard disks but located in the cloud + +## Example Usage + +{{tffile "examples/resources/volume/example_1.tf"}} + + + +## Schema + +### Required + +- `name` (String) + +### Optional + +- `image_id` (String) Mandatory if volume is created from image +- `last_updated` (String) +- `metadata_map` (Map of String) +- `project_id` (Number) +- `project_name` (String) +- `region_id` (Number) +- `region_name` (String) +- `size` (Number) +- `snapshot_id` (String) Mandatory if volume is created from a snapshot +- `type_name` (String) Available value is 'standard', 'ssd_hiiops', 'cold', 'ultra'. Defaults to standard + +### Read-Only + +- `id` (String) The ID of this resource. +- `metadata_read_only` (List of Object) (see [below for nested schema](#nestedatt--metadata_read_only)) + + + +### Nested Schema for `metadata_read_only` + +Read-Only: + +- `key` (String) +- `read_only` (Boolean) +- `value` (String) + +## Import + +Import is supported using the following syntax: + +```shell +# import using :: format +terraform import gcore_volume.volume1 1:6:447d2959-8ae0-4ca0-8d47-9f050a3637d7 +```