python-tripleoclient/tripleoclient/v1/overcloud_deploy.py

1208 lines
52 KiB
Python

# Copyright 2015 Red Hat, Inc.
#
# 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.
#
from __future__ import print_function
import argparse
import glob
import hashlib
import logging
import os
import os.path
import re
import shutil
import six
import tempfile
import time
import uuid
import yaml
from heatclient.common import template_utils
from heatclient import exc as hc_exc
from keystoneclient import exceptions as kscexc
from os_cloud_config import keystone
from os_cloud_config import keystone_pki
from os_cloud_config.utils import clients
from osc_lib.command import command
from osc_lib import exceptions as oscexc
from osc_lib.i18n import _
from osc_lib import utils as osc_utils
from swiftclient.exceptions import ClientException
from tripleo_common import update
from tripleoclient import constants
from tripleoclient import exceptions
from tripleoclient import utils
from tripleoclient.workflows import deployment
from tripleoclient.workflows import parameters as workflow_params
from tripleoclient.workflows import plan_management
class DeployOvercloud(command.Command):
"""Deploy Overcloud"""
log = logging.getLogger(__name__ + ".DeployOvercloud")
predeploy_errors = 0
predeploy_warnings = 0
def set_overcloud_passwords(self, stack_is_new, parameters):
"""Add passwords to the parameters dictionary
:param parameters: A dictionary for the passwords to be added to
:type parameters: dict
"""
undercloud_ceilometer_snmpd_password = utils.get_config_value(
"auth", "undercloud_ceilometer_snmpd_password")
if not undercloud_ceilometer_snmpd_password:
self.log.warning("Undercloud ceilometer SNMPd password missing!")
passwords = utils.generate_overcloud_passwords(
create_password_file=stack_is_new)
ceilometer_pass = passwords['OVERCLOUD_CEILOMETER_PASSWORD']
ceilometer_secret = passwords['OVERCLOUD_CEILOMETER_SECRET']
parameters['AdminPassword'] = passwords['OVERCLOUD_ADMIN_PASSWORD']
parameters['AdminToken'] = passwords['OVERCLOUD_ADMIN_TOKEN']
parameters['AodhPassword'] = passwords['OVERCLOUD_AODH_PASSWORD']
parameters['BarbicanPassword'] = (
passwords['OVERCLOUD_BARBICAN_PASSWORD'])
parameters['CeilometerPassword'] = ceilometer_pass
parameters['CeilometerMeteringSecret'] = ceilometer_secret
parameters['CinderPassword'] = passwords[
'OVERCLOUD_CINDER_PASSWORD']
parameters['GlancePassword'] = passwords[
'OVERCLOUD_GLANCE_PASSWORD']
parameters['GnocchiPassword'] = passwords['OVERCLOUD_GNOCCHI_PASSWORD']
parameters['HAProxyStatsPassword'] = passwords[
'OVERCLOUD_HAPROXY_STATS_PASSWORD']
parameters['HeatPassword'] = passwords['OVERCLOUD_HEAT_PASSWORD']
parameters['HeatStackDomainAdminPassword'] = passwords[
'OVERCLOUD_HEAT_STACK_DOMAIN_PASSWORD']
parameters['IronicPassword'] = passwords['OVERCLOUD_IRONIC_PASSWORD']
parameters['MistralPassword'] = passwords['OVERCLOUD_MISTRAL_PASSWORD']
parameters['MysqlClustercheckPassword'] = passwords[
'OVERCLOUD_MYSQL_CLUSTERCHECK_PASSWORD']
parameters['NeutronPassword'] = passwords[
'OVERCLOUD_NEUTRON_PASSWORD']
parameters['NovaPassword'] = passwords['OVERCLOUD_NOVA_PASSWORD']
parameters['RabbitPassword'] = passwords['OVERCLOUD_RABBITMQ_PASSWORD']
parameters['RedisPassword'] = passwords['OVERCLOUD_REDIS_PASSWORD']
parameters['SaharaPassword'] = (
passwords['OVERCLOUD_SAHARA_PASSWORD'])
parameters['SwiftHashSuffix'] = passwords['OVERCLOUD_SWIFT_HASH']
parameters['SwiftPassword'] = passwords['OVERCLOUD_SWIFT_PASSWORD']
parameters['SnmpdReadonlyUserPassword'] = (
undercloud_ceilometer_snmpd_password)
parameters['TrovePassword'] = (
passwords['OVERCLOUD_TROVE_PASSWORD'])
parameters['ZaqarPassword'] = passwords['OVERCLOUD_ZAQAR_PASSWORD']
parameters['ManilaPassword'] = passwords['OVERCLOUD_MANILA_PASSWORD']
parameters['NeutronMetadataProxySharedSecret'] = (
passwords['NEUTRON_METADATA_PROXY_SHARED_SECRET'])
parameters['CephMonKey'] = passwords['OVERCLOUD_CEPH_MON_KEY']
parameters['CephAdminKey'] = passwords['OVERCLOUD_CEPH_ADMIN_KEY']
parameters['CephClientKey'] = passwords['OVERCLOUD_CEPH_CLIENT_KEY']
parameters['CephRgwKey'] = passwords['OVERCLOUD_CEPH_RGW_KEY']
parameters['KeystoneCredential0'] = passwords[
'OVERCLOUD_KEYSTONE_CREDENTIALS_0']
parameters['KeystoneCredential1'] = passwords[
'OVERCLOUD_KEYSTONE_CREDENTIALS_1']
def _update_parameters(self, args, network_client, stack):
parameters = {}
stack_is_new = stack is None
self.log.debug("Generating overcloud passwords")
self.set_overcloud_passwords(stack_is_new, parameters)
timestamp = int(time.time())
parameters['DeployIdentifier'] = timestamp
parameters['UpdateIdentifier'] = ''
parameters['StackAction'] = 'CREATE' if stack_is_new else 'UPDATE'
# Update parameters from answers file:
if args.answers_file is not None:
with open(args.answers_file, 'r') as answers_file:
answers = yaml.load(answers_file)
if args.templates is None:
args.templates = answers['templates']
if 'environments' in answers:
if args.environment_files is not None:
answers['environments'].extend(args.environment_files)
args.environment_files = answers['environments']
param_args = (
('NeutronPublicInterface', 'neutron_public_interface'),
('NeutronBridgeMappings', 'neutron_bridge_mappings'),
('NeutronFlatNetworks', 'neutron_flat_networks'),
('HypervisorNeutronPhysicalBridge', 'neutron_physical_bridge'),
('NtpServer', 'ntp_server'),
('ControllerCount', 'control_scale'),
('ComputeCount', 'compute_scale'),
('ObjectStorageCount', 'swift_storage_scale'),
('BlockStorageCount', 'block_storage_scale'),
('CephStorageCount', 'ceph_storage_scale'),
('OvercloudControlFlavor', 'control_flavor'),
('OvercloudComputeFlavor', 'compute_flavor'),
('OvercloudBlockStorageFlavor', 'block_storage_flavor'),
('OvercloudSwiftStorageFlavor', 'swift_storage_flavor'),
('OvercloudCephStorageFlavor', 'ceph_storage_flavor'),
('NeutronNetworkVLANRanges', 'neutron_network_vlan_ranges'),
('NeutronMechanismDrivers', 'neutron_mechanism_drivers')
)
if stack_is_new:
new_stack_args = (
('NeutronNetworkType', 'neutron_network_type'),
('NeutronTunnelIdRanges', 'neutron_tunnel_id_ranges'),
('NeutronTunnelTypes', 'neutron_tunnel_types'),
('NeutronVniRanges', 'neutron_vni_ranges'),
('NovaComputeLibvirtType', 'libvirt_type'),
)
param_args = param_args + new_stack_args
# Update parameters from commandline
for param, arg in param_args:
if getattr(args, arg, None) is not None:
# these must be converted to [] which is what Heat expects
if param.endswith(('NeutronTunnelIdRanges',
'NeutronVniRanges')):
parameters[param] = [getattr(args, arg)]
else:
parameters[param] = getattr(args, arg)
# Scaling needs extra parameters
number_controllers = int(parameters.get('ControllerCount', 0))
dhcp_agents_per_network = (min(number_controllers, 3) if
number_controllers else 1)
parameters.update({
'NeutronDhcpAgentsPerNetwork': dhcp_agents_per_network,
})
if stack_is_new:
parameters.update({
'CephClusterFSID': six.text_type(uuid.uuid1())})
return parameters
def _create_registration_env(self, args):
tht_root = args.templates
env_file = os.path.join(
tht_root,
constants.RHEL_REGISTRATION_EXTRACONFIG_NAME,
'environment-rhel-registration.yaml')
registry = os.path.join(
tht_root,
constants.RHEL_REGISTRATION_EXTRACONFIG_NAME,
'rhel-registration-resource-registry.yaml')
user_env = {'rhel_reg_method': args.reg_method,
'rhel_reg_org': args.reg_org,
'rhel_reg_force': args.reg_force,
'rhel_reg_sat_url': args.reg_sat_url,
'rhel_reg_activation_key': args.reg_activation_key}
return [registry, env_file], {"parameter_defaults": user_env}
def _create_parameters_env(self, parameters):
parameter_defaults = {"parameter_defaults": parameters}
return parameter_defaults
def _process_multiple_environments(self, created_env_files, added_files,
tht_root, user_tht_root):
env_files = {}
localenv = {}
for env_path in created_env_files:
self.log.debug("Processing environment files %s" % env_path)
abs_env_path = os.path.abspath(env_path)
if abs_env_path.startswith(user_tht_root):
new_env_path = abs_env_path.replace(user_tht_root, tht_root)
self.log.debug("Redirecting env file %s to %s"
% (abs_env_path, new_env_path))
env_path = new_env_path
try:
files, env = template_utils.process_environment_and_files(
env_path=env_path)
except hc_exc.CommandError as ex:
self.log.debug("Error %s processing environment file %s"
% (six.text_type(ex), env_path))
# FIXME(shardy) We need logic here to handle the case described
# in https://bugs.launchpad.net/tripleo/+bug/1625783 so that
# resource_registry contents are redirected to tmpdir tht_root
raise
if files:
self.log.debug("Adding files %s for %s" % (files, env_path))
env_files.update(files)
# 'env' can be a deeply nested dictionary, so a simple update is
# not enough
localenv = template_utils.deep_update(localenv, env)
return env_files, localenv
def _heat_deploy(self, stack, stack_name, template_path, parameters,
env_files, timeout, tht_root, env):
"""Verify the Baremetal nodes are available and do a stack update"""
clients = self.app.client_manager
workflow_client = clients.workflow_engine
if stack:
update.add_breakpoints_cleanup_into_env(env)
self.log.debug("Getting template contents from plan %s" % stack_name)
# We need to reference the plan here, not the local
# tht root, as we need template_object to refer to
# the rendered overcloud.yaml, not the tht_root overcloud.j2.yaml
# FIXME(shardy) we need to move more of this into mistral actions
plan_yaml_path = os.path.relpath(template_path, tht_root)
# heatclient template_utils needs a function that can
# retrieve objects from a container by name/path
objectclient = clients.tripleoclient.object_store
def do_object_request(method='GET', object_path=None):
obj = objectclient.get_object(stack_name, object_path)
return obj and obj[1]
template_files, template = template_utils.get_template_contents(
template_object=plan_yaml_path,
object_request=do_object_request)
files = dict(list(template_files.items()) + list(env_files.items()))
number_controllers = int(parameters.get('ControllerCount', 0))
if number_controllers > 1:
if not env.get('parameter_defaults').get('NtpServer'):
raise exceptions.InvalidConfiguration(
'Specify --ntp-server as parameter or NtpServer in '
'environments when using multiple controllers '
'(with HA).')
clients = self.app.client_manager
moved_files = self._upload_missing_files(
stack_name, objectclient, files, tht_root)
self._process_and_upload_environment(
stack_name, objectclient, env, moved_files, tht_root,
workflow_client)
deployment.deploy_and_wait(self.log, clients, stack, stack_name,
self.app_args.verbose_level, timeout)
def _load_environment_directories(self, directories):
if os.environ.get('TRIPLEO_ENVIRONMENT_DIRECTORY'):
directories.append(os.environ.get('TRIPLEO_ENVIRONMENT_DIRECTORY'))
environments = []
for d in directories:
if os.path.exists(d) and d != '.':
self.log.debug("Environment directory: %s" % d)
for f in sorted(glob.glob(os.path.join(d, '*.yaml'))):
self.log.debug("Environment directory file: %s" % f)
if os.path.isfile(f):
environments.append(f)
return environments
def _process_and_upload_environment(self, container_name, swift_client,
env, moved_files, tht_root, mistral):
"""Process the environment and upload to Swift
The environment at this point should be the result of the merged
custom user environments. We need to look at the paths in the
environment and update any that changed when they were uploaded to
swift.
"""
file_prefix = "file://"
if 'resource_registry' in env:
for name, path in env['resource_registry'].items():
if not isinstance(path, six.string_types):
continue
if path in moved_files:
new_path = moved_files[path]
env['resource_registry'][name] = new_path
elif path.startswith(file_prefix):
path = path[len(file_prefix):]
if path.startswith(tht_root):
path = path[len(tht_root):]
# We want to make sure all the paths are relative.
if path.startswith("/"):
path = path[1:]
env['resource_registry'][name] = path
# Parameters are removed from the environment and sent to the update
# parameters action, this stores them in the Mistral environment and
# means the UI can find them.
if 'parameter_defaults' in env:
params = env.pop('parameter_defaults')
workflow_params.update_parameters(
mistral, container=container_name, parameters=params)
contents = yaml.safe_dump(env)
# Until we have a well defined plan update workflow in tripleo-common
# we need to manually add an environment in swift and mistral for users
# custom environments passed to the deploy command.
# See bug: https://bugs.launchpad.net/tripleo/+bug/1623431
swift_path = "user-environment.yaml"
swift_client.put_object(container_name, swift_path, contents)
mistral_env = mistral.environments.get(container_name)
user_env = {'path': swift_path}
if user_env not in mistral_env.variables['environments']:
mistral_env.variables['environments'].append(user_env)
mistral.environments.update(
name=container_name,
variables=mistral_env.variables
)
def _upload_missing_files(self, container_name, swift_client, files_dict,
tht_root):
"""Find the files referenced in custom environments and upload them
Heat environments can be passed to be included in the deployment, these
files can include references to other files anywhere on the local
file system. These need to be discovered and uploaded to Swift. When
they have been uploaded to Swift the path to them will be different,
the new paths are store din the file_relocation dict, which is returned
and used by _process_and_upload_environment which will merge the
environment and update paths to the relative Swift path.
"""
file_relocation = {}
file_prefix = "file://"
for fullpath, contents in files_dict.items():
if not fullpath.startswith(file_prefix):
continue
path = fullpath[len(file_prefix):]
if path.startswith(tht_root):
# This should already be uploaded.
continue
filename = os.path.basename(path)
checksum = hashlib.md5()
checksum.update(path)
digest = checksum.hexdigest()
swift_path = "user-files/{}-{}".format(digest, filename)
swift_client.put_object(container_name, swift_path, contents)
file_relocation[fullpath] = swift_path
return file_relocation
def _download_missing_files_from_plan(self, tht_dir, plan_name):
# get and download missing files into tmp directory
clients = self.app.client_manager
objectclient = clients.tripleoclient.object_store
plan_list = objectclient.get_container(plan_name)
plan_filenames = [f['name'] for f in plan_list[1]]
added_files = {}
for pf in plan_filenames:
file_path = os.path.join(tht_dir, pf)
if not os.path.isfile(file_path):
self.log.debug("Missing in templates directory, downloading \
%s from swift into %s" % (pf, file_path))
if not os.path.exists(os.path.dirname(file_path)):
os.makedirs(os.path.dirname(file_path))
with open(file_path, 'w') as f:
f.write(objectclient.get_object(plan_name, pf)[1])
added_files[pf] = file_path
self.log.debug("added_files = %s" % added_files)
return added_files
def _deploy_tripleo_heat_templates_tmpdir(self, stack, parsed_args):
# copy tht_root to temporary directory because we need to
# download any missing (e.g j2 rendered) files from the plan
tht_root = os.path.abspath(parsed_args.templates)
tht_tmp = tempfile.mkdtemp(prefix='tripleoclient-')
new_tht_root = "%s/tripleo-heat-templates" % tht_tmp
self.log.debug("Creating temporary templates tree in %s"
% new_tht_root)
try:
shutil.copytree(tht_root, new_tht_root, symlinks=True)
self._deploy_tripleo_heat_templates(stack, parsed_args,
new_tht_root, tht_root)
finally:
if parsed_args.no_cleanup:
self.log.warning("Not cleaning temporary directory %s"
% tht_tmp)
else:
shutil.rmtree(tht_tmp)
def _deploy_tripleo_heat_templates(self, stack, parsed_args,
tht_root, user_tht_root):
"""Deploy the fixed templates in TripleO Heat Templates"""
clients = self.app.client_manager
network_client = clients.network
workflow_client = clients.workflow_engine
parameters = self._update_parameters(
parsed_args, network_client, stack)
plans = plan_management.list_deployment_plans(workflow_client)
# TODO(d0ugal): We need to put a more robust strategy in place here to
# handle updating plans.
if parsed_args.stack in plans:
# Upload the new plan templates to swift to replace the existing
# templates.
plan_management.update_plan_from_templates(
clients, parsed_args.stack, tht_root, parsed_args.roles_file)
else:
plan_management.create_plan_from_templates(
clients, parsed_args.stack, tht_root, parsed_args.roles_file)
# Get any missing (e.g j2 rendered) files from the plan to tht_root
added_files = self._download_missing_files_from_plan(
tht_root, parsed_args.stack)
print("Deploying templates in the directory {0}".format(
os.path.abspath(tht_root)))
self.log.debug("Creating Environment file")
# TODO(jprovazn): env file generated by create_environment_file()
# is not very usable any more, scale params are included in
# parameters and keystone cert is generated on create only
env_path = utils.create_environment_file()
env = {}
created_env_files = []
if stack is None:
self.log.debug("Creating Keystone certificates")
keystone_pki.generate_certs_into_json(env_path, False)
created_env_files.append(env_path)
if parsed_args.environment_directories:
created_env_files.extend(self._load_environment_directories(
parsed_args.environment_directories))
env.update(self._create_parameters_env(parameters))
if parsed_args.rhel_reg:
reg_env_files, reg_env = self._create_registration_env(parsed_args)
created_env_files.extend(reg_env_files)
template_utils.deep_update(env, reg_env)
if parsed_args.environment_files:
created_env_files.extend(parsed_args.environment_files)
self.log.debug("Processing environment files %s" % created_env_files)
env_files, localenv = self._process_multiple_environments(
created_env_files, added_files, tht_root, user_tht_root)
# Command line has more precedence than env files
template_utils.deep_update(localenv, env)
self._try_overcloud_deploy_with_compat_yaml(
tht_root, stack, parsed_args.stack, parameters, env_files,
parsed_args.timeout, localenv)
def _try_overcloud_deploy_with_compat_yaml(self, tht_root, stack,
stack_name, parameters,
env_files, timeout,
env):
overcloud_yaml = os.path.join(tht_root, constants.OVERCLOUD_YAML_NAME)
try:
self._heat_deploy(stack, stack_name, overcloud_yaml,
parameters, env_files, timeout,
tht_root, env)
except ClientException as e:
messages = 'Failed to deploy: %s' % str(e)
raise ValueError(messages)
def _is_tls_enabled(self, overcloud_endpoint):
return overcloud_endpoint.startswith('https')
def _keystone_init(self, overcloud_endpoint, overcloud_ip_or_fqdn,
parsed_args, stack):
keystone_admin_ip = utils.get_endpoint('KeystoneAdmin', stack)
keystone_admin_ip = utils.unbracket_ipv6(keystone_admin_ip)
keystone_internal_ip = utils.get_endpoint('KeystoneInternal', stack)
keystone_internal_ip = utils.unbracket_ipv6(keystone_internal_ip)
tls_enabled = self._is_tls_enabled(overcloud_endpoint)
keystone_tls_host = None
if tls_enabled:
# NOTE(jaosorior): This triggers set up the keystone endpoint with
# the https protocol and the required port set in
# keystone.initialize.
keystone_tls_host = overcloud_ip_or_fqdn
keystone_client = clients.get_keystone_client(
'admin',
utils.get_password('OVERCLOUD_ADMIN_PASSWORD'),
'admin',
overcloud_endpoint)
services = {}
for service, data in six.iteritems(constants.SERVICE_LIST):
try:
keystone_client.services.find(name=service)
except kscexc.NotFound:
service_data = self._set_service_data(service, data, stack)
if service_data:
services.update({service: service_data})
if services:
# This was deprecated in Newton. The deprecation message and
# os-cloud-config keystone init should remain until at least the
# Pike release to ensure users have a chance to update their
# templates, including ones for the previous release.
self.log.warning('DEPRECATED: '
'It appears Keystone was not initialized by '
'Puppet. Will do initialization via '
'os-cloud-config, but this behavior is '
'deprecated. Please update your templates to a '
'version that has Puppet initialization of '
'Keystone.'
)
# NOTE(jaosorior): These ports will be None if the templates
# don't support the EndpointMap as an output yet. And so the
# default values will be taken.
public_port = None
admin_port = None
internal_port = None
endpoint_map = utils.get_endpoint_map(stack)
if endpoint_map:
public_port = endpoint_map.get('KeystonePublic').get('port')
admin_port = endpoint_map.get('KeystoneAdmin').get('port')
internal_port = endpoint_map.get(
'KeystoneInternal').get('port')
keystone.initialize(
keystone_admin_ip,
utils.get_password('OVERCLOUD_ADMIN_TOKEN'),
'admin@example.com',
utils.get_password('OVERCLOUD_ADMIN_PASSWORD'),
ssl=keystone_tls_host,
public=overcloud_ip_or_fqdn,
user=parsed_args.overcloud_ssh_user,
admin=keystone_admin_ip,
internal=keystone_internal_ip,
public_port=public_port,
admin_port=admin_port,
internal_port=internal_port)
if not tls_enabled:
# NOTE(bcrochet): Bad hack. Remove the ssl_port info from the
# os_cloud_config.SERVICES dictionary
for service_name, data in keystone.SERVICES.items():
data.pop('ssl_port', None)
keystone.setup_endpoints(
services,
client=keystone_client,
os_auth_url=overcloud_endpoint,
public_host=overcloud_ip_or_fqdn)
# End of deprecated Keystone init
def _set_service_data(self, service, data, stack):
self.log.debug("Setting data for service '%s'" % service)
service_data = data.copy()
service_data.pop('password_field', None)
endpoint_map = utils.get_endpoint_map(stack)
try:
service_data.update(
self._get_base_service_data(service, data, stack))
except KeyError:
output_source = "service IPs"
if endpoint_map:
output_source = "endpoint map"
self.log.debug(
("Skipping \"{}\" postconfig because it wasn't found in the "
"{} output").format(service, output_source))
return None
if not endpoint_map:
return service_data
service_data.update(self._get_endpoint_data(service, endpoint_map,
stack))
return service_data
def _get_base_service_data(self, service, data, stack):
service_data = {}
password_field = data.get('password_field')
if password_field:
service_data['password'] = utils.get_password(
password_field)
# Set internal endpoint
service_name_internal = self._format_endpoint_name(service, 'internal')
service_data['internal_host'] = utils.get_endpoint(
service_name_internal, stack)
return service_data
def _get_endpoint_data(self, service, endpoint_map, stack):
endpoint_data = {}
# Set standard port
service_name_internal = self._format_endpoint_name(service, 'internal')
endpoint_data['port'] = endpoint_map[service_name_internal]['port']
# Set public endpoint
service_name_public = self._format_endpoint_name(service, 'public')
public_endpoint_data = endpoint_map.get(service_name_public)
endpoint_data['public_host'] = public_endpoint_data['host']
# Set SSL port
if public_endpoint_data['uri'].startswith('https'):
endpoint_data['ssl_port'] = public_endpoint_data['port']
return endpoint_data
def _format_endpoint_name(self, service, interface):
return re.sub('v[0-9]+', '',
service.capitalize() + interface.capitalize())
def _endpoints_managed(self, stack):
for output in stack.to_dict().get('outputs', {}):
if output['output_key'] == 'ManagedEndpoints':
# NOTE(jaosorior): We don't really care about the value as
# long as the key is there.
return output['output_value']
return False
def _deploy_postconfig(self, stack, parsed_args):
self.log.debug("_deploy_postconfig(%s)" % parsed_args)
overcloud_endpoint = utils.get_overcloud_endpoint(stack)
# NOTE(jaosorior): The overcloud endpoint can contain an IP address or
# an FQDN depending on how what it's configured to output in the
# tripleo-heat-templates. Such a configuration can be done by
# overriding the EndpointMap through parameter_defaults.
overcloud_ip_or_fqdn = six.moves.urllib.parse.urlparse(
overcloud_endpoint).hostname
no_proxy = [os.environ.get('no_proxy'), overcloud_ip_or_fqdn]
os.environ['no_proxy'] = ','.join(
[x for x in no_proxy if x is not None])
utils.remove_known_hosts(overcloud_ip_or_fqdn)
if not self._endpoints_managed(stack):
self._keystone_init(overcloud_endpoint, overcloud_ip_or_fqdn,
parsed_args, stack)
else:
self.log.debug("Keystone endpoints and services are managed by "
"puppet. Skipping post-config.")
def _validate_args(self, parsed_args):
if parsed_args.templates is None and parsed_args.answers_file is None:
raise oscexc.CommandError(
"You must specify either --templates or --answers-file")
if parsed_args.environment_files:
nonexisting_envs = []
for env_file in parsed_args.environment_files:
if not os.path.isfile(env_file):
# Tolerate missing file if there's a j2.yaml file that will
# be rendered in the plan but not available locally (yet)
if not os.path.isfile(env_file.replace(".yaml",
".j2.yaml")):
nonexisting_envs.append(env_file)
if nonexisting_envs:
raise oscexc.CommandError(
"Error: The following files were not found: {0}".format(
", ".join(nonexisting_envs)))
network_type = parsed_args.neutron_network_type
tunnel_types = parsed_args.neutron_tunnel_types
tunnel_disabled = parsed_args.neutron_disable_tunneling
neutron_network_vlan_ranges = parsed_args.neutron_network_vlan_ranges
if network_type == 'vlan' and not neutron_network_vlan_ranges:
raise oscexc.CommandError(
"Neutron network VLAN ranges must be specified when the "
"network type is set to VLAN")
elif network_type and tunnel_types:
# Validate that neutron_network_type is in neutron_tunnel_types
if network_type not in tunnel_types:
raise oscexc.CommandError("Neutron network type must be in "
"Neutron tunnel types "
"(%s) " % tunnel_types)
elif not tunnel_disabled:
if network_type and not tunnel_types:
raise oscexc.CommandError("Neutron tunnel types must be "
"specified when Neutron network "
"type is specified")
elif tunnel_types and not network_type:
raise oscexc.CommandError("Neutron network type must be "
"specified when Neutron tunnel "
"types is specified")
def _predeploy_verify_capabilities(self, stack, parameters, parsed_args):
self.predeploy_errors = 0
self.predeploy_warnings = 0
self.log.debug("Starting _pre_verify_capabilities")
bm_client = self.app.client_manager.baremetal
self._check_boot_images()
flavors = self._collect_flavors(parsed_args)
self._check_ironic_boot_configuration(bm_client)
errors, warnings = utils.assign_and_verify_profiles(
bm_client, flavors,
assign_profiles=False,
dry_run=parsed_args.dry_run
)
self.predeploy_errors += errors
self.predeploy_warnings += warnings
compute_client = self.app.client_manager.compute
self.log.debug("Checking hypervisor stats")
if utils.check_hypervisor_stats(compute_client) is None:
self.log.error("Expected hypervisor stats not met")
self.predeploy_errors += 1
self.log.debug("Checking nodes count")
enough_nodes, count, ironic_nodes_count = utils.check_nodes_count(
bm_client,
stack,
parameters,
{
'ControllerCount': 1,
'ComputeCount': 1,
'ObjectStorageCount': 0,
'BlockStorageCount': 0,
'CephStorageCount': 0,
}
)
if not enough_nodes:
self.log.error(
"Not enough nodes - available: {0}, requested: {1}".format(
ironic_nodes_count, count))
self.predeploy_errors += 1
return self.predeploy_errors, self.predeploy_warnings
__kernel_id = None
__ramdisk_id = None
def _image_ids(self):
if self.__kernel_id is not None and self.__ramdisk_id is not None:
return self.__kernel_id, self.__ramdisk_id
image_client = self.app.client_manager.image
kernel_id, ramdisk_id = None, None
try:
kernel_id = osc_utils.find_resource(
image_client.images, 'bm-deploy-kernel').id
except AttributeError:
self.log.exception("Please make sure there is only one image "
"named 'bm-deploy-kernel' in glance.")
except oscexc.CommandError:
self.log.exception("Error finding 'bm-deploy-kernel' in "
"glance.")
try:
ramdisk_id = osc_utils.find_resource(
image_client.images, 'bm-deploy-ramdisk').id
except AttributeError:
self.log.exception("Please make sure there is only one image "
"named 'bm-deploy-ramdisk' in glance.")
except oscexc.CommandError:
self.log.exception("Error finding 'bm-deploy-ramdisk' in "
"glance.")
self.log.debug("Using kernel ID: {0} and ramdisk ID: {1}".format(
kernel_id, ramdisk_id))
self.__kernel_id = kernel_id
self.__ramdisk_id = ramdisk_id
return kernel_id, ramdisk_id
def _check_boot_images(self):
kernel_id, ramdisk_id = self._image_ids()
message = ("No image with the name '{}' found - make "
"sure you've uploaded boot images")
if kernel_id is None:
self.predeploy_errors += 1
self.log.error(message.format('bm-deploy-kernel'))
if ramdisk_id is None:
self.predeploy_errors += 1
self.log.error(message.format('bm-deploy-ramdisk'))
def _collect_flavors(self, parsed_args):
"""Validate and collect nova flavors in use.
Ensure that selected flavors (--ROLE-flavor) are valid in nova.
Issue a warning of local boot is not set for a flavor.
:returns: dictionary flavor name -> (flavor object, scale)
"""
compute_client = self.app.client_manager.compute
flavors = {f.name: f for f in compute_client.flavors.list()}
result = {}
message = "Provided --{}-flavor, '{}', does not exist"
for target, (flavor_name, scale) in (
utils.get_roles_info(parsed_args).items()
):
if flavor_name is None or not scale:
self.log.debug("--{}-flavor not used".format(target))
continue
try:
flavor, old_scale = result[flavor_name]
except KeyError:
pass
else:
result[flavor_name] = (flavor, old_scale + scale)
continue
try:
flavor = flavors[flavor_name]
except KeyError:
self.predeploy_errors += 1
self.log.error(message.format(target, flavor_name))
continue
if flavor.get_keys().get('capabilities:boot_option', '') \
!= 'local':
self.predeploy_warnings += 1
self.log.warning(
'Flavor %s "capabilities:boot_option" is not set to '
'"local". Nodes must have ability to PXE boot from '
'deploy image.', flavor_name)
self.log.warning(
'Recommended solution: openstack flavor set --property '
'"cpu_arch"="x86_64" --property '
'"capabilities:boot_option"="local" ' + flavor_name)
result[flavor_name] = (flavor, scale)
return result
def _check_ironic_boot_configuration(self, bm_client):
for node in bm_client.node.list(detail=True, maintenance=False):
self.log.debug("Checking config for Node {0}".format(node.uuid))
self._check_node_boot_configuration(node)
def _check_node_boot_configuration(self, node):
kernel_id, ramdisk_id = self._image_ids()
self.log.debug("Doing boot checks for {}".format(node.uuid))
message = ("Node uuid={uuid} has an incorrectly configured "
"{property}. Expected \"{expected}\" but got "
"\"{actual}\".")
if node.driver_info.get('deploy_ramdisk') != ramdisk_id:
self.predeploy_errors += 1
self.log.error(message.format(
uuid=node.uuid,
property='driver_info/deploy_ramdisk',
expected=ramdisk_id,
actual=node.driver_info.get('deploy_ramdisk')
))
if node.driver_info.get('deploy_kernel') != kernel_id:
self.predeploy_errors += 1
self.log.error(message.format(
uuid=node.uuid,
property='driver_info/deploy_kernel',
expected=kernel_id,
actual=node.driver_info.get('deploy_kernel')
))
if 'boot_option:local' not in node.properties.get('capabilities', ''):
self.predeploy_warnings += 1
self.log.warning(message.format(
uuid=node.uuid,
property='properties/capabilities',
expected='boot_option:local',
actual=node.properties.get('capabilities')
))
def get_parser(self, prog_name):
# add_help doesn't work properly, set it to False:
parser = argparse.ArgumentParser(
description=self.get_description(),
prog=prog_name,
add_help=False
)
parser.add_argument(
'--templates', nargs='?', const=constants.TRIPLEO_HEAT_TEMPLATES,
help=_("The directory containing the Heat templates to deploy"),
)
parser.add_argument('--stack',
help=_("Stack name to create or update"),
default='overcloud')
parser.add_argument('--timeout', '-t', metavar='<TIMEOUT>',
type=int, default=240,
help=_('Deployment timeout in minutes.'))
utils.add_deployment_plan_arguments(parser)
parser.add_argument('--neutron-flat-networks',
help=_('Comma separated list of physical_network '
'names with which flat networks can be '
'created. Use * to allow flat networks '
'with arbitrary physical_network names. '
'(DEPRECATED)'))
parser.add_argument('--neutron-physical-bridge',
help=_('Deprecated.'))
parser.add_argument('--neutron-bridge-mappings',
help=_('Comma separated list of bridge mappings. '
'(DEPRECATED)'))
parser.add_argument('--neutron-public-interface',
help=_('Deprecated.'))
parser.add_argument('--neutron-network-type',
help=_('The network type for tenant networks. '
'(DEPRECATED)'))
parser.add_argument('--neutron-tunnel-types',
help=_('Network types supported by the agent '
'(gre and/or vxlan). '
'(DEPRECATED)'))
parser.add_argument('--neutron-tunnel-id-ranges',
help=_("Ranges of GRE tunnel IDs to make "
"available for tenant network allocation "
"(DEPRECATED)"),)
parser.add_argument('--neutron-vni-ranges',
help=_("Ranges of VXLAN VNI IDs to make "
"available for tenant network allocation "
"(DEPRECATED)"),)
parser.add_argument('--neutron-disable-tunneling',
dest='neutron_disable_tunneling',
action="store_const", const=True,
help=_('Disables tunneling. (DEPRECATED)')),
parser.add_argument('--neutron-network-vlan-ranges',
help=_('Comma separated list of '
'<physical_network>:<vlan_min>:<vlan_max> '
'or <physical_network> specifying '
'physical_network names usable for VLAN '
'provider and tenant networks, as well as '
'ranges of VLAN tags on each available for '
'allocation to tenant networks. '
'(ex: datacentre:1:1000) (DEPRECATED)'))
parser.add_argument('--neutron-mechanism-drivers',
help=_('An ordered list of extension driver '
'entrypoints to be loaded from the '
'neutron.ml2.extension_drivers namespace. '
'(DEPRECATED)'))
parser.add_argument('--libvirt-type',
choices=['kvm', 'qemu'],
help=_('Libvirt domain type.'))
parser.add_argument('--ntp-server',
help=_('The NTP for overcloud nodes. '))
parser.add_argument(
'--no-proxy',
default=os.environ.get('no_proxy', ''),
help=_('A comma separated list of hosts that should not be '
'proxied.')
)
parser.add_argument(
'--overcloud-ssh-user',
default='heat-admin',
help=_('User for ssh access to overcloud nodes')
)
parser.add_argument(
'--environment-file', '-e', metavar='<HEAT ENVIRONMENT FILE>',
action='append', dest='environment_files',
help=_('Environment files to be passed to the heat stack-create '
'or heat stack-update command. (Can be specified more than '
'once.)')
)
parser.add_argument(
'--environment-directory', metavar='<HEAT ENVIRONMENT DIRECTORY>',
action='append', dest='environment_directories',
default=[os.path.join(os.environ.get('HOME', ''), '.tripleo',
'environments')],
help=_('Environment file directories that are automatically '
' added to the heat stack-create or heat stack-update'
' commands. Can be specified more than once. Files in'
' directories are loaded in ascending sort order.')
)
parser.add_argument(
'--roles-file', '-r', dest='roles_file',
help=_('Roles file, overrides the default %s in the --templates '
'directory') % constants.OVERCLOUD_ROLES_FILE
)
parser.add_argument(
'--no-cleanup', action='store_true',
help=_('Don\'t cleanup temporary files, just log their location')
)
# TODO(bnemec): In Ocata or later, remove this group and just leave
# --validation-errors-nonfatal
error_group = parser.add_mutually_exclusive_group()
error_group.add_argument(
'--validation-errors-fatal',
action='store_true',
default=True,
help=_('DEPRECATED: Validation errors are now fatal by default. '
'This option will be removed in the future.')
)
error_group.add_argument(
'--validation-errors-nonfatal',
dest='validation_errors_fatal',
action='store_false',
default=True,
help=_('Allow the deployment to continue in spite of validation '
'errors. Note that attempting deployment while errors '
'exist is likely to fail.')
)
parser.add_argument(
'--validation-warnings-fatal',
action='store_true',
default=False,
help=_('Exit if there are warnings from the configuration '
'pre-checks.')
)
parser.add_argument(
'--dry-run',
action='store_true',
default=False,
help=_('Only run validations, but do not apply any changes.')
)
parser.add_argument(
'--skip-postconfig',
action='store_true',
default=False,
help=_('Skip the overcloud post-deployment configuration.')
)
parser.add_argument(
'--force-postconfig',
action='store_true',
default=False,
help=_('Force the overcloud post-deployment configuration.')
)
reg_group = parser.add_argument_group('Registration Parameters')
reg_group.add_argument(
'--rhel-reg',
action='store_true',
help=_('Register overcloud nodes to the customer portal or a '
'satellite.')
)
reg_group.add_argument(
'--reg-method',
choices=['satellite', 'portal'],
default='satellite',
help=_('RHEL registration method to use for the overcloud nodes.')
)
reg_group.add_argument(
'--reg-org',
default='',
help=_('Organization key to use for registration.')
)
reg_group.add_argument(
'--reg-force',
action='store_true',
help=_('Register the system even if it is already registered.')
)
reg_group.add_argument(
'--reg-sat-url',
default='',
help=_('Satellite server to register overcloud nodes.')
)
reg_group.add_argument(
'--reg-activation-key',
default='',
help=_('Activation key to use for registration.')
)
parser.add_argument(
'--answers-file',
help=_('Path to a YAML file with arguments and parameters.')
)
return parser
def take_action(self, parsed_args):
self.log.debug("take_action(%s)" % parsed_args)
# Swiftclient logs things like 404s at error level, which is a problem
# because we use EAFP to check for the existence of files. Turn off
# most swiftclient logging to avoid cluttering up our output with
# pointless tracebacks.
sc_logger = logging.getLogger("swiftclient")
sc_logger.setLevel(logging.CRITICAL)
self._validate_args(parsed_args)
clients = self.app.client_manager
orchestration_client = clients.orchestration
stack = utils.get_stack(orchestration_client, parsed_args.stack)
parameters = self._update_parameters(
parsed_args, clients.network, stack)
errors, warnings = self._predeploy_verify_capabilities(
stack, parameters, parsed_args)
if errors > 0:
self.log.error(
"Configuration has %d errors, fix them before proceeding. "
"Ignoring these errors is likely to lead to a failed deploy.",
errors)
if parsed_args.validation_warnings_fatal or \
parsed_args.validation_errors_fatal:
return
if warnings > 0:
self.log.error(
"Configuration has %d warnings, fix them before proceeding. ",
warnings)
if parsed_args.validation_warnings_fatal:
return
else:
self.log.info("SUCCESS: No warnings or errors in deploy "
"configuration, proceeding.")
stack_create = stack is None
if stack_create:
self.log.info("No stack found, will be doing a stack create")
else:
self.log.info("Stack found, will be doing a stack update")
if parsed_args.rhel_reg:
if parsed_args.reg_method == 'satellite':
sat_required_args = (parsed_args.reg_org and
parsed_args.reg_sat_url and
parsed_args.reg_activation_key)
if not sat_required_args:
raise exceptions.DeploymentError(
"ERROR: In order to use satellite registration, "
"you must specify --reg-org, --reg-sat-url, and "
"--reg-activation-key.")
else:
portal_required_args = (parsed_args.reg_org and
parsed_args.reg_activation_key)
if not portal_required_args:
raise exceptions.DeploymentError(
"ERROR: In order to use portal registration, you "
"must specify --reg-org, and "
"--reg-activation-key.")
if parsed_args.dry_run:
print("Validation Finished")
return
self._deploy_tripleo_heat_templates_tmpdir(stack, parsed_args)
# Get a new copy of the stack after stack update/create. If it was
# a create then the previous stack object would be None.
stack = utils.get_stack(orchestration_client, parsed_args.stack)
# Force fetching of attributes
stack.get()
utils.create_overcloudrc(stack, parsed_args.no_proxy)
utils.create_tempest_deployer_input()
# Run postconfig on create or force. Use force to makes sure endpoints
# are created with deploy reruns and upgrades
if (stack_create or parsed_args.force_postconfig
and not parsed_args.skip_postconfig):
self._deploy_postconfig(stack, parsed_args)
overcloud_endpoint = utils.get_overcloud_endpoint(stack)
print("Overcloud Endpoint: {0}".format(overcloud_endpoint))
print("Overcloud Deployed")