Skip to content

Commit

Permalink
chore: update docs from v0.29.2
Browse files Browse the repository at this point in the history
  • Loading branch information
mgcservices committed Nov 6, 2024
1 parent 203054c commit 2f43cdc
Show file tree
Hide file tree
Showing 19 changed files with 558 additions and 74 deletions.
6 changes: 3 additions & 3 deletions docs/data-sources/kubernetes_cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ Data source for Kubernetes cluster in MGC
## Example Usage

```terraform
data "mgc_kubernetes_cluster_kubeconfig" "cluster" {
cluster_id = mgc_kubernetes_cluster.my_cluster.id
data "mgc_kubernetes_cluster" "cluster" {
id = mgc_kubernetes_cluster.my_cluster.id
}
output "cluster" {
value = data.mgc_kubernetes_cluster_kubeconfig.cluster
value = data.mgc_kubernetes_cluster.cluster
}
```

Expand Down
6 changes: 3 additions & 3 deletions docs/data-sources/kubernetes_cluster_kubeconfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ Get the kubeconfig of a Kubernetes cluster by cluster_id.
## Example Usage

```terraform
data "mgc_kubernetes_cluster" "cluster" {
id = mgc_kubernetes_cluster.my_cluster.id
data "mgc_kubernetes_cluster_kubeconfig" "cluster" {
cluster_id = mgc_kubernetes_cluster.my_cluster.id
}
output "cluster" {
value = data.mgc_kubernetes_cluster.cluster
value = data.mgc_kubernetes_cluster_kubeconfig.cluster
}
```

Expand Down
37 changes: 37 additions & 0 deletions docs/data-sources/network_public_ip.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "mgc_network_public_ip Data Source - terraform-provider-mgc"
subcategory: "Network"
description: |-
Network Public IP
---

# mgc_network_public_ip (Data Source)

Network Public IP

## Example Usage

