Shipyard
latest
  • Sample Configuration File
  • Shipyard API
  • Action Commands
  • Shipyard CLI
  • Site Definition Documents
  • Shipyard Client User's Guide
  • Deployment Guide
  • Sample Policy File
  • Multiple Distro Support
Shipyard
  • »
  • Welcome to Shipyard's documentation!
  • View page source

Welcome to Shipyard's documentation!¶

Shipyard is a directed acyclic graph controller for Kubernetes and OpenStack control plane life-cycle management, and is part of the Airship platform.

  • Sample Configuration File
  • Shipyard API
    • Standards used by the API
    • Notes on examples
    • Document Staging API
    • Action API
    • Airflow Monitoring API
    • Site Statuses API
    • Logs Retrieval API
    • Notes Handling API
  • Action Commands
    • Example invocation
    • Supported actions
  • Shipyard CLI
    • Environment Variables
    • Shipyard command options
    • Commit Commands
    • Control commands
    • Create Commands
    • Describe Commands
    • Get Commands
    • Logs Commands
    • Help Commands
  • Site Definition Documents
    • Schemas
    • Deployment Configuration
    • Deployment Strategy
    • Using A Deployment Strategy
    • Deployment Version
  • Shipyard Client User's Guide
    • CLI Invocation Flow
    • Setup
    • Running Shipyard CLI with Docker Container
    • Use Case: Ingest Site Design
    • Use Case: Deploy Site
  • Deployment Guide
    • Deployment
    • Post Deployment
  • Sample Policy File
  • Multiple Distro Support
    • Adding New Distro Support

Building this Documentation¶

Use make docs or tox -e docs to generate these docs. This will and build an html version of this documentation that can be viewed using a browser at doc/build/index.html on the local filesystem.

Next

© Copyright 2017, Shipyard Authors Revision 99c2da74.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
Downloads
pdf
html
On Read the Docs
Project Home
Builds