Using Deis¶

• Welcome
• Understanding Deis
  • Concepts
    • Twelve-Factor
    • Docker
    • CoreOS
    • Applications
    • Build, Release, Run
    • Backing Services
    • See Also
  • Architecture
    • System Diagram
    • Control Plane
    • Data Plane
    • Topologies
  • Components
    • Controller
    • Database
    • Cache
    • Builder
    • Registry
    • Logspout
    • Logger
    • Publisher
    • Router
    • Store
• Installing Deis
  • Quick Start
    • Get the Source
    • Generate SSH Key
    • Generate a New Discovery URL
    • Check System Requirements
    • Choose a Provider
    • Configure DNS
    • Install Deis Platform
  • System Requirements
    • Resources
    • Cluster size
    • Network
  • Amazon AWS
    • Install the AWS Command Line Interface
    • Configure aws-cli
    • Upload keys
    • Choose Number of Instances
    • Generate a New Discovery URL
    • Customize cloudformation.json
    • Launch into an existing VPC
    • Run the Provision Script
    • Remote IPs behind your ELB
    • Configure DNS
    • Install Deis Platform
    • CloudFormation Updates
  • Bare Metal
    • Check System Requirements
    • Generate SSH Key
    • Customize user-data
    • Install CoreOS to disk
    • Configure DNS
    • Install Deis Platform
    • Known Problems
  • DigitalOcean
    • Prerequisites
    • Check System Requirements
    • Generate SSH Key
    • Generate a New Discovery URL
    • Create CoreOS Droplets
    • Configure DNS
    • Apply Security Group Settings
    • Install Deis Platform
  • Engine Yard
  • Google Compute Engine
    • Prerequisites
    • Cloud Init
    • Launch Instances
    • Load Balancing
    • Configure DNS
    • Install Deis Platform
  • Linode
    • Prerequisites
    • Check System Requirements
    • Create Cloud Init
    • Provision Cluster
    • Apply Security Group Settings
    • Install Deis Platform
  • Microsoft Azure
    • Install Python and Azure SDK for Python
    • Generate Certificates
    • Upload Management Cert
    • Create CoreOS Cluster
    • Configure DNS
    • Install Deis Platform
  • OpenStack
    • Check System Requirements
    • Prerequisites
    • Configure OpenStack
    • Set up your keys
    • Upload a CoreOS image to Glance
    • Generate a New Discovery URL
    • Choose number of instances
    • Deis network settings
    • Run the provision script
    • Manually start the instances
    • Configure floating IPs
    • Deploy a load balancer
    • Configure DNS
    • Install Deis Platform
  • Vagrant
    • Install Prerequisites
    • Generate a New Discovery URL
    • Generate SSH Key
    • Boot CoreOS
    • Configure DNS
    • Install Deis Platform
  • Install deisctl
    • Run the Installer
    • Building from Source
  • Install the Deis Platform
• Using Deis
  • Install the Client
    • Install the Deis Client
    • Proxy Support
    • Integrated Help
    • Multiple Profile Support
  • Register a User
    • Register with a Controller
    • Upload Your SSH Public Key
    • Logout from a Controller
    • Login to a Controller
  • Deploy an Application
    • Supported Applications
    • Login to the Controller
    • Select a Build Process
  • Process Types and the Procfile
    • Process Types as Templates
    • Declaring Process Types
    • Deploying to Deis
    • Web vs Cmd Process Types
  • Using Buildpacks
    • Prepare an Application
    • Create an Application
    • Push to Deploy
    • Included Buildpacks
    • Using a Custom Buildpack
    • Using Private Repositories
  • Using Dockerfiles
    • Prepare an Application
    • Create an Application
    • Push to Deploy
  • Using Docker Images
    • Prepare an Application
    • Create an Application
    • Deploy the Application
  • Configure an Application
    • Configure the Application
    • Attach to Backing Services
    • Custom Domains
    • Custom Health Checks
    • Track Changes
    • Rollback the Application
  • Manage an Application
    • Scale the Application
    • Administer the Application
    • Share the Application
    • Troubleshoot the Application
    • Limit the Application
    • Isolate the Application
  • Application SSL Certificates
    • Overview
    • Acquire SSL Certificate
    • DNS and Domain Configuration
    • Attach the Certificate
    • Endpoint Details
    • Testing SSL
    • Remove Certificate
    • Troubleshooting
