shipyard/shipyard_airflow/plugins/promenade_base_operator.py
Anthony Lin 47cd7a25f4 Align Operators with UcpBaseOperator
All UCP Operators will inherit from the UcpBaseOperator [0]

This patch set will align the rest of the Operators, i.e. Armada,
Deckhand and Promenade Operators with the UcpBaseOperator

It also updates the name of the shipyard container to be
'shipyard-api' instead of 'shipyard'

[0] https://review.gerrithub.io/#/c/407736/

Change-Id: I516590c492e9bb5554161119dade278d74197374
2018-04-19 16:32:51 +00:00

95 lines
3.5 KiB
Python

# Copyright 2018 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.
import logging
from airflow.utils.decorators import apply_defaults
from airflow.plugins_manager import AirflowPlugin
from airflow.exceptions import AirflowException
from service_endpoint import ucp_service_endpoint
from service_token import shipyard_service_token
from ucp_base_operator import UcpBaseOperator
LOG = logging.getLogger(__name__)
class PromenadeBaseOperator(UcpBaseOperator):
"""Promenade Base Operator
All promenade related workflow operators will use the promenade
base operator as the parent and inherit attributes and methods
from this class
"""
@apply_defaults
def __init__(self,
promenade_svc_endpoint=None,
promenade_svc_type='kubernetesprovisioner',
redeploy_server=None,
svc_token=None,
*args, **kwargs):
"""Initialization of PromenadeBaseOperator object.
:param promenade_svc_endpoint: Promenade Service Endpoint
:param promenade_svc_type: Promenade Service Type
:param redeploy_server: Server to be redeployed
:param svc_token: Keystone Token
The Drydock operator assumes that prior steps have set xcoms for
the action and the deployment configuration
"""
super(PromenadeBaseOperator,
self).__init__(
pod_selector_pattern=[{'pod_pattern': 'promenade-api',
'container': 'promenade-api'}],
*args, **kwargs)
self.promenade_svc_endpoint = promenade_svc_endpoint
self.promenade_svc_type = promenade_svc_type
self.redeploy_server = redeploy_server
self.svc_token = svc_token
@shipyard_service_token
def run_base(self, context):
# Logs uuid of Shipyard action
LOG.info("Executing Shipyard Action %s", self.action_info['id'])
# Retrieve information of the server that we want to redeploy
# if user executes the 'redeploy_server' dag
if self.action_info['dag_id'] == 'redeploy_server':
self.redeploy_server = self.action_info['parameters'].get(
'server-name')
if self.redeploy_server:
LOG.info("Server to be redeployed is %s", self.redeploy_server)
else:
raise AirflowException('%s was unable to retrieve the '
'server to be redeployed.'
% self.__class__.__name__)
# Retrieve promenade endpoint
self.promenade_svc_endpoint = ucp_service_endpoint(
self, svc_type=self.promenade_svc_type)
LOG.info("Promenade endpoint is %s", self.promenade_svc_endpoint)
class PromenadeBaseOperatorPlugin(AirflowPlugin):
"""Creates PromenadeBaseOperator in Airflow."""
name = 'promenade_base_operator_plugin'
operators = [PromenadeBaseOperator]