21. Architecture Reference

This section is intended to act as a reference to the internals of Digital Rebar for developers and power users.

• 21.1. Architecture Overview
  • 21.1.1. models
  • 21.1.2. api
  • 21.1.3. cli
  • 21.1.4. plugin
• 21.2. Data Architecture
  • 21.2.1. Provisioner Models
    • 21.2.1.1. Machine
    • 21.2.1.2. Cluster
    • 21.2.1.3. Resource Broker
    • 21.2.1.4. Param
    • 21.2.1.5. Profile
    • 21.2.1.6. BootEnv
    • 21.2.1.7. Template
      • 21.2.1.7.1. Sub-templates
        • 21.2.1.7.1.1. Update Digital Rebar Provisioner BootEnv
        • 21.2.1.7.1.2. Web Proxy
        • 21.2.1.7.1.3. Package Repositories
          • 21.2.1.7.1.3.1. The package-repositories Param
          • 21.2.1.7.1.3.2. Repo Object
          • 21.2.1.7.1.3.3. Expanding Package Repositories
          • 21.2.1.7.1.3.4. Local Repos
        • 21.2.1.7.1.4. Set Hostname
        • 21.2.1.7.1.5. Remote Root Access
        • 21.2.1.7.1.6. Digital Rebar Integration
  • 21.2.2. DHCP Models
    • 21.2.2.1. Subnet
    • 21.2.2.2. Pickers
    • 21.2.2.3. Reservation
    • 21.2.2.4. Lease
    • 21.2.2.5. Interface
  • 21.2.3. Additional Models
    • 21.2.3.1. User
    • 21.2.3.2. Identity Provider
    • 21.2.3.3. Prefs
  • 21.2.4. Special Objects
    • 21.2.4.1. Files
    • 21.2.4.2. Isos
• 21.3. Data Models
  • 21.3.1. Model Metadata
  • 21.3.2. Params.Meta has extra special behaviors in the UX
  • 21.3.3. Machines.Meta has extra special behaviors
  • 21.3.4. Model Validation
  • 21.3.5. Other Common Model Fields
• 21.4. Object.Meta
  • 21.4.1. Param.Meta Options for the UX
  • 21.4.2. Machine.Meta Options
  • 21.4.3. Cluster.Meta controls
  • 21.4.4. ResourceBroker.Meta controls
  • 21.4.5. Pipeline options
    • 21.4.5.1. Workflows.Meta
    • 21.4.5.2. Profiles.Meta
  • 21.4.6. Stages.Meta
  • 21.4.7. Tasks.Meta
  • 21.4.8. Blueprints.Meta
  • 21.4.9. WorkOrder.Meta
  • 21.4.10. Legacy & Non-Operational Meta
• 21.5. Authentication Models
  • 21.5.1. User
  • 21.5.2. Claim
  • 21.5.3. Role
  • 21.5.4. Tenants
• 21.6. How Authentication Works
  • 21.6.1. User Tokens
  • 21.6.2. Machine Tokens
  • 21.6.3. How Tokens Are Checked
• 21.7. Provisioning Models
  • 21.7.1. Template
  • 21.7.2. TemplateInfo
  • 21.7.3. Rendering Templates
  • 21.7.4. Param
    • 21.7.4.1. Secure Params
      • 21.7.4.1.1. Setting Secure Param Values
      • 21.7.4.1.2. Retrieving Decrypted Secure Data Values
  • 21.7.5. Task
    • 21.7.5.1. Rendering a Task for a Machine
    • 21.7.5.2. Template Prerequisite Expansion
  • 21.7.6. Task Control Operations
    • 21.7.6.1. Single Step
    • 21.7.6.2. Stop At
    • 21.7.6.3. Retry
    • 21.7.6.4. Error Handlers
    • 21.7.6.5. Parameter Conversion
  • 21.7.7. Profile
  • 21.7.8. Stage
    • 21.7.8.1. Rendering a Stage for a Machine
  • 21.7.9. Context
    • 21.7.9.1. Plugins that provide Engines
  • 21.7.10. BootEnv
    • 21.7.10.1. Rendering the unknownBootEnv
    • 21.7.10.2. Rendering a BootEnv for a Machine
    • 21.7.10.3. Customization using bootenv-customize
  • 21.7.11. Workflow
  • 21.7.12. Machine
  • 21.7.13. Cluster and Resource Broker
  • 21.7.14. Job
  • 21.7.15. Job Actions
