f8fb44b7a0
We will need to provide distinctive/unique step_id/step_name in order to make use of the Shipyard logs API/CLI. It is found during testing that 'deckhand_get_design_version' is used as both the name of the subdag as well as 'task_id' [0]. As such, we will only be able to retrieve the logs of the subdag when we run a query with step_id as 'deckhand_get_design_version'. This is an issue and hence we will change the name of the subdag so that it is different from the task_id. In this way we will be retrieve the logs for the subdag as well as the task. [0] Current output of describe step (note the name of the steps in failed state): Steps Index State step/01CAYXMTK1ECXBK0SF4MQBYEND/action_xcom 1 success step/01CAYXMTK1ECXBK0SF4MQBYEND/dag_concurrency_check 2 success step/01CAYXMTK1ECXBK0SF4MQBYEND/preflight 3 success step/01CAYXMTK1ECXBK0SF4MQBYEND/deckhand_get_design_version 4 failed step/01CAYXMTK1ECXBK0SF4MQBYEND/dag_deployment_configuration 5 upstream_failed step/01CAYXMTK1ECXBK0SF4MQBYEND/validate_site_design 6 upstream_failed step/01CAYXMTK1ECXBK0SF4MQBYEND/deckhand_get_design_version 7 failed step/01CAYXMTK1ECXBK0SF4MQBYEND/drydock_build 8 upstream_failed step/01CAYXMTK1ECXBK0SF4MQBYEND/ucp_preflight_check 9 success step/01CAYXMTK1ECXBK0SF4MQBYEND/k8s_preflight_check 10 success step/01CAYXMTK1ECXBK0SF4MQBYEND/shipyard_retrieve_rendered_doc 11 upstream_failed step/01CAYXMTK1ECXBK0SF4MQBYEND/armada_build 12 upstream_failed Change-Id: I191cb8509c8d3d8e63f539b25c1693e9b8794aac
Shipyard
Shipyard is the directed acyclic graph controller for Kubernetes and OpenStack control plane life cycle management, and a component of the Undercloud Platform (UCP).
Shipyard provides the entrypoint for the following aspects of the control plane established by the UCP:
- Designs and Secrets
-
Site designs, including the configuration of bare metal host
nodes, network design, operating systems, Kubernetes nodes,
Armada manifests, Helm charts, and any other descriptors that
define the build out of a group of servers enter the UCP via
Shipyard. Secrets, such as passwords and certificates use the
same mechanism.
The designs and secrets are stored in UCP's Deckhand, providing for version history and secure storage among other document-based conveniences. - Actions
- Interaction with the site's control plane is done via invocation of actions in Shipyard. Each action is backed by a workflow implemented as a directed acyclic graph (DAG) that runs using Apache Airflow. Shipyard provides a mechanism to monitor and control the execution of the workflow.
Find more documentation for Shipyard on Read the Docs
Integration Points:
OpenStack Identity (Keystone)
provides authentication and support for role based authorization
Apache Airflow provides the
framework and automation of workflows provided by Shipyard
PostgreSQL is used to persist
information to correlate workflows with users and history of workflow
commands
Deckhand supplies storage
and management of site designs and secrets
Drydock is orchestrated by
Shipyard to perform bare metal node provisioning
Promenade is indirectly
orchestrated by Shipyard to configure and join Kubernetes nodes
Armada is orchestrated by
Shipyard to deploy and test Kubernetes workloads
Getting Started:
Shipyard @ Gerrithub
Helm chart