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
  • Why use Unfurl?
  • How it works
  • Our Vision
  • Features
• Installation
  • Requirements
  • Shell autocomplete
  • Development
  • Running unit tests
  • Status and Caveats
  • Unfurl Cloud
  • Get Started
• Quick start
  • Step 1 Create a project
  • Step 2: Describe your application
  • Step 3 Instantiate your blueprint
  • Step 4. Deploy and manage
  • Step 5. Share and Collaborate
• Solution Overview
  • Step 1: Create an Unfurl Project
  • Step 2: Create a cloud blueprint
  • Step 3: Instantiate your blueprint
  • Step 4: Deploy and manage
  • Step 5: Share and Collaborate
• Unfurl Projects
  • Introduction
  • Project files
  • Git Repositories
  • Environments
  • External ensembles
  • Creating projects
  • Publishing your project
  • Cloning projects and ensembles
  • Browser-based Admin User Interface
  • Unfurl Home
  • Execution Runtime
• Ensembles
  • Anatomy of a Manifest
  • Repositories and History
  • Isolation and Reproducibility
  • URIs
• Jobs and Workflows
  • Job Lifecycle
  • Generated Files
  • Updating a deployment
  • Undeploy (teardown)
  • Resource Discovery
  • Checking resources
  • Ad-hoc Jobs
  • Locking
  • Operational status and state
• TOSCA
  • Introduction
  • Core TOSCA Concepts
  • Service Template
  • Types
  • Topology Template
  • Deployment blueprints
  • Node Template
  • Requirements and Relationships
  • Artifacts
  • Interfaces and Operations
  • Complete Example
• TOSCA as Python
  • Why a DSL (Domain Specic Language)?
  • Installation
  • Status
  • Examples
  • Usage
  • Safe Mode
  • API Documentation
• TOSCA Language Reference
  • Metadata
  • Repositories
  • Imports
  • Node Types
  • Data Types
  • Other Types
  • Topology Templates
  • Unfurl Specific
  • Type Definitions
• Repositories and Packages
  • Repositories
  • Packages
  • Package Resolution
  • Package identifiers
  • Locked ensembles
  • Package Rules
• Managing Secrets
  • Sensitive Values
  • Creating secrets
• Runtime Environment
  • Job Variables
  • Connections
  • Environment Variables
  • Topology Inputs
• 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
• Cloud Maps
  • Key Concepts
  • How To…
  • Configuration
  • Anatomy of a cloud map
  • Future directions
• Command Line
  • unfurl
• Configuration Files
  • Files
  • Sections
  • 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