Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 1 | package com.mirantis.mk |
| 2 | |
Jakub Josef | bceaa32 | 2017-06-13 18:28:27 +0200 | [diff] [blame] | 3 | import com.cloudbees.groovy.cps.NonCPS |
Jakub Josef | b77c081 | 2017-03-27 14:11:01 +0200 | [diff] [blame] | 4 | import java.util.stream.Collectors |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 5 | /** |
| 6 | * Salt functions |
| 7 | * |
| 8 | */ |
| 9 | |
| 10 | /** |
| 11 | * Salt connection and context parameters |
| 12 | * |
| 13 | * @param url Salt API server URL |
| 14 | * @param credentialsID ID of credentials store entry |
| 15 | */ |
| 16 | def connection(url, credentialsId = "salt") { |
Tomáš Kukrál | 6c04bd0 | 2017-03-01 22:18:52 +0100 | [diff] [blame] | 17 | def common = new com.mirantis.mk.Common() |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 18 | params = [ |
| 19 | "url": url, |
| 20 | "credentialsId": credentialsId, |
| 21 | "authToken": null, |
| 22 | "creds": common.getCredentials(credentialsId) |
| 23 | ] |
| 24 | params["authToken"] = saltLogin(params) |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 25 | return params |
| 26 | } |
| 27 | |
| 28 | /** |
| 29 | * Login to Salt API, return auth token |
| 30 | * |
| 31 | * @param master Salt connection object |
| 32 | */ |
| 33 | def saltLogin(master) { |
Tomáš Kukrál | 7bec053 | 2017-02-20 15:39:31 +0100 | [diff] [blame] | 34 | def http = new com.mirantis.mk.Http() |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 35 | data = [ |
| 36 | 'username': master.creds.username, |
| 37 | 'password': master.creds.password.toString(), |
| 38 | 'eauth': 'pam' |
| 39 | ] |
Tomáš Kukrál | 7bec053 | 2017-02-20 15:39:31 +0100 | [diff] [blame] | 40 | authToken = http.restGet(master, '/login', data)['return'][0]['token'] |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 41 | return authToken |
| 42 | } |
| 43 | |
| 44 | /** |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 45 | * Run action using Salt API (using plain HTTP request from Jenkins master) or Pepper (from slave shell) |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 46 | * |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 47 | * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method) (determines if command will be sent with Pepper of Salt API ) |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 48 | * @param client Client type |
| 49 | * @param target Target specification, eg. for compound matches by Pillar |
| 50 | * data: ['expression': 'I@openssh:server', 'type': 'compound']) |
| 51 | * @param function Function to execute (eg. "state.sls") |
Jakub Josef | 2f25cf2 | 2017-03-28 13:34:57 +0200 | [diff] [blame] | 52 | * @param batch Batch param to salt (integer or string with percents) |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 53 | * @param args Additional arguments to function |
| 54 | * @param kwargs Additional key-value arguments to function |
Jiri Broulik | 48544be | 2017-06-14 18:33:54 +0200 | [diff] [blame] | 55 | * @param timeout Additional argument salt api timeout |
Vasyl Saienko | e36ab7c | 2017-07-17 14:35:48 +0300 | [diff] [blame] | 56 | * @param read_timeout http session read timeout |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 57 | */ |
| 58 | @NonCPS |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 59 | def runSaltCommand(saltId, client, target, function, batch = null, args = null, kwargs = null, timeout = -1, read_timeout = -1) { |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 60 | |
| 61 | data = [ |
| 62 | 'tgt': target.expression, |
| 63 | 'fun': function, |
| 64 | 'client': client, |
| 65 | 'expr_form': target.type, |
| 66 | ] |
Jakub Josef | 5f83821 | 2017-04-06 12:43:58 +0200 | [diff] [blame] | 67 | if(batch != null && ( (batch instanceof Integer && batch > 0) || (batch instanceof String && batch.contains("%")))){ |
Jakub Josef | 2f25cf2 | 2017-03-28 13:34:57 +0200 | [diff] [blame] | 68 | data['client']= "local_batch" |
| 69 | data['batch'] = batch |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 70 | } |
| 71 | |
| 72 | if (args) { |
| 73 | data['arg'] = args |
| 74 | } |
| 75 | |
| 76 | if (kwargs) { |
| 77 | data['kwarg'] = kwargs |
| 78 | } |
| 79 | |
Jiri Broulik | 48544be | 2017-06-14 18:33:54 +0200 | [diff] [blame] | 80 | if (timeout != -1) { |
| 81 | data['timeout'] = timeout |
| 82 | } |
| 83 | |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 84 | // Command will be sent using HttpRequest |
| 85 | if (saltId instanceof HashMap && saltId.containsKey("authToken") ) { |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 86 | |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 87 | def headers = [ |
| 88 | 'X-Auth-Token': "${saltId.authToken}" |
| 89 | ] |
| 90 | |
| 91 | def http = new com.mirantis.mk.Http() |
| 92 | return http.sendHttpPostRequest("${saltId.url}/", data, headers, read_timeout) |
| 93 | } else if (saltId instanceof HashMap) { |
| 94 | throw new Exception("Invalid saltId") |
| 95 | } |
| 96 | |
| 97 | // Command will be sent using Pepper |
| 98 | return runPepperCommand(data, saltId) |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 99 | } |
| 100 | |
Jakub Josef | 5ade54c | 2017-03-10 16:14:01 +0100 | [diff] [blame] | 101 | /** |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 102 | * Return pillar for given saltId and target |
| 103 | * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method) |
Jakub Josef | 5ade54c | 2017-03-10 16:14:01 +0100 | [diff] [blame] | 104 | * @param target Get pillar target |
| 105 | * @param pillar pillar name (optional) |
| 106 | * @return output of salt command |
| 107 | */ |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 108 | def getPillar(saltId, target, pillar = null) { |
Tomáš Kukrál | d258970 | 2017-03-10 16:30:46 +0100 | [diff] [blame] | 109 | if (pillar != null) { |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 110 | return runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'pillar.get', null, [pillar.replace('.', ':')]) |
Tomáš Kukrál | d258970 | 2017-03-10 16:30:46 +0100 | [diff] [blame] | 111 | } else { |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 112 | return runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'pillar.data') |
Ales Komarek | a3c7e50 | 2017-03-13 11:20:44 +0100 | [diff] [blame] | 113 | } |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 114 | } |
| 115 | |
Jakub Josef | 5ade54c | 2017-03-10 16:14:01 +0100 | [diff] [blame] | 116 | /** |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 117 | * Return grain for given saltId and target |
| 118 | * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method) |
Jakub Josef | 5ade54c | 2017-03-10 16:14:01 +0100 | [diff] [blame] | 119 | * @param target Get grain target |
| 120 | * @param grain grain name (optional) |
| 121 | * @return output of salt command |
| 122 | */ |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 123 | def getGrain(saltId, target, grain = null) { |
Ales Komarek | cec24d4 | 2017-03-08 10:25:45 +0100 | [diff] [blame] | 124 | if(grain != null) { |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 125 | return runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'grains.item', null, [grain]) |
Jakub Josef | 5ade54c | 2017-03-10 16:14:01 +0100 | [diff] [blame] | 126 | } else { |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 127 | return runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'grains.items') |
Ales Komarek | cec24d4 | 2017-03-08 10:25:45 +0100 | [diff] [blame] | 128 | } |
Ales Komarek | cec24d4 | 2017-03-08 10:25:45 +0100 | [diff] [blame] | 129 | } |
| 130 | |
Jakub Josef | 5ade54c | 2017-03-10 16:14:01 +0100 | [diff] [blame] | 131 | /** |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 132 | * Enforces state on given saltId and target |
| 133 | * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method) |
Jakub Josef | 5ade54c | 2017-03-10 16:14:01 +0100 | [diff] [blame] | 134 | * @param target State enforcing target |
| 135 | * @param state Salt state |
| 136 | * @param output print output (optional, default true) |
| 137 | * @param failOnError throw exception on salt state result:false (optional, default true) |
Jakub Josef | 2f25cf2 | 2017-03-28 13:34:57 +0200 | [diff] [blame] | 138 | * @param batch salt batch parameter integer or string with percents (optional, default null - disable batch) |
Petr Michalec | de0ff32 | 2017-10-04 09:32:14 +0200 | [diff] [blame] | 139 | * @param read_timeout http session read timeout (optional, default -1 - disabled) |
| 140 | * @param retries Retry count for salt state. (optional, default -1 - no retries) |
| 141 | * @param queue salt queue parameter for state.sls calls (optional, default true) - CANNOT BE USED WITH BATCH |
Jakub Josef | 5ade54c | 2017-03-10 16:14:01 +0100 | [diff] [blame] | 142 | * @return output of salt command |
| 143 | */ |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 144 | def enforceState(saltId, target, state, output = true, failOnError = true, batch = null, optional = false, read_timeout=-1, retries=-1, queue=true) { |
Tomáš Kukrál | 6c04bd0 | 2017-03-01 22:18:52 +0100 | [diff] [blame] | 145 | def common = new com.mirantis.mk.Common() |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 146 | def run_states |
Tomáš Kukrál | 6c04bd0 | 2017-03-01 22:18:52 +0100 | [diff] [blame] | 147 | |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 148 | if (state instanceof String) { |
| 149 | run_states = state |
| 150 | } else { |
| 151 | run_states = state.join(',') |
| 152 | } |
| 153 | |
Marek Celoud | 6336611 | 2017-07-25 17:27:24 +0200 | [diff] [blame] | 154 | common.infoMsg("Running state ${run_states} on ${target}") |
Vasyl Saienko | e36ab7c | 2017-07-17 14:35:48 +0300 | [diff] [blame] | 155 | def out |
Petr Michalec | de0ff32 | 2017-10-04 09:32:14 +0200 | [diff] [blame] | 156 | def kwargs = [:] |
| 157 | |
| 158 | if (queue && batch == null) { |
| 159 | kwargs["queue"] = true |
| 160 | } |
Vasyl Saienko | e36ab7c | 2017-07-17 14:35:48 +0300 | [diff] [blame] | 161 | |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 162 | if (optional == false || testTarget(saltId, target)){ |
Richard Felkl | 03203d6 | 2017-11-01 17:57:32 +0100 | [diff] [blame] | 163 | if (retries > 0){ |
| 164 | failOnError = true |
Vasyl Saienko | e36ab7c | 2017-07-17 14:35:48 +0300 | [diff] [blame] | 165 | retry(retries){ |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 166 | out = runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'state.sls', batch, [run_states], kwargs, -1, read_timeout) |
Richard Felkl | 03203d6 | 2017-11-01 17:57:32 +0100 | [diff] [blame] | 167 | checkResult(out, failOnError, output) |
Vasyl Saienko | e36ab7c | 2017-07-17 14:35:48 +0300 | [diff] [blame] | 168 | } |
Petr Michalec | de0ff32 | 2017-10-04 09:32:14 +0200 | [diff] [blame] | 169 | } else { |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 170 | out = runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'state.sls', batch, [run_states], kwargs, -1, read_timeout) |
Richard Felkl | 03203d6 | 2017-11-01 17:57:32 +0100 | [diff] [blame] | 171 | checkResult(out, failOnError, output) |
Vasyl Saienko | e36ab7c | 2017-07-17 14:35:48 +0300 | [diff] [blame] | 172 | } |
Oleg Iurchenko | 7eb2150 | 2017-11-28 18:53:43 +0200 | [diff] [blame] | 173 | waitForMinion(out) |
Martin Polreich | 1c77afa | 2017-07-18 11:27:02 +0200 | [diff] [blame] | 174 | return out |
Martin Polreich | 1c77afa | 2017-07-18 11:27:02 +0200 | [diff] [blame] | 175 | } else { |
| 176 | common.infoMsg("No Minions matched the target given, but 'optional' param was set to true - Pipeline continues. ") |
| 177 | } |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 178 | } |
| 179 | |
Jakub Josef | 5ade54c | 2017-03-10 16:14:01 +0100 | [diff] [blame] | 180 | /** |
| 181 | * Run command on salt minion (salt cmd.run wrapper) |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 182 | * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method) |
Jakub Josef | 5ade54c | 2017-03-10 16:14:01 +0100 | [diff] [blame] | 183 | * @param target Get pillar target |
| 184 | * @param cmd command |
Jakub Josef | 053df39 | 2017-05-03 15:51:05 +0200 | [diff] [blame] | 185 | * @param checkResponse test command success execution (default true) |
Jakub Josef | 2f25cf2 | 2017-03-28 13:34:57 +0200 | [diff] [blame] | 186 | * @param batch salt batch parameter integer or string with percents (optional, default null - disable batch) |
Jiri Broulik | 2c69f3d | 2017-07-18 14:23:58 +0200 | [diff] [blame] | 187 | * @param output do you want to print output |
chnyda | 205a92b | 2018-01-11 17:07:32 +0100 | [diff] [blame] | 188 | * @param saltArgs additional salt args eq. ["runas=aptly"] |
Jakub Josef | 5ade54c | 2017-03-10 16:14:01 +0100 | [diff] [blame] | 189 | * @return output of salt command |
| 190 | */ |
chnyda | 205a92b | 2018-01-11 17:07:32 +0100 | [diff] [blame] | 191 | def cmdRun(saltId, target, cmd, checkResponse = true, batch=null, output = true, saltArgs = []) { |
Tomáš Kukrál | 6c04bd0 | 2017-03-01 22:18:52 +0100 | [diff] [blame] | 192 | def common = new com.mirantis.mk.Common() |
Jakub Josef | 053df39 | 2017-05-03 15:51:05 +0200 | [diff] [blame] | 193 | def originalCmd = cmd |
Tomáš Kukrál | dfd4b49 | 2017-03-02 12:08:50 +0100 | [diff] [blame] | 194 | common.infoMsg("Running command ${cmd} on ${target}") |
Jakub Josef | 053df39 | 2017-05-03 15:51:05 +0200 | [diff] [blame] | 195 | if (checkResponse) { |
| 196 | cmd = cmd + " && echo Salt command execution success" |
| 197 | } |
chnyda | 205a92b | 2018-01-11 17:07:32 +0100 | [diff] [blame] | 198 | |
| 199 | saltArgs << cmd |
| 200 | |
| 201 | def out = runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'cmd.run', batch, saltArgs.reverse()) |
Jakub Josef | 053df39 | 2017-05-03 15:51:05 +0200 | [diff] [blame] | 202 | if (checkResponse) { |
| 203 | // iterate over all affected nodes and check success return code |
Jiri Broulik | 16e9ce7 | 2017-05-17 13:28:31 +0200 | [diff] [blame] | 204 | if (out["return"]){ |
| 205 | for(int i=0;i<out["return"].size();i++){ |
| 206 | def node = out["return"][i]; |
Jakub Josef | 053df39 | 2017-05-03 15:51:05 +0200 | [diff] [blame] | 207 | for(int j=0;j<node.size();j++){ |
| 208 | def nodeKey = node.keySet()[j] |
| 209 | if (!node[nodeKey].contains("Salt command execution success")) { |
| 210 | throw new Exception("Execution of cmd ${originalCmd} failed. Server returns: ${node[nodeKey]}") |
| 211 | } |
| 212 | } |
| 213 | } |
| 214 | }else{ |
| 215 | throw new Exception("Salt Api response doesn't have return param!") |
| 216 | } |
| 217 | } |
Jiri Broulik | 16e9ce7 | 2017-05-17 13:28:31 +0200 | [diff] [blame] | 218 | if (output == true) { |
| 219 | printSaltCommandResult(out) |
| 220 | } |
| 221 | return out |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 222 | } |
| 223 | |
Jiri Broulik | 2c69f3d | 2017-07-18 14:23:58 +0200 | [diff] [blame] | 224 | /** |
Jiri Broulik | 71512bc | 2017-08-04 10:00:18 +0200 | [diff] [blame] | 225 | * Checks if salt minion is in a list of salt master's accepted keys |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 226 | * @usage minionPresent(saltId, 'I@salt:master', 'ntw', true, null, true, 200, 3) |
| 227 | * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method) |
Jiri Broulik | 2c69f3d | 2017-07-18 14:23:58 +0200 | [diff] [blame] | 228 | * @param target Get pillar target |
| 229 | * @param minion_name unique identification of a minion in salt-key command output |
| 230 | * @param waitUntilPresent return after the minion becomes present (default true) |
| 231 | * @param batch salt batch parameter integer or string with percents (optional, default null - disable batch) |
| 232 | * @param output print salt command (default true) |
Jiri Broulik | 71512bc | 2017-08-04 10:00:18 +0200 | [diff] [blame] | 233 | * @param maxRetries finite number of iterations to check status of a command (default 200) |
| 234 | * @param answers how many minions should return (optional, default 1) |
Jiri Broulik | 2c69f3d | 2017-07-18 14:23:58 +0200 | [diff] [blame] | 235 | * @return output of salt command |
| 236 | */ |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 237 | def minionPresent(saltId, target, minion_name, waitUntilPresent = true, batch=null, output = true, maxRetries = 200, answers = 1) { |
Jiri Broulik | 71512bc | 2017-08-04 10:00:18 +0200 | [diff] [blame] | 238 | minion_name = minion_name.replace("*", "") |
| 239 | def common = new com.mirantis.mk.Common() |
| 240 | def cmd = 'salt-key | grep ' + minion_name |
| 241 | if (waitUntilPresent){ |
| 242 | def count = 0 |
| 243 | while(count < maxRetries) { |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 244 | def out = runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'cmd.shell', batch, [cmd], null, 5) |
Jiri Broulik | 71512bc | 2017-08-04 10:00:18 +0200 | [diff] [blame] | 245 | if (output) { |
| 246 | printSaltCommandResult(out) |
| 247 | } |
| 248 | def valueMap = out["return"][0] |
| 249 | def result = valueMap.get(valueMap.keySet()[0]) |
| 250 | def resultsArray = result.tokenize("\n") |
| 251 | def size = resultsArray.size() |
| 252 | if (size >= answers) { |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 253 | return out |
Jiri Broulik | 71512bc | 2017-08-04 10:00:18 +0200 | [diff] [blame] | 254 | } |
| 255 | count++ |
| 256 | sleep(time: 500, unit: 'MILLISECONDS') |
| 257 | common.infoMsg("Waiting for ${cmd} on ${target} to be in correct state") |
| 258 | } |
| 259 | } else { |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 260 | def out = runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'cmd.shell', batch, [cmd], null, 5) |
Jiri Broulik | 71512bc | 2017-08-04 10:00:18 +0200 | [diff] [blame] | 261 | if (output) { |
| 262 | printSaltCommandResult(out) |
| 263 | } |
| 264 | return out |
| 265 | } |
| 266 | // otherwise throw exception |
| 267 | common.errorMsg("Status of command ${cmd} on ${target} failed, please check it.") |
| 268 | throw new Exception("${cmd} signals failure of status check!") |
| 269 | } |
| 270 | |
| 271 | /** |
| 272 | * You can call this function when salt-master already contains salt keys of the target_nodes |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 273 | * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method) |
Jiri Broulik | 71512bc | 2017-08-04 10:00:18 +0200 | [diff] [blame] | 274 | * @param target Should always be salt-master |
| 275 | * @param target_nodes unique identification of a minion or group of salt minions |
| 276 | * @param batch salt batch parameter integer or string with percents (optional, default null - disable batch) |
| 277 | * @param wait timeout for the salt command if minions do not return (default 10) |
| 278 | * @param maxRetries finite number of iterations to check status of a command (default 200) |
| 279 | * @return output of salt command |
| 280 | */ |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 281 | def minionsReachable(saltId, target, target_nodes, batch=null, wait = 10, maxRetries = 200) { |
Jiri Broulik | 71512bc | 2017-08-04 10:00:18 +0200 | [diff] [blame] | 282 | def common = new com.mirantis.mk.Common() |
| 283 | def cmd = "salt -t${wait} -C '${target_nodes}' test.ping" |
| 284 | common.infoMsg("Checking if all ${target_nodes} minions are reachable") |
| 285 | def count = 0 |
| 286 | while(count < maxRetries) { |
| 287 | Calendar timeout = Calendar.getInstance(); |
| 288 | timeout.add(Calendar.SECOND, wait); |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 289 | def out = runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'cmd.shell', batch, [cmd], null, wait) |
Jiri Broulik | 71512bc | 2017-08-04 10:00:18 +0200 | [diff] [blame] | 290 | Calendar current = Calendar.getInstance(); |
| 291 | if (current.getTime().before(timeout.getTime())) { |
| 292 | printSaltCommandResult(out) |
| 293 | return out |
| 294 | } |
| 295 | common.infoMsg("Not all of the targeted '${target_nodes}' minions returned yet. Waiting ...") |
| 296 | count++ |
| 297 | sleep(time: 500, unit: 'MILLISECONDS') |
| 298 | } |
Jiri Broulik | 2c69f3d | 2017-07-18 14:23:58 +0200 | [diff] [blame] | 299 | } |
| 300 | |
| 301 | /** |
| 302 | * Run command on salt minion (salt cmd.run wrapper) |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 303 | * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method) |
Jiri Broulik | 2c69f3d | 2017-07-18 14:23:58 +0200 | [diff] [blame] | 304 | * @param target Get pillar target |
| 305 | * @param cmd name of a service |
| 306 | * @param correct_state string that command must contain if status is in correct state (optional, default 'running') |
Jiri Broulik | cf1f233 | 2017-07-25 11:30:03 +0200 | [diff] [blame] | 307 | * @param find bool value if it is suppose to find some string in the output or the cmd should return empty string (optional, default true) |
Jiri Broulik | 2c69f3d | 2017-07-18 14:23:58 +0200 | [diff] [blame] | 308 | * @param waitUntilOk return after the minion becomes present (optional, default true) |
| 309 | * @param batch salt batch parameter integer or string with percents (optional, default null - disable batch) |
| 310 | * @param output print salt command (default true) |
Jiri Broulik | 71512bc | 2017-08-04 10:00:18 +0200 | [diff] [blame] | 311 | * @param maxRetries finite number of iterations to check status of a command (default 200) |
| 312 | * @param answers how many minions should return (optional, default 0) |
Jiri Broulik | 2c69f3d | 2017-07-18 14:23:58 +0200 | [diff] [blame] | 313 | * @return output of salt command |
| 314 | */ |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 315 | def commandStatus(saltId, target, cmd, correct_state='running', find = true, waitUntilOk = true, batch=null, output = true, maxRetries = 200, answers = 0) { |
Jiri Broulik | 2c69f3d | 2017-07-18 14:23:58 +0200 | [diff] [blame] | 316 | def common = new com.mirantis.mk.Common() |
| 317 | common.infoMsg("Checking if status of verification command ${cmd} on ${target} is in correct state") |
| 318 | if (waitUntilOk){ |
| 319 | def count = 0 |
| 320 | while(count < maxRetries) { |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 321 | def out = runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'cmd.shell', batch, [cmd], null, 5) |
Jiri Broulik | 71512bc | 2017-08-04 10:00:18 +0200 | [diff] [blame] | 322 | if (output) { |
| 323 | printSaltCommandResult(out) |
| 324 | } |
Jakub Josef | 115a78f | 2017-07-18 15:04:00 +0200 | [diff] [blame] | 325 | def resultMap = out["return"][0] |
Jiri Broulik | 71512bc | 2017-08-04 10:00:18 +0200 | [diff] [blame] | 326 | def success = 0 |
| 327 | if (answers == 0){ |
| 328 | answers = resultMap.size() |
| 329 | } |
| 330 | for (int i=0;i<answers;i++) { |
| 331 | result = resultMap.get(resultMap.keySet()[i]) |
| 332 | // if the goal is to find some string in output of the command |
| 333 | if (find) { |
| 334 | if(result == null || result instanceof Boolean || result.isEmpty()) { result='' } |
| 335 | if (result.toLowerCase().contains(correct_state.toLowerCase())) { |
| 336 | success++ |
| 337 | if (success == answers) { |
| 338 | return out |
| 339 | } |
Jiri Broulik | d0c2757 | 2017-07-24 20:01:10 +0200 | [diff] [blame] | 340 | } |
Jiri Broulik | 71512bc | 2017-08-04 10:00:18 +0200 | [diff] [blame] | 341 | // else the goal is to not find any string in output of the command |
| 342 | } else { |
| 343 | if(result instanceof String && result.isEmpty()) { |
| 344 | success++ |
| 345 | if (success == answers) { |
| 346 | return out |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 347 | } |
Jiri Broulik | 71512bc | 2017-08-04 10:00:18 +0200 | [diff] [blame] | 348 | } |
| 349 | } |
| 350 | } |
| 351 | count++ |
| 352 | sleep(time: 500, unit: 'MILLISECONDS') |
| 353 | common.infoMsg("Waiting for ${cmd} on ${target} to be in correct state") |
| 354 | } |
| 355 | } else { |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 356 | def out = runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'cmd.shell', batch, [cmd], null, 5) |
Jiri Broulik | 71512bc | 2017-08-04 10:00:18 +0200 | [diff] [blame] | 357 | def resultMap = out["return"][0] |
| 358 | if (output) { |
| 359 | printSaltCommandResult(out) |
| 360 | } |
| 361 | for (int i=0;i<resultMap.size();i++) { |
| 362 | result = resultMap.get(resultMap.keySet()[i]) |
| 363 | // if the goal is to find some string in output of the command |
| 364 | if (find) { |
| 365 | if(result == null || result instanceof Boolean || result.isEmpty()) { result='' } |
| 366 | if (result.toLowerCase().contains(correct_state.toLowerCase())) { |
Jiri Broulik | d0c2757 | 2017-07-24 20:01:10 +0200 | [diff] [blame] | 367 | return out |
| 368 | } |
| 369 | |
| 370 | // else the goal is to not find any string in output of the command |
| 371 | } else { |
| 372 | if(result instanceof String && result.isEmpty()) { |
| 373 | return out |
| 374 | } |
| 375 | } |
Jiri Broulik | 2c69f3d | 2017-07-18 14:23:58 +0200 | [diff] [blame] | 376 | } |
| 377 | } |
| 378 | // otherwise throw exception |
Jiri Broulik | d0c2757 | 2017-07-24 20:01:10 +0200 | [diff] [blame] | 379 | common.errorMsg("Status of command ${cmd} on ${target} failed, please check it.") |
Jiri Broulik | 2c69f3d | 2017-07-18 14:23:58 +0200 | [diff] [blame] | 380 | throw new Exception("${cmd} signals failure of status check!") |
| 381 | } |
| 382 | |
Jakub Josef | 5ade54c | 2017-03-10 16:14:01 +0100 | [diff] [blame] | 383 | /** |
| 384 | * Perform complete salt sync between master and target |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 385 | * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method) |
Jakub Josef | 5ade54c | 2017-03-10 16:14:01 +0100 | [diff] [blame] | 386 | * @param target Get pillar target |
| 387 | * @return output of salt command |
| 388 | */ |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 389 | def syncAll(saltId, target) { |
| 390 | return runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'saltutil.sync_all') |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 391 | } |
| 392 | |
Jakub Josef | 5ade54c | 2017-03-10 16:14:01 +0100 | [diff] [blame] | 393 | /** |
| 394 | * Enforce highstate on given targets |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 395 | * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method) |
Jakub Josef | 5ade54c | 2017-03-10 16:14:01 +0100 | [diff] [blame] | 396 | * @param target Highstate enforcing target |
| 397 | * @param output print output (optional, default true) |
| 398 | * @param failOnError throw exception on salt state result:false (optional, default true) |
Jakub Josef | 2f25cf2 | 2017-03-28 13:34:57 +0200 | [diff] [blame] | 399 | * @param batch salt batch parameter integer or string with percents (optional, default null - disable batch) |
Jakub Josef | 5ade54c | 2017-03-10 16:14:01 +0100 | [diff] [blame] | 400 | * @return output of salt command |
| 401 | */ |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 402 | def enforceHighstate(saltId, target, output = false, failOnError = true, batch = null) { |
| 403 | def out = runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'state.highstate', batch) |
Alexander Noskov | 657ccfc | 2017-07-14 11:35:52 +0000 | [diff] [blame] | 404 | def common = new com.mirantis.mk.Common() |
| 405 | |
Marek Celoud | 6336611 | 2017-07-25 17:27:24 +0200 | [diff] [blame] | 406 | common.infoMsg("Running state highstate on ${target}") |
Alexander Noskov | 657ccfc | 2017-07-14 11:35:52 +0000 | [diff] [blame] | 407 | |
Jakub Josef | 374beb7 | 2017-04-27 15:45:09 +0200 | [diff] [blame] | 408 | checkResult(out, failOnError, output) |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 409 | return out |
| 410 | } |
| 411 | |
Jakub Josef | 5ade54c | 2017-03-10 16:14:01 +0100 | [diff] [blame] | 412 | /** |
Ales Komarek | 5276ebe | 2017-03-16 08:46:34 +0100 | [diff] [blame] | 413 | * Get running minions IDs according to the target |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 414 | * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method) |
Ales Komarek | 5276ebe | 2017-03-16 08:46:34 +0100 | [diff] [blame] | 415 | * @param target Get minions target |
| 416 | * @return list of active minions fitin |
| 417 | */ |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 418 | def getMinions(saltId, target) { |
| 419 | def minionsRaw = runSaltCommand(saltId, 'local', ['expression': target, 'type': 'compound'], 'test.ping') |
Ales Komarek | 5276ebe | 2017-03-16 08:46:34 +0100 | [diff] [blame] | 420 | return new ArrayList<String>(minionsRaw['return'][0].keySet()) |
| 421 | } |
| 422 | |
| 423 | |
| 424 | /** |
Tomáš Kukrál | b12ff9f | 2017-07-12 12:32:34 +0200 | [diff] [blame] | 425 | * Test if there are any minions to target |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 426 | * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method) |
Tomáš Kukrál | b12ff9f | 2017-07-12 12:32:34 +0200 | [diff] [blame] | 427 | * @param target Target to test |
vrovachev | 1c4770b | 2017-07-05 13:25:21 +0400 | [diff] [blame] | 428 | * @return bool indicating if target was succesful |
Tomáš Kukrál | b12ff9f | 2017-07-12 12:32:34 +0200 | [diff] [blame] | 429 | */ |
| 430 | |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 431 | def testTarget(saltId, target) { |
| 432 | return getMinions(saltId, target).size() > 0 |
Tomáš Kukrál | b12ff9f | 2017-07-12 12:32:34 +0200 | [diff] [blame] | 433 | } |
| 434 | |
| 435 | /** |
Jakub Josef | 5ade54c | 2017-03-10 16:14:01 +0100 | [diff] [blame] | 436 | * Generates node key using key.gen_accept call |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 437 | * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method) |
Jakub Josef | 5ade54c | 2017-03-10 16:14:01 +0100 | [diff] [blame] | 438 | * @param target Key generating target |
| 439 | * @param host Key generating host |
| 440 | * @param keysize generated key size (optional, default 4096) |
| 441 | * @return output of salt command |
| 442 | */ |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 443 | def generateNodeKey(saltId, target, host, keysize = 4096) { |
| 444 | return runSaltCommand(saltId, 'wheel', target, 'key.gen_accept', [host], ['keysize': keysize]) |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 445 | } |
| 446 | |
Jakub Josef | 5ade54c | 2017-03-10 16:14:01 +0100 | [diff] [blame] | 447 | /** |
Jakub Josef | 2f25cf2 | 2017-03-28 13:34:57 +0200 | [diff] [blame] | 448 | * Generates node reclass metadata |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 449 | * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method) |
Jakub Josef | 5ade54c | 2017-03-10 16:14:01 +0100 | [diff] [blame] | 450 | * @param target Metadata generating target |
| 451 | * @param host Metadata generating host |
| 452 | * @param classes Reclass classes |
| 453 | * @param parameters Reclass parameters |
| 454 | * @return output of salt command |
| 455 | */ |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 456 | def generateNodeMetadata(saltId, target, host, classes, parameters) { |
| 457 | return runSaltCommand(saltId, 'local', target, 'reclass.node_create', [host, '_generated'], ['classes': classes, 'parameters': parameters]) |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 458 | } |
| 459 | |
Jakub Josef | 5ade54c | 2017-03-10 16:14:01 +0100 | [diff] [blame] | 460 | /** |
| 461 | * Run salt orchestrate on given targets |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 462 | * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method) |
Jakub Josef | 5ade54c | 2017-03-10 16:14:01 +0100 | [diff] [blame] | 463 | * @param target Orchestration target |
| 464 | * @param orchestrate Salt orchestrate params |
| 465 | * @return output of salt command |
| 466 | */ |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 467 | def orchestrateSystem(saltId, target, orchestrate) { |
| 468 | return runSaltCommand(saltId, 'runner', target, 'state.orchestrate', [orchestrate]) |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 469 | } |
| 470 | |
Jakub Josef | 5ade54c | 2017-03-10 16:14:01 +0100 | [diff] [blame] | 471 | /** |
| 472 | * Run salt process step |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 473 | * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method) |
Jakub Josef | 5ade54c | 2017-03-10 16:14:01 +0100 | [diff] [blame] | 474 | * @param tgt Salt process step target |
| 475 | * @param fun Salt process step function |
| 476 | * @param arg process step arguments (optional, default []) |
Jakub Josef | 2f25cf2 | 2017-03-28 13:34:57 +0200 | [diff] [blame] | 477 | * @param batch salt batch parameter integer or string with percents (optional, default null - disable batch) |
Jakub Josef | 5ade54c | 2017-03-10 16:14:01 +0100 | [diff] [blame] | 478 | * @param output print output (optional, default false) |
Jiri Broulik | 48544be | 2017-06-14 18:33:54 +0200 | [diff] [blame] | 479 | * @param timeout Additional argument salt api timeout |
Jakub Josef | 5ade54c | 2017-03-10 16:14:01 +0100 | [diff] [blame] | 480 | * @return output of salt command |
| 481 | */ |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 482 | def runSaltProcessStep(saltId, tgt, fun, arg = [], batch = null, output = false, timeout = -1, kwargs = null) { |
Tomáš Kukrál | 6c04bd0 | 2017-03-01 22:18:52 +0100 | [diff] [blame] | 483 | def common = new com.mirantis.mk.Common() |
Jiri Broulik | 48544be | 2017-06-14 18:33:54 +0200 | [diff] [blame] | 484 | def salt = new com.mirantis.mk.Salt() |
Tomáš Kukrál | adb4ecd | 2017-03-02 10:06:36 +0100 | [diff] [blame] | 485 | def out |
| 486 | |
Marek Celoud | 6336611 | 2017-07-25 17:27:24 +0200 | [diff] [blame] | 487 | common.infoMsg("Running step ${fun} ${arg} on ${tgt}") |
Tomáš Kukrál | 6c04bd0 | 2017-03-01 22:18:52 +0100 | [diff] [blame] | 488 | |
Filip Pytloun | f0435c0 | 2017-03-02 17:48:54 +0100 | [diff] [blame] | 489 | if (batch == true) { |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 490 | out = runSaltCommand(saltId, 'local_batch', ['expression': tgt, 'type': 'compound'], fun, String.valueOf(batch), arg, kwargs, timeout) |
Tomáš Kukrál | adb4ecd | 2017-03-02 10:06:36 +0100 | [diff] [blame] | 491 | } else { |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 492 | out = runSaltCommand(saltId, 'local', ['expression': tgt, 'type': 'compound'], fun, batch, arg, kwargs, timeout) |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 493 | } |
Tomáš Kukrál | adb4ecd | 2017-03-02 10:06:36 +0100 | [diff] [blame] | 494 | |
Tomáš Kukrál | f5dda64 | 2017-03-02 14:22:59 +0100 | [diff] [blame] | 495 | if (output == true) { |
Jiri Broulik | 48544be | 2017-06-14 18:33:54 +0200 | [diff] [blame] | 496 | salt.printSaltCommandResult(out) |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 497 | } |
Jiri Broulik | ae19c26 | 2017-05-16 19:06:52 +0200 | [diff] [blame] | 498 | return out |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 499 | } |
| 500 | |
| 501 | /** |
| 502 | * Check result for errors and throw exception if any found |
| 503 | * |
| 504 | * @param result Parsed response of Salt API |
Jakub Josef | 8021c00 | 2017-03-27 15:41:28 +0200 | [diff] [blame] | 505 | * @param failOnError Do you want to throw exception if salt-call fails (optional, default true) |
Jakub Josef | a87941c | 2017-04-20 17:14:58 +0200 | [diff] [blame] | 506 | * @param printResults Do you want to print salt results (optional, default true) |
Jakub Josef | a87941c | 2017-04-20 17:14:58 +0200 | [diff] [blame] | 507 | * @param printOnlyChanges If true (default), print only changed resources |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 508 | */ |
Jakub Josef | 374beb7 | 2017-04-27 15:45:09 +0200 | [diff] [blame] | 509 | def checkResult(result, failOnError = true, printResults = true, printOnlyChanges = true) { |
Jakub Josef | 5ade54c | 2017-03-10 16:14:01 +0100 | [diff] [blame] | 510 | def common = new com.mirantis.mk.Common() |
Jakub Josef | d9afd0e | 2017-03-15 19:19:23 +0100 | [diff] [blame] | 511 | if(result != null){ |
| 512 | if(result['return']){ |
| 513 | for (int i=0;i<result['return'].size();i++) { |
| 514 | def entry = result['return'][i] |
| 515 | if (!entry) { |
| 516 | if (failOnError) { |
| 517 | throw new Exception("Salt API returned empty response: ${result}") |
| 518 | } else { |
| 519 | common.errorMsg("Salt API returned empty response: ${result}") |
Jakub Josef | ece32af | 2017-03-14 19:20:08 +0100 | [diff] [blame] | 520 | } |
Jakub Josef | d9afd0e | 2017-03-15 19:19:23 +0100 | [diff] [blame] | 521 | } |
| 522 | for (int j=0;j<entry.size();j++) { |
| 523 | def nodeKey = entry.keySet()[j] |
| 524 | def node=entry[nodeKey] |
Jakub Josef | a87941c | 2017-04-20 17:14:58 +0200 | [diff] [blame] | 525 | def outputResources = [] |
Jakub Josef | d9afd0e | 2017-03-15 19:19:23 +0100 | [diff] [blame] | 526 | common.infoMsg("Node ${nodeKey} changes:") |
| 527 | if(node instanceof Map || node instanceof List){ |
| 528 | for (int k=0;k<node.size();k++) { |
| 529 | def resource; |
| 530 | def resKey; |
| 531 | if(node instanceof Map){ |
| 532 | resKey = node.keySet()[k] |
| 533 | }else if(node instanceof List){ |
| 534 | resKey = k |
| 535 | } |
| 536 | resource = node[resKey] |
Jakub Josef | c4c4020 | 2017-04-28 12:04:24 +0200 | [diff] [blame] | 537 | // print |
Jakub Josef | a87941c | 2017-04-20 17:14:58 +0200 | [diff] [blame] | 538 | if(printResults){ |
| 539 | if(resource instanceof Map && resource.keySet().contains("result")){ |
| 540 | //clean unnesaccary fields |
| 541 | if(resource.keySet().contains("__run_num__")){ |
| 542 | resource.remove("__run_num__") |
| 543 | } |
| 544 | if(resource.keySet().contains("__id__")){ |
| 545 | resource.remove("__id__") |
| 546 | } |
| 547 | if(resource.keySet().contains("pchanges")){ |
| 548 | resource.remove("pchanges") |
| 549 | } |
| 550 | if(!resource["result"] || (resource["result"] instanceof String && resource["result"] != "true")){ |
| 551 | if(resource["result"] != null){ |
Jakub Josef | bceaa32 | 2017-06-13 18:28:27 +0200 | [diff] [blame] | 552 | outputResources.add(String.format("Resource: %s\n\u001B[31m%s\u001B[0m", resKey, common.prettify(resource))) |
Jakub Josef | a87941c | 2017-04-20 17:14:58 +0200 | [diff] [blame] | 553 | }else{ |
Jakub Josef | bceaa32 | 2017-06-13 18:28:27 +0200 | [diff] [blame] | 554 | outputResources.add(String.format("Resource: %s\n\u001B[33m%s\u001B[0m", resKey, common.prettify(resource))) |
Jakub Josef | a87941c | 2017-04-20 17:14:58 +0200 | [diff] [blame] | 555 | } |
| 556 | }else{ |
| 557 | if(!printOnlyChanges || resource.changes.size() > 0){ |
Jakub Josef | bceaa32 | 2017-06-13 18:28:27 +0200 | [diff] [blame] | 558 | outputResources.add(String.format("Resource: %s\n\u001B[32m%s\u001B[0m", resKey, common.prettify(resource))) |
Jakub Josef | a87941c | 2017-04-20 17:14:58 +0200 | [diff] [blame] | 559 | } |
| 560 | } |
| 561 | }else{ |
Jakub Josef | bceaa32 | 2017-06-13 18:28:27 +0200 | [diff] [blame] | 562 | outputResources.add(String.format("Resource: %s\n\u001B[36m%s\u001B[0m", resKey, common.prettify(resource))) |
Jakub Josef | a87941c | 2017-04-20 17:14:58 +0200 | [diff] [blame] | 563 | } |
Jakub Josef | d9afd0e | 2017-03-15 19:19:23 +0100 | [diff] [blame] | 564 | } |
Jakub Josef | c4c4020 | 2017-04-28 12:04:24 +0200 | [diff] [blame] | 565 | common.debugMsg("checkResult: checking resource: ${resource}") |
| 566 | if(resource instanceof String || (resource["result"] != null && !resource["result"]) || (resource["result"] instanceof String && resource["result"] == "false")){ |
Jakub Josef | bceaa32 | 2017-06-13 18:28:27 +0200 | [diff] [blame] | 567 | def prettyResource = common.prettify(resource) |
Jakub Josef | c4c4020 | 2017-04-28 12:04:24 +0200 | [diff] [blame] | 568 | if(env["ASK_ON_ERROR"] && env["ASK_ON_ERROR"] == "true"){ |
| 569 | timeout(time:1, unit:'HOURS') { |
| 570 | input message: "False result on ${nodeKey} found, resource ${prettyResource}. \nDo you want to continue?" |
| 571 | } |
| 572 | }else{ |
Jakub Josef | d97d7db | 2017-05-11 19:11:53 +0200 | [diff] [blame] | 573 | common.errorMsg(String.format("Resource: %s\n%s", resKey, prettyResource)) |
Jakub Josef | d9001df | 2017-05-11 16:45:28 +0200 | [diff] [blame] | 574 | def errorMsg = "Salt state on node ${nodeKey} failed: ${prettyResource}." |
Jakub Josef | c4c4020 | 2017-04-28 12:04:24 +0200 | [diff] [blame] | 575 | if (failOnError) { |
| 576 | throw new Exception(errorMsg) |
| 577 | } else { |
| 578 | common.errorMsg(errorMsg) |
| 579 | } |
| 580 | } |
| 581 | } |
Jakub Josef | d9afd0e | 2017-03-15 19:19:23 +0100 | [diff] [blame] | 582 | } |
Jakub Josef | a87941c | 2017-04-20 17:14:58 +0200 | [diff] [blame] | 583 | }else if(node!=null && node!=""){ |
Jakub Josef | 62f6c84 | 2017-08-04 16:36:35 +0200 | [diff] [blame] | 584 | outputResources.add(String.format("Resource: %s\n\u001B[36m%s\u001B[0m", nodeKey, common.prettify(node))) |
Jakub Josef | a87941c | 2017-04-20 17:14:58 +0200 | [diff] [blame] | 585 | } |
| 586 | if(printResults && !outputResources.isEmpty()){ |
Jakub Josef | e6c562e | 2017-08-09 14:41:03 +0200 | [diff] [blame] | 587 | print outputResources.stream().collect(Collectors.joining("\n")) |
Jakub Josef | d9afd0e | 2017-03-15 19:19:23 +0100 | [diff] [blame] | 588 | } |
| 589 | } |
Jakub Josef | 52f69f7 | 2017-03-14 15:18:08 +0100 | [diff] [blame] | 590 | } |
Jakub Josef | d9afd0e | 2017-03-15 19:19:23 +0100 | [diff] [blame] | 591 | }else{ |
| 592 | common.errorMsg("Salt result hasn't return attribute! Result: ${result}") |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 593 | } |
Jakub Josef | 52f69f7 | 2017-03-14 15:18:08 +0100 | [diff] [blame] | 594 | }else{ |
Jakub Josef | a87941c | 2017-04-20 17:14:58 +0200 | [diff] [blame] | 595 | common.errorMsg("Cannot check salt result, given result is null") |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 596 | } |
| 597 | } |
| 598 | |
| 599 | /** |
Oleg Iurchenko | 7eb2150 | 2017-11-28 18:53:43 +0200 | [diff] [blame] | 600 | * Parse salt API output to check minion restart and wait some time to be sure minion is up. |
| 601 | * See https://mirantis.jira.com/browse/PROD-16258 for more details |
| 602 | * TODO: change sleep to more tricky procedure. |
| 603 | * |
| 604 | * @param result Parsed response of Salt API |
| 605 | */ |
| 606 | def waitForMinion(result) { |
| 607 | def common = new com.mirantis.mk.Common() |
Oleg Iurchenko | 3eedc78 | 2017-12-12 11:49:29 +0200 | [diff] [blame] | 608 | //In order to prevent multiple sleeps use bool variable to catch restart for any minion. |
Oleg Iurchenko | 7eb2150 | 2017-11-28 18:53:43 +0200 | [diff] [blame] | 609 | def isMinionRestarted = false |
Oleg Iurchenko | 3eedc78 | 2017-12-12 11:49:29 +0200 | [diff] [blame] | 610 | if(result != null){ |
| 611 | if(result['return']){ |
| 612 | for (int i=0;i<result['return'].size();i++) { |
| 613 | def entry = result['return'][i] |
| 614 | // exit in case of empty response. |
| 615 | if (!entry) { |
| 616 | return |
| 617 | } |
| 618 | // Loop for nodes |
| 619 | for (int j=0;j<entry.size();j++) { |
| 620 | def nodeKey = entry.keySet()[j] |
| 621 | def node=entry[nodeKey] |
| 622 | if(node instanceof Map || node instanceof List){ |
| 623 | // Loop for node resources |
| 624 | for (int k=0;k<node.size();k++) { |
| 625 | def resource; |
| 626 | def resKey; |
| 627 | if(node instanceof Map){ |
| 628 | resKey = node.keySet()[k] |
| 629 | }else if(node instanceof List){ |
| 630 | resKey = k |
| 631 | } |
| 632 | resource = node[resKey] |
| 633 | if(resKey.contains("salt_minion_service_restart") && resource instanceof Map && resource.keySet().contains("result")){ |
| 634 | if((resource["result"] instanceof Boolean && resource["result"]) || (resource["result"] instanceof String && resource["result"] == "true")){ |
| 635 | if(resource.changes.size() > 0){ |
| 636 | isMinionRestarted=true |
| 637 | } |
| 638 | } |
| 639 | } |
| 640 | } |
| 641 | } |
| 642 | } |
| 643 | } |
Oleg Iurchenko | 7eb2150 | 2017-11-28 18:53:43 +0200 | [diff] [blame] | 644 | } |
| 645 | } |
Oleg Iurchenko | 7eb2150 | 2017-11-28 18:53:43 +0200 | [diff] [blame] | 646 | if (isMinionRestarted){ |
| 647 | common.infoMsg("Salt minion service restart detected. Sleep 10 seconds to wait minion restart") |
| 648 | sleep(10) |
| 649 | } |
| 650 | } |
| 651 | |
| 652 | /** |
Jakub Josef | 7852fe1 | 2017-03-15 16:02:41 +0100 | [diff] [blame] | 653 | * Print salt command run results in human-friendly form |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 654 | * |
| 655 | * @param result Parsed response of Salt API |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 656 | */ |
Filip Pytloun | d2f1bbe | 2017-02-27 19:03:51 +0100 | [diff] [blame] | 657 | def printSaltCommandResult(result) { |
Jakub Josef | 871bf15 | 2017-03-14 20:13:41 +0100 | [diff] [blame] | 658 | def common = new com.mirantis.mk.Common() |
Jakub Josef | d9afd0e | 2017-03-15 19:19:23 +0100 | [diff] [blame] | 659 | if(result != null){ |
| 660 | if(result['return']){ |
| 661 | for (int i=0; i<result['return'].size(); i++) { |
| 662 | def entry = result['return'][i] |
| 663 | for (int j=0; j<entry.size(); j++) { |
| 664 | common.debugMsg("printSaltCommandResult: printing salt command entry: ${entry}") |
| 665 | def nodeKey = entry.keySet()[j] |
| 666 | def node=entry[nodeKey] |
Jakub Josef | bceaa32 | 2017-06-13 18:28:27 +0200 | [diff] [blame] | 667 | common.infoMsg(String.format("Node %s changes:\n%s",nodeKey, common.prettify(node))) |
Jakub Josef | d9afd0e | 2017-03-15 19:19:23 +0100 | [diff] [blame] | 668 | } |
Jakub Josef | 8a715bf | 2017-03-14 21:39:01 +0100 | [diff] [blame] | 669 | } |
Jakub Josef | d9afd0e | 2017-03-15 19:19:23 +0100 | [diff] [blame] | 670 | }else{ |
| 671 | common.errorMsg("Salt result hasn't return attribute! Result: ${result}") |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 672 | } |
Jakub Josef | 8a715bf | 2017-03-14 21:39:01 +0100 | [diff] [blame] | 673 | }else{ |
Jakub Josef | d9afd0e | 2017-03-15 19:19:23 +0100 | [diff] [blame] | 674 | common.errorMsg("Cannot print salt command result, given result is null") |
Jakub Josef | 52f69f7 | 2017-03-14 15:18:08 +0100 | [diff] [blame] | 675 | } |
Jakub Josef | 79ecec3 | 2017-02-17 14:36:28 +0100 | [diff] [blame] | 676 | } |
Tomáš Kukrál | b12eedd | 2017-04-21 10:45:13 +0200 | [diff] [blame] | 677 | |
| 678 | |
| 679 | /** |
| 680 | * Return content of file target |
| 681 | * |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 682 | * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method) |
Tomáš Kukrál | b12eedd | 2017-04-21 10:45:13 +0200 | [diff] [blame] | 683 | * @param target Compound target (should target only one host) |
| 684 | * @param file File path to read (/etc/hosts for example) |
| 685 | */ |
| 686 | |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 687 | def getFileContent(saltId, target, file) { |
| 688 | result = cmdRun(saltId, target, "cat ${file}") |
Tomáš Kukrál | f1a692a | 2017-08-11 13:29:28 +0200 | [diff] [blame] | 689 | return result['return'][0].values()[0].replaceAll('Salt command execution success','') |
Tomáš Kukrál | b12eedd | 2017-04-21 10:45:13 +0200 | [diff] [blame] | 690 | } |
Matthew Mosesohn | 9e88085 | 2017-07-04 21:17:53 +0300 | [diff] [blame] | 691 | |
| 692 | /** |
| 693 | * Set override parameters in Salt cluster metadata |
| 694 | * |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 695 | * @param saltId Salt Connection object or pepperEnv (the command will be sent using the selected method) |
Matthew Mosesohn | 9e88085 | 2017-07-04 21:17:53 +0300 | [diff] [blame] | 696 | * @param salt_overrides YAML formatted string containing key: value, one per line |
Matthew Mosesohn | e564684 | 2017-07-19 16:54:57 +0300 | [diff] [blame] | 697 | * @param reclass_dir Directory where Reclass git repo is located |
Matthew Mosesohn | 9e88085 | 2017-07-04 21:17:53 +0300 | [diff] [blame] | 698 | */ |
| 699 | |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 700 | def setSaltOverrides(saltId, salt_overrides, reclass_dir="/srv/salt/reclass") { |
Tomáš Kukrál | f178f05 | 2017-07-11 11:31:00 +0200 | [diff] [blame] | 701 | def common = new com.mirantis.mk.Common() |
Mykyta Karpin | 1c165e2 | 2017-08-22 18:27:01 +0300 | [diff] [blame] | 702 | def salt_overrides_map = readYaml text: salt_overrides |
Tomáš Kukrál | 243cf84 | 2017-07-11 13:11:56 +0200 | [diff] [blame] | 703 | for (entry in common.entries(salt_overrides_map)) { |
Matthew Mosesohn | 9e88085 | 2017-07-04 21:17:53 +0300 | [diff] [blame] | 704 | def key = entry[0] |
| 705 | def value = entry[1] |
| 706 | |
| 707 | common.debugMsg("Set salt override ${key}=${value}") |
Mykyta Karpin | d4a42d0 | 2017-11-16 16:24:37 +0200 | [diff] [blame] | 708 | runSaltProcessStep(saltId, 'I@salt:master', 'reclass.cluster_meta_set', [key, value], false) |
Matthew Mosesohn | 9e88085 | 2017-07-04 21:17:53 +0300 | [diff] [blame] | 709 | } |
chnyda | a0dbb25 | 2017-10-05 10:46:09 +0200 | [diff] [blame] | 710 | runSaltProcessStep(saltId, 'I@salt:master', 'cmd.run', ["git -C ${reclass_dir} update-index --skip-worktree classes/cluster/overrides.yml"]) |
Matthew Mosesohn | 9e88085 | 2017-07-04 21:17:53 +0300 | [diff] [blame] | 711 | } |
Oleg Grigorov | bec4558 | 2017-09-12 20:29:24 +0300 | [diff] [blame] | 712 | |
| 713 | /** |
| 714 | * Execute salt commands via salt-api with |
| 715 | * CLI client salt-pepper |
| 716 | * |
| 717 | * @param data Salt command map |
| 718 | * @param venv Path to virtualenv with |
| 719 | */ |
| 720 | |
| 721 | def runPepperCommand(data, venv) { |
Jakub Josef | 03d4d5a | 2017-12-20 16:35:09 +0100 | [diff] [blame] | 722 | def common = new com.mirantis.mk.Common() |
Oleg Grigorov | bec4558 | 2017-09-12 20:29:24 +0300 | [diff] [blame] | 723 | def python = new com.mirantis.mk.Python() |
| 724 | def dataStr = new groovy.json.JsonBuilder(data).toString() |
chnyda | 4901a04 | 2017-11-16 12:14:56 +0100 | [diff] [blame] | 725 | |
Jakub Josef | 5e50e17 | 2017-12-20 17:18:23 +0100 | [diff] [blame] | 726 | //def offlineDeployment = env.getEnvironment().containsKey("OFFLINE_DEPLOYMENT") && env["OFFLINE_DEPLOYMENT"].toBoolean() |
| 727 | def offlineDeployment = env.getEnvironment().containsKey("OFFLINE_DEPLOYMENT") |
Jakub Josef | 804dd05 | 2017-11-29 18:59:05 +0100 | [diff] [blame] | 728 | if(!offlineDeployment){ |
Jakub Josef | 03d4d5a | 2017-12-20 16:35:09 +0100 | [diff] [blame] | 729 | //TODO: remove wget after global env prop enforcments |
| 730 | def netcheckResult = sh(script: "wget -q -T 10 --spider http://google.com", returnStatus: true) |
| 731 | offlineDeployment = netcheckResult != 0 && netcheckResult <= 5 |
Jakub Josef | 5e50e17 | 2017-12-20 17:18:23 +0100 | [diff] [blame] | 732 | }else{ |
| 733 | offlineDeployment = env["OFFLINE_DEPLOYMENT"].toBoolean() |
chnyda | bcfff18 | 2017-11-29 10:24:36 +0100 | [diff] [blame] | 734 | } |
chnyda | bcfff18 | 2017-11-29 10:24:36 +0100 | [diff] [blame] | 735 | def pepperCmd |
| 736 | |
| 737 | if (!offlineDeployment) { |
| 738 | def pepperCmdFile = "${venv}/pepper-cmd.json" |
| 739 | writeFile file: pepperCmdFile, text: dataStr |
| 740 | pepperCmd = "pepper -c ${venv}/pepperrc --make-token -x ${venv}/.peppercache --json-file ${pepperCmdFile}" |
| 741 | } else { |
Jakub Josef | 03d4d5a | 2017-12-20 16:35:09 +0100 | [diff] [blame] | 742 | common.warningMsg("You might be offline, will use pepper with option --json instead of option --json-file, some complex commands like complicated cmd.runs may not work!") |
Jakub Josef | 38ad6cc | 2017-11-29 23:13:42 +0100 | [diff] [blame] | 743 | pepperCmd = "pepper -c ${venv}/pepperrc --make-token -x ${venv}/.peppercache --json \"" + dataStr.replaceAll('"', '\\\\\\\"') + "\"" // yeah, really 7 backslashes, don't ask why |
chnyda | bcfff18 | 2017-11-29 10:24:36 +0100 | [diff] [blame] | 744 | } |
Oleg Grigorov | bec4558 | 2017-09-12 20:29:24 +0300 | [diff] [blame] | 745 | |
| 746 | if (venv) { |
| 747 | output = python.runVirtualenvCommand(venv, pepperCmd) |
| 748 | } else { |
| 749 | echo("[Command]: ${pepperCmd}") |
| 750 | output = sh ( |
| 751 | script: pepperCmd, |
| 752 | returnStdout: true |
| 753 | ).trim() |
| 754 | } |
| 755 | |
| 756 | return new groovy.json.JsonSlurperClassic().parseText(output) |
| 757 | } |