411 lines
16 KiB
Python
411 lines
16 KiB
Python
# Copyright 2017 The Armada Authors.
|
|
#
|
|
# 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 difflib
|
|
import yaml
|
|
|
|
from oslo_log import log as logging
|
|
from supermutes.dot import dotify
|
|
|
|
from armada.handlers.chartbuilder import ChartBuilder
|
|
from armada.handlers.manifest import Manifest
|
|
from armada.handlers.override import Override
|
|
from armada.handlers.tiller import Tiller
|
|
from armada.exceptions import armada_exceptions
|
|
from armada.exceptions import source_exceptions
|
|
from armada.exceptions import lint_exceptions
|
|
from armada.exceptions import tiller_exceptions
|
|
from armada.utils.release import release_prefix
|
|
from armada.utils import source
|
|
from armada.utils import lint
|
|
from armada import const
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
DEFAULT_TIMEOUT = 3600
|
|
|
|
|
|
class Armada(object):
|
|
'''
|
|
This is the main Armada class handling the Armada
|
|
workflows
|
|
'''
|
|
|
|
def __init__(self,
|
|
file,
|
|
disable_update_pre=False,
|
|
disable_update_post=False,
|
|
enable_chart_cleanup=False,
|
|
dry_run=False,
|
|
set_ovr=None,
|
|
wait=False,
|
|
timeout=DEFAULT_TIMEOUT,
|
|
tiller_host=None,
|
|
tiller_port=44134,
|
|
values=None):
|
|
'''
|
|
Initialize the Armada Engine and establish
|
|
a connection to Tiller
|
|
'''
|
|
|
|
self.disable_update_pre = disable_update_pre
|
|
self.disable_update_post = disable_update_post
|
|
self.enable_chart_cleanup = enable_chart_cleanup
|
|
self.dry_run = dry_run
|
|
self.overrides = set_ovr
|
|
self.wait = wait
|
|
self.timeout = timeout
|
|
self.tiller = Tiller(tiller_host=tiller_host, tiller_port=tiller_port)
|
|
self.values = values
|
|
self.documents = file
|
|
self.config = None
|
|
|
|
def get_armada_manifest(self):
|
|
return Manifest(self.documents).get_manifest()
|
|
|
|
def find_release_chart(self, known_releases, name):
|
|
'''
|
|
Find a release given a list of known_releases and a release name
|
|
'''
|
|
for chart_name, _, chart, values, _ in known_releases:
|
|
if chart_name == name:
|
|
return chart, values
|
|
|
|
def pre_flight_ops(self):
|
|
'''
|
|
Perform a series of checks and operations to ensure proper deployment
|
|
'''
|
|
|
|
# Ensure tiller is available and manifest is valid
|
|
if not self.tiller.tiller_status():
|
|
raise tiller_exceptions.TillerServicesUnavailableException()
|
|
|
|
if not lint.validate_armada_documents(self.documents):
|
|
raise lint_exceptions.InvalidManifestException()
|
|
|
|
# Override manifest values if --set flag is used
|
|
if self.overrides or self.values:
|
|
self.documents = Override(
|
|
self.documents, overrides=self.overrides,
|
|
values=self.values).update_manifests()
|
|
|
|
# Get config and validate
|
|
self.config = self.get_armada_manifest()
|
|
|
|
if not lint.validate_armada_object(self.config):
|
|
raise lint_exceptions.InvalidArmadaObjectException()
|
|
|
|
# Purge known releases that have failed and are in the current yaml
|
|
prefix = self.config.get(const.KEYWORD_ARMADA).get(
|
|
const.KEYWORD_PREFIX)
|
|
failed_releases = self.get_releases_by_status(const.STATUS_FAILED)
|
|
for release in failed_releases:
|
|
for group in self.config.get(const.KEYWORD_ARMADA).get(
|
|
const.KEYWORD_GROUPS):
|
|
for ch in group.get(const.KEYWORD_CHARTS):
|
|
ch_release_name = release_prefix(prefix,
|
|
ch.get('chart')
|
|
.get('chart_name'))
|
|
if release[0] == ch_release_name:
|
|
LOG.info('Purging failed release %s '
|
|
'before deployment', release[0])
|
|
self.tiller.uninstall_release(release[0])
|
|
|
|
# Clone the chart sources
|
|
#
|
|
# We only support a git source type right now, which can also
|
|
# handle git:// local paths as well
|
|
repos = {}
|
|
for group in self.config.get(const.KEYWORD_ARMADA).get(
|
|
const.KEYWORD_GROUPS):
|
|
for ch in group.get(const.KEYWORD_CHARTS):
|
|
self.tag_cloned_repo(ch, repos)
|
|
|
|
for dep in ch.get('chart').get('dependencies'):
|
|
self.tag_cloned_repo(dep, repos)
|
|
|
|
def tag_cloned_repo(self, ch, repos):
|
|
location = ch.get('chart').get('source').get('location')
|
|
ct_type = ch.get('chart').get('source').get('type')
|
|
subpath = ch.get('chart').get('source').get('subpath', '.')
|
|
|
|
if ct_type == 'local':
|
|
ch.get('chart')['source_dir'] = (location, subpath)
|
|
elif ct_type == 'tar':
|
|
LOG.info('Downloading tarball from: %s', location)
|
|
tarball_dir = source.get_tarball(location)
|
|
ch.get('chart')['source_dir'] = (tarball_dir, subpath)
|
|
elif ct_type == 'git':
|
|
reference = ch.get('chart').get('source').get(
|
|
'reference', 'master')
|
|
repo_branch = (location, reference)
|
|
|
|
if repo_branch not in repos:
|
|
try:
|
|
LOG.info('Cloning repo: %s branch: %s', *repo_branch)
|
|
repo_dir = source.git_clone(*repo_branch)
|
|
except Exception:
|
|
raise source_exceptions.GitLocationException(
|
|
'{} reference: {}'.format(*repo_branch))
|
|
repos[repo_branch] = repo_dir
|
|
ch.get('chart')['source_dir'] = (repo_dir, subpath)
|
|
else:
|
|
ch.get('chart')['source_dir'] = (repos.get(repo_branch),
|
|
subpath)
|
|
else:
|
|
chart_name = ch.get('chart').get('chart_name')
|
|
raise source_exceptions.ChartSourceException(ct_type, chart_name)
|
|
|
|
def get_releases_by_status(self, status):
|
|
'''
|
|
:params status - status string to filter releases on
|
|
|
|
Return a list of current releases with a specified status
|
|
'''
|
|
filtered_releases = []
|
|
known_releases = self.tiller.list_charts()
|
|
for release in known_releases:
|
|
if release[4] == status:
|
|
filtered_releases.append(release)
|
|
|
|
return filtered_releases
|
|
|
|
def sync(self):
|
|
'''
|
|
Syncronize Helm with the Armada Config(s)
|
|
'''
|
|
|
|
msg = {'install': [], 'upgrade': [], 'diff': []}
|
|
|
|
# TODO: (gardlt) we need to break up this func into
|
|
# a more cleaner format
|
|
LOG.info("Performing Pre-Flight Operations")
|
|
self.pre_flight_ops()
|
|
|
|
# extract known charts on tiller right now
|
|
known_releases = self.tiller.list_charts()
|
|
prefix = self.config.get(const.KEYWORD_ARMADA).get(
|
|
const.KEYWORD_PREFIX)
|
|
|
|
if known_releases is None:
|
|
raise armada_exceptions.KnownReleasesException()
|
|
|
|
for release in known_releases:
|
|
LOG.debug("Release %s, Version %s found on tiller", release[0],
|
|
release[1])
|
|
|
|
for entry in self.config[const.KEYWORD_ARMADA][const.KEYWORD_GROUPS]:
|
|
|
|
chart_wait = self.wait
|
|
desc = entry.get('description', 'A Chart Group')
|
|
chart_group = entry.get(const.KEYWORD_CHARTS, [])
|
|
test_charts = entry.get('test_charts', False)
|
|
|
|
if entry.get('sequenced', False) or test_charts:
|
|
chart_wait = True
|
|
|
|
LOG.info('Deploying: %s', desc)
|
|
|
|
for gchart in chart_group:
|
|
chart = dotify(gchart['chart'])
|
|
values = gchart.get('chart').get('values', {})
|
|
wait_values = gchart.get('chart').get('wait', {})
|
|
test_chart = gchart.get('chart').get('test', False)
|
|
pre_actions = {}
|
|
post_actions = {}
|
|
|
|
if chart.release is None:
|
|
continue
|
|
|
|
if test_chart:
|
|
chart_wait = True
|
|
|
|
# retrieve appropriate timeout value if 'wait' is specified
|
|
chart_timeout = self.timeout
|
|
if chart_wait:
|
|
if chart_timeout == DEFAULT_TIMEOUT:
|
|
chart_timeout = getattr(
|
|
chart, 'timeout', chart_timeout)
|
|
|
|
chartbuilder = ChartBuilder(chart)
|
|
protoc_chart = chartbuilder.get_helm_chart()
|
|
|
|
# determine install or upgrade by examining known releases
|
|
LOG.debug("RELEASE: %s", chart.release)
|
|
deployed_releases = [x[0] for x in known_releases]
|
|
prefix_chart = release_prefix(prefix, chart.release)
|
|
|
|
if prefix_chart in deployed_releases:
|
|
|
|
# indicate to the end user what path we are taking
|
|
LOG.info("Upgrading release %s", chart.release)
|
|
# extract the installed chart and installed values from the
|
|
# latest release so we can compare to the intended state
|
|
LOG.info("Checking Pre/Post Actions")
|
|
apply_chart, apply_values = self.find_release_chart(
|
|
known_releases, prefix_chart)
|
|
|
|
LOG.info("Checking Pre/Post Actions")
|
|
upgrade = gchart.get('chart', {}).get('upgrade', False)
|
|
|
|
if upgrade:
|
|
if not self.disable_update_pre and upgrade.get(
|
|
'pre', False):
|
|
pre_actions = getattr(chart.upgrade, 'pre', {})
|
|
|
|
if not self.disable_update_post and upgrade.get(
|
|
'post', False):
|
|
post_actions = getattr(chart.upgrade, 'post', {})
|
|
|
|
# show delta for both the chart templates and the chart
|
|
# values
|
|
# TODO(alanmeadows) account for .files differences
|
|
# once we support those
|
|
|
|
upgrade_diff = self.show_diff(
|
|
chart, apply_chart, apply_values,
|
|
chartbuilder.dump(), values, msg)
|
|
|
|
if not upgrade_diff:
|
|
LOG.info("There are no updates found in this chart")
|
|
continue
|
|
|
|
# do actual update
|
|
LOG.info('wait: %s', chart_wait)
|
|
self.tiller.update_release(
|
|
protoc_chart,
|
|
prefix_chart,
|
|
chart.namespace,
|
|
pre_actions=pre_actions,
|
|
post_actions=post_actions,
|
|
dry_run=self.dry_run,
|
|
disable_hooks=chart.upgrade.no_hooks,
|
|
values=yaml.safe_dump(values),
|
|
wait=chart_wait,
|
|
timeout=chart_timeout)
|
|
|
|
if chart_wait:
|
|
# TODO(gardlt): after v0.7.1 depricate timeout values
|
|
if not wait_values.get('timeout', None):
|
|
wait_values['timeout'] = chart_timeout
|
|
|
|
self.tiller.k8s.wait_until_ready(
|
|
release=prefix_chart,
|
|
labels=wait_values.get('labels', ''),
|
|
namespace=chart.namespace,
|
|
timeout=wait_values.get('timeout', DEFAULT_TIMEOUT)
|
|
)
|
|
|
|
msg['upgrade'].append(prefix_chart)
|
|
|
|
# process install
|
|
else:
|
|
LOG.info("Installing release %s", chart.release)
|
|
self.tiller.install_release(
|
|
protoc_chart,
|
|
prefix_chart,
|
|
chart.namespace,
|
|
dry_run=self.dry_run,
|
|
values=yaml.safe_dump(values),
|
|
wait=chart_wait,
|
|
timeout=chart_timeout)
|
|
|
|
if chart_wait:
|
|
if not wait_values.get('timeout', None):
|
|
wait_values['timeout'] = chart_timeout
|
|
|
|
self.tiller.k8s.wait_until_ready(
|
|
release=prefix_chart,
|
|
labels=wait_values.get('labels', ''),
|
|
namespace=chart.namespace,
|
|
timeout=wait_values.get('timeout', 3600))
|
|
|
|
msg['install'].append(prefix_chart)
|
|
|
|
LOG.debug("Cleaning up chart source in %s",
|
|
chartbuilder.source_directory)
|
|
|
|
if test_charts or test_chart:
|
|
LOG.info('Testing: %s', prefix_chart)
|
|
resp = self.tiller.testing_release(prefix_chart)
|
|
test_status = getattr(resp.info.status,
|
|
'last_test_suite_run', 'FAILED')
|
|
LOG.info("Test INFO: %s", test_status)
|
|
if resp:
|
|
LOG.info("PASSED: %s", prefix_chart)
|
|
else:
|
|
LOG.info("FAILED: %s", prefix_chart)
|
|
|
|
self.tiller.k8s.wait_until_ready(timeout=chart_timeout)
|
|
|
|
LOG.info("Performing Post-Flight Operations")
|
|
self.post_flight_ops()
|
|
|
|
if self.enable_chart_cleanup:
|
|
self.tiller.chart_cleanup(
|
|
prefix,
|
|
self.config[const.KEYWORD_ARMADA][const.KEYWORD_GROUPS])
|
|
|
|
return msg
|
|
|
|
def post_flight_ops(self):
|
|
'''
|
|
Operations to run after deployment process has terminated
|
|
'''
|
|
# Delete temp dirs used for deployment
|
|
for group in self.config.get(const.KEYWORD_ARMADA).get(
|
|
const.KEYWORD_GROUPS):
|
|
for ch in group.get(const.KEYWORD_CHARTS):
|
|
if ch.get('chart').get('source').get('type') == 'git':
|
|
source.source_cleanup(ch.get('chart').get('source_dir')[0])
|
|
|
|
def show_diff(self, chart, installed_chart, installed_values, target_chart,
|
|
target_values, msg):
|
|
'''
|
|
Produce a unified diff of the installed chart vs our intention
|
|
|
|
TODO(alanmeadows): This needs to be rewritten to produce better
|
|
unified diff output and avoid the use of print
|
|
'''
|
|
|
|
source = str(installed_chart.SerializeToString()).split('\n')
|
|
chart_diff = list(
|
|
difflib.unified_diff(source, str(target_chart).split('\n')))
|
|
|
|
if len(chart_diff) > 0:
|
|
LOG.info("Chart Unified Diff (%s)", chart.release)
|
|
diff_msg = []
|
|
for line in chart_diff:
|
|
diff_msg.append(line)
|
|
LOG.debug(line)
|
|
|
|
msg['diff'].append({'chart': diff_msg})
|
|
|
|
values_diff = list(
|
|
difflib.unified_diff(
|
|
installed_values.split('\n'),
|
|
yaml.safe_dump(target_values).split('\n')))
|
|
|
|
if len(values_diff) > 0:
|
|
LOG.info("Values Unified Diff (%s)", chart.release)
|
|
diff_msg = []
|
|
for line in values_diff:
|
|
diff_msg.append(line)
|
|
LOG.debug(line)
|
|
msg['diff'].append({'values': diff_msg})
|
|
|
|
result = (len(chart_diff) > 0) or (len(values_diff) > 0)
|
|
|
|
return result
|