bosh-gen 0.23.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8b00234c82d49b763a3ed19a84afceafc7493c8
-  data.tar.gz: 3c69fec977cc0128d6a91353e9933a647a715c42
+  metadata.gz: fbd5f5ae54cc9d6045654c2545801a6c4f1f3d05
+  data.tar.gz: 1763c8535dbd032b94009dc164e1d178d983de8c
 SHA512:
-  metadata.gz: 6b32ffaff5af4640f65a567baa60864021eb4faaccad2d870abbd308653874dea027a8ca9e32a2fa56f6c15974008c01052237dd6e50a1de24878a310a49c0a4
-  data.tar.gz: 77f926b0c7c91283989e7b3f237dff994fb32b8fff2976bac04269231853db3bc19c1c8b2629a3524559d74bb952779e928c71934e1e88f3e4c1d20f5251672d
+  metadata.gz: bc70d4413f65711c68f4644f63fbec7c02f6c9a66865adba53bcc7e946416bfe206af44ab5ed5a0c709cc21c317402f9c328412d5fb74145191e774dc38227c7
+  data.tar.gz: 41a3a15b2d28a5e60cc33d076e8eebb24893a915e8e47ecdd4b82fba86d16dc7c49aab1b7752b947b5199da2fba98426c9fd591b1333665d0b69c0505ceb3583

data/ChangeLog.md

@@ -1,6 +1,10 @@
 Change Log
 ==========
 
