diff --git a/Readme.md b/Readme.md index c03724f7..2a419879 100644 --- a/Readme.md +++ b/Readme.md @@ -12,7 +12,74 @@ - +* [cf-ops-automation (COA)](#cf-ops-automation-coa) + * [Table of Contents](#table-of-contents) + * [Introduction](#introduction) + * [Core principles](#core-principles) + * [Skills prereqs](#skills-prereqs) + * [Model Overview](#model-overview) + * [Sample deployment topology](#sample-deployment-topology) + * [Generated pipelines](#generated-pipelines) + * [singletons](#singletons) + * [per-root-deployment](#per-root-deployment) + * [Template engine reference documentation](#template-engine-reference-documentation) + * [Multi deployer support](#multi-deployer-support) + * [Bosh deployer](#bosh-deployer) + * [Concourse pipeline deployer](#concourse-pipeline-deployer) + * [Resource lifecycle overview](#resource-lifecycle-overview) + * [Bosh deployment resources template format](#bosh-deployment-resources-template-format) + * [Iaas specifics support](#iaas-specifics-support) + * [Terraform specific](#terraform-specific) + * [Bosh cli v2 specific features support](#bosh-cli-v2-specific-features-support) + * [ops-files](#ops-files) + * [vars-files](#vars-files) + * [Cloud and runtime config](#cloud-and-runtime-config) + * [git submodules](#git-submodules) + * [enable deployment format (enable-deployment.yml)](#enable-deployment-format-enable-deploymentyml) + * [deployment dependencies format (deployment-dependencies.yml)](#deployment-dependencies-format-deployment-dependenciesyml) + * [Cloudfoundry application resources template format](#cloudfoundry-application-resources-template-format) + * [pipeline auto-update](#pipeline-auto-update) + * [Concourse team](#concourse-team) + * [terraform](#terraform) + * [file format](#file-format) + * [delete lifecycle support](#delete-lifecycle-support) + * [bosh deployment](#bosh-deployment) + * [cf-app deployment](#cf-app-deployment) + * [shared and private configuration](#shared-and-private-configuration) + * ["paas-templates" and "secrets" repo structure examples](#paas-templates-and-secrets-repo-structure-examples) + * [Stemcell management](#stemcell-management) +* [COA development](#coa-development) + * [Status and roadmap](#status-and-roadmap) + * [Interns](#interns) + * [Running the Test Suite](#running-the-test-suite) + * [Generating pipelines locally and uploading a test version](#generating-pipelines-locally-and-uploading-a-test-version) + * [Local terraform development](#local-terraform-development) + * [Submitting Pull Requests](#submitting-pull-requests) + * [Releasing COA](#releasing-coa) + * [Standard release](#standard-release) + * [Hotfix release](#hotfix-release) + * [Bootstrapping a COA env](#bootstrapping-a-coa-env) + * [How to use it](#how-to-use-it) + * [Prerequisites](#prerequisites) + * [Connecting to Concourse](#connecting-to-concourse) + * [Known issues](#known-issues) + * [VMs access issues](#vms-access-issues) + * [Stemcell loading creates a timeout](#stemcell-loading-creates-a-timeout) + * [Some Concourse resource won't load](#some-concourse-resource-wont-load) +* [FAQ](#faq) + * [How to initialize a new bosh deployment template ?](#how-to-initialize-a-new-bosh-deployment-template-) + * [How to enable a bosh deployment template ?](#how-to-enable-a-bosh-deployment-template-) + * [How to upload a bosh release not available on bosh.io?](#how-to-upload-a-bosh-release-not-available-on-boshio) + * [How to generate a tfvars in json from a yaml template?](#how-to-generate-a-tfvars-in-json-from-a-yaml-template) + * [Sample](#sample) + * [How to bootstrap pipelines to a new concourse?](#how-to-bootstrap-pipelines-to-a-new-concourse) + * [pre requisite](#pre-requisite) + * [How to create a new root deployment?](#how-to-create-a-new-root-deployment) + * [pre requisite](#pre-requisite-1) +* [Credits](#credits) +* [Changelog](#changelog) +* [Upgrade](#upgrade) + * [pre requisite](#pre-requisite-2)