Unfurl documentation

Welcome! This is the documentation for Unfurl.

Unfurl organizes your DevOps infrastructure into Git repositories and integrates with Terraform and Ansible. Use it to record Ensembles, reusable and sharable building blocks for deploying and managing your online creations.

Table of Contents

• Introduction
  • Our Vision
  • How it works
  • Features
• Installation
  • Requirements
  • Shell autocomplete
  • Developing
  • Running unit tests
  • Status and Caveats
  • Unfurl Cloud
  • Get Started
• Quick start
• Getting Started
  • 1. Configure your home environment
  • 2. Create a project
  • 3. Create a service template
  • 4. Implementing an operation
  • 5 Activate your ensemble
  • 6. Publish your project
• Ensembles
  • Repositories and History
  • Isolation and Reproducibility
  • URIs
  • Anatomy of a Manifest
• Unfurl Projects
  • Environments
  • External ensembles
  • Project defaults
  • Runtimes
• Managing Secrets
  • Sensitive Values
  • Creating secrets
• TOSCA
  • Introduction
  • Core TOSCA Concepts
  • Service Template
  • Entity Types
  • Topology Template
  • Node Template
  • Relationship Template
  • Complete Example
• Python alternative to YAML
  • Why a DSL (Domain Specic Language)?
  • Installation
  • Status
  • Examples
  • Usage
  • Safe Mode
  • API Documentation
• Repositories and Packages
  • Repositories
  • Packages
  • Package Resolution
  • Package identifiers
  • Locked ensembles
  • Package Rules
• Jobs and Workflows
  • Job Lifecycle
  • Operational status and state
  • ChangeIds
• Runtime Environment
  • Job Variables
  • Connections
  • Environment Variables
• Configurators
  • Ansible
  • Cmd
  • Delegate
  • Shell
  • Template
  • Terraform
• Installers
  • Docker
  • DNS
  • Helm
  • Kubernetes
  • Supervisor
• Template Processing
  • YAML Merge directives
  • Ansible Jinja2 Templates
  • Eval Expressions
• Expression Functions
  • TOSCA functions and other stand-alone functions
  • Expression Functions
  • Special keys
• Command Line
  • unfurl
• Configuration Files
  • Files
  • Sections
  • Definitions
• TOSCA Language Reference
  • Metadata
  • Repositories
  • Imports
  • Node Types
  • Data Types
  • Other Types
  • Topology Templates
  • Unfurl Specific
  • Type Definitions
• Glossary
  • Terminology from TOSCA
  • Unfurl specific
• Python API
  • API for writing service templates
  • API for writing configurators
  • APIs for controlling Unfurl
  • Utility classes and functions
• Changelog for Unfurl
  • v1.1.0 - 2024-4-02
  • v1.0.0 - 2024-2-26
  • v0.9.1 - 2023-10-25
  • v0.9.0 - Friday 10-13-23
  • 0.8.0 - 2023-07-26

Indices and tables

• Index

• Module Index

• Search Page