Module: Bosh::Cli::DeploymentHelper
- Included in:
- Command::Base
- Defined in:
- lib/cli/deployment_helper.rb
Instance Method Summary collapse
- #cancel_deployment ⇒ Object
-
#deployment_changed?(current_manifest, manifest, show = true) ⇒ Boolean
Check if the 2 deployments are different.
-
#inspect_deployment_changes(manifest, options = {}) ⇒ Object
Interactive walkthrough of deployment changes, expected to bail out of CLI using ‘cancel_deployment’ if something goes wrong, so it doesn’t need to have a meaningful return value.
- #job_exists_in_deployment?(job_name) ⇒ Boolean
- #job_must_exist_in_deployment(job) ⇒ Object
- #job_unique_in_deployment?(job_name) ⇒ Boolean
- #jobs_and_indexes ⇒ Object
- #latest_release_versions ⇒ Object
- #prepare_deployment_manifest(options = {}) ⇒ Object
-
#prompt_for_errand_name ⇒ Object
return a job/errand selected by user by name.
- #prompt_for_job_and_index ⇒ Object
- #resolve_release_aliases(manifest) ⇒ void
- #warn_about_stemcell_changes(diff) ⇒ Object
Instance Method Details
#cancel_deployment ⇒ Object
294 295 296 |
# File 'lib/cli/deployment_helper.rb', line 294 def cancel_deployment quit('Deployment canceled'.make_red) end |
#deployment_changed?(current_manifest, manifest, show = true) ⇒ Boolean
Check if the 2 deployments are different. Print out a summary if “show” is true.
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/cli/deployment_helper.rb', line 69 def deployment_changed?(current_manifest, manifest, show = true) diff = Bosh::Cli::HashChangeset.new diff.add_hash(normalize_deployment_manifest(manifest), :new) diff.add_hash(normalize_deployment_manifest(current_manifest), :old) changed = diff.changed? if changed && show @_diff_key_visited = {} diff.keys.each do |key| unless @_diff_key_visited[key] print_summary(diff, key, false) nl end end end changed end |
#inspect_deployment_changes(manifest, options = {}) ⇒ Object
Interactive walkthrough of deployment changes, expected to bail out of CLI using ‘cancel_deployment’ if something goes wrong, so it doesn’t need to have a meaningful return value.
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 |
# File 'lib/cli/deployment_helper.rb', line 93 def inspect_deployment_changes(manifest, = {}) show_empty_changeset = .fetch(:show_empty_changeset, true) interactive = .fetch(:interactive, false) redact_diff = .fetch(:redact_diff, false) manifest = manifest.dup current_deployment = director.get_deployment(manifest['name']) # We cannot retrieve current manifest until there was at least one # successful deployment. There used to be a warning about that # but it turned out to be confusing to many users and thus has # been removed. return if current_deployment['manifest'].nil? current_manifest = Psych.load(current_deployment['manifest']) unless current_manifest.is_a?(Hash) err('Current deployment manifest format is invalid, check if director works properly') end diff = Bosh::Cli::HashChangeset.new diff.add_hash(normalize_deployment_manifest(manifest), :new) diff.add_hash(normalize_deployment_manifest(current_manifest), :old) @_diff_key_visited = { 'name' => 1, 'director_uuid' => 1 } header('Detecting deployment changes') if !diff.changed? && !show_empty_changeset return false end if diff[:release] print_summary(diff, :release, redact_diff) warn_about_release_changes(diff[:release]) if interactive nl end if diff[:releases] print_summary(diff, :releases, redact_diff) if interactive diff[:releases].each do |release_diff| warn_about_release_changes(release_diff) end end nl end print_summary(diff, :compilation, redact_diff) nl print_summary(diff, :update, redact_diff) nl print_summary(diff, :resource_pools, redact_diff) warn_about_stemcell_changes(diff) if interactive nl print_summary(diff, :disk_pools, redact_diff) nl print_summary(diff, :networks, redact_diff) nl print_summary(diff, :jobs, redact_diff) nl print_summary(diff, :properties, redact_diff) nl diff.keys.each do |key| unless @_diff_key_visited[key] print_summary(diff, key, redact_diff) nl end end diff.changed? rescue Bosh::Cli::ResourceNotFound say('Cannot get current deployment information from director, possibly a new deployment'.make_red) true end |
#job_exists_in_deployment?(job_name) ⇒ Boolean
247 248 249 |
# File 'lib/cli/deployment_helper.rb', line 247 def job_exists_in_deployment?(job_name) !!find_job(job_name) end |
#job_must_exist_in_deployment(job) ⇒ Object
251 252 253 |
# File 'lib/cli/deployment_helper.rb', line 251 def job_must_exist_in_deployment(job) err("Job `#{job}' doesn't exist") unless job_exists_in_deployment?(job) end |
#job_unique_in_deployment?(job_name) ⇒ Boolean
242 243 244 245 |
# File 'lib/cli/deployment_helper.rb', line 242 def job_unique_in_deployment?(job_name) job = find_job(job_name) job ? job.fetch('instances') == 1 : false end |
#jobs_and_indexes ⇒ Object
282 283 284 285 286 287 288 289 290 291 292 |
# File 'lib/cli/deployment_helper.rb', line 282 def jobs_and_indexes jobs = prepare_deployment_manifest.fetch('jobs') jobs.inject([]) do |jobs_and_indexes, job| job_name = job.fetch('name') 0.upto(job.fetch('instances').to_i - 1) do |index| jobs_and_indexes << [job_name, index] end jobs_and_indexes end end |
#latest_release_versions ⇒ Object
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 |
# File 'lib/cli/deployment_helper.rb', line 204 def latest_release_versions @_latest_release_versions ||= begin director.list_releases.inject({}) do |hash, release| name = release['name'] versions = release['versions'] || release['release_versions'].map { |release_version| release_version['version'] } parsed_versions = versions.map do |version| { original: version, parsed: Bosh::Common::Version::ReleaseVersion.parse(version) } end latest_version = parsed_versions.sort_by {|v| v[:parsed] }.last[:original] hash[name] = latest_version.to_s hash end end end |
#prepare_deployment_manifest(options = {}) ⇒ Object
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 |
# File 'lib/cli/deployment_helper.rb', line 3 def prepare_deployment_manifest( = {}) deployment_required manifest_filename = deployment unless File.exists?(manifest_filename) err("Cannot find deployment manifest in `#{manifest_filename}'") end header('Processing deployment manifest') manifest = load_yaml_file(manifest_filename) manifest_yaml = File.read(manifest_filename) if manifest['name'].blank? err('Deployment name not found in the deployment manifest') end if manifest['target'] err(manifest_target_upgrade_notice) end if [:resolve_properties] compiler = DeploymentManifestCompiler.new(manifest_yaml) properties = {} begin say('Getting deployment properties from director...') properties = director.list_properties(manifest['name']) rescue Bosh::Cli::DirectorError say('Unable to get properties list from director, ' + 'trying without it...') end say('Compiling deployment manifest...') compiler.properties = properties.inject({}) do |hash, property| hash[property['name']] = property['value'] hash end manifest = Psych.load(compiler.result) end if manifest['name'].blank? || manifest['director_uuid'].blank? err("Invalid manifest `#{File.basename(deployment)}': " + 'name and director UUID are required') end if director.uuid != manifest['director_uuid'] err("Target director UUID doesn't match UUID from deployment manifest") end if manifest['release'].blank? && manifest['releases'].blank? err("Deployment manifest doesn't have release information: '" + "please add 'release' or 'releases' section") end resolve_release_aliases(manifest) resolve_stemcell_aliases(manifest) report_manifest_warnings(manifest) [:yaml] ? Psych.dump(manifest) : manifest end |
#prompt_for_errand_name ⇒ Object
return a job/errand selected by user by name
269 270 271 272 273 274 275 276 277 278 279 280 |
# File 'lib/cli/deployment_helper.rb', line 269 def prompt_for_errand_name errands = list_errands err('Deployment has no available errands') if errands.size == 0 choose do || .prompt = 'Choose an errand: ' errands.each do |errand, index| .choice("#{errand['name']}") { errand } end end end |
#prompt_for_job_and_index ⇒ Object
255 256 257 258 259 260 261 262 263 264 265 266 |
# File 'lib/cli/deployment_helper.rb', line 255 def prompt_for_job_and_index jobs_list = jobs_and_indexes return jobs_list.first if jobs_list.size == 1 choose do || .prompt = 'Choose an instance: ' jobs_list.each do |job_name, index| .choice("#{job_name}/#{index}") { [job_name, index] } end end end |
#resolve_release_aliases(manifest) ⇒ void
This method returns an undefined value.
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 |
# File 'lib/cli/deployment_helper.rb', line 224 def resolve_release_aliases(manifest) releases = manifest['releases'] || [manifest['release']] releases.each do |release| if release['version'] == 'latest' latest_release_version = latest_release_versions[release['name']] unless latest_release_version err("Release '#{release['name']}' not found on director. Unable to resolve 'latest' alias in manifest.") end release['version'] = latest_release_version end if release['version'].to_i.to_s == release['version'] release['version'] = release['version'].to_i end end end |
#warn_about_stemcell_changes(diff) ⇒ Object
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 |
# File 'lib/cli/deployment_helper.rb', line 174 def warn_about_stemcell_changes(diff) old_stemcells = Set.new new_stemcells = Set.new diff[:resource_pools].each do |pool| old_stemcells << { :name => pool[:stemcell][:name].old, :version => pool[:stemcell][:version].old } new_stemcells << { :name => pool[:stemcell][:name].new, :version => pool[:stemcell][:version].new } end if old_stemcells != new_stemcells unless confirmed?('Stemcell update has been detected. Are you sure you want to update stemcells?') cancel_deployment end end if old_stemcells.size != new_stemcells.size say('Stemcell update seems to be inconsistent with current '.make_red + 'deployment. Please carefully review changes above.'.make_red) unless confirmed?('Are you sure this configuration is correct?') cancel_deployment end end end |