https://github.com/infrablocks/terraform-mongodbatlas-project
A Terraform module for creating a project in a MongoDB Atlas organisation.
https://github.com/infrablocks/terraform-mongodbatlas-project
infrastructure mongodb mongodb-atlas terraform terraform-modules
Last synced: 6 months ago
JSON representation
A Terraform module for creating a project in a MongoDB Atlas organisation.
- Host: GitHub
- URL: https://github.com/infrablocks/terraform-mongodbatlas-project
- Owner: infrablocks
- License: mit
- Created: 2021-02-18T12:31:47.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T23:18:19.000Z (about 1 year ago)
- Last Synced: 2024-10-29T00:20:15.257Z (about 1 year ago)
- Topics: infrastructure, mongodb, mongodb-atlas, terraform, terraform-modules
- Language: Ruby
- Homepage:
- Size: 194 KB
- Stars: 3
- Watchers: 7
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Terraform MongoDB Atlas Project
===============================
[](https://circleci.com/gh/infrablocks/terraform-mongodbatlas-project)
A Terraform module for creating a project in a MongoDB Atlas organisation.
The MongoDB Atlas project consists of:
* TODO
Usage
-----
To use the module, include something like the following in your Terraform
configuration:
```hcl-terraform
module "mongodbatlas_project" {
source = "infrablocks/project/mongodbatlas"
version = "0.1.0"
}
```
See the
[Terraform registry entry](https://registry.terraform.io/modules/infrablocks/project/mongodbatlas/latest)
for more details.
### Inputs
| Name | Description | Default | Required |
|----------------------------------|-------------------------------------------------------------------------------|:-------------------:|:------------------------------------:|
### Outputs
| Name | Description |
|-----------------------------------------|-----------------------------------------------------------|
### Compatibility
This module is compatible with Terraform versions greater than or equal to
Terraform 1.0.
Development
-----------
### Machine Requirements
In order for the build to run correctly, a few tools will need to be installed
on your development machine:
* Ruby (3.1.1)
* Bundler
* git
* git-crypt
* gnupg
* direnv
* aws-vault
#### Mac OS X Setup
Installing the required tools is best managed by [homebrew](http://brew.sh).
To install homebrew:
```
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
```
Then, to install the required tools:
```
# ruby
brew install rbenv
brew install ruby-build
echo 'eval "$(rbenv init - bash)"' >> ~/.bash_profile
echo 'eval "$(rbenv init - zsh)"' >> ~/.zshrc
eval "$(rbenv init -)"
rbenv install 3.1.1
rbenv rehash
rbenv local 3.1.1
gem install bundler
# git, git-crypt, gnupg
brew install git
brew install git-crypt
brew install gnupg
# direnv
brew install direnv
echo "$(direnv hook bash)" >> ~/.bash_profile
echo "$(direnv hook zsh)" >> ~/.zshrc
eval "$(direnv hook $SHELL)"
direnv allow
```
### Running the build
To provision module infrastructure, run tests and then destroy that
infrastructure, execute:
```bash
./go
```
To provision the module contents:
```bash
./go deployment:root:provision[]
```
To destroy the module contents:
```bash
./go deployment:root:destroy[]
```
To destroy the module prerequisites:
```bash
./go deployment:prerequisites:destroy[]
```
Configuration parameters can be overridden via environment variables:
```bash
SEED=testing ./go
```
When a seed is provided via an environment variable, infrastructure will not be
destroyed at the end of test execution. This can be useful during development to
avoid lengthy provision and destroy cycles. To subsequently destroy the
infrastructure, execute again with `FORCE_DESTROY=true`.
### Common Tasks
#### Generating an SSH key pair
To generate an SSH key pair:
```
ssh-keygen -m PEM -t rsa -b 4096 -C integration-test@example.com -N '' -f config/secrets/keys/bastion/ssh
```
#### Generating a self-signed certificate
To generate a self signed certificate:
```
openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365
```
To decrypt the resulting key:
```
openssl rsa -in key.pem -out ssl.key
```
#### Add a git-crypt user
To adding a user to git-crypt using their GPG key:
```
gpg --import ~/path/xxxx.pub
git-crypt add-gpg-user --trusted GPG-USER-ID
```
#### Managing CircleCI keys
To encrypt a GPG key for use by CircleCI:
```bash
openssl aes-256-cbc \
-e \
-md sha1 \
-in ./config/secrets/ci/gpg.private \
-out ./.circleci/gpg.private.enc \
-k ""
```
To check decryption is working correctly:
```bash
openssl aes-256-cbc \
-d \
-md sha1 \
-in ./.circleci/gpg.private.enc \
-k ""
```
Contributing
------------
Bug reports and pull requests are welcome on GitHub at
https://github.com/infrablocks/terraform-mongodbatlas-project.
This project is intended to be a safe, welcoming space for collaboration, and
contributors are expected to adhere to the
[Contributor Covenant](http://contributor-covenant.org) code of conduct.
License
-------
The library is available as open source under the terms of the
[MIT License](http://opensource.org/licenses/MIT).