Examples

Working YAML examples for ApplyDocument resources used by matlas infra and comprehensive demonstrations of CLI functionality.

These examples demonstrate both ApplyDocument (recommended) and standalone YAML approaches. All examples include detailed comments explaining usage patterns and best practices.

Quick Start

Environment Variables Setup

Before running examples, set up required environment variables:

# Basic user passwords
export APP_USER_PASSWORD='StrongPass123!'
export APP_WRITER_PASSWORD='StrongPass123!'
export ANALYTICS_PASSWORD='StrongPass123!'
export DATABASE_ADMIN_PASSWORD='AdminPass123!'
export SERVICE_ACCOUNT_PASSWORD='ServicePass123!'

Basic Usage

# Validate any example
matlas infra validate -f examples/cluster-basic.yaml

# Preview changes before applying
matlas infra plan -f examples/users-basic.yaml

# Apply configuration safely
matlas infra apply -f examples/safe-operations-preserve-existing.yaml --preserve-existing

Example Categories

Discovery Examples

Convert existing Atlas resources to infrastructure-as-code format

Basic project discovery
Comprehensive discovery with databases

Cluster Examples

MongoDB cluster configurations for different environments

Basic development clusters
Production clusters with autoscaling
Multi-region configurations

User Management

Database user and authentication examples

Basic user creation
Scoped users for specific clusters
Password management patterns

Custom Roles

Granular permission management with custom database roles

Basic custom role definitions
Advanced permission patterns
Role inheritance examples

Network Access

IP allowlisting and network security configurations

IP address and CIDR rules
AWS security group integration
Temporary access patterns

Infrastructure Patterns

Complete infrastructure management workflows

Project-centric configurations
Safe operations with preserve-existing
Dependency management

Search & VPC

Advanced Atlas features

Atlas Search index configurations
VPC endpoint setups
Vector search for AI applications

Alerts & Monitoring

Atlas alert configurations for monitoring and notifications

Basic CPU and memory monitoring
Multi-channel notification setups (Email, Slack, PagerDuty)
Complex matcher and threshold patterns
Comprehensive alert configurations

Best Practices

ApplyDocument vs Standalone Files

ApplyDocument is recommended for most use cases as it provides dependency management, cross-resource validation, and atomic operations.

# ✅ Recommended: ApplyDocument with multiple resources
apiVersion: matlas.mongodb.com/v1
kind: ApplyDocument
metadata:
  name: my-infrastructure
resources:
  - kind: Cluster
    # ...
  - kind: DatabaseUser
    # ...

# ⚠️ Limited use: Standalone for simple scenarios only
apiVersion: matlas.mongodb.com/v1
kind: Cluster
metadata:
  name: simple-cluster
spec:
  # ...

Safety Patterns

Use --preserve-existing flag to protect existing resources
Always run matlas infra plan before apply
Use environment variables for sensitive data
Test with --dry-run for complex changes

Common Workflows

# 1. Discovery-driven development
matlas discover --project-id <id> --include-databases --output-file current.yaml

# 2. Modify the discovered configuration
vim current.yaml

# 3. Preview and apply changes
matlas infra diff -f current.yaml
matlas infra apply -f current.yaml --preserve-existing

YAML Kinds Reference - Complete reference for all resource types
Infrastructure Commands - plan, apply, diff, and destroy operations
Atlas Commands - Direct Atlas resource management
Database Commands - MongoDB database operations

For the complete source files, see the examples directory in the GitHub repository.