• Managing Deis
  • Adding/Removing Hosts
    • Inspecting health
    • Adding a node
    • Removing a node
  • Automatic Host Removal
  • Backing Up and Restoring Data
    • Setup
    • Backing up
    • Restoring
    • Tools
  • Configure DNS
    • Vagrant
    • Necessary DNS records
    • Using xip.io
  • Configure Load Balancers
    • AWS
    • Google Compute Engine
  • Disk Usage
    • Identifying low disk space
    • Recovering disk space
  • Operational tasks
    • Managing users
  • Platform logging
    • Application log drain
    • Routing host logs to a custom location
  • Platform monitoring
    • Tools
    • Monitoring services
  • Production deployments
    • Isolating etcd
    • Running Deis without Ceph
    • Preseeding containers
    • Review security considerations
    • Back up data
    • Change Registration Mode
    • Configure logging and monitoring
    • Enable TLS
  • Isolating etcd
    • cloud-config
  • Recovering Ceph quorum
  • Running Deis without Ceph
    • Requirements
    • Understanding component changes
    • Deploying the cluster
    • Upgrading Deis
  • Security considerations
    • Access to etcd
    • Application runtime segregation
    • Running Deis on Public Clouds
    • Router firewall
  • Installing SSL for the Platform
    • Installing SSL on a Load Balancer
    • Installing SSL on the Deis Routers
    • Redirecting traffic to HTTPS
  • Upgrading Deis
    • In-place Upgrade
    • Graceful Upgrade
    • Migration Upgrade
    • Upgrading CoreOS
  • Using a Proxy Server
    • Configuring before server launch
    • Configuring after server launch
• Troubleshooting Deis
  • Troubleshooting deis-store
    • Using store-admin
    • store-monitor
    • store-daemon
    • store-gateway
    • store-metadata
    • store-volume
  • Logging in to the cluster
  • Troubleshooting etcd
  • A deis-store component fails to start
  • Any component fails to start
  • Failed initializing SSH client
  • All the given peers are not reachable
  • Could not find unit template...
  • Other issues
• Customizing Deis
  • Choosing a Scheduler
    • Settings set by scheduler
    • Settings used by scheduler
    • Fleet Scheduler
    • Kubernetes Scheduler
    • Mesos with Marathon framework
    • Swarm Scheduler
  • CLI Plugins
  • Customizing builder
    • Dependencies
    • Settings set by builder
    • Settings used by builder
    • Using a custom builder image
  • Customizing cache
    • Dependencies
    • Settings set by cache
    • Settings used by cache
    • Using a custom cache image
  • Customizing controller
    • Dependencies
    • Settings set by controller
    • Settings used by controller
    • Using a custom controller image
    • Unit hostname
    • Changing the Registration Mode
    • Using a LDAP Auth
  • Customizing database
    • Dependencies
    • Settings set by database
    • Settings used by database
    • Using a custom database image
  • Customizing logger
    • Dependencies
    • Settings set by logger
    • Settings used by logger
    • Using a custom logger image
  • Customizing registry
    • Dependencies
    • Settings set by registry
    • Settings used by registry
    • Using a custom registry image
  • Customizing router
    • Dependencies
    • Settings set by router
    • Settings used by router
    • Using a custom router image
    • PROXY Protocol
  • Customizing store-daemon
    • Dependencies
    • Settings set by store-daemon
    • Settings used by store-daemon
    • Using a custom store-daemon image
  • Customizing store-gateway
    • Dependencies
    • Settings set by store-gateway
    • Settings used by store-gateway
    • Using a custom store-gateway image
  • Customizing store-metadata
    • Dependencies
    • Settings set by store-metadata
    • Settings used by store-metadata
    • Using a custom store-metadata image
  • Customizing store-monitor
    • Dependencies
    • Settings set by store-monitor
    • Settings used by store-monitor
    • Using a custom store-monitor image
