This is the repository for the Terraform MongoDB Atlas Provider, which allows one to use Terraform with MongoDB's Database as a Service offering, Atlas. Learn more about Atlas at https://www.mongodb.com/cloud/atlas
For general information about Terraform, visit the official website and the GitHub project page.
If you wish to work on the provider, you'll first need Go installed on your machine (please check the requirements before proceeding).
Note: This project uses Go Modules making it safe to work with it outside of your existing GOPATH. The instructions that follow assume a directory in your home directory outside of the standard GOPATH (i.e $HOME/development/terraform-providers/).
Clone repository to: $HOME/development/terraform-providers/
$ mkdir -p $HOME/development/terraform-providers/; cd $HOME/development/terraform-providers/
$ git clone git@github.com:mongodb/terraform-mongodbatlas
...
Enter the provider directory and run make tools. This will install the needed tools for the provider.
$ make tools
To compile the provider, run make build. This will build the provider and put the provider binary in the $GOPATH/bin directory.
$ make build
...
$ $GOPATH/bin/terraform-provider-mongodbatlas
...
To use a released provider in your Terraform environment, run terraform init and Terraform will automatically install the provider. To specify a particular provider version when installing released providers, see the Terraform documentation on provider versioning.
To instead use a custom-built provider in your Terraform environment (e.g. the provider binary from the build instructions above), follow the instructions to install it as a plugin. After placing it into your plugins directory, run terraform init to initialize it.
For either installation method, documentation about the provider specific configuration options can be found on the provider's website.
In order to test the provider, you can run make test. You need to generic provider arguments (e.g.
alias and version), the following arguments are supported in the MongoDB
Atlas provider block:
-
public_key- (Optional) This is the MongoDB Atlas API publick_key. It must be provided, but it can also be sourced from theMONGODB_ATLAS_PUBLIC_KEYenvironment variable. -
private_key- (Optional) This is the MongoDB Atlas private_key. It must be provided, but it can also be sourced from theMONGODB_ATLAS_PRIVATE_KEYenvironment variable.
You must also configure the MONGODB_ATLAS_PROJECT_ID and MONGODB_ATLAS_ORG_ID enviroment variables before make the test:
$ export MONGODB_ATLAS_PROJECT_ID=5cf5a45a9ccf6400e60981b6
$ export MONGODB_ATLAS_ORG_ID=5b71ff2f96e82120d0aaec14
Then you can run the test with:
$ make test
In order to run the full suite of Acceptance tests, run make testacc.
Note: Acceptance tests create real resources, and often cost money to run. Please note in any PRs made if you are unable to pay to run acceptance tests for your contribution. We will accept "best effort" implementations of acceptance tests in this case and run them for you on our side. This may delay the contribution but we do not want your contribution blocked by funding.
$ make testacc
For more information about how to get this programmatic API Keys see the following link.
Terraform is the work of thousands of contributors. We appreciate your help!
We welcome issues of all kinds including feature requests, bug reports, and general questions within this repo.
To contribute, please read the Terraform contribution guidelines: https://www.terraform.io/docs/extend/community/contributing.html
Note: Additional guidelines for this Provider may be added in a future CONTRIBUTING file.
If you have issues on GitHub, they are intended to be related to bugs or feature requests with provider codebase. See https://www.terraform.io/docs/extend/community/index.html for a list of community resources to ask questions about Terraform.
We'd like to thank Akshay Karle for writing the first version of a Terraform Provider for MongoDB Atlas and paving the way for the creation of this one.