Merge pull request #9 from bytebase/chore/update

chore: update variables and release 0.0.3

Author: d-bytebase

.github/workflows/tests.yml

@@ -51,6 +51,6 @@ jobs:
           go test -v -cover ./...
         env:
           TF_ACC: '1'
-          BYTEBASE_USER_EMAIL: 'test_email'
-          BYTEBASE_USER_PASSWORD: 'test_pwd'
-          BYTEBASE_URL: 'test_url'
+          BYTEBASE_SERVICE_ACCOUNT: '[email protected]'
+          BYTEBASE_SERVICE_KEY: 'test_secret'
+          BYTEBASE_URL: 'https://bytebase.example.com'

README.md

@@ -32,8 +32,8 @@ air -c scripts/.air.toml
 # install the provider in your local machine
 cd terraform-provider-bytebase && make install
 
-# initial the terraform for your example
-# you may need to change the username and password
+# initialize the terraform for your example
+# you need to set the service_account and service_key to your own
 cd examples && terraform init
 
 # check the changes

VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

api/environment.go

@@ -13,7 +13,7 @@ type Environment struct {
 type EnvironmentCreate struct {
 	// Domain specific fields
 	Name  string `json:"name"`
-	Order *int   `json:"order,omitempty"`
+	Order int    `json:"order"`
 }
 
 // EnvironmentPatch is the API message for patching an environment.

docs/index.md

@@ -27,9 +27,9 @@ terraform {
 }
 
 provider "bytebase" {
-  email        = "<Your Bytebase account email>"
-  password     = "<Your Bytebase account password>"
-  bytebase_url = "<Your Bytebase OpenAPI URL>"
+  service_account = "<Your Bytebase service account email>"
+  service_key     = "<Your Bytebase service account key>"
+  url             = "<Your Bytebase external URL>"
 }
 ```
 
@@ -41,13 +41,60 @@ resource "bytebase_environment" "dev" {
 }
 ```
 
+```bash
+# install the provider
+terraform init
+
+# check changes
+terraform plan
+
+# apply changes
+terraform apply
+
+# remove resources
+terraform destory
+```
+
 You can check [examples](https://github.com/bytebase/terraform-provider-bytebase/blob/main/examples/main.tf) for more usage examples.
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Optional
 
-- `bytebase_url` (String) The OpenAPI URL for your Bytebase server. If not provided in the configuration, you must set the `BYTEBASE_URL` variable in the environment.
-- `email` (String) The Bytebase user account email. If not provided in the configuration, you must set the `BYTEBASE_USER_EMAIL` variable in the environment.
-- `password` (String, Sensitive) The Bytebase user account password. If not provided in the configuration, you must set the `BYTEBASE_USER_PASSWORD` variable in the environment.
+- `url`: Required. The [external URL](/docs/get-started/install/external-url) for your Bytebase server. Alternatively, you can set `BYTEBASE_URL` environment variable.
+- `service_account`: Required. The Bytebase service account email. The user must have **Owner** or **DBA** role. Alternatively, you can set `BYTEBASE_SERVICE_ACCOUNT` environment variable.
+- `service_key`: Required. The Bytebase service account key. Alternatively, you can set `BYTEBASE_SERVICE_KEY` environment variable.
+
+It's optional to provide these configuration through the provider:
+
+```terraform
+provider "bytebase" {
+  service_account = "<Your Bytebase service account email>"
+  service_key     = "<Your Bytebase service account key>"
+  url             = "<Your Bytebase external URL>"
+}
+```
+
+But you can also write them into the environment:
+
+```terraform
+# Configure the Bytebase Provider without options
+
+terraform {
+  required_providers {
+    bytebase = {
+      source = "bytebase/bytebase"
+      version = "0.0.3"
+    }
+  }
+}
+
+provider "bytebase" {}
+```
+
+```bash
+export BYTEBASE_URL=<Your Bytebase EXTERNAL URL> BYTEBASE_SERVICE_ACCOUNT=<Your Bytebase service account email> BYTEBASE_SERVICE_KEY=<Your Bytebase service account key>
+
+terraform init && terraform plan
+```

docs/resources/environment.md

@@ -15,7 +15,8 @@ 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"
+  name  = "dev"
+  order = 1
 }
 ```
 
@@ -27,13 +28,8 @@ You can check [examples](https://github.com/bytebase/terraform-provider-bytebase
 ### Required
 
 - `name` (String) The environment unique name.
-
-### Optional
-
 - `order` (Number) The environment sorting order.
 
 ### Read-Only
 
 - `id` (String) The ID of this resource.
-
-

examples/environments/main.tf

@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "0.0.2"
+      version = "0.0.3"
       source  = "terraform.local/bytebase/bytebase"
     }
   }

examples/instances/main.tf

@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "0.0.2"
+      version = "0.0.3"
       source  = "terraform.local/bytebase/bytebase"
     }
   }

examples/main.tf

@@ -1,31 +1,37 @@
 # This is an example for using Bytebase Terraform provider to manage your resource.
+# Docs: https://www.bytebase.com/docs/get-started/work-with-terraform/overview
 # To run this provider in your local machine,
 # 1. Run your Bytebase service, then you can access the OpenAPI via http://localhost:8080/v1
-# 2. Replace the email and password with your own Bytebase account
+# 2. Replace the service_account and service_key with your own Bytebase service account
 # 3. Run `make install` under terraform-provider-bytebase folder
 # 4. Run `cd examples && terraform init`
 # 5. Run `terraform plan` to check the changes
 # 6. Run `terraform apply` to apply the changes
 # 7. Run `terraform output` to find the outputs
 # 8. Run `terraform destory` to delete the test resources
 provider "bytebase" {
-  # You need to replace the email and password with your own Bytebase account.
-  email    = "[email protected]"
-  password = "ed"
-  # The source is only used in the local example.
-  bytebase_url = "http://localhost:8080/v1"
+  # You need to replace the account and key with your Bytebase service account.
+  service_account = "[email protected]"
+  service_key     = "bbs_qHX6CswQ1nMMELSCc2lk"
+  url             = "https://bytebase.example.com"
 }
 
 locals {
-  environment_name = "dev"
-  instance_name    = "dev instance"
+  environment_name_dev  = "dev"
+  environment_name_prod = "prod"
+  instance_name         = "dev instance"
 }
 
 # Create a new environment named "dev"
 resource "bytebase_environment" "dev" {
-  name = local.environment_name
-  # You can specific the environment order
-  # order = 1
+  name  = local.environment_name_dev
+  order = 0
+}
+
+# Create another environment named "prod"
+resource "bytebase_environment" "prod" {
+  name  = local.environment_name_prod
+  order = 1
 }
 
 # Print the new environment
@@ -56,7 +62,7 @@ output "dev_instance" {
 # import environments module and filter by environment name
 module "environment" {
   source           = "./environments"
-  environment_name = local.environment_name
+  environment_name = local.environment_name_dev
   # Make sure the module exec after the "dev" environment is created
   depends_on = [
     bytebase_environment.dev

examples/versions.tf

@@ -1,7 +1,7 @@
 terraform {
   required_providers {
     bytebase = {
-      version = "0.0.2"
+      version = "0.0.3"
       source  = "terraform.local/bytebase/bytebase"
     }
   }