Skip to content

Commit

Permalink
chore: update docs and acceptance tests of ELB (FlexibleEngineCloud#1083
Browse files Browse the repository at this point in the history
)

* docs: normalize FlexibleEngine in docs

* chore: deprecate apig vpc channel resource

* chore: rename dedicated elb logtank and security policy resources
  • Loading branch information
ShiChangkuo authored and Zippo-Wang committed Jan 3, 2024
1 parent 943dba9 commit 393a402
Show file tree
Hide file tree
Showing 39 changed files with 70 additions and 69 deletions.
2 changes: 1 addition & 1 deletion docs/data-sources/apig_environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ subcategory: "API Gateway (Dedicated APIG)"

# flexibleengine_apig_environments

Use this data source to query the environment list under the APIG instance within Flexibleengine.
Use this data source to query the environment list under the APIG instance within FlexibleEngine.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/elb_loadbalancers.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
subcategory: Dedicated Load Balance (Dedicated ELB)
subcategory: "Elastic Load Balance (Dedicated ELB)"
---

# flexibleengine_elb_loadbalancers
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/apig_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_apig_api"

# flexibleengine_apig_api

Manages an APIG API resource within Flexibleengine.
Manages an APIG API resource within FlexibleEngine.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/apig_api_publishment.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_apig_api_publishment"

# flexibleengine_apig_api_publishment

API publish Management within Flexibleengine.
API publish Management within FlexibleEngine.

~> If you republish on the same environment or switch versions through other ways (such as console) after the API is
published through terraform, the current resource attributes will be affected, resulting in data inconsistency.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/apig_custom_authorizer.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_apig_custom_authorizer"

# flexibleengine_apig_custom_authorizer

Manages an APIG custom authorizer resource within Flexibleengine.
Manages an APIG custom authorizer resource within FlexibleEngine.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/apig_environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_apig_environment"

# flexibleengine_apig_environment

Manages an APIG environment resource within Flexibleengine.
Manages an APIG environment resource within FlexibleEngine.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/apig_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_apig_group"

# flexibleengine_apig_group

Manages an APIG (API) group resource within Flexibleengine.
Manages an APIG (API) group resource within FlexibleEngine.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/apig_instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_apig_instance"

# flexibleengine_apig_instance

Manages an APIG dedicated instance resource within Flexibleengine.
Manages an APIG dedicated instance resource within FlexibleEngine.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/apig_response.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_apig_response"

# flexibleengine_apig_response

Manages an APIG (API) custom response resource within Flexibleengine.
Manages an APIG (API) custom response resource within FlexibleEngine.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/apig_throttling_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_apig_throttling_policy"

# flexibleengine_apig_throttling_policy

Manages an APIG (API) throttling policy resource within Flexibleengine.
Manages an APIG (API) throttling policy resource within FlexibleEngine.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/apig_throttling_policy_associate.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_apig_throttling_policy_associate"

# flexibleengine_apig_throttling_policy_associate

Use this resource to bind the APIs to the throttling policy within Flexibleengine.
Use this resource to bind the APIs to the throttling policy within FlexibleEngine.

## Example Usage

Expand Down
6 changes: 4 additions & 2 deletions docs/resources/apig_vpc_channel.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
---
subcategory: "API Gateway (Dedicated APIG)"
subcategory: "Deprecated"
description: ""
page_title: "flexibleengine_apig_vpc_channel"
---

# flexibleengine_apig_vpc_channel

Manages a VPC channel resource within Flexibleengine.
!> **WARNING:** It has been deprecated.

Manages a VPC channel resource within FlexibleEngine.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/cce_namespace.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_cce_namespace"

# flexibleengine_cce_namespace

Manages a CCE namespace resource within Flexibleengine.
Manages a CCE namespace resource within FlexibleEngine.

-> **NOTE:** Currently, there is an ongoing certificate issue regarding the namespace management APIs.
Please set `insecure = true` in provider block to ignore SSL certificate verification.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/cce_pvc.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_cce_pvc"

# flexibleengine_cce_pvc

Manages a CCE Persistent Volume Claim resource within Flexibleengine.
Manages a CCE Persistent Volume Claim resource within FlexibleEngine.

-> **NOTE:** Currently, there is an ongoing certificate issue regarding the PVC management APIs.
Please set `insecure = true` in provider block to ignore SSL certificate verification.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/cse_microservice.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_cse_microservice"

# flexibleengine_cse_microservice

Manages a dedicated microservice resource within Flexibleengine.
Manages a dedicated microservice resource within FlexibleEngine.

-> When deleting a microservice, all instances under it will also be deleted together.

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/cse_microservice_engine.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_cse_microservice_engine"

# flexibleengine_cse_microservice_engine

Manages a dedicated microservice engine resource within Flexibleengine.
Manages a dedicated microservice engine resource within FlexibleEngine.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/cse_microservice_instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_cse_microservice_instance"

# flexibleengine_cse_microservice_instance

Manages a dedicated microservice instance resource within Flexibleengine.
Manages a dedicated microservice instance resource within FlexibleEngine.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/dli_database.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_dli_database"

# flexibleengine_dli_database

Manages DLI SQL database resource within Flexibleengine.
Manages DLI SQL database resource within FlexibleEngine.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/dli_flinksql_job.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_dli_flinksql_job"

# flexibleengine_dli_flinksql_job

Manages a flink sql job resource within Flexibleengine DLI.
Manages a flink sql job resource within FlexibleEngine DLI.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/dli_package.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_dli_package"

# flexibleengine_dli_package