+v0.24.0
+
+- Added new `forge` command to generate new forges for [blacksmith](https://github.com/cloudfoundry-community/blacksmith). Thanks @jhunt
+
 v0.23.0
 
 Appreciation to James Hunt, Dennis Bell and Chris Weibel for the contributions.

data/lib/bosh/gen/cli.rb

@@ -94,6 +94,13 @@ module Bosh
         Bosh::Gen::Generators::JobTemplateGenerator.start([job_name, file_path])
       end
 
+      desc "forge NAME",
+        "Creates a Blacksmith Forge job to get you up and running"
+      def forge(job_name)
+        require 'bosh/gen/generators/blacksmith_forge_generator'
+        Bosh::Gen::Generators::BlacksmithForgeGenerator.start([job_name])
+      end
+
       desc "extract-job SOURCE_PACKAGE_PATH",
         "Extracts a job from another release and all its " +
         "dependent packages and source"

data/lib/bosh/gen/generators/blacksmith_forge_generator.rb

@@ -0,0 +1,40 @@
+require 'yaml'
+require 'thor/group'
+
+module Bosh::Gen
+  module Generators
+    class BlacksmithForgeGenerator < Thor::Group
+      include Thor::Actions
+
+      argument :name
+
+      def self.source_root
+        File.join(File.dirname(__FILE__), "blacksmith_forge_generator", "templates")
+      end
+
+      # FYI, bosh-gen (the CLI) will eventually call Thor, telling it to `start()`
+      # Don't bother looking for a start() function anywhere; Thor just calls all of
+      # the public methods of this class.
+
+      def check_root_is_release
+        unless File.exist?("jobs") && File.exist?("packages")
+          raise Thor::Error.new("run inside a BOSH release project")
+        end
+      end
+
+      def check_name
+        raise Thor::Error.new("'#{name}' is not a valid BOSH id") unless "#{name}-blacksmith-plans".bosh_valid_id?
+      end
+
+      def copy_files
+        generator_job_templates_path = File.join(self.class.source_root, "jobs/%job_name%")
+        directory "jobs/%job_name%", "jobs/#{job_name}"
+      end
+
+      private
+      def job_name
+        "#{name}-blacksmith-plans"
+      end
+    end
+  end
+end

data/lib/bosh/gen/generators/blacksmith_forge_generator/templates/jobs/%job_name%/spec.tt

@@ -0,0 +1,51 @@
+name: <%= job_name %>
+packages: []
+templates:
+  bin/configure-blacksmith:         bin/configure-blacksmith
+
+  plans/service.yml:                plans/service.yml
+
+  plans/standalone/manifest.yml:    plans/standalone/manifest.yml
+  plans/standalone/credentials.yml: plans/standalone/credentials.yml
+  plans/standalone/init:            plans/standalone/init
+
+
+properties:
+  service.id:
+    description: Machine-friendly name for this service.
+    default: <%= name %>
+
+  service.name:
+    description: Human-friendly name for this service, to be displayed in the Cloud Foundry marketplace.
+    default: <%= name.capitalize %>
+
+  service.description:
+    description: A description for this service, to be displayed in the Cloud Foundry marketplace.
+    default: A dedicated <%= name.capitalize %> instance, deployed just for you.
+
+  service.tags:
+    description: List of tags to apply to service instances.
+    default: [blacksmith, dedicated, <%= name %>]
+
+  service.limit:
+    description: A global limit on the number of <%= name.capitalize %> services (regardless of the plan); 0 = unlimited.
+    default: 0
+
+  plans:
+    description: |
+      A map of plans.  I.e.:
+
+        standalone:
+          name: Standalone <%= name.capitalize %> Instance
+          description: A single <%= name %> server, with no redundancy or replication
+          limit: 7
+          type: standalone
+          vm_type: default
+
+      Configuration keys beyond `name', `description', `limit', and `type' are type-specific.
+          limit: 7
+
+      For type=standalone:
+
+        vm_type    What VM type to use for the standalone <%= name %> server.
+                   Defaults to 'default'

data/lib/bosh/gen/generators/blacksmith_forge_generator/templates/jobs/%job_name%/templates/bin/configure-blacksmith.tt

@@ -0,0 +1,45 @@
+#!/bin/bash
+set -eu
+
+PLANSRC=/var/vcap/jobs/<%= job_name %>/plans
+SVCROOT=/var/vcap/data/blacksmith/<%= name %>-forge/services
+rm    -rf $SVCROOT
+mkdir -p  $SVCROOT
+
+# Copy the service definition stub for Blacksmith
+cp $PLANSRC/service.yml $SVCROOT
+
+<%= "<"+"%" %> p('plans').each do |id, plan| <%= "%"+">" %>
+##############################################
+#
+# Set up plan <%= "<"+"%" %>= id <%= "%"+">" %>
+#
+PLANROOT="$SVCROOT/<%= "<"+"%" %>= id <%= "%"+">" %>"
+PLANTYPE="<%= "<"+"%" %>= plan["type"] || 'standalone' <%= "%"+">" %>"
+
+mkdir -p $PLANROOT
+cat > $PLANROOT/plan.yml <<EOF
+---
+id: <%= "<"+"%" %>= id <%= "%"+">" %>
+name: <%= "<"+"%" %>= plan["name"] || id <%= "%"+">" %>
+limit: <%= "<"+"%" %>= plan["limit"] || 0 <%= "%"+">" %>
+description: |+
+  <%= "<"+"%" %>= plan["description"] || 'no description provided' <%= "%"+">" %>
+EOF
+
+for file in init credentials.yml manifest.yml; do
+  cp $PLANSRC/$PLANTYPE/$file $PLANROOT/
+done
+chmod 0755 $PLANROOT/init
+
+cat > $PLANROOT/params.yml <<EOF
+---
+# auto-generated by <%= job_name %>
+# for plan-id <%= "<"+"%" %>= id <%= "%"+">" %> (<%= "<"+"%" %>= plan["name"] || id <%= "%"+">" %>)
+meta:
+  size: <%= "<"+"%" %>= plan["vm_type"] || 'default' <%= "%"+">" %>
+EOF
+
+
+
+<%= "<"+"%" %> end <%= "%"+">" %>

data/lib/bosh/gen/generators/blacksmith_forge_generator/templates/jobs/%job_name%/templates/plans/service.yml

@@ -0,0 +1,12 @@
+---
+id:   <%= p('service.id') %>
+name: <%= p('service.name') %>
+description: |
+    <%= p('service.description') %>
+tags:
+  <% p('service.tags', []).each { |tag| %>  - <%= tag %>
+  <% } %>
+bindable: true
+metadata: {}
+plan_updateable: true
+<% if p('service.limit') > 0 %>limit: <%= p('service.limit') %><% end %>

data/lib/bosh/gen/generators/blacksmith_forge_generator/templates/jobs/%job_name%/templates/plans/standalone/credentials.yml

@@ -0,0 +1,18 @@
+---
+# credentials.yml is the means to communicate credentials
+# and connection information to cf applications, when they
+# bind your service to their applications.
+#
+# Blacksmith will `spruce merge` this file with:
+#  - The full BOSH deployment manifest
+#  - A file with the IP addresses for each BOSH instance.
+#
+# For example, if you have a job named `xyzzy', and you
+# need to pass back the IP address of the first instance to
+# bound applications, you could do this:
+#
+#    ---
+#    credentials:
+#      host: (( grab jobs.xyzzy/0.ips[0] ))
+#
+credentials: {}

data/lib/bosh/gen/generators/blacksmith_forge_generator/templates/jobs/%job_name%/templates/plans/standalone/init

@@ -0,0 +1,3 @@
+#!/bin/bash
+# nothing to do, yet.
+exit 0

data/lib/bosh/gen/generators/blacksmith_forge_generator/templates/jobs/%job_name%/templates/plans/standalone/manifest.yml.tt

@@ -0,0 +1,14 @@
+---
+stemcells:
+- alias: default
+  os: ubuntu-trusty
+  version: latest
+
+update:
+  canaries: 1
+  max_in_flight: 10
+  canary_watch_time: 1000-30000
+  update_watch_time: 1000-30000
+
+releases: (( param "The author or this Forge forgot to define any releases.  Oops." ))
+instance_groups: (( param "The author of this Forge forgot to define any instance_groups.  Oops." ))

data/lib/bosh/gen/generators/new_release_generator/templates/templates/deployment.yml.tt

@@ -9,7 +9,7 @@ director_uuid: (( param "Please set the UUID of your BOSH Directory" ))
 
 releases: (( param "Please list the BOSH releases to use for this deployment" ))
 
-jobs: (( param "Please configure the constituent Jobs for this Deployment" ))
+instance_groups: (( param "Please configure the constituent instance groups for this Deployment" ))
 
 compilation:
   workers: 6

data/lib/bosh/gen/generators/new_release_generator/templates/templates/infrastructure-aws-ec2.yml.tt

@@ -8,7 +8,7 @@ meta:
     name: bosh-aws-xen-hvm-ubuntu-trusty-go_agent
     version: latest
 
-jobs:
+instance_groups:
   - name: just_install_packages
     networks:
       - name: <%= project_name_underscored %>1

data/lib/bosh/gen/generators/new_release_generator/templates/templates/infrastructure-warden.yml.tt

@@ -12,7 +12,7 @@ update:
   canary_watch_time: 1000-30000
   update_watch_time: 1000-30000
 
-jobs:
+instance_groups:
   - name: just_install_packages
     networks:
       - name: <%= project_name_underscored %>1

data/lib/bosh/gen/generators/new_release_generator/templates/templates/jobs.yml.tt

@@ -6,9 +6,9 @@ update:
   update_watch_time: 1000-30000
   serial: false
 
-jobs:
+instance_groups:
   - name: just_install_packages
-    templates:
+    jobs:
     - name: just_install_packages
       release: <%= project_name_hyphenated %>
     instances: 1

data/lib/bosh/gen/version.rb

@@ -1,5 +1,5 @@
 module Bosh
   module Gen
-    VERSION = "0.23.0"
+    VERSION = "0.24.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bosh-gen
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.24.0
 platform: ruby
 authors:
 - Dr Nic Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-18 00:00:00.000000000 Z
+date: 2017-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -192,6 +192,15 @@ files:
 - lib/bosh/cli/commands/share_release.rb
 - lib/bosh/gen.rb
 - lib/bosh/gen/cli.rb
+- lib/bosh/gen/generators/blacksmith_forge_generator.rb
+- lib/bosh/gen/generators/blacksmith_forge_generator/templates/.gitkeep
+- lib/bosh/gen/generators/blacksmith_forge_generator/templates/jobs/%job_name%/monit.tt
+- lib/bosh/gen/generators/blacksmith_forge_generator/templates/jobs/%job_name%/spec.tt
+- lib/bosh/gen/generators/blacksmith_forge_generator/templates/jobs/%job_name%/templates/bin/configure-blacksmith.tt
+- lib/bosh/gen/generators/blacksmith_forge_generator/templates/jobs/%job_name%/templates/plans/service.yml
+- lib/bosh/gen/generators/blacksmith_forge_generator/templates/jobs/%job_name%/templates/plans/standalone/credentials.yml
+- lib/bosh/gen/generators/blacksmith_forge_generator/templates/jobs/%job_name%/templates/plans/standalone/init
+- lib/bosh/gen/generators/blacksmith_forge_generator/templates/jobs/%job_name%/templates/plans/standalone/manifest.yml.tt
 - lib/bosh/gen/generators/bosh_cli_plugin_generator.rb
 - lib/bosh/gen/generators/bosh_cli_plugin_generator/templates/lib/bosh/cli/commands/%underscore_plugin_name%.rb.tt
 - lib/bosh/gen/generators/errand_generator.rb