chore: update docs and examples (#36)

* chore: update docs

* chore: update examples

* fix: test

Author: ecmadao

VERSION

@@ -1 +1 @@
-0.0.6-beta.3
+0.0.7-alpha

docs/data-sources/database_role.md

@@ -16,17 +16,19 @@ The database role data source. You can get a single role in a specific instance
 
 ```terraform
 data "bytebase_database_role" "find_role" {
-  name     = "<role name>"
-  instance = "<instance name>"
+  name        = "<role name>"
+  instance    = "<the instance resource id>"
+  environment = "<the environment resource id>"
 }
 ```
 
 ## Schema
 
 ### Required
 
-- `name` (String) The role unique name.
-- `instance` (String) The instance unique name.
+- `name` (String) The role **unique name**.
+- `environment` (String) The environment **unique resource id**.
+- `instance` (String) The instance **unique resource id**.
 
 ### Read-Only
 

docs/data-sources/database_role_list.md

@@ -16,15 +16,17 @@ The database role list data source. You can list roles in a specific instance th
 
 ```terraform
 data "bytebase_database_role_list" "list_role" {
-  instance = "<instance name>"
+  instance    = "<the instance resource id>"
+  environment = "<the environment resource id>"
 }
 ```
 
 ## Schema
 
 ### Required
 
-- `instance` (String) The instance unique name.
+- `environment` (String) The environment **unique resource id**.
+- `instance` (String) The instance **unique resource id**.
 
 ### Read-Only
 

docs/data-sources/environment.md

@@ -13,9 +13,9 @@ The environment data source. You can get a single environment through `bytebase_
 ## Example Usage
 
 ```terraform
-# Get environment named "dev"
+# Get environment by resource id
 data "bytebase_environment" "dev" {
-    name = "dev"
+    resource_id = "dev"
 }
 
 output "env" {
@@ -31,20 +31,13 @@ You can check [examples](https://github.com/bytebase/terraform-provider-bytebase
 
 ### Required
 
-- `name` (String) The environment unique name.
+- `resource_id` (String) The environment **unique resource id**.
 
 ### Read-Only
 
 - `id` (Number) The ID of this resource.
+- `title` (String) The environment **unique** name.
 - `order` (Number) The environment sorting order. Starting with 1. Lower number appears first in the deployment pipeline.
 - `environment_tier_policy` (String) Check [Environment Tier](https://www.bytebase.com/docs/administration/environment-policy/tier) for details. Should be one of:
   - `PROTECTED`
   - `UNPROTECTED`
-- `pipeline_approval_policy` (String) Check [Approval Policy](https://www.bytebase.com/docs/administration/environment-policy/approval-policy) for details. Should be one of:
-  - `MANUAL_APPROVAL_NEVER`
-  - `MANUAL_APPROVAL_BY_PROJECT_OWNER`
-  - `MANUAL_APPROVAL_BY_WORKSPACE_OWNER_OR_DBA`
-- `backup_plan_policy` (String) Check [Backup Schedule Policy](https://www.bytebase.com/docs/administration/environment-policy/backup-schedule-policy) for details. Should be one of:
-  - `UNSET`
-  - `DAILY`
-  - `WEEKLY`

docs/data-sources/environment_list.md

@@ -27,10 +27,13 @@ You can check [examples](https://github.com/bytebase/terraform-provider-bytebase
 
 ## Schema
 
+### Optional
+
+- `show_deleted` (Boolean) If also show the deleted environments.
+
 ### Read-Only
 
 - `environments` (List of Object) (see [below for nested schema](#nestedatt--environments))
-- `id` (String) The ID of this resource.
 
 <a id="nestedatt--environments"></a>
 

docs/data-sources/instance.md

@@ -13,9 +13,10 @@ The instance data source. You can get a single instance through `bytebase_instan
 ## Example Usage
 
 ```terraform
-# Find a instance named "dev-instance"
+# Find a instance by resource id "dev-instance" in the "dev" environment.
 data "bytebase_instance" "dev" {
-    name = "dev-instance"
+  resource_id = "dev-instance"
+  environment = "dev"
 }
 
 output "instance" {
@@ -31,38 +32,39 @@ You can check [examples](https://github.com/bytebase/terraform-provider-bytebase
 
 ### Required
 
-- `name` (String) The instance unique name.
+- `resource_id` (String) The instance **unique resource id**.
+- `environment` (String) The environment **unique resource id** for the instance.
 
 ### Read-Only
 
 - `id` (Number) The instance id.
+- `title` (String) The instance name.
 - `engine` (String) The instance engine. Should be one of:
   - `MYSQL`
   - `POSTGRES`
   - `TIDB`
   - `SNOWFLAKE`
   - `CLICKHOUSE`
-- `environment` (String) The unique environment name for your instance.
-- `host` (String) Host or socket for your instance, or the account name if the instance type is Snowflake.
-- `port` (String) The port for your instance.
+  - `SQLITE`
+  - `MONGODB`
 - `external_link` (String) The external console URL managing this instance (e.g. AWS RDS console, your in-house DB instance console)
-- `database` (String) The database for your instance.
-- `data_source_list` (List of Object, Min: 1, Max: 3) The connection for the instance. You can configure read-only or admin connection account here. (see [below for nested schema](#nestedblock--data_source_list))
+- `data_sources` (List of Object) The connection for the instance. You can configure read-only or admin connection account here. (see [below for nested schema](#nestedblock--data_sources))
 
-<a id="nestedblock--data_source_list"></a>
+<a id="nestedblock--data_sources"></a>
 
-### Nested Schema for `data_source_list`
+### Nested Schema for `data_sources`
 
 #### Read-Only
 
-- `name` (String) The unique data source name in this instance.
+- `title` (String) The unique data source name in this instance.
 - `type` (String) The data source type. Should be one of:
   - `ADMIN`: The ADMIN type of data source.
-  - `RO`: The read-only type of data source.
+  - `READ_ONLY`: The read-only type of data source.
 - `username` (String) The connection user name used by Bytebase to perform DDL and DML operations.
 - `password` (String) The connection user password used by Bytebase to perform DDL and DML operations.
 - `ssl_ca` (String) The CA certificate. Optional, you can set this if the engine type is `CLICKHOUSE`.
 - `ssl_cert` (String) The client certificate. Optional, you can set this if the engine type is `CLICKHOUSE`.
 - `ssl_key` (String) The client key. Optional, you can set this if the engine type is `CLICKHOUSE`.
-- `host_override` (String) The Read-replica Host. Only works for RO type data source.
-- `port_override` (String) The Read-replica Port. Only works for RO type data source.
+- `host` (String) Host or socket for the data source, or the account name if the instance type is Snowflake.
+- `port` (String) The port for the data source.
+- `database` (String) The database for the data source.

docs/data-sources/instance_list.md

@@ -13,11 +13,20 @@ The instance data source list. You can list instances through `bytebase_instance
 ## Example Usage
 
 ```terraform
-# List instances
+# List all instances in all environments
 data "bytebase_instance_list" "all" {}
 
 output "all_instances" {
-  value = data.bytebase_instance_list.all.instances
+  value = data.bytebase_instance_list.all
+}
+
+# List all instances in the "dev" environment
+data "bytebase_instance_list" "dev_instances" {
+  environment = "dev"
+}
+
+output "dev_instances" {
+  value = data.bytebase_instance_list.dev_instances
 }
 ```
 
@@ -27,9 +36,13 @@ You can check [examples](https://github.com/bytebase/terraform-provider-bytebase
 
 ## Schema
 
+### Optional
+
+- `environment` (String) The environment **unique resource id**.
+- `show_deleted` (Boolean) If also show the deleted instances.
+
 ### Read-Only
 
-- `id` (String) The ID of this resource.
 - `instances` (List of Object) (see [below for nested schema](#nestedatt--instances))
 
 <a id="nestedatt--instances"></a>
@@ -38,6 +51,6 @@ You can check [examples](https://github.com/bytebase/terraform-provider-bytebase
 
 See [Instance Schema](https://registry.terraform.io/providers/bytebase/bytebase/latest/docs/data-sources/instance#schema).
 
-### Nested Schema for `data_source_list`
+### Nested Schema for `data_sources`
 
-See [Data Source Schema](https://registry.terraform.io/providers/bytebase/bytebase/latest/docs/data-sources/instance#nested-schema-for-data_source_list).
+See [Data Source Schema](https://registry.terraform.io/providers/bytebase/bytebase/latest/docs/data-sources/instance#nested-schema-for-data_sources).

docs/index.md

@@ -61,9 +61,12 @@ provider "bytebase" {
 
 ```terraform
 # Usage example
-# Create a new environment named "dev"
+# Create a new environment named "Dev"
 resource "bytebase_environment" "dev" {
-  name = "dev"
+  resource_id             = "dev"
+  title                   = "Dev"
+  order                   = 0
+  environment_tier_policy = "UNPROTECTED"
 }
 ```
 

docs/resources/database_role.md

@@ -17,7 +17,8 @@ Database role resource. You can read, create, update or delete a single role in
 ```terraform
 resource "bytebase_database_role" "admin" {
   name             = "admin"
-  instance         = <the instance unique name>
+  instance         = "<the instance resource id>"
+  environment      = "<the environment resource id>"
   password         = "123456"
   connection_limit = 99
   valid_until      = "2022-12-31T00:00:00+08:00"
@@ -41,7 +42,8 @@ resource "bytebase_database_role" "admin" {
 ### Required
 
 - `name` (String) The role **unique name**.
-- `instance` (String) The instance **unique name**.
+- `environment` (String) The environment **unique resource id**.
+- `instance` (String) The instance **unique resource id**.
 - `attribute` (Object) The attribute for the role. (see [below for nested schema](#nestedblock--attribute))
 
 ### Optional

docs/resources/environment.md

@@ -15,20 +15,18 @@ The environment resource. You can read, create, update or delete a single enviro
 ```terraform
 # Create a new environment named "dev"
 resource "bytebase_environment" "dev" {
-  name  = "dev"
-  order = 1
+  resource_id              = "dev"
+  title                    = "Dev"
+  order                    = 1
   environment_tier_policy  = "UNPROTECTED"
-  pipeline_approval_policy = "MANUAL_APPROVAL_NEVER"
-  backup_plan_policy       = "UNSET"
 }
 
 # Create a new environment named "prod"
 resource "bytebase_environment" "prod" {
-  name  = "prod"
-  order = 2
+  resource_id              = "prod"
+  title                    = "Prod"
+  order                    = 2
   environment_tier_policy  = "PROTECTED"
-  pipeline_approval_policy = "MANUAL_APPROVAL_BY_WORKSPACE_OWNER_OR_DBA"
-  backup_plan_policy       = "DAILY"
 }
 ```
 
@@ -40,19 +38,15 @@ You can check [examples](https://github.com/bytebase/terraform-provider-bytebase
 
 ### Required
 
-- `name` (String) The environment **unique** name.
+- `resource_id` (String) The environment **unique resource id**. For example, `dev`, `dev-env`.
+- `title` (String) The environment **unique name**. For example, `Dev`.
 - `order` (Number) The environment sorting order. Starting with 1. Lower number appears first in the deployment pipeline.
+
+### Optional
+
 - `environment_tier_policy` (String) Check [Environment Tier](https://www.bytebase.com/docs/administration/environment-policy/tier) for details. Should be one of:
   - `PROTECTED`
   - `UNPROTECTED`
-- `pipeline_approval_policy` (String) Check [Approval Policy](https://www.bytebase.com/docs/administration/environment-policy/approval-policy) for details. Should be one of:
-  - `MANUAL_APPROVAL_NEVER`
-  - `MANUAL_APPROVAL_BY_PROJECT_OWNER`
-  - `MANUAL_APPROVAL_BY_WORKSPACE_OWNER_OR_DBA`
-- `backup_plan_policy` (String) Check [Backup Schedule Policy](https://www.bytebase.com/docs/administration/environment-policy/backup-schedule-policy) for details. Should be one of:
-  - `UNSET`
-  - `DAILY`
-  - `WEEKLY`
 
 ### Read-Only