Anthony Lin 77d962013f Move Shipyard Deployment Guide from .md to .rst

This patch set changes the shipyard deployment guide from
markdown to reStructuredText format. It also adds banners
to the other .rst document.

It seems that client set up using the current instructions with
Python 2.x was giving syntax errors when we try and execute the
Shipyard CLI. Hence, updates were also made to client_user_guide
to specify the usage of Python 3.x

Note that 'Drydock build' includes step that checks that the
nodes are deployed before starting 'Armada Build'. Hence we
are collapsing 'Drydock build' and 'Check deployed node status'
into a single step, i.e. 'Drydock build' instead.

Change-Id: Ie5f15b81d4dc89afb9c6800e7a181b02f2acabcc

2017-12-18 08:48:08 +00:00

2.5 KiB

Raw Blame History

Action Commands

Supported actions

These actions are currently supported using the Action API

deploy_site

Triggers the initial deployment of a site, using the latest committed configuration documents. Steps:

Concurrency check

Prevents concurrent site modifications by conflicting actions/workflows.
Preflight checks

Ensures all UCP components are in a responsive state.
Get design version

Uses Deckhand to discover the latest committed version of design for the site.
Validate design

Asks each involved UCP component to validate the design. This ensures that the previously committed design is valid at the present time.
Drydock build

Orchestrates the Drydock component to configure hardware and the Kubernetes environment (Drydock -> Promenade)
Armada build

Orchestrates Armada to configure software on the nodes as designed.

Actions under development

These actions are under active development

update_site

Triggers the initial deployment of a site, using the latest committed configuration documents. Steps: (a superset of deploy_site)

redeploy_server

Using parameters to indicate which server(s), triggers a redeployment of server to the last known good design and secrets

Future actions

These actions are anticipated for development

test region

Invoke site validation testing - perhaps baseline is a invocation of all components regular “component” tests. This test would be used as a preflight-style test to ensure all components are in a working state.
test component

Invoke a particular platform component to test it. This test would be used to interrogate a particular platform component to ensure it is in a working state, and that its own downstream dependencies are also operational

2.5 KiB Raw Blame History