• Roadmap
  • Planning Process
    • The Role of Maintainers
    • Open Roadmap
    • Contributing to the Roadmap
    • Release Milestones
    • Release Planning Meetings
    • Credits
  • Deis Roadmap
    • TTY Broker
    • Scheduling and Orchestration
    • Etcd 2
    • Monitoring & Telemetry
    • Production Hardening
    • Stateless Logger
    • Update Service
    • Deis Push
    • Networking v2
    • Service Broker
  • Release Schedule
    • Semantic Versioning
    • Patch Releases
    • Minor Releases
    • Major Releases
  • Release Checklist
    • Patch Release
    • Major or Minor Release
    • Any Release
    • Patch Release
    • Major or Minor Release
  • Test Plan
    • Identifier
    • References
    • Introduction
    • Test items
    • Features to be Tested
    • Features not to be Tested
    • Approach
    • Item Pass/Fail Criteria
    • Suspension Criteria and Resumption Requirements
    • Test Deliverables
    • Remaining Test Tasks
    • Environmental needs
    • Staffing and training needs
    • Responsibilities
    • Schedule
    • Risks and Contingencies
    • Approvals
• Contributing
  • Contributor Overview
    • File Bugs & Enhancements
    • Write Documentation
    • Contribute Code
    • Share your Experience
  • Design Documents
    • Goals
    • Contents
    • Approval
  • Development Environment
    • Prerequisites
    • Fork the Deis Repository
    • Build Deisctl
    • Configure SSH Tunneling for Deisctl
    • Install the Deis Client
    • Start Up a Development Cluster
    • Configure a Docker Registry
    • Initial Platform Build
    • Development Workflow
    • Test Your Changes
    • Useful Commands
    • Pull Requests
  • Testing Deis
    • Set Up the Environment
    • Run the Tests
    • Customize Test Runs
  • Submitting a Pull Request
    • Design Document
    • Single Issue
    • Include Tests
    • Include Docs
    • Code Standards
    • Commit Style
    • Merge Approval
  • Community
    • Open Source Bounties
  • Conduct
• Reference Guide
  • Usage
  • Terms
    • Controller
    • Scheduler
    • Application
    • Container
    • Config
    • Build
    • Release
    • Key
  • Creating a Self-Signed SSL Certificate
    • Prerequisites
    • Generate Private Key and Certificate Signing Request
    • Generate SSL Certificate
  • Client Reference
    • deis apps
    • deis auth
    • deis builds
    • deis config
    • deis domains
    • deis keys
    • deis limits
    • deis perms
    • deis pull
    • deis ps
    • deis releases
    • deis tags
  • Server Reference
    • api.admin
    • api.authentication
    • api.fields
    • api.middleware
    • api.models
    • api.permissions
    • api.routers
    • api.serializers
    • api.utils
    • api.views
    • api.viewsets
    • registry
    • scheduler
    • web
  • Controller API v1.0
    • Authentication
    • Applications
    • Containers
    • Configuration
    • Domains
    • Builds
    • Releases
    • Keys
    • Permissions
  • Controller API v1.1
    • What’s New
    • Authentication
    • Applications
    • Containers
    • Configuration
    • Domains
    • Builds
    • Releases
    • Keys
    • Permissions
  • Controller API v1.2
    • What’s New
    • Authentication
    • Applications
    • Certificates
    • Containers
    • Configuration
    • Domains
    • Builds
    • Releases
    • Keys
    • Permissions
  • Controller API v1.3
    • What’s New
    • Authentication
    • Applications
    • Certificates
    • Containers
    • Configuration
    • Domains
    • Builds
    • Releases
    • Keys
    • Permissions
    • Users
  • Controller API v1.4
    • What’s New
    • Authentication
    • Applications
    • Certificates
    • Containers
    • Configuration
    • Domains
    • Builds
    • Releases
    • Keys
    • Permissions
    • Users
  • Controller API v1.5
    • What’s New
    • Authentication
    • Applications
    • Certificates
    • Containers
    • Configuration
    • Domains
    • Builds
    • Releases
    • Keys
    • Permissions
    • Users
• FAQ