chore: update terraform provider example (#63)

Author: tianzhou

.github/workflows/tests.yml

@@ -51,6 +51,6 @@ jobs:
           go test -v -cover ./...
         env:
           TF_ACC: '1'
-          BYTEBASE_SERVICE_ACCOUNT: 'test@service.bytebase.com'
-          BYTEBASE_SERVICE_KEY: 'test_secret'
-          BYTEBASE_URL: 'https://bytebase.example.com'
+          BYTEBASE_SERVICE_ACCOUNT: 'terraform@service.bytebase.com'
+          BYTEBASE_SERVICE_KEY: ${{ secrets.BTYEBASE_SERVICE_KEY }}
+          BYTEBASE_URL: 'https://tf.bytebase.com'

.gitignore

@@ -14,6 +14,9 @@ examples/terraform.*
 crash.log
 crash.*.log
 
+# Misc
+**/.DS_Store
+
 # Exclude all .tfvars files, which are likely to contain sensitive data, such as
 # password, private keys, and other secrets. These should not be part of version 
 # control as they are data points which are potentially sensitive and subject 

README.md

@@ -46,7 +46,7 @@ cd terraform-provider-bytebase && make install
 
 # initialize the terraform for your example
 # you need to set the service_account and service_key to your own
-cd examples && terraform init
+cd examples/setup && terraform init
 
 # check the changes
 terraform plan
@@ -77,5 +77,5 @@ Follow [this doc](https://developer.hashicorp.com/terraform/registry/providers/p
 > We need to publish a new tag for a new version, the tag must be a valid [Semantic Version](https://semver.org/) **preceded with a v (for example, v1.2.3)**. There must not be a branch name with the same name as the tag.
 
 1. Develop and merge the feature code.
-2. Create a new PR to update the version in [`./VERSION`](./VERSION)
-3. After the version is updated, the action [`./.github/workflows/release.yml`](./.github/workflows/release.yml) will use the newest version `x.y.z` to create a new tag `vx.y.z`, then use the tag to create the release.
+1. Create a new PR to update the version in [`./VERSION`](./VERSION)
+1. After the version is updated, the action [`./.github/workflows/release.yml`](./.github/workflows/release.yml) will use the newest version `x.y.z` to create a new tag `vx.y.z`, then use the tag to create the release.

examples/README.md

@@ -5,20 +5,20 @@ Examples of using the Terraform Bytebase Provider to manage your resource:
 - [setup](./setup): Initialize the data.
 - [environments](./environments): Use the Bytebase provider to query the environment.
 - [instances](./instances): Use the Bytebase provider to query the instance.
-- [roles](./roles): Use the  Bytebase provider to manage instance role in your instance.
-- [projects](./projects): Use the  Bytebase provider to query projects in your Bytebase instance.
+- [roles](./roles): Use the Bytebase provider to manage instance role in your instance.
+- [projects](./projects): Use the Bytebase provider to query projects in your Bytebase instance.
 
 To run this provider on your local machine:
 
 1. Run your Bytebase service, then you can access the service via `http://localhost:8080`.
-2. Create the service account. Docs [Create service account](https://www.bytebase.com/docs/get-started/terraform#create-service-account).
-3. Replace the `service_account` and `service_key` with your Bytebase service account, and replace the `url` with your Bytebase service URL.
-4. Go to the [setup](./setup) to initialize the data.
-5. Go to the `environments`/`instances`/`role`/`projects` folder to query the data.
-6. Go to the [setup](./setup) and run `terraform destory` to delete the test resources.
+1. Create the service account. Docs [Create service account](https://www.bytebase.com/docs/get-started/terraform#create-service-account).
+1. Replace the `service_account` and `service_key` with your Bytebase service account, and replace the `url` with your Bytebase service URL.
+1. Go to the [setup](./setup) to initialize the data.
+1. Go to the `environments`/`instances`/`role`/`projects` folder to query the data.
+1. Go to the [setup](./setup) and run `terraform destory` to delete the test resources.
 
 To run this provider for development and testing:
 
 1. Replace the source `registry.terraform.io/bytebase/bytebase` with `terraform.local/bytebase/bytebase`.
-2. Run `make install` under the `terraform-provider-bytebase` folder.
-3. Go to example folders and run `terraform init`.
+1. Run `make install` under the `terraform-provider-bytebase` folder.
+1. Go to example folders and run `terraform init`.

examples/instances/main.tf

@@ -19,8 +19,8 @@ provider "bytebase" {
 }
 
 locals {
-  instance_id_test = "test-instance"
-  instance_id_prod = "prod-instance"
+  instance_id_test = "test-sample-instance"
+  instance_id_prod = "prod-sample-instance"
 }
 
 # List all instances in all environments

examples/projects/main.tf

@@ -19,7 +19,7 @@ provider "bytebase" {
 }
 
 locals {
-  project_id_test = "project-test"
+  project_id = "project-sample"
 }
 
 # List all projects
@@ -30,10 +30,10 @@ output "all_projects" {
 }
 
 # Find a specific project by name
-data "bytebase_project" "test_project" {
-  resource_id = local.project_id_test
+data "bytebase_project" "sample_project" {
+  resource_id = local.project_id
 }
 
-output "test_project" {
-  value = data.bytebase_project.test_project
+output "sample_project" {
+  value = data.bytebase_project.sample_project
 }

examples/roles/main.tf

@@ -19,15 +19,15 @@ provider "bytebase" {
 
 locals {
   role_name        = "role_test_terraform"
-  instance_id_test = "test-instance"
+  instance_id_test = "test-sample-instance"
 }
 
 # Find the instance
 data "bytebase_instance" "test" {
   resource_id = local.instance_id_test
 }
 
-# Find the role "role_test_terraform" in the instance "test-instance"
+# Find the role "role_test_terraform" in the instance "test-sample-instance"
 data "bytebase_instance_role" "test" {
   name     = local.role_name
   instance = data.bytebase_instance.test.resource_id
@@ -37,7 +37,7 @@ output "role" {
   value = data.bytebase_instance_role.test
 }
 
-# List all roles in the instance "test-instance"
+# List all roles in the instance "test-sample-instance"
 data "bytebase_instance_role_list" "all" {
   instance = data.bytebase_instance.test.resource_id
 }

examples/setup/README.md

@@ -6,5 +6,5 @@ We will create two environments named `dev` and `prod`. Each environment contain
 Before you start, please make sure you have running your Bytebase service and have created the service account, and replace the provider initial variables. Check the [README](../README.md) for details.
 
 1. Run `terraform init` to install the provider.
-2. Run `terraform plan` to check the changes.
-3. Run `terraform apply` to apply the changes.
+1. Run `terraform plan` to check the changes.
+1. Run `terraform apply` to apply the changes.

examples/setup/main.tf

@@ -17,13 +17,14 @@ provider "bytebase" {
   url = "https://bytebase.example.com"
 }
 
+# Correspond to the sample data Bytebase generates during onboarding.
 locals {
   environment_id_test = "test"
   environment_id_prod = "prod"
-  instance_id_test    = "test-instance"
-  instance_id_prod    = "prod-instance"
+  instance_id_test    = "test-sample-instance"
+  instance_id_prod    = "prod-sample-instance"
   role_name           = "role_test_terraform"
-  project_id_test     = "project-test"
+  project_id          = "project-sample"
 }
 
 # Create a new environment named "Test"
@@ -89,10 +90,10 @@ resource "bytebase_instance" "prod" {
   }
 }
 
-# Create a new role named "role_test_terraform" in the instance "test-instance"
+# Create a new role named "role_test_terraform" in the instance "test-sample-instance"
 resource "bytebase_instance_role" "test" {
   name     = local.role_name
-  instance = bytebase_instance.test.resource_id
+  instance = bytebase_instance.sample.resource_id
 
   password         = "123456"
   connection_limit = 10
@@ -110,10 +111,10 @@ resource "bytebase_instance_role" "test" {
 }
 
 # Create a new project
-resource "bytebase_project" "test_project" {
-  resource_id    = local.project_id_test
-  title          = "Test project"
-  key            = "BYT"
+resource "bytebase_project" "sample_project" {
+  resource_id    = local.project_id
+  title          = "Sample project"
+  key            = "SAM"
   workflow       = "UI"
   schema_version = "SEMANTIC"
   schema_change  = "DDL"

provider/data_source_database_role_list_test.go

@@ -10,7 +10,7 @@ import (
 )
 
 func TestAccInstanceRoleListDataSource(t *testing.T) {
-	instanceName := "test-instance"
+	instanceName := "test-sample-instance"
 	roleName := "test_role"
 	outputName := "role_list"
 	resourceName := fmt.Sprintf("data.bytebase_instance_role_list.%s", outputName)