How newrelic-experimental/deployer works
Project Type and Purpose
• This is an open-source, multi-cloud deployment and orchestration CLI tool (Ruby) that manages configuration, validation, templating, provisioning, deployment, instrumentation, installation, teardown, and summary across AWS, Azure, and GCP.
• The core value is a pluggable, provider-agnostic orchestration engine with built-in validators and template generators.
Main Architectural Components
A. CLI Layer
• main.rb, batch.rb, Rakefile
• Command-line parser & dispatcher (src/command_line, src/batch/command_line)
B. Configuration Layer
• User config loader & validator (src/user_config)
• Application config loader & validator (src/app_config)
• Static templates & credentials (configs/)
C. Core Orchestrator
• src/orchestrator.rb, src/configuration_orchestrator.rb
• Dispatches execution to each domain orchestrator
D. Domain Modules (each with: orchestrator, provider interface, validators)
1. services (src/services)
2. deployment (src/deployment)
3. infrastructure (src/infrastructure)
4. install (src/install)
5. instrumentation (src/instrumentation)
6. provision (src/provision)
7. teardown (src/teardown)
8. summary (src/summary)
9. tags (src/tags)
E. Common Utilities
• Logging, I/O, YAML/JSON parsing (src/common)
• Template merging engine (src/common/template_merger)
• Ansible integration (src/common/ansible)
F. Cloud Provider Adapters
• AWS, Azure, GCP implementations under each domain module
• Template builders & contexts (src/provision/templates)
G. External Services
• Cloud APIs (AWS SDK, Azure SDK, GCP SDK)
• Git (repo cloning, versioning)
• Ansible (playbooks via common/ansible)
H. Tests & Documentation
• Comprehensive unit/integration tests (tests/, user_acceptance_tests/)
• On-repo documentation (documentation/)
Interactions & Data Flow
2. Parser → Core Orchestrator → Configuration Orchestrator (blue)
a. services → defines service metadata
b. deployment → validates and transforms deployment settings
c. infrastructure → generates resource definitions
d. install → builds instrumentation/install definitions
e. instrumentation → injects instrumentor metadata
f. provision → uses Template Engine to generate cloud-specific templates
g. teardown → similar flow removing resources
h. summary/tags → composes output JSON or logs
5. Throughout, Common Utilities (purple) provide I/O, logging, YAML/JSON, Git, Ansible calls.
Architectural Patterns & Design Principles
• Orchestrator Pattern: each domain has an orchestrator + sub-orchestrators
• Provider/Strategy Pattern: pluggable cloud-specific adapters implementing uniform interfaces
• Validator Chain: configurable validators per domain and provider
• Template-Driven Provisioning: ERB and Jinja2 templates, context builders
• Single Responsibility & Separation of Concerns: config, domain logic, templating, CLI, utilities