```terraform
data "mgc_network_public_ip" "example" {
id = mgc_network_public_ips.example.id
}
output "datasource_public_ip_id" {
value = data.mgc_network_public_ip.example
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `id` (String) The ID of the public IP

### Read-Only

- `description` (String) The description of the public IP
- `port_id` (String) The port ID it's attached to
- `public_ip` (String) The public IP address
- `vpc_id` (String) The related VPC ID
66 changes: 66 additions & 0 deletions docs/data-sources/network_security_group.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "mgc_network_security_group Data Source - terraform-provider-mgc"
subcategory: "Network"
description: |-
Network Security Group
---

# mgc_network_security_group (Data Source)

Network Security Group

## Example Usage

```terraform
data "mgc_network_security_group" "example" {
id = mgc_network_security_groups.example.id
}
output "datasource_security_group" {
value = data.mgc_network_security_group.example
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `id` (String) The ID of the security group.

### Optional

- `description` (String) The description of the security group.

### Read-Only

- `created_at` (String) The creation timestamp of the security group.
- `error` (String) Error message, if any.
- `external_id` (String) The external ID of the security group.
- `is_default` (Boolean) Indicates if this is the default security group.
- `name` (String) The name of the security group.
- `project_type` (String) The project type of the security group.
- `rules` (Attributes List) The rules of the security group. (see [below for nested schema](#nestedatt--rules))
- `status` (String) The status of the security group.
- `tenant_id` (String) The tenant ID of the security group.
- `updated` (String) The last update timestamp of the security group.
- `vpc_id` (String) The VPC ID of the security group.

<a id="nestedatt--rules"></a>
### Nested Schema for `rules`

Read-Only:

- `created_at` (String) The creation timestamp of the rule.
- `direction` (String) The direction of the rule.
- `error` (String) Error message, if any.
- `ethertype` (String) The ethertype of the rule.
- `id` (String) The ID of the rule.
- `port_range_max` (Number) The maximum port range of the rule.
- `port_range_min` (Number) The minimum port range of the rule.
- `protocol` (String) The protocol of the rule.
- `remote_group_id` (String) The remote group ID of the rule.
- `remote_ip_prefix` (String) The remote IP prefix of the rule.
- `security_group_id` (String) The security group ID of the rule.
- `status` (String) The status of the rule.
39 changes: 39 additions & 0 deletions docs/data-sources/network_subnetpool.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "mgc_network_subnetpool Data Source - terraform-provider-mgc"
subcategory: "Network"
description: |-
Network Subnet Pool
---

# mgc_network_subnetpool (Data Source)

Network Subnet Pool

## Example Usage

```terraform
data "mgc_network_subnetpool" "example" {
id = "subnetpool-id"
}
output "subnetpool_cidr" {
value = data.mgc_network_subnetpool.example
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `id` (String) The unique identifier of the subnetpool

### Read-Only

- `cidr` (String) The CIDR range associated with the subnetpool
- `created_at` (String) The timestamp when the subnetpool was created
- `description` (String) The description of the subnetpool
- `ip_version` (Number) The IP version of the subnetpool (4 or 6)
- `name` (String) The name of the subnetpool
- `tenant_id` (String) The ID of the tenant that owns the subnetpool
35 changes: 35 additions & 0 deletions docs/data-sources/network_vpc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "mgc_network_vpc Data Source - terraform-provider-mgc"
subcategory: "Network"
description: |-
Network VPC
---

# mgc_network_vpc (Data Source)

Network VPC

## Example Usage

```terraform
data "mgc_network_vpc" "example" {
id = mgc_network_vpcs.example.id
}
output "datasource_vpc_id" {
value = data.mgc_network_vpc.example
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `id` (String) The ID of the VPC

### Read-Only

- `description` (String) The description of the VPC
- `name` (String) The name of the VPC
61 changes: 61 additions & 0 deletions docs/data-sources/network_vpcs_interface.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "mgc_network_vpcs_interface Data Source - terraform-provider-mgc"
subcategory: "Network"
description: |-
Network VPC Interface
---

# mgc_network_vpcs_interface (Data Source)

Network VPC Interface

## Example Usage

```terraform
data "mgc_network_vpcs_interface" "example" {
id = mgc_network_vpcs_interfaces.example.id
}
output "datasource_vpcs_interface" {
value = data.mgc_network_vpcs_interface.example
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `id` (String) The ID of the VPC interface

### Read-Only

- `created_at` (String) Creation timestamp of the VPC interface
- `description` (String) Description of the VPC interface
- `ip_address` (Attributes List) The IP addresses associated with the VPC interface (see [below for nested schema](#nestedatt--ip_address))
- `is_admin_state_up` (Boolean) Administrative state of the VPC interface
- `is_port_security_enabled` (Boolean) Port security status of the VPC interface
- `name` (String) Name of the VPC interface
- `public_ip` (Attributes List) Public IP configuration of the VPC interface (see [below for nested schema](#nestedatt--public_ip))
- `security_groups` (List of String) List of security group IDs
- `updated` (String) Last update timestamp of the VPC interface
- `vpc_id` (String) ID of the VPC this interface belongs to

<a id="nestedatt--ip_address"></a>
### Nested Schema for `ip_address`

Read-Only:

- `ethertype` (String) The ethertype of the IP address
- `ip_address` (String) The IP address
- `subnet_id` (String) The subnet ID


<a id="nestedatt--public_ip"></a>
### Nested Schema for `public_ip`

Read-Only:

- `public_ip` (String) The public IP address
- `public_ip_id` (String) The public IP ID
51 changes: 51 additions & 0 deletions docs/data-sources/network_vpcs_subnet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "mgc_network_vpcs_subnet Data Source - terraform-provider-mgc"
subcategory: "Network"
description: |-
Network VPC Subnet
---

# mgc_network_vpcs_subnet (Data Source)

Network VPC Subnet

## Example Usage

```terraform
data "mgc_network_vpcs_subnet" "example" {
id = mgc_network_vpcs_subnets.example.id
}
output "datasource_subnet_id" {
value = data.mgc_network_vpcs_subnet.example
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `id` (String) The ID of the subnet

### Read-Only

- `cidr_block` (String) The CIDR block of the subnet
- `description` (String) The description of the subnet
- `dhcp_pools` (Attributes List) The DHCP pools of the subnet (see [below for nested schema](#nestedatt--dhcp_pools))
- `dns_nameservers` (List of String) The DNS nameservers of the subnet
- `gateway_ip` (String) The gateway IP of the subnet
- `ip_version` (String) The IP version of the subnet
- `name` (String) The name of the subnet
- `updated` (String) The updated timestamp of the subnet
- `vpc_id` (String) The VPC ID of the subnet
- `zone` (String) The zone of the subnet

<a id="nestedatt--dhcp_pools"></a>
### Nested Schema for `dhcp_pools`

Read-Only:

- `end` (String) The end of the DHCP pool
- `start` (String) The start of the DHCP pool
1 change: 1 addition & 0 deletions docs/data-sources/virtual_machine_instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,4 @@ output "vm_instances" {
- `ssh_key_name` (String) SSH Key name
- `state` (String) State of instance
- `status` (String) Status of instance.
- `user_data` (String) User data of instance
1 change: 1 addition & 0 deletions docs/data-sources/virtual_machine_instances.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,4 @@ Read-Only:
- `ssh_key_name` (String) SSH Key name
- `state` (String) State of instance
- `status` (String) Status of instance.
- `user_data` (String) User data of instance
37 changes: 21 additions & 16 deletions docs/resources/network_public_ips.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,37 +3,42 @@
page_title: "mgc_network_public_ips Resource - terraform-provider-mgc"
subcategory: "Network"
description: |-
VPC Public IPs
Network Public IP
---

# mgc_network_public_ips (Resource)

VPC Public IPs
Network Public IP

## Example Usage

```terraform
resource "mgc_network_public_ips" "example" {
description = "example public ip"
vpc_id = mgc_network_vpc.example.id
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `vpc_id` (String) Id of the VPC to create the Public IP in
- `vpc_id` (String) The related VPC ID

### Optional

- `description` (String)
- `validate_quota` (Boolean) Validate the quota before creating the Public IP
- `wait` (Boolean) The request will be asynchronous. The wait parameter tells the API that you want the request to simulate synchronous behavior (to maintain endpoint compatibility). You can set an approximate timeout with the waitTimeout parameter
- `wait_timeout` (Number) the approximate time in seconds you want to wait when simulating the request as synchronous (only works with wait=true)
- `description` (String) The description of the public IP

### Read-Only

- `created_at` (String)
- `current_vpc_id` (String)
- `error` (String)
- `external_id` (String)
- `id` (String) Id of the Public IP to delete
- `port_id` (String)
- `public_ip` (String)
- `status` (String)
- `updated` (String)
- `id` (String) The ID of the public IP
- `public_ip` (String) The public IP address

## Import

Import is supported using the following syntax:

```shell
terraform import mgc_network_public_ips.example 123
```
Loading

0 comments on commit 2f43cdc

Please sign in to comment.