• 21.8. Machine Matching (the Who Am I API)
  • 21.8.1. DRPCLI whoami
  • 21.8.2. Fingerprint Critieria
  • 21.8.3. Fingerprint Critieria
• 21.9. DHCP Models
  • 21.9.1. Interface
  • 21.9.2. DHCP Option
  • 21.9.3. Subnet
  • 21.9.4. Reservation
  • 21.9.5. Lease
• 21.10. Sledgehammer Overview
  • 21.10.1. Sledgehammer Build
  • 21.10.2. Sledgehammer Design
  • 21.10.3. How Sledgehammer Boots
  • 21.10.4. How Sledgehammer Identifies a Machine
    • 21.10.4.1. Using drpcli machines whoami
    • 21.10.4.2. Using the kernel command line
• 21.11. Universal Workflow Architecture
  • 21.11.1. Requirements
  • 21.11.2. Universal Application
  • 21.11.3. Layout
  • 21.11.4. Defaults and Overrides
  • 21.11.5. Workflow Chaining
• 21.12. Universal Hardware Architecture
  • 21.12.1. Functional Requirements
    • 21.12.1.1. Inventory Functions
      • 21.12.1.1.1. IPMI Inventory
      • 21.12.1.1.2. BIOS Inventory
      • 21.12.1.1.3. RAID Inventory
      • 21.12.1.1.4. Flash Inventory
    • 21.12.1.2. Configuration Functions
      • 21.12.1.2.1. IPMI Configuration
      • 21.12.1.2.2. IPMI Install Certificate
      • 21.12.1.2.3. BIOS Configuration
      • 21.12.1.2.4. RAID Configuration
      • 21.12.1.2.5. RAID Enabled Encryption
      • 21.12.1.2.6. Flash Update
    • 21.12.1.3. Baseline Functions
      • 21.12.1.3.1. IPMI Baseline
      • 21.12.1.3.2. BIOS Baseline
      • 21.12.1.3.3. RAID Baseline
      • 21.12.1.3.4. Flash Baseline
    • 21.12.1.4. Reset Functions
      • 21.12.1.4.1. IPMI Reset
      • 21.12.1.4.2. BIOS Reset
      • 21.12.1.4.3. RAID Reset
      • 21.12.1.4.4. Flash Reset
  • 21.12.2. Default Tooling
  • 21.12.3. Custom Tasks
  • 21.12.4. Generic Tool Runner
• 21.13. Workflow
  • 21.13.1. The Bits and Bobs
    • 21.13.1.1. Tasks
    • 21.13.1.2. Jobs
    • 21.13.1.3. Stages
    • 21.13.1.4. Machine Agent
    • 21.13.1.5. Change Stage Map (DEPRECATED)
    • 21.13.1.6. Workflows
  • 21.13.2. How They Work Together
    • 21.13.2.1. Machine Agent (client side)
      • 21.13.2.1.1. Reboot! Using Agent State Changes in Scripts
    • 21.13.2.2. idempotent behavior
    • 21.13.2.3. dr-provision (server side)
      • 21.13.2.3.1. Retrieving the next Job
      • 21.13.2.3.2. Changing the Workflow on a Machine
      • 21.13.2.3.3. Removing a Workflow from a Machine
      • 21.13.2.3.4. Changing the Stage on a Machine
      • 21.13.2.3.5. Resetting the CurrentTask index to -1
• 21.14. WorkOrders
  • 21.14.1. The Objects
    • 21.14.1.1. WorkOrders
      • 21.14.1.1.1. WorkOrder State
    • 21.14.1.2. Jobs
    • 21.14.1.3. Blueprint
    • 21.14.1.4. TriggerProvider
      • 21.14.1.4.1. CronTrigger
      • 21.14.1.4.2. EventTrigger
    • 21.14.1.5. Trigger
      • 21.14.1.5.1. Trigger Definition
      • 21.14.1.5.2. Trigger Scope
      • 21.14.1.5.3. Trigger Work Orders
  • 21.14.2. Execution Models
    • 21.14.2.1. Machine as Service
    • 21.14.2.2. Orchestrated Tasks
    • 21.14.2.3. CI/CD Pipelines
