| package com.mirantis.mk |
| |
| /** |
| * |
| * Openstack functions |
| * |
| */ |
| |
| /** |
| * Convert maps |
| * |
| */ |
| |
| @NonCPS def entries(m) { |
| return m.collect {k, v -> [k, v]} |
| } |
| |
| /** |
| * Install OpenStack service clients in isolated environment |
| * |
| * @param path Path where virtualenv is created |
| * @param version Version of the OpenStack clients |
| */ |
| |
| def setupOpenstackVirtualenv(path, version = 'latest') { |
| def python = new com.mirantis.mk.Python() |
| python.setupDocutilsVirtualenv(path) |
| |
| def openstack_kilo_packages = [ |
| //XXX: hack to fix https://bugs.launchpad.net/ubuntu/+source/python-pip/+bug/1635463 |
| 'cliff==2.8', |
| 'python-cinderclient>=1.3.1,<1.4.0', |
| 'python-glanceclient>=0.19.0,<0.20.0', |
| 'python-heatclient>=0.6.0,<0.7.0', |
| 'python-keystoneclient>=1.6.0,<1.7.0', |
| 'python-neutronclient>=2.2.6,<2.3.0', |
| 'python-novaclient>=2.19.0,<2.20.0', |
| 'python-swiftclient>=2.5.0,<2.6.0', |
| 'python-openstackclient>=1.7.0,<1.8.0', |
| 'oslo.config>=2.2.0,<2.3.0', |
| 'oslo.i18n>=2.3.0,<2.4.0', |
| 'oslo.serialization>=1.8.0,<1.9.0', |
| 'oslo.utils>=1.4.0,<1.5.0', |
| 'docutils' |
| ] |
| |
| def openstack_latest_packages = [ |
| //XXX: hack to fix https://bugs.launchpad.net/ubuntu/+source/python-pip/+bug/1635463 |
| 'cliff==2.8', |
| 'python-openstackclient', |
| 'python-heatclient', |
| 'docutils' |
| ] |
| |
| if (version == 'kilo') { |
| requirements = openstack_kilo_packages |
| } else if (version == 'liberty') { |
| requirements = openstack_kilo_packages |
| } else if (version == 'mitaka') { |
| requirements = openstack_kilo_packages |
| } else { |
| requirements = openstack_latest_packages |
| } |
| python.setupVirtualenv(path, 'python2', requirements, null, true) |
| } |
| |
| /** |
| * create connection to OpenStack API endpoint |
| * |
| * @param path Path to created venv |
| * @param url OpenStack API endpoint address |
| * @param credentialsId Credentials to the OpenStack API |
| * @param project OpenStack project to connect to |
| */ |
| def createOpenstackEnv(path, url, credentialsId, project, project_domain="default", |
| project_id="", user_domain="default", api_ver="2", cacert="/etc/ssl/certs/ca-certificates.crt") { |
| def common = new com.mirantis.mk.Common() |
| rcFile = "${path}/keystonerc" |
| creds = common.getPasswordCredentials(credentialsId) |
| rc = """set +x |
| export OS_USERNAME=${creds.username} |
| export OS_PASSWORD=${creds.password.toString()} |
| export OS_TENANT_NAME=${project} |
| export OS_AUTH_URL=${url} |
| export OS_AUTH_STRATEGY=keystone |
| export OS_PROJECT_NAME=${project} |
| export OS_PROJECT_ID=${project_id} |
| export OS_PROJECT_DOMAIN_ID=${project_domain} |
| export OS_USER_DOMAIN_NAME=${user_domain} |
| export OS_IDENTITY_API_VERSION=${api_ver} |
| export OS_CACERT=${cacert} |
| set -x |
| """ |
| writeFile file: rcFile, text: rc |
| return rcFile |
| } |
| |
| /** |
| * Run command with OpenStack env params and optional python env |
| * |
| * @param cmd Command to be executed |
| * @param env Environmental parameters with endpoint credentials |
| * @param path Optional path to virtualenv with specific clients |
| */ |
| def runOpenstackCommand(cmd, venv, path = null) { |
| def python = new com.mirantis.mk.Python() |
| openstackCmd = ". ${venv}; ${cmd}" |
| if (path) { |
| output = python.runVirtualenvCommand(path, openstackCmd) |
| } |
| else { |
| echo("[Command]: ${openstackCmd}") |
| output = sh ( |
| script: openstackCmd, |
| returnStdout: true |
| ).trim() |
| } |
| return output |
| } |
| |
| /** |
| * Get OpenStack Keystone token for current credentials |
| * |
| * @param env Connection parameters for OpenStack API endpoint |
| * @param path Optional path to the custom virtualenv |
| */ |
| def getKeystoneToken(client, path = null) { |
| def python = new com.mirantis.mk.Python() |
| cmd = "openstack token issue" |
| outputTable = runOpenstackCommand(cmd, client, path) |
| output = python.parseTextTable(outputTable, 'item', 'prettytable', path) |
| return output |
| } |
| |
| /** |
| * Create OpenStack environment file |
| * |
| * @param env Connection parameters for OpenStack API endpoint |
| * @param path Optional path to the custom virtualenv |
| */ |
| def createHeatEnv(file, environment = [], original_file = null) { |
| if (original_file) { |
| envString = readFile file: original_file |
| } else { |
| envString = "parameters:\n" |
| } |
| |
| p = entries(environment) |
| for (int i = 0; i < p.size(); i++) { |
| envString = "${envString} ${p.get(i)[0]}: ${p.get(i)[1]}\n" |
| } |
| |
| echo("writing to env file:\n${envString}") |
| writeFile file: file, text: envString |
| } |
| |
| /** |
| * Create new OpenStack Heat stack |
| * |
| * @param env Connection parameters for OpenStack API endpoint |
| * @param template HOT template for the new Heat stack |
| * @param environment Environmentale parameters of the new Heat stack |
| * @param name Name of the new Heat stack |
| * @param path Optional path to the custom virtualenv |
| */ |
| def createHeatStack(client, name, template, params = [], environment = null, path = null, action="create") { |
| def python = new com.mirantis.mk.Python() |
| def templateFile = "${env.WORKSPACE}/template/template/${template}.hot" |
| def envFile |
| def envSource |
| if (environment) { |
| envFile = "${env.WORKSPACE}/template/env/${name}.env" |
| if (environment.contains("/")) { |
| //init() returns all elements but the last in a collection. |
| def envPath = environment.tokenize("/").init().join("/") |
| if (envPath) { |
| envFile = "${env.WORKSPACE}/template/env/${envPath}/${name}.env" |
| } |
| } |
| envSource = "${env.WORKSPACE}/template/env/${environment}.env" |
| createHeatEnv(envFile, params, envSource) |
| } else { |
| envFile = "${env.WORKSPACE}/template/${name}.env" |
| createHeatEnv(envFile, params) |
| } |
| |
| def cmd |
| def waitState |
| |
| if (action == "create") { |
| cmd = "heat stack-create -f ${templateFile} -e ${envFile} ${name}" |
| waitState = "CREATE_COMPLETE" |
| } else { |
| cmd = "heat stack-update -f ${templateFile} -e ${envFile} ${name}" |
| waitState = "UPDATE_COMPLETE" |
| } |
| |
| dir("${env.WORKSPACE}/template/template") { |
| outputTable = runOpenstackCommand(cmd, client, path) |
| } |
| |
| output = python.parseTextTable(outputTable, 'item', 'prettytable', path) |
| |
| def heatStatusCheckerCount = 1 |
| while (heatStatusCheckerCount <= 250) { |
| status = getHeatStackStatus(client, name, path) |
| echo("[Heat Stack] Status: ${status}, Check: ${heatStatusCheckerCount}") |
| |
| if (status.contains('CREATE_FAILED')) { |
| info = getHeatStackInfo(client, name, path) |
| throw new Exception(info.stack_status_reason) |
| |
| } else if (status.contains(waitState)) { |
| info = getHeatStackInfo(client, name, path) |
| echo(info.stack_status_reason) |
| break |
| } |
| |
| sleep(30) |
| heatStatusCheckerCount++ |
| } |
| echo("[Heat Stack] Status: ${status}") |
| } |
| |
| /** |
| * Returns list of stacks for stack name filter |
| * |
| * @param client Connection parameters for OpenStack API endpoint |
| * @param filter Stack name filter |
| * @param path Optional path to the custom virtualenv |
| */ |
| def getStacksForNameContains(client, filter, path = null){ |
| cmd = 'heat stack-list | awk \'NR>3 {print $4}\' | sed \'$ d\' | grep ' + filter + '|| true' |
| return runOpenstackCommand(cmd, client, path).trim().tokenize("\n") |
| } |
| |
| |
| /** |
| * Get list of stack names with given stack status |
| * |
| * @param client Connection parameters for OpenStack API endpoint |
| * @param status Stack status |
| * @param path Optional path to the custom virtualenv |
| */ |
| def getStacksWithStatus(client, status, path = null) { |
| cmd = 'heat stack-list -f stack_status='+status+' | awk \'NR>3 {print $4}\' | sed \'$ d\'' |
| return runOpenstackCommand(cmd, client, path).trim().tokenize("\n") |
| } |
| |
| /** |
| * Get life cycle status for existing OpenStack Heat stack |
| * |
| * @param env Connection parameters for OpenStack API endpoint |
| * @param name Name of the managed Heat stack instance |
| * @param path Optional path to the custom virtualenv |
| */ |
| def getHeatStackStatus(client, name, path = null) { |
| cmd = 'heat stack-list | awk -v stack='+name+' \'{if ($4==stack) print $6}\'' |
| return runOpenstackCommand(cmd, client, path) |
| } |
| |
| /** |
| * Get info about existing OpenStack Heat stack |
| * |
| * @param env Connection parameters for OpenStack API endpoint |
| * @param name Name of the managed Heat stack instance |
| * @param path Optional path to the custom virtualenv |
| */ |
| def getHeatStackInfo(env, name, path = null) { |
| def python = new com.mirantis.mk.Python() |
| cmd = "heat stack-show ${name}" |
| outputTable = runOpenstackCommand(cmd, env, path) |
| output = python.parseTextTable(outputTable, 'item', 'prettytable', path) |
| return output |
| } |
| |
| /** |
| * Get existing OpenStack Heat stack output parameter |
| * |
| * @param env Connection parameters for OpenStack API endpoint |
| * @param name Name of the managed Heat stack |
| * @param parameter Name of the output parameter |
| * @param path Optional path to the custom virtualenv |
| */ |
| def getHeatStackOutputParam(env, name, outputParam, path = null) { |
| cmd = "heat output-show ${name} ${outputParam}" |
| output = runOpenstackCommand(cmd, env, path) |
| echo("${cmd}: ${output}") |
| // NOTE(vsaienko) heatclient 1.5.1 returns output in "", while later |
| // versions returns string without "". |
| // TODO Use openstack 'stack output show' when all jobs using at least Mitaka heatclient |
| return "${output}".replaceAll('"', '') |
| } |
| |
| /** |
| * List all resources from existing OpenStack Heat stack |
| * |
| * @param env Connection parameters for OpenStack API endpoint |
| * @param name Name of the managed Heat stack instance |
| * @param path Optional path to the custom virtualenv |
| */ |
| def getHeatStackResources(env, name, path = null) { |
| def python = new com.mirantis.mk.Python() |
| cmd = "heat resource-list ${name}" |
| outputTable = runOpenstackCommand(cmd, env, path) |
| output = python.parseTextTable(outputTable, 'list', 'prettytable', path) |
| return output |
| } |
| |
| /** |
| * Get info about resource from existing OpenStack Heat stack |
| * |
| * @param env Connection parameters for OpenStack API endpoint |
| * @param name Name of the managed Heat stack instance |
| * @param path Optional path to the custom virtualenv |
| */ |
| def getHeatStackResourceInfo(env, name, resource, path = null) { |
| def python = new com.mirantis.mk.Python() |
| cmd = "heat resource-show ${name} ${resource}" |
| outputTable = runOpenstackCommand(cmd, env, path) |
| output = python.parseTextTable(outputTable, 'item', 'prettytable', path) |
| return output |
| } |
| |
| /** |
| * Update existing OpenStack Heat stack |
| * |
| * @param env Connection parameters for OpenStack API endpoint |
| * @param name Name of the managed Heat stack instance |
| * @param path Optional path to the custom virtualenv |
| */ |
| def updateHeatStack(env, name, path = null) { |
| def python = new com.mirantis.mk.Python() |
| cmd = "heat stack-update ${name}" |
| outputTable = runOpenstackCommand(cmd, env, path) |
| output = python.parseTextTable(outputTable, 'item', 'prettytable', path) |
| return output |
| } |
| |
| /** |
| * Delete existing OpenStack Heat stack |
| * |
| * @param env Connection parameters for OpenStack API endpoint |
| * @param name Name of the managed Heat stack instance |
| * @param path Optional path to the custom virtualenv |
| */ |
| def deleteHeatStack(env, name, path = null) { |
| cmd = "heat stack-delete ${name}" |
| outputTable = runOpenstackCommand(cmd, env, path) |
| } |
| |
| /** |
| * Return list of servers from OpenStack Heat stack |
| * |
| * @param env Connection parameters for OpenStack API endpoint |
| * @param name Name of the managed Heat stack instance |
| * @param path Optional path to the custom virtualenv |
| */ |
| def getHeatStackServers(env, name, path = null) { |
| resources = heatGetStackResources(env, name, path) |
| servers = [] |
| for (resource in resources) { |
| if (resource.resource_type == 'OS::Nova::Server') { |
| resourceName = resource.resource_name |
| server = heatGetStackResourceInfo(env, name, resourceName, path) |
| servers.add(server.attributes.name) |
| } |
| } |
| echo("[Stack ${name}] Servers: ${servers}") |
| return servers |
| } |