https://github.com/oceanbase/terraform-provider-oceanbase
Terraform provider for OceanBase based on MultiCloud APIs
https://github.com/oceanbase/terraform-provider-oceanbase
Last synced: 11 months ago
JSON representation
Terraform provider for OceanBase based on MultiCloud APIs
- Host: GitHub
- URL: https://github.com/oceanbase/terraform-provider-oceanbase
- Owner: oceanbase
- License: apache-2.0
- Created: 2025-02-18T06:21:39.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-25T03:18:53.000Z (about 1 year ago)
- Last Synced: 2025-03-25T04:23:05.858Z (about 1 year ago)
- Language: Go
- Homepage:
- Size: 326 KB
- Stars: 4
- Watchers: 7
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Terraform Provider for OceanBase
This provider allows user to manage OceanBase resources on cloud environment using terraform, it's based on OceanBase's [multi-cloud platform](https://console-cn.oceanbase.com) APIs.
## Requirements
Go 1.22 (to build the provider)
## Building The Provider
Run the following command to build the provider
```
make build
```
## Using the provider
First, configure the `.terraformrc` file under user's home directory, make sure to the real path where the binary located.
```
provider_installation {
dev_overrides {
"oceanbase.github.io/oceanbase/oceanbase" = "~/terraform-provider-oceanbase/bin"
}
# For all other providers, install them directly from their origin provider
# registries as normal. If you omit this, Terraform will _only_ use
# the dev_overrides block, and so no other providers will be available.
direct {}
}
```
You can refer to the following config to use the provider.
```
terraform {
required_providers {
oceanbase = {
source = "oceanbase.github.io/oceanbase/oceanbase"
}
}
}
provider "oceanbase" {
access_key = "access_key"
secret_key = "secret_key"
site = "CHINA" # CHINA or GLOBAL
}
```
For OceanBase related resources configurations, please refer to the files under example directory.