9b3cd66156
This adds the Shipyard workflow for the new relabel_nodes action. Related changes are https://review.openstack.org/593609 (Drydock) and https://review.openstack.org/584925 (Promenade). Change-Id: I2881199c1622e873b5fc3e948231bacd10a1beba
189 lines
7.2 KiB
Python
189 lines
7.2 KiB
Python
# Copyright 2017 AT&T Intellectual Property. All other rights reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
"""Deployment Configuration
|
|
|
|
Retrieves the deployment configuration from Deckhand and places the values
|
|
retrieved into a dictionary
|
|
"""
|
|
import logging
|
|
|
|
from airflow.exceptions import AirflowException
|
|
from airflow.models import BaseOperator
|
|
from airflow.plugins_manager import AirflowPlugin
|
|
from airflow.utils.decorators import apply_defaults
|
|
|
|
try:
|
|
from deckhand_client_factory import DeckhandClientFactory
|
|
except ImportError:
|
|
from shipyard_airflow.plugins.deckhand_client_factory import (
|
|
DeckhandClientFactory
|
|
)
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
class DeploymentConfigurationOperator(BaseOperator):
|
|
"""Deployment Configuration Operator
|
|
|
|
Retrieve the deployment configuration from Deckhand for use throughout
|
|
the workflow. Put the configuration into a dictionary.
|
|
|
|
Failures are raised:
|
|
- when Deckhand cannot be contacted
|
|
- when the DeploymentConfiguration (deployment-configuration) document
|
|
cannot be retrieved
|
|
"""
|
|
config_keys_defaults = {
|
|
"physical_provisioner.deployment_strategy": None,
|
|
"physical_provisioner.deploy_interval": 30,
|
|
"physical_provisioner.deploy_timeout": 3600,
|
|
"physical_provisioner.destroy_interval": 30,
|
|
"physical_provisioner.destroy_timeout": 900,
|
|
"physical_provisioner.join_wait": 120,
|
|
"physical_provisioner.prepare_node_interval": 30,
|
|
"physical_provisioner.prepare_node_timeout": 1800,
|
|
"physical_provisioner.prepare_site_interval": 10,
|
|
"physical_provisioner.prepare_site_timeout": 300,
|
|
"physical_provisioner.verify_interval": 10,
|
|
"physical_provisioner.verify_timeout": 60,
|
|
"physical_provisioner.relabel_nodes_interval": 30,
|
|
"physical_provisioner.relabel_nodes_timeout": 900,
|
|
"kubernetes.node_status_interval": 30,
|
|
"kubernetes.node_status_timeout": 1800,
|
|
"kubernetes_provisioner.drain_timeout": 3600,
|
|
"kubernetes_provisioner.drain_grace_period": 1800,
|
|
"kubernetes_provisioner.clear_labels_timeout": 1800,
|
|
"kubernetes_provisioner.remove_etcd_timeout": 1800,
|
|
"kubernetes_provisioner.etcd_ready_timeout": 600,
|
|
"armada.get_releases_timeout": 300,
|
|
"armada.get_status_timeout": 300,
|
|
"armada.manifest": "full-site",
|
|
"armada.post_apply_timeout": 2700,
|
|
"armada.validate_design_timeout": 600
|
|
}
|
|
|
|
@apply_defaults
|
|
def __init__(self,
|
|
main_dag_name=None,
|
|
shipyard_conf=None,
|
|
*args, **kwargs):
|
|
"""Deployment Configuration Operator
|
|
|
|
Generate a DeploymentConfigurationOperator to read the deployment's
|
|
configuration for use by other operators
|
|
|
|
:param main_dag_name: Parent Dag
|
|
:param shipyard_conf: Location of shipyard.conf
|
|
"""
|
|
|
|
super(DeploymentConfigurationOperator, self).__init__(*args, **kwargs)
|
|
self.main_dag_name = main_dag_name
|
|
self.shipyard_conf = shipyard_conf
|
|
|
|
def execute(self, context):
|
|
"""Perform Deployment Configuration extraction"""
|
|
|
|
revision_id = self.get_revision_id(context.get('task_instance'))
|
|
doc = self.get_doc(revision_id)
|
|
converted = self.map_config_keys(doc)
|
|
# return the mapped configuration so that it can be placed on xcom
|
|
return converted
|
|
|
|
def get_revision_id(self, task_instance):
|
|
"""Get the revision id from xcom"""
|
|
if task_instance:
|
|
LOG.debug("task_instance found, extracting design version")
|
|
# Set the revision_id to the revision on the xcom
|
|
action_info = task_instance.xcom_pull(
|
|
task_ids='action_xcom',
|
|
dag_id=self.main_dag_name,
|
|
key='action')
|
|
|
|
revision_id = action_info['committed_rev_id']
|
|
|
|
if revision_id:
|
|
LOG.info("Revision is set to: %s for deployment configuration",
|
|
revision_id)
|
|
return revision_id
|
|
# either revision id was not on xcom, or the task_instance is messed
|
|
raise AirflowException(
|
|
"Design_revision is not set. Cannot proceed with retrieval of"
|
|
" the design configuration"
|
|
)
|
|
|
|
def get_doc(self, revision_id):
|
|
"""Get the DeploymentConfiguration document dictionary from Deckhand"""
|
|
LOG.info(
|
|
"Attempting to retrieve shipyard/DeploymentConfiguration/v1, "
|
|
"deployment-configuration from Deckhand"
|
|
)
|
|
filters = {
|
|
"schema": "shipyard/DeploymentConfiguration/v1",
|
|
"metadata.name": "deployment-configuration"
|
|
}
|
|
try:
|
|
dhclient = DeckhandClientFactory(self.shipyard_conf).get_client()
|
|
LOG.info("Deckhand Client acquired")
|
|
doc = dhclient.revisions.documents(revision_id,
|
|
rendered=True,
|
|
**filters)
|
|
except Exception as ex:
|
|
try:
|
|
failed_url = ex.url
|
|
except AttributeError:
|
|
failed_url = "No URL generated"
|
|
LOG.exception(ex)
|
|
raise AirflowException("Failed to retrieve deployment "
|
|
"configuration yaml using url: "
|
|
"{}".format(failed_url))
|
|
|
|
if len(doc) == 1 and doc[0].data:
|
|
doc_dict = doc[0].data
|
|
else:
|
|
raise AirflowException("A valid deployment-configuration is "
|
|
"required")
|
|
|
|
LOG.info("DeploymentConfiguration retrieved")
|
|
return doc_dict
|
|
|
|
def map_config_keys(self, cfg_data):
|
|
"""Maps the deployment-configuration
|
|
|
|
Converts to a more simple map of key-value pairs
|
|
"""
|
|
LOG.info("Mapping keys from deployment configuration")
|
|
return {
|
|
cfg_key: self.get_cfg_value(cfg_data, cfg_key, cfg_default)
|
|
for cfg_key, cfg_default in
|
|
DeploymentConfigurationOperator.config_keys_defaults.items()
|
|
}
|
|
|
|
def get_cfg_value(self, cfg_data, cfg_key, cfg_default):
|
|
"""Uses the dot notation key to get the value from the design config"""
|
|
data = cfg_data
|
|
for node in cfg_key.split('.'):
|
|
data = data.get(node, {})
|
|
if data:
|
|
LOG.info("Deployment Config value set- %s: %s", cfg_key, data)
|
|
return data
|
|
else:
|
|
LOG.info("Deployment Config using default- %s: %s",
|
|
cfg_key, cfg_default)
|
|
return cfg_default
|
|
|
|
|
|
class DeploymentConfigurationOperatorPlugin(AirflowPlugin):
|
|
name = 'deployment_configuration_operator_plugin'
|
|
operators = [DeploymentConfigurationOperator]
|