Skip to content

Commit

Permalink
feat: update docs and version
Browse files Browse the repository at this point in the history
  • Loading branch information
msq177 committed Jan 24, 2024
1 parent 20dd05d commit e3cc4a3
Show file tree
Hide file tree
Showing 16 changed files with 405 additions and 5 deletions.
2 changes: 1 addition & 1 deletion common/common_volcengine_version.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ package common

const (
TerraformProviderName = "terraform-provider-volcengine"
TerraformProviderVersion = "0.0.137"
TerraformProviderVersion = "0.0.138"
)
1 change: 1 addition & 0 deletions docgen/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,7 @@ var resourceKeys = map[string]string{
"alb": "ALB",
"bandwidth_package": "BANDWIDTH_PACKAGE",
"cloud_monitor": "CLOUD_MONITOR",
"rds_mssql": "RDS_MSSQL",
}

type Products struct {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ func DataSourceVolcengineRdsMssqlInstances() *schema.Resource {
"overdue_time": {
Type: schema.TypeString,
Computed: true,
Description: "Time for Disconnection due to Unpaid Fees",
Description: "Time for Disconnection due to Unpaid Fees.",
},
},
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ func ResourceVolcengineRdsMssqlInstance() *schema.Resource {
Type: schema.TypeString,
},
Description: "The subnet id of the instance node. When creating an instance that includes primary and backup nodes and needs to deploy primary and backup nodes across availability zones, you can specify two subnet_id. " +
"By default, the first is the primary node availability zone, and the second is the backup node availability zone",
"By default, the first is the primary node availability zone, and the second is the backup node availability zone.",
},
"node_spec": {
Type: schema.TypeString,
Expand Down Expand Up @@ -144,7 +144,7 @@ func ResourceVolcengineRdsMssqlInstance() *schema.Resource {
"overdue_time": {
Type: schema.TypeString,
Computed: true,
Description: "Time for Disconnection due to Unpaid Fees",
Description: "Time for Disconnection due to Unpaid Fees.",
},
},
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,9 @@ func TestAccVolcengineSslVpnClientCertResource_Basic(t *testing.T) {
}

const testAccVolcengineSslVpnClientCertUpdateConfig = `
data "volcengine_zones" "foo"{
}
resource "volcengine_vpc" "foo" {
vpc_name = "acc-test-vpc"
cidr_block = "172.16.0.0/16"
Expand All @@ -109,7 +112,7 @@ resource "volcengine_vpc" "foo" {
resource "volcengine_subnet" "foo" {
subnet_name = "acc-test-subnet"
cidr_block = "172.16.0.0/24"
zone_id = "cn-guilin-a"
zone_id = data.volcengine_zones.foo.zones[0].id
vpc_id = volcengine_vpc.foo.id
}
Expand Down
52 changes: 52 additions & 0 deletions website/docs/d/rds_mssql_backups.html.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
subcategory: "RDS_MSSQL"
layout: "volcengine"
page_title: "Volcengine: volcengine_rds_mssql_backups"
sidebar_current: "docs-volcengine-datasource-rds_mssql_backups"
description: |-
Use this data source to query detailed information of rds mssql backups
---
# volcengine_rds_mssql_backups
Use this data source to query detailed information of rds mssql backups
## Example Usage
```hcl
data "volcengine_rds_mssql_backups" "foo" {
instance_id = "mssql-40914121fd22"
}
```
## Argument Reference
The following arguments are supported:
* `instance_id` - (Required) The id of the instance.
* `backup_end_time` - (Optional) The end time of the backup.
* `backup_id` - (Optional) The id of the backup.
* `backup_start_time` - (Optional) The start time of the backup.
* `backup_type` - (Optional) The type of the backup.
* `output_file` - (Optional) File name where to save data source results.

## Attributes Reference
In addition to all arguments above, the following attributes are exported:
* `backups` - The collection of query.
* `backup_database_detail` - The detail of the database.
* `backup_download_link_eip` - External backup download link.
* `backup_download_link_inner` - Intranet backup download link.
* `backup_end_time` - The end time of the backup.
* `backup_file_name` - The name of the backup file.
* `backup_file_size` - The size of the backup file.
* `backup_start_time` - The start time of the backup.
* `backup_type` - The type of the backup.
* `database_name` - The name of the database.
* `download_progress` - Backup file preparation progress, unit: %.
* `download_status` - Download status.
* `link_expired_time` - Download link expiration time.
* `backup_end_time` - The end time of the backup.
* `backup_file_size` - The size of the backup file.
* `backup_id` - The id of the backup.
* `backup_method` - The name of the backup method.
* `backup_start_time` - The start time of the backup.
* `backup_status` - The status of the backup.
* `backup_type` - The type of the backup.
* `create_type` - The type of the backup create.
* `id` - The id of the backup.
* `total_count` - The total count of query.


120 changes: 120 additions & 0 deletions website/docs/d/rds_mssql_instances.html.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
---
subcategory: "RDS_MSSQL"
layout: "volcengine"
page_title: "Volcengine: volcengine_rds_mssql_instances"
sidebar_current: "docs-volcengine-datasource-rds_mssql_instances"
description: |-
Use this data source to query detailed information of rds mssql instances
---
# volcengine_rds_mssql_instances
Use this data source to query detailed information of rds mssql instances
## Example Usage
```hcl
data "volcengine_rds_mssql_instances" "foo" {
instance_id = "mssql-d2fc5abe****"
}
```
## Argument Reference
The following arguments are supported:
* `charge_type` - (Optional) The charge type. Valid values: `PostPaid`, `PrePaid`.
* `create_time_end` - (Optional) The end time of creating the instance, using UTC time format.
* `create_time_start` - (Optional) The start time of creating the instance, using UTC time format.
* `db_engine_version` - (Optional) Compatible version. Valid values: `SQLServer_2019_Std`, `SQLServer_2019_Web`, `SQLServer_2019_Ent`.
* `instance_id` - (Optional) Id of the instance.
* `instance_name` - (Optional) Name of the instance.
* `instance_status` - (Optional) Status of the instance.
* `instance_type` - (Optional) Instance type. Valid values: `HA`, `Basic`, `Cluster`.
* `name_regex` - (Optional) A Name Regex of RDS mssql instance.
* `output_file` - (Optional) File name where to save data source results.
* `tags` - (Optional) Tags.
* `zone_id` - (Optional) The id of the zone.

The `tags` object supports the following:

* `key` - (Required) The Key of Tags.
* `value` - (Required) The Value of Tags.

## Attributes Reference
In addition to all arguments above, the following attributes are exported:
* `instances` - The collection of query.
* `backup_use` - The used backup space of the instance. Unit: GiB.
* `charge_detail` - The charge detail.
* `auto_renew` - Whether to enable automatic renewal in the prepaid scenario. This parameter can be set when ChargeType is Prepaid.
* `charge_end_time` - Charge end time.
* `charge_start_time` - Charge start time.
* `charge_status` - The charge status.
* `charge_type` - The charge type.
* `overdue_reclaim_time` - Expected release time when overdue fees are shut down.
* `overdue_time` - Time for Disconnection due to Unpaid Fees.
* `period_unit` - Purchase cycle in prepaid scenarios. This parameter can be set when ChargeType is Prepaid.
* `period` - Purchase duration in a prepaid scenario.
* `connection_info` - The connection info of the instance.
* `address` - The address info.
* `dns_visibility` - Whether to enable private to public network resolution.
* `domain` - The domain.
* `eip_id` - The eip id for public address.
* `ip_address` - The ip address.
* `network_type` - The network type.
* `port` - The port.
* `subnet_id` - The subnet id for private address.
* `description` - The description.
* `endpoint_id` - The endpoint id.
* `endpoint_name` - The endpoint name.
* `endpoint_type` - The endpoint type.
* `create_time` - The creation time of the instance.
* `db_engine_version` - The db engine version.
* `id` - The id of the instance.
* `inner_version` - The inner version of the instance.
* `instance_category` - The instance category.
* `instance_id` - The id of the instance.
* `instance_name` - The name of the instance.
* `instance_status` - The status of the instance.
* `instance_type` - The type of the instance.
* `memory` - The Memory of the instance. Unit: GiB.
* `node_detail_info` - Node detail information.
* `create_time` - Node creation time.
* `instance_id` - Instance ID.
* `memory` - The Memory.
* `node_id` - The Node ID.
* `node_ip` - The node ip.
* `node_spec` - The node spec.
* `node_status` - The node status.
* `node_type` - The node type.
* `region_id` - The region id.
* `update_time` - The update time.
* `v_cpu` - CPU size. For example: 1 represents 1U.
* `zone_id` - The zone id.
* `node_spec` - The node spec.
* `parameter_count` - The count of instance parameters.
* `parameters` - The list of instance parameters.
* `checking_code` - The valid value range of the parameter.
* `force_modify` - Indicates whether the parameter running value can be modified.
* `force_restart` - Indicates whether the instance needs to be restarted to take effect after modifying the running value of the parameter.
* `parameter_default_value` - The default value of the parameter.
* `parameter_description` - The description of the parameter.
* `parameter_name` - The name of the parameter.
* `parameter_type` - The type of the parameter.
* `parameter_value` - The value of the parameter.
* `port` - The port of the instance.
* `primary_instance_id` - The id of the primary instance.
* `project_name` - The project name.
* `read_only_number` - The number of read only instance.
* `region_id` - The region id.
* `server_collation` - Server sorting rules.
* `slow_query_enable` - Whether to enable slow query function.
* `slow_query_time` - The slow query time. Unit: second.
* `storage_space` - The storage space.
* `storage_type` - The storage type.
* `storage_use` - The used storage space.
* `subnet_id` - The subnet id.
* `tags` - Tags.
* `key` - The Key of Tags.
* `value` - The Value of Tags.
* `time_zone` - The time zone.
* `update_time` - The update time of the instance.
* `v_cpu` - The CPU size of the instance. For example: 1 represents 1U.
* `vpc_id` - The vpc id.
* `zone_id` - The zone id.
* `total_count` - The total count of query.


27 changes: 27 additions & 0 deletions website/docs/d/rds_mssql_regions.html.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
subcategory: "RDS_MSSQL"
layout: "volcengine"
page_title: "Volcengine: volcengine_rds_mssql_regions"
sidebar_current: "docs-volcengine-datasource-rds_mssql_regions"
description: |-
Use this data source to query detailed information of rds mssql regions
---
# volcengine_rds_mssql_regions
Use this data source to query detailed information of rds mssql regions
## Example Usage
```hcl
data "volcengine_rds_mssql_regions" "foo" {
}
```
## Argument Reference
The following arguments are supported:
* `output_file` - (Optional) File name where to save data source results.

## Attributes Reference
In addition to all arguments above, the following attributes are exported:
* `regions` - The collection of region query.
* `region_id` - The id of the region.
* `region_name` - The name of region.
* `total_count` - The total count of region query.


31 changes: 31 additions & 0 deletions website/docs/d/rds_mssql_zones.html.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
subcategory: "RDS_MSSQL"
layout: "volcengine"
page_title: "Volcengine: volcengine_rds_mssql_zones"
sidebar_current: "docs-volcengine-datasource-rds_mssql_zones"
description: |-
Use this data source to query detailed information of rds mssql zones
---
# volcengine_rds_mssql_zones
Use this data source to query detailed information of rds mssql zones
## Example Usage
```hcl
data "volcengine_rds_mssql_zones" "foo" {
}
```
## Argument Reference
The following arguments are supported:
* `output_file` - (Optional) File name where to save data source results.
* `region_id` - (Optional) The Id of Region.

## Attributes Reference
In addition to all arguments above, the following attributes are exported:
* `total_count` - The total count of zone query.
* `zones` - The collection of zone query.
* `description` - The description of the zone.
* `id` - The id of the zone.
* `zone_id` - The id of the zone.
* `zone_name` - The name of the zone.


1 change: 1 addition & 0 deletions website/docs/d/vke_kubeconfigs.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ The following arguments are supported:
* `output_file` - (Optional) File name where to save data source results.
* `page_number` - (Optional) The page number of Kubeconfigs query.
* `page_size` - (Optional) The page size of Kubeconfigs query.
* `role_ids` - (Optional) A list of Role IDs.
* `types` - (Optional) The type of Kubeconfigs query.

## Attributes Reference
Expand Down
1 change: 1 addition & 0 deletions website/docs/d/vke_node_pools.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,7 @@ In addition to all arguments above, the following attributes are exported:
* `initialize_script` - The InitializeScript of NodeConfig.
* `instance_charge_type` - The InstanceChargeType of NodeConfig.
* `instance_type_ids` - The InstanceTypeIds of NodeConfig.
* `kube_config_name_prefix` - The NamePrefix of node metadata.
* `label_content` - The LabelContent of KubernetesConfig.
* `key` - The Key of KubernetesConfig.
* `value` - The Value of KubernetesConfig.
Expand Down
38 changes: 38 additions & 0 deletions website/docs/r/rds_mssql_backup.html.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
subcategory: "RDS_MSSQL"
layout: "volcengine"
page_title: "Volcengine: volcengine_rds_mssql_backup"
sidebar_current: "docs-volcengine-resource-rds_mssql_backup"
description: |-
Provides a resource to manage rds mssql backup
---
# volcengine_rds_mssql_backup
Provides a resource to manage rds mssql backup
## Example Usage
```hcl
resource "volcengine_rds_mssql_backup" "foo" {
instance_id = "mssql-40914121fd22"
}
```
## Argument Reference
The following arguments are supported:
* `instance_id` - (Required, ForceNew) The id of the instance.
* `backup_meta` - (Optional, ForceNew) Backup repository information. When importing resources, this attribute will not be imported. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
* `backup_type` - (Optional, ForceNew) Backup type. Currently only supports full backup, with a value of Full (default).

The `backup_meta` object supports the following:

* `db_name` - (Required, ForceNew) The name of the database.

## Attributes Reference
In addition to all arguments above, the following attributes are exported:
* `id` - ID of the resource.
* `backup_id` - The ID of the backup.


## Import
Rds Mssql Backup can be imported using the id, e.g.
```
$ terraform import volcengine_rds_mssql_backup.default instanceId:backupId
```

Loading

0 comments on commit e3cc4a3

Please sign in to comment.