Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(cce): fix docs issues. #994

Merged
merged 1 commit into from
Sep 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions docs/data-sources/cce_addon_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ data "flexibleengine_cce_addon_template" "test" {

The following arguments are supported:

* `region` - (Optional, String) The region in which to query the data source. If omitted, the provider-level region
will be used.

* `cluster_id` - (Required, String) Specifies the ID of CCE cluster.

* `name` - (Required, String) Specifies the add-on name. The supported addons are as follows:
Expand All @@ -42,7 +45,7 @@ The following arguments are supported:

* `version` - (Required, String) Specifies the add-on version.

## Attributes Reference
## Attribute Reference

In addition to all arguments above, the following attributes are exported:

Expand All @@ -54,6 +57,12 @@ In addition to all arguments above, the following attributes are exported:

* `stable` - Whether the add-on template is a stable version.

* `support_version/virtual_machine` - The cluster (Virtual Machine) version that the add-on template supported.
* `support_version` - The cluster information.
The [support_version](#cce_support_version) object structure is documented below.

<a name="cce_support_version"></a>
The `support_version` block supports:

* `virtual_machine` - The cluster (Virtual Machine) version that the add-on template supported.

* `support_version/bare_metal` - The cluster (Bare Metal) version that the add-on template supported.
* `bare_metal` - The cluster (Bare Metal) version that the add-on template supported.
19 changes: 13 additions & 6 deletions docs/data-sources/cce_cluster_v3.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,20 @@ data "flexibleengine_cce_cluster_v3" "cluster" {

The following arguments are supported:

* `name` - (Optional)The Name of the cluster resource.
* `region` - (Optional, String) The region in which to query the data source. If omitted, the provider-level region
will be used.

* `id` - (Optional) The ID of container cluster.
* `name` - (Optional, String)The Name of the cluster resource.

* `status` - (Optional) The state of the cluster.
* `id` - (Optional, String) The ID of container cluster.

* `cluster_type` - (Optional) Type of the cluster. Possible values: VirtualMachine, BareMetal or Windows
* `status` - (Optional, String) The state of the cluster.

## Attributes Reference
* `cluster_type` - (Optional, String) Type of the cluster. Possible values: VirtualMachine, BareMetal or Windows

* `vpc_id` - (Optional, String) The ID of the VPC used to create the node.

## Attribute Reference

All above argument parameters can be exported as attribute parameters along with attribute reference:

Expand Down Expand Up @@ -69,8 +74,10 @@ All above argument parameters can be exported as attribute parameters along with

* `authentication_mode` - Authentication mode of the cluster, possible values are x509 and rbac.

* `masters` - Advanced configuration of master nodes. Structure is documented below.
* `masters` - Advanced configuration of master nodes.
The [masters](#cce_masters) object structure is documented below.

<a name="cce_masters"></a>
The `masters` block supports:

* `availability_zone` - The availability zone (AZ) of the master node.
27 changes: 19 additions & 8 deletions docs/data-sources/cce_clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,16 +36,18 @@ The following arguments are supported:

* `status` - (Optional, String) Specifies the status of the cluster.

## Attributes Reference
## Attribute Reference

In addition to all arguments above, the following attributes are exported:

* `id` - Indicates a data source ID.

* `ids` - Indicates a list of IDs of all CCE clusters found.

* `clusters` - Indicates a list of CCE clusters found. Structure is documented below.
* `clusters` - Indicates a list of CCE clusters found.
The [clusters](#cce_clusters) object structure is documented below.

<a name="cce_clusters"></a>
The `clusters` block supports:

* `name` - The name of the cluster.
Expand Down Expand Up @@ -76,26 +78,33 @@ The `clusters` block supports:

* `authentication_mode` - The authentication mode of the cluster, possible values are x509 and rbac. Defaults to **rbac**.

* `masters` - The advanced configuration of master nodes.
* `masters` - The advanced configuration of master nodes.The [masters](#cce_masters) object structure is documented below.

* `security_group_id` - The security group ID of the cluster.

* `vpc_id` - The vpc ID of the cluster.

* `subnet_id` - The ID of the VPC Subnet used to create the node.

* `highway_subnet_id` - The ID of the high speed network used to create bare metal nodes.

* `enterprise_project_id` - The enterprise project ID of the CCE cluster.

* `endpoints` - The access addresses of kube-apiserver in the cluster. Structure is documented below.
* `endpoints` - The access addresses of kube-apiserver in the cluster.
The [endpoints](#cce_endpoints) object structure is documented below.

* `certificate_clusters` - The certificate clusters. Structure is documented below.
* `certificate_clusters` - The certificate clusters.
The [certificate_clusters](#cce_certificate_clusters) object structure is documented below.

* `certificate_users` - The certificate users. Structure is documented below.
* `certificate_users` - The certificate users
The [certificate_users](#cce_certificate_users) object structure is documented below.

* `kube_config_raw` - The raw Kubernetes config to be used by kubectl and other compatible tools.

<a name="cce_masters"></a>
The `masters` block supports:

* `availability_zone` - The availability zone (AZ) of the master node.

<a name="cce_endpoints"></a>
The `endpoints` block supports:

* `url` - The URL of the cluster access address.
Expand All @@ -104,6 +113,7 @@ The `endpoints` block supports:
+ **Internal**: The user's subnet access address.
+ **External**: The public network access address.

<a name="cce_certificate_clusters"></a>
The `certificate_clusters` block supports:

* `name` - The cluster name.
Expand All @@ -112,6 +122,7 @@ The `certificate_clusters` block supports:

* `certificate_authority_data` - The certificate data.

<a name="cce_certificate_users"></a>
The `certificate_users` block supports:

* `name` - The user name.
Expand Down
7 changes: 5 additions & 2 deletions docs/data-sources/cce_node_ids_v3.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,12 @@ data "flexibleengine_cce_node_ids_v3" "node_ids" {

The following arguments are supported:

* `cluster_id` (Required) - Specifies the CCE cluster ID used as the query filter.
* `region` - (Optional, String) The region in which to query the data source. If omitted, the provider-level region
will be used.

## Attributes Reference
* `cluster_id` (Required, String) - Specifies the CCE cluster ID used as the query filter.

## Attribute Reference

The following attributes are exported:

Expand Down
20 changes: 12 additions & 8 deletions docs/data-sources/cce_node_v3.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,18 @@ data "flexibleengine_cce_node_v3" "node" {

The following arguments are supported:

* `cluster_id` - (Required) The id of container cluster.
* `region` - (Optional, String) The region in which to query the data source. If omitted, the provider-level region
will be used.

* `name` - (Optional) - Name of the node.
* `cluster_id` - (Required, String) The id of container cluster.

* `node_id` - (Optional) - The id of the node.
* `name` - (Optional, String) - Name of the node.

* `status` - (Optional) - The state of the node.
* `node_id` - (Optional, String) - The id of the node.

## Attributes Reference
* `status` - (Optional, String) - The state of the node.

## Attribute Reference

All above argument parameters can be exported as attribute parameters along with attribute reference:

Expand All @@ -53,13 +56,14 @@ All above argument parameters can be exported as attribute parameters along with
* `ip_type` - Elastic IP address type.

* `share_type` - Bandwidth sharing type.

* `bandwidth_size` - Bandwidth (Mbit/s), in the range of [1, 2000].

* `charge_mode` - Bandwidth billing type.

* `root_volume` - It corresponds to the system disk related configuration.
* `disk_size` - Disk size in GB.

+ `disk_size` - Disk size in GB.
+ `volume_type` - Disk type.
* `volume_type` - Disk type.

* `data_volumes` - Represents the data disk to be created.

Expand Down
13 changes: 9 additions & 4 deletions docs/resources/cce_addon_v3.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@ resource "flexibleengine_cce_addon_v3" "autoscaler" {

The following arguments are supported:

* `region` - (Optional, String, ForceNew) Specifies the region in which to create the CCE addon resource.
If omitted, the provider-level region will be used. Changing this will create a new CCE addon resource.

* `cluster_id` - (Required, String, ForceNew) ID of the cluster. Changing this parameter will create a new resource.

* `template_name` - (Required, String, ForceNew) Name of the addon template.
Expand All @@ -68,8 +71,10 @@ The following arguments are supported:

* `values` - (Optional, List, ForceNew) Add-on template installation parameters.
These parameters vary depending on the add-on. Changing this parameter will create a new resource.
The [values](#cce_values) object structure is documented below.

* The `values` block supports:
<a name="cce_values"></a>
The `values` block supports:

* `basic` - (Required, String, ForceNew) The basic parameters in json string format.
Changing this will create a new resource.
Expand All @@ -80,7 +85,7 @@ The following arguments are supported:
* `flavor` - (Optional, String, ForceNew) The flavor parameters in json string format.
Changing this will create a new resource.

## Attributes Reference
## Attribute Reference

In addition to all arguments above, the following attributes are exported:

Expand All @@ -92,8 +97,8 @@ In addition to all arguments above, the following attributes are exported:

This resource provides the following timeouts configuration options:

* `create` - Default is 10 minute.
* `delete` - Default is 3 minute.
* `create` - Default is 10 minutes.
* `delete` - Default is 3 minutes.

## Import

Expand Down
85 changes: 55 additions & 30 deletions docs/resources/cce_cluster_v3.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,18 @@ resource "flexibleengine_cce_cluster_v3" "cluster_1" {

The following arguments are supported:

* `name` - (Required) Cluster name. Changing this parameter will create a new cluster resource.
* `region` - (Optional, String, ForceNew) Specifies the region in which to create the CCE cluster resource.
If omitted, the provider-level region will be used. Changing this will create a new CCE cluster resource.

* `labels` - (Optional) Cluster tag, key/value pair format. Changing this parameter will create a new cluster resource.
* `name` - (Required, String, ForceNew) Cluster name. Changing this parameter will create a new cluster resource.

* `annotations` - (Optional) Cluster annotation, key/value pair format.
* `labels` - (Optional, Map, ForceNew) Cluster tag, key/value pair format. Changing this parameter will create a new
cluster resource.

* `annotations` - (Optional, Map, ForceNew) Cluster annotation, key/value pair format.
Changing this parameter will create a new cluster resource.

* `flavor_id` - (Required) Cluster specifications. Changing this parameter will create a new cluster resource.
* `flavor_id` - (Required, String, ForceNew) Cluster specifications. Changing this parameter will create a new cluster resource.

+ `cce.s1.small` - small-scale single cluster (up to 50 nodes).
+ `cce.s1.medium` - medium-scale single cluster (up to 200 nodes).
Expand All @@ -63,47 +67,47 @@ The following arguments are supported:
+ `cce.t2.medium` - medium-scale HA physical machine cluster (up to 100 nodes).
+ `cce.t2.large` - large-scale HA physical machine cluster (up to 500 nodes).

* `cluster_version` - (Optional) For the cluster version, possible values are listed on the
* `cluster_version` - (Optional, String, ForceNew) For the cluster version, possible values are listed on the
[CCE Cluster Version Release Notes](https://docs.prod-cloud-ocb.orange-business.com/usermanual2/cce/cce_01_0068.html).
If this parameter is not set, the latest available version will be used.

* `cluster_type` - (Required) Cluster Type, possible values are VirtualMachine and BareMetal.
* `cluster_type` - (Required, String, ForceNew) Cluster Type, possible values are VirtualMachine and BareMetal.
Changing this parameter will create a new cluster resource.

* `description` - (Optional) Cluster description.

* `billing_mode` - (Optional) Charging mode of the cluster, which is 0 (on demand).
Changing this parameter will create a new cluster resource.
* `description` - (Optional, String) Cluster description.

* `extend_param` - (Optional) Extended parameter. Changing this parameter will create a new cluster resource.
* `extend_param` - (Optional, Map, ForceNew) Extended parameter. Changing this parameter will create a new cluster resource.

* `vpc_id` - (Required) The ID of the VPC used to create the node. Changing this parameter will create a new cluster resource.
* `vpc_id` - (Required, String, ForceNew) The ID of the VPC used to create the node.
Changing this parameter will create a new cluster resource.

* `subnet_id` - (Required) The ID of the VPC Subnet used to create the node.
* `subnet_id` - (Required, String, ForceNew) The ID of the VPC Subnet used to create the node.
Changing this parameter will create a new cluster resource.

* `highway_subnet_id` - (Optional) The ID of the high speed network used to create bare metal nodes.
* `highway_subnet_id` - (Optional, String, ForceNew) The ID of the high speed network used to create bare metal nodes.
Changing this parameter will create a new cluster resource.

* `container_network_type` - (Required) Container network parameters. Possible values:
* `container_network_type` - (Required, String, ForceNew) Container network parameters. Possible values:

+ `overlay_l2` - An overlay_l2 network built for containers by using Open vSwitch(OVS)
+ `underlay_ipvlan` - An underlay_ipvlan network built for bare metal servers by using ipvlan.
+ `vpc-router` - An vpc-router network built for containers by using ipvlan and custom VPC routes.

* `container_network_cidr` - (Optional) Container network segment. Changing this parameter will create a new cluster resource.
* `container_network_cidr` - (Optional, String, ForceNew) Container network segment.
Changing this parameter will create a new cluster resource.

* `service_network_cidr` - (Optional) Service network segment. Changing this parameter will create a new cluster resource.
* `service_network_cidr` - (Optional, String, ForceNew) Service network segment. Changing this parameter will create
a new cluster resource.

* `custom_san` - (Optional) Custom san to add to certificate. (array of string)
* `custom_san` - (Optional, List) Custom san to add to certificate. (array of string)

* `authentication_mode` - (Optional) Authentication mode of the cluster, possible values are x509 and rbac. Defaults to *rbac*.
Changing this parameter will create a new cluster resource.
* `authentication_mode` - (Optional, String, ForceNew) Authentication mode of the cluster, possible values are x509
and rbac. Defaults to *rbac*. Changing this parameter will create a new cluster resource.

* `authenticating_proxy_ca` - (Optional) CA root certificate provided in the authenticating_proxy mode. The CA root certificate
is encoded to the Base64 format. Changing this parameter will create a new cluster resource.
* `authenticating_proxy_ca` - (Optional, String, ForceNew) CA root certificate provided in the authenticating_proxy mode.
The CA root certificate is encoded to the Base64 format. Changing this parameter will create a new cluster resource.

* `eip` - (Optional) EIP address of the cluster.
* `eip` - (Optional, String) EIP address of the cluster.

* `kube_proxy_mode` - (Optional, String, ForceNew) Service forwarding mode. Two modes are available:

Expand All @@ -114,13 +118,15 @@ The following arguments are supported:
can keep connections uninterrupted during service updates. It is suitable for large-sized clusters.

* `masters` - (Optional, List, ForceNew) Advanced configuration of master nodes. Changing this creates a new cluster.
The [masters](#cce_masters) object structure is documented below.

<a name="cce_masters"></a>
The `masters` block supports:

* `availability_zone` - (Optional, String, ForceNew) Specifies the availability zone of the master node.
Changing this creates a new cluster.

## Attributes Reference
## Attribute Reference

All above argument parameters can be exported as attribute parameters along with attribute reference.

Expand All @@ -136,17 +142,36 @@ All above argument parameters can be exported as attribute parameters along with

* `security_group_id` - Security group ID of the cluster.

* `certificate_clusters.name` - The cluster name.
* `certificate_clusters` - Security group ID of the cluster.
The [certificate_clusters](#cce_certificate_clusters) object structure is documented below.

* `certificate_users` - Security group ID of the cluster.
The [certificate_users](#cce_certificate_users) object structure is documented below.

<a name="cce_certificate_clusters"></a>
The `certificate_clusters` block supports:

* `name` - The cluster name.

* `server` - The server IP address.

* `certificate_authority_data` - The certificate data.

<a name="cce_certificate_users"></a>
The `certificate_users` block supports:

* `name` - The user name.

* `certificate_clusters.server` - The server IP address.
* `client_certificate_data` - The client certificate data.

* `certificate_clusters.certificate_authority_data` - The certificate data.
* `client_key_data` - The client key data.

* `certificate_users.name` - The user name.
## Timeouts

* `certificate_users.client_certificate_data` - The client certificate data.
This resource provides the following timeouts configuration options:

* `certificate_users.client_key_data` - The client key data.
* `create` - Default is 30 minutes.
* `delete` - Default is 30 minutes.

## Import

Expand Down
Loading
Loading