Couchbase Cloud Automation
Project description
Couch Formation 4.0.0
Toolset for running and managing Couchbase assets in the cloud.
Disclaimer
This package is NOT SUPPORTED BY COUCHBASE. The toolset is under active development, therefore features and functionality can change.
Prerequisites
- Python 3.8+
- Cloud CLI/SDKs
- Homebrew (for macOS)
Quick Start
Install (pip user local method):
pip install --user couchformation
export PATH=$(python -m site --user-base)/bin:$PATH
Install (virtual environment method):
Linux
Create virtual environment:
python -m venv couchformation
Activate virtual environment:
. couchformation/bin/activate
Install Couch Formation into the virtual environment:
pip install couchformation
Activate Windows virtual environment using cmd
couchformation\Scripts\activate.bat
Active Windows virtual environment using PowerShell
couchformation\Scripts\Activate.ps1
Install directly from GitHub repo:
pip install --user git+https://github.com/couchbaselabs/couch-formation-core
Basic example
Configure and deploy a Couchbase Server cluster:
cloudmgr create --build cbs --cloud gcp --project test-gcp --name test-cluster --region us-central1 --quantity 3 --os_id ubuntu --os_version 22.04 --ssh_key /Users/jdoe/.ssh/jdoe-default-key-pair.pem --machine_type 4x16
Deploy the project:
cloudmgr deploy --project test-gcp
MDS example
Create the initial service group:
cloudmgr create --build cbs --cloud aws --project dev01 --name testdb01 --region us-east-2 --quantity 3 --os_id ubuntu --os_version 22.04 --ssh_key /Users/jdoe/.ssh/jdoe-default-key-pair.pem --machine_type 8x32
Add a second service group:
cloudmgr add --build cbs --cloud aws --project dev01 --name testdb01 --region us-east-2 --quantity 2 --os_id ubuntu --os_version 22.04 --ssh_key /Users/jdoe/.ssh/jdoe-default-key-pair.pem --machine_type 8x32 --services analytics
Multiservice project example
Configure a 3 node Couchbase Server cluster in US Ease, another 3 node Couchbase Server cluster in US West, plus a Linux generic node and a Windows generic node to run an application.
cloudmgr create --build cbs --cloud aws --project dev01 --name source01 --region us-east-2 --quantity 3 --os_id ubuntu --os_version 22.04 --ssh_key /Users/jdoe/.ssh/jdoe-default-key-pair.pem --machine_type 8x32
cloudmgr create --build cbs --cloud aws --project dev01 --name target01 --region us-west-2 --quantity 3 --os_id ubuntu --os_version 22.04 --ssh_key /Users/jdoe/.ssh/jdoe-default-key-pair.pem --machine_type 8x32
cloudmgr create --build generic --cloud aws --project dev01 --name app01 --region us-east-2 --quantity 1 --os_id ubuntu --os_version 22.04 --ssh_key /Users/jdoe/.ssh/jdoe-default-key-pair.pem --machine_type 8x32
cloudmgr create --build generic --cloud aws --project dev01 --name app02 --region us-east-2 --quantity 1 --os_id windows --os_version 2022 --ssh_key /Users/jdoe/.ssh/jdoe-default-key-pair.pem --machine_type 8x32
Providing tags in AWS
cloudmgr create --build cbs --cloud aws --project test-db --name testdb --region us-east-1 --auth_mode sso --ssh_key /Users/jdoe/.ssh/jdoe-default-key-pair.pem --os_id ubuntu --os_version 22.04 --machine_type 8x32 --quantity 3 --tags user:john.doe@example.com
Custom services example
cloudmgr create --build cbs --cloud aws --project eventing --name eventing01 --region us-east-2 --quantity 3 --os_id ubuntu --os_version 22.04 --ssh_key /Users/jdoe/.ssh/jdoe-default-key-pair.pem --machine_type 8x32 --services data,index,query,eventing
Sync Gateway example
Create the Couchbase Server cluster:
cloudmgr create --build cbs --cloud aws --project sgw-dev01 --name devdb01 --region us-east-2 --quantity 3 --os_id ubuntu --os_version 22.04 --ssh_key /Users/jdoe/.ssh/jdoe-default-key-pair.pem --machine_type 4x16
Create a Sync Gateway and connect to the cluster:
cloudmgr create --build sgw --cloud aws --project sgw-dev01 --name gateway --region us-east-2 --quantity 1 --os_id ubuntu --os_version 22.04 --ssh_key /Users/jdoe/.ssh/jdoe-default-key-pair.pem --machine_type 4x16 --connect devdb01
Capella example
For Capella the Couch Formation project aligns with the Capella project.
cloudmgr create --build capella --cloud capella --project test-project --name test-cluster --profile pytest --region us-east-2 --quantity 3 --provider aws --machine_type 4x16
Optionally create an app service (Sync Gateway in Capella) and attach it to a Capella database.
cloudmgr create --build capella --cloud capella --project test-project --name test-app-svc --profile pytest --quantity 2 --machine_type 4x8 --type mobile --connect test-cluster
Columnar example
cloudmgr create --build columnar --cloud capella --project test-project --name test-cluster --profile pytest --provider aws --region us-east-1 --machine_type 4x32 --quantity 1
Capella automatic peering
Use the --peer_project
argument to provide a project for peering:
cloudmgr create --build capella --cloud capella --project test-capella --name testdb --profile test --provider aws --region us-east-1 --cidr 10.12.4.0/23 --machine_type 8x32 --quantity 3 --peer_project test-node
Deploy the peer project (if not already deployed):
cloudmgr deploy --project test-node
Then deploy the Capella project:
cloudmgr deploy --project test-capella
NOTE: Automatic peering is only supported with AWS and GCP.
Additional commands
Destroy a project:
cloudmgr destroy --project dev01
List node details (including IP addresses and generated passwords):
cloudmgr list --project dev01
Operate on only one service in a project:
cloudmgr deploy --project dev01 --name source01
List all projects and services:
cloudmgr list
Display detailed information about configured services in a project:
cloudmgr show --project dev01
Recall the CLI commands that were used to add services to a project (you can use this to copy and paste to create a new project):
cloudmgr cli --project dev01
Change the values for parameters in a previously created service:
cloudmgr update --project dev01 --name node --machine_type 8x32
Change the values for parameters for a service node group:
cloudmgr update --project dev01 --name testdb --group 2 --machine_type 4x16
AWS SSO Support
Setup AWS CLI SSO:
aws configure sso
SSO Integration:
Use the auth_mode option to enable SSO integration. Couch Formation will open a browser for you to complete the SSO process, or you will have to paste the link provided into a browser to continue.
cloudmgr create --build cbs --cloud aws --project dev01 --name testdb01 --auth_mode sso --region us-east-2 --quantity 3 --os_id ubuntu --os_version 22.04 --ssh_key /Users/jdoe/.ssh/jdoe-default-key-pair.pem --machine_type 8x32
AWS Default Authentication
Configure the AWS CLI via an appropriate method based on your IAM settings. For example use aws configure
to configure long term credentials, or manually set the access parameters in .aws/credentials
or with environment variables. Couch Formation accepts an optional --profile
service configuration parameter to use a specific auth profile. Check here for more information.
GCP Default Authentication
For Google Cloud use gcloud auth application-default login
to configure CLI access. Check here for more information.
Azure Default Authentication
For Azure use az login
to configure CLI access. Check here for more information.
Capella Support
The automation for Capella uses the v4 public API. To use the automation, set the capella.token
and capella.user
configuration parameters.
cloudmgr config set capella.token dGhpcyBpcyBhIHNhbXBsZSBzdHJpbmcgZm9yIFJFQURNRS5tZC4uCg==
cloudmgr config set capella.user john.doe@example.com
By default, the Couch Formation project is used as the Capella project. To use a different Capella project, set the capella.project
parameter.
cloudmgr config set capella.project my-project
Windows
Download and install a 64-bit version of Python 3.8+ from here. Use the Run as Administrator
option to start PowerShell and then install Couch Formation with pip
. Once the installation is complete, it will be available for all users (launch a PowerShell window as your login user to use Couch Formation). You should install the wheel
pacakge before you install Couch Formation.
pip3 install wheel
pip3 install couchformation
Configuration Parameters
Parameter | Description |
---|---|
capella.token | Capella API token |
capella.user | Capella user email address |
capella.user.id | Capella user ID |
capella.project | Capella project |
Operating System Information
ID | Operating System | Versions | AWS User | GCP User | Azure User |
---|---|---|---|---|---|
amzn | Amazon Linux | 2, 2023 | ec2-user | N/A | N/A |
rhel | Red Hat Enterprise Linux | 8, 9 | ec2-user | admin | rhel |
centos | CentOS | 8 | centos | centos | centos |
ol | Oracle Linux | 8, 9 | ec2-user | N/A | N/A |
rocky | Rocky Linux | 8, 9 | rocky | rocky | N/A |
fedora | Fedora | 34 | core | fedora | N/A |
sles | SUSE Linux | 12, 15 | ec2-user | admin | sles |
opensuse-leap | openSUSE | 15 | ec2-user | admin | sles |
ubuntu | Ubuntu Linux | 20.04, 22.04 | ubuntu | ubuntu | ubuntu |
debian | Debian Linux | 10, 11 | admin | admin | debian |
windows | Windows Server | 2019, 2022 | Administrator | adminuser | adminuser |
macos | macOS | 13, 14 | ec2-user | N/A | N/A |
Build Types
Build Type | Description |
---|---|
cbs | Couchbase Server |
cbscert | Couchbase Server with cert auth |
cbsc | Couchbase Community Edition |
sgw | Sync Gateway |
capella | Capella Database |
columnar | Capella Columnar |
generic | Base configured node from image |
database | Generic database node |
windev | Windows development host |
Troubleshooting
Log files are written to .config/couch-formation/log
.
To create a support bundle with diagnostic information, use the dump
command.
cloudmgr dump
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file couchformation-4.0.0.tar.gz
.
File metadata
- Download URL: couchformation-4.0.0.tar.gz
- Upload date:
- Size: 115.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.12.7 Darwin/24.0.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 50541ddb947e63a10e4a2247818d417dba935c4b7c5408a19f34dedc470a8791 |
|
MD5 | 1ef84392967f55ff910c492104cc57fd |
|
BLAKE2b-256 | 186ab119e8be6161063ea34359226891e72153096d2bf138520bbab996d826f8 |
File details
Details for the file couchformation-4.0.0-py3-none-any.whl
.
File metadata
- Download URL: couchformation-4.0.0-py3-none-any.whl
- Upload date:
- Size: 156.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.12.7 Darwin/24.0.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c8a850b4bd3f192ca2f17cbb86413daeb1a763190ffe80a151485afd48c3424a |
|
MD5 | 35e7300e94a55a3e90d93db46951e4dc |
|
BLAKE2b-256 | c0f9d895024dae2e2a0d7f33cf3344b9fbff427f543bc6859a91a36ea9e7a8b2 |