Manages DLI package resource within Flexibleengine
Manages DLI package resource within FlexibleEngine

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/dli_spark_job.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_dli_spark_job"

# flexibleengine_dli_spark_job

Manages spark job resource of DLI within Flexibleengine
Manages spark job resource of DLI within FlexibleEngine

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/dli_table.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_dli_table"

# flexibleengine_dli_table

Manages DLI Table resource within Flexibleengine
Manages DLI Table resource within FlexibleEngine

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/drs_job.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_drs_job"

# flexibleengine_drs_job

Manages DRS job resource within Flexibleengine.
Manages DRS job resource within FlexibleEngine.

## Example Usage

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
subcategory: "Dedicated Load Balance (Dedicated ELB)"
subcategory: "Elastic Load Balance (Dedicated ELB)"
---

# flexibleengine_lb_logtank_v3
# flexibleengine_elb_logtank

Manage an LB logtank resource within FlexibleEngine.

Expand All @@ -13,7 +13,7 @@ variable "loadbalancer_id" {}
variable "group_id" {}
variable "topic_id" {}
resource "flexibleengine_lb_logtank_v3" "test" {
resource "flexibleengine_elb_logtank" "test" {
loadbalancer_id = var.loadbalancer_id
log_group_id = var.group_id
log_topic_id = var.topic_id
Expand Down Expand Up @@ -45,5 +45,5 @@ In addition to all arguments above, the following attributes are exported:
LB logtank can be imported using the logtank ID, e.g.

```bash
terraform import flexibleengine_lb_logtank_v3.test 2f148a75-acd3-4ce7-8f63-d5c9fadab3a0
terraform import flexibleengine_elb_logtank.test 2f148a75-acd3-4ce7-8f63-d5c9fadab3a0
```
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
subcategory: "Dedicated Load Balance (Dedicated ELB)"
subcategory: "Elastic Load Balance (Dedicated ELB)"
---

# flexibleengine_lb_security_policy_v3
# flexibleengine_elb_security_policy

Manages an ELB security policy resource within Flexibleengine.
Manages an ELB security policy resource within FlexibleEngine.

## Example Usage

```hcl
resource "flexibleengine_lb_security_policy_v3" "test" {
resource "flexibleengine_elb_security_policy" "test" {
name = "security_policy_test"
description = "this is a security policy"
protocols = ["TLSv1", "TLSv1.1", "TLSv1.2", "TLSv1.3"]
Expand Down Expand Up @@ -70,5 +70,5 @@ The `listeners` block supports:
The elb security policies can be imported using the `id`, e.g.

```bash
terraform import flexibleengine_lb_security_policy_v3.test 0ce123456a00f2591fabc00385ff1234
terraform import flexibleengine_elb_security_policy.test 0ce123456a00f2591fabc00385ff1234
```
2 changes: 1 addition & 1 deletion docs/resources/modelarts_dataset.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_modelarts_dataset"

# flexibleengine_modelarts_dataset

Manages ModelArts dataset resource within Flexibleengine.
Manages ModelArts dataset resource within FlexibleEngine.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/modelarts_dataset_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_modelarts_dataset_version"

# flexibleengine_modelarts_dataset_version

Manages ModelArts dataset version resource within Flexibleengine.
Manages ModelArts dataset version resource within FlexibleEngine.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/rds_account.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_rds_account"

# flexibleengine_rds_account

Manages RDS Mysql account resource within Flexibleengine.
Manages RDS Mysql account resource within FlexibleEngine.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/rds_database.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_rds_database"

# flexibleengine_rds_database

Manages RDS Mysql database resource within Flexibleengine.
Manages RDS Mysql database resource within FlexibleEngine.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/rds_database_privilege.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_rds_database_privilege"

# flexibleengine_rds_database_privilege

Manages RDS Mysql database privilege resource within Flexibleengine.
Manages RDS Mysql database privilege resource within FlexibleEngine.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/vpc_route.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_vpc_route"

# flexibleengine_vpc_route

Manages a VPC route resource within Flexibleengine.
Manages a VPC route resource within FlexibleEngine.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/vpc_route_table.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_vpc_route_table"

# flexibleengine_vpc_route_table

Manages a VPC custom route table resource within Flexibleengine.
Manages a VPC custom route table resource within FlexibleEngine.

-> **NOTE:** To use a custom route table, you need to submit a service ticket to increase quota.

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/waf_dedicated_certificate.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_waf_dedicated_certificate"

# flexibleengine_waf_dedicated_certificate

Manages a WAF dedicated certificate resource within Flexibleengine.
Manages a WAF dedicated certificate resource within FlexibleEngine.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/waf_dedicated_domain.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_waf_dedicated_domain"

# flexibleengine_waf_dedicated_domain

Manages a dedicated mode domain resource within Flexibleengine.
Manages a dedicated mode domain resource within FlexibleEngine.

-> **NOTE:** All WAF resources depend on WAF instances, and the WAF instances need to be purchased before they can be
used. The dedicated mode domain name resource can be used in Dedicated Mode and ELB Mode.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/waf_dedicated_instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_waf_dedicated_instance"

# flexibleengine_waf_dedicated_instance

Manages a WAF dedicated instance resource within Flexibleengine.
Manages a WAF dedicated instance resource within FlexibleEngine.

## Example Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/waf_dedicated_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ page_title: "flexibleengine_waf_dedicated_policy"

# flexibleengine_waf_dedicated_policy

Manages a WAF dedicated policy resource within Flexibleengine.
Manages a WAF dedicated policy resource within FlexibleEngine.

## Example Usage

Expand Down
Loading

0 comments on commit 393a402

Please sign in to comment.