• 21.15. Runner State, Contexts, Reboots and BootEnvs
  • 21.15.1. Contexts
  • 21.15.2. Empty BootEnv
• 21.16. Content Packages
  • 21.16.1. Metadata
    • 21.16.1.1. Operational Fields
      • 21.16.1.1.1. Name
      • 21.16.1.1.2. Version
      • 21.16.1.1.3. RequiredFeatures
      • 21.16.1.1.4. Prerequisites
        • 21.16.1.1.4.1. Version Constraints
    • 21.16.1.2. Informational Fields
      • 21.16.1.2.1. Description
      • 21.16.1.2.2. Source
      • 21.16.1.2.3. Documentation
      • 21.16.1.2.4. DisplayName
      • 21.16.1.2.5. Icon
      • 21.16.1.2.6. Color
      • 21.16.1.2.7. Author
      • 21.16.1.2.8. License
      • 21.16.1.2.9. Copyright
      • 21.16.1.2.10. CodeSource
      • 21.16.1.2.11. Order
      • 21.16.1.2.12. Tags
      • 21.16.1.2.13. DocUrl
  • 21.16.2. Data
• 21.17. Clusters v4.8+
  • 21.17.1. Shared Data via Cluster Profile
  • 21.17.2. Adding Data to the Cluster Profile
  • 21.17.3. Resolving Potential Race Conditions via Atomic Updates with JSON PATCH
  • 21.17.4. Cluster Filter to Collect Members
  • 21.17.5. Starting Workflow on Cluster Members
  • 21.17.6. Working with Cluster Roles
• 21.18. Resource Brokers
• 21.19. Pooling Architecture
  • 21.19.1. Pool Functions
    • 21.19.1.1. Grouping by Pools
    • 21.19.1.2. Machine Allocation
    • 21.19.1.3. Machine Transitions
  • 21.19.2. Pool Implementation
    • 21.19.2.1. Machine Object
    • 21.19.2.2. Pool Object
• 21.20. Pipelines
  • 21.20.1. Building Universal Applications for DRP Pipelines
    • 21.20.1.1. What is a DRP Pipeline?
    • 21.20.1.2. Starting a Pipeline
  • 21.20.2. Creating a Minimal Universal Application
    • 21.20.2.1. Choosing a Universal Application Name
    • 21.20.2.2. Creating a Universal Application Profile
    • 21.20.2.3. Creating a Chain Map Entry
    • 21.20.2.4. Create Universal Workflow
    • 21.20.2.5. Test your Universal Workflow
    • 21.20.2.6. Add WORK to Your Workflow
    • 21.20.2.7. Adding Standardized Components
    • 21.20.2.8. Update the Workflow to include Standard Stages
    • 21.20.2.9. Add Stages and Params
  • 21.20.3. Clusters and Resource Brokers
    • 21.20.3.1. Create A Resource Broker
    • 21.20.3.2. Behind the Scenes: Terraform
    • 21.20.3.3. Behind the Scenes: Cloud Resource Profile
    • 21.20.3.4. Build a Cluster
    • 21.20.3.5. Behind the Scenes: Tracking Cluster Building
    • 21.20.3.6. Behind the Scenes: Building a Test Cluster with Context-Broker
    • 21.20.3.7. Behind the Scenes: Multiple Machine Types and Named Machines
    • 21.20.3.8. Resize the Cluster
    • 21.20.3.9. Destroy The Cluster
• 21.21. Manager Architecture
  • 21.21.1. Manager Hierarchy
  • 21.21.2. Manager Functions
    • 21.21.2.1. Single Pane of Glass
    • 21.21.2.2. Configuration Management
  • 21.21.3. Manager Implementation
    • 21.21.3.1. Endpoint Object
    • 21.21.3.2. VersionSet Object
• 21.22. Swagger UI