opensecret 0.0.951 → 0.0.957

data/lib/opensecret/commons/eco.systems.rb

@@ -1,98 +0,0 @@
-#!/usr/bin/ruby
-	
-# ---
-# --- Build the complete services eco-system directed by the parameter service descriptors.
-# --- Everything that is done -> is done for (because of, to, in spite of) the application.
-# ---
-class EcoSystems
-
-  # -
-  # -- Create one or more eco-systems if that is
-  # -- the wish of the commmander (interpreter).
-  # -
-  def self.create
-
-    return unless CmdLine.instance.create || CmdLine.instance.task
-    eco_descriptors = CmdLine.instance.key_values[:service_descriptors]
-    EcoSystems.new.provision_services eco_descriptors
-
-  end
-
-  # --- -------------------------------------------------------------------------- --- #
-  # --- This input array of [service descriptors] are mapped to the below classes. --- #
-  # --- -------------------------------------------------------------------------- --- #
-  # --- the service descriptors => ["mongo.db", "properties", "rest.docs"]       --- #
-  # --- -------------------------------------------------------------------------- --- #
-  # --- [eco boot] service => [mongo.db] implemented by => [MongoDb]
-  # --- [eco boot] service => [ properties] implemented by => [Properties]
-  # --- [eco boot] service => [ rest.docs] implemented by => [RestDocs]
-  # --- ------------------------------------------------------------------------- --- #
-  def provision_services service_descriptors
-
-
-    log.info(ere) { "------------------------------------------------------------------- --- #" }
-    log.info(ere) { "[service descriptor to class conversion loop]                       --- #" }
-    log.info(ere) { "------------------------------------------------------------------- --- #" }
-
-    eco_services = eco_system_classes service_descriptors
-    eco_services.each do |eco_service|
-
-      top_and_tail "Provision the => [#{eco_service.class.name}] eco-system."
-      eco_service.provision
-      top_and_tail "The [#{eco_service.eco_id_str}] => eco system is now [ready]."
-
-    end
-
-  end
-
-
-  # --- -------------------------------------------------------------------- --- #
-  # --- Create the provisioner classes from the parameter descriptors array. --- #
-  # --- -------------------------------------------------------------------- --- #
-  def eco_system_classes service_descriptors
-
-    log.info(ere) { "[eco boot] service descriptors => #{service_descriptors.to_s}" }
-    eco_services = Array.new
-
-    service_descriptors.each do |class_desc|
-
-      class_name = SnapFlat.undo class_desc
-      log.info(ere) { "[eco boot] service => [#{class_desc}] implemented by => [#{class_name}]" }
-
-      begin
-
-        class_object = Object::const_get("#{class_name}").new
-
-      rescue Exception => e
-
-        log.fatal(ere) { "Exception instantiating eco-system [#{class_name}]." }
-        log.fatal(ere) { "Exception Message => #{e.message}" }
-        log.fatal(ere) { "Exception Backtrace => #{e.backtrace.inspect}" }
-        exit
-
-      end
-
-      eco_services.push class_object
-
-    end
-
-    return eco_services
-
-  end
-
-
-  # --
-  # -- Write the header string as the meat in a highlighted
-  # -- lines sandwich.
-  # --
-  def top_and_tail header_str
-
-      log.info(ere) { "# ### ############################################################## ### #" }
-      log.info(ere) { "# ~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~ #" }
-      log.info(ere) { "#{header_str}" }
-      log.info(ere) { "# ~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~ #" }
-      log.info(ere) { "# ### ############################################################## ### #" }
-
-  end
-
-end

data/lib/opensecret/factbase/hub-runtime.ini

@@ -1,123 +0,0 @@
-#--
-#-- This fact base holds the [keyinstance facts] for the
-#-- eco-system (hub) being created.
-#--
-#-- ---------------------
-#-- [Fact Assimilation]
-#-- ---------------------
-#--
-#-- This core factfile is always parsed and its constituent
-#-- facts are assimilated. These facts are also guaranteed
-#-- to be assimilated [FIRST].
-#--
-#-- ----------------
-#-- [Dependencies]
-#-- ----------------
-#--
-#-- As these facts are assimilated [first], they cannot be
-#-- beholden to (dependent on) any other fact files.
-#--
-
-[this]
-host            =  e>> NetDns.instance.host_name
-user            =  e>> Home.usr
-home.dir        =  e>> Home.dir
-host.user       =  e>> @f[:this][:host] + Do.t + @f[:this][:user]
-
-## ---------------------------
-## start refactor
-## @todo => drive   belongs to the workstation fact cluster
-## @todo => archive belongs to the workstation fact cluster
-drive           =  e>> File.join Home.dir, "com.laundry4j.drive"
-archive         =  e>> File.join @f[:this][:drive], "library.packaged.software"
-## end refactor
-## ---------------------------
-
-[time]
-stamp           =  e>> Stamp.yyjjj_hhmm_sst
-now             =  @todo
-
-today           =  @todo
-yesterday       =  @todo
-tomorrow        =  @todo
-
-this.week       =  @todo
-last.week       =  @todo
-next.week       =  @todo
-
-this.month      =  @todo
-last.month      =  @todo
-next.month      =  @todo
-
-this.year       =  @todo
-last.year       =  @todo
-next.year       =  @todo
-
-# @todo -- refactor - change FROM [eco] TO [hub]
-# @todo -- refactor - change FROM [eco] TO [hub]
-# @todo -- refactor - change FROM [eco] TO [hub]
-# @todo -- refactor - change FROM [eco] TO [hub]
-# @todo -- refactor - change FROM [eco] TO [hub]
-# @todo -- refactor - change FROM [eco] TO [hub]
-# @todo -- refactor - change FROM [eco] TO [hub]
-# @todo -- refactor - change FROM [eco] TO [hub]
-# @todo -- refactor - change FROM [eco] TO [hub]
-# @todo -- refactor - change FROM [eco] TO [hub]
-# @todo -- refactor - change FROM [eco] TO [hub]
-[eco]
-id              =  e>> @i[:plugin]
-sym             =  e>> @i[:plugin].to_sym
-url             =  eco-platform.co.uk
-box             =  eco-platform.archive
-src             =  eco-platform.station
-dst             =  eco-platform.uploads
-vms             =  eco-platform.cluster
-ip.url          =  https://www.eco-platform.co.uk/commons/eco-platform.git
-
-
-## decommission and remove the plugin month spanning facts
-## decommission and remove the plugin month spanning facts
-## decommission and remove the plugin month spanning facts
-## decommission and remove the plugin month spanning facts
-## decommission and remove the plugin month spanning facts
-[plugin]
-month.span      =  e>> @i[:plugin] + Do.t + Stamp.yymo_mmm
-month.span.b4   =  e>> @i[:plugin] + Do.t + Stamp.yymo_mmm_prev
-month.stamp     =  e>> "eco." + @s[:month_span]
-month.stamp.b4  =  e>> "eco." + @s[:month_span_b4]
-
-
-## @todo - Change to (1) [hub][dir]  (2) [hub][name] and  (3) [hub][path] - THEN MOVE UP (where eco is now)
-## @todo - Change to (1) [hub][dir]  (2) [hub][name] and  (3) [hub][path] - THEN MOVE UP (where eco is now)
-## @todo - Change to (1) [hub][dir]  (2) [hub][name] and  (3) [hub][path] - THEN MOVE UP (where eco is now)
-## @todo - Change to (1) [hub][dir]  (2) [hub][name] and  (3) [hub][path] - THEN MOVE UP (where eco is now)
-## @todo - Change to (1) [hub][dir]  (2) [hub][name] and  (3) [hub][path] - THEN MOVE UP (where eco is now)
-[runtime]
-dirname         =  e>> @i[:plugin] + Do.t + @f[:time][:stamp] + Do.t + @f[:this][:user] + "." + @f[:this][:host]
-
-
-dstname         =  e>> @f[:eco][:dst]
-dstpath         =  e>> File.join @f[:runtime][:dstname], @f[:runtime][:dirname]
-
-station.1.dir   =  e>> File.join Home.dir, @f[:eco][:src]
-station.2.dir   =  e>> File.join @f[:runtime][:station_1_dir], @f[:plugin][:month_stamp]
-station.3.dir   =  e>> File.join @f[:runtime][:station_2_dir], @f[:runtime][:dirname]
-
-dir             =  e>> @f[:runtime][:station_3_dir]
-archive         =  e>> File.join Home.dir, @f[:eco][:box]
-
-
-## DELETE all the below facts
-## DELETE all the below facts
-## DELETE all the below facts
-## DELETE all the below facts
-## DELETE all the below facts
-## DELETE all the below facts
-## DELETE all the below facts
-[stamp]
-mini            =  e>> @i[:plugin] + Do.t + Stamp.yyjjj_hhmm_sst + Do.t + @f[:this][:user]
-midi            =  e>> @f[:stamp][:mini] + "." + @f[:this][:host]
-mini.2          =  e>> (@f[:stamp][:mini]).gsub ".", "-"
-flat            =  e>> Stamp.yyjjj_hhmm_sst.gsub ".", ""
-time            =  e>> Stamp.yyjjj_hhmm_sst
-

data/lib/opensecret/factbase/known-hosts.ini

@@ -1,75 +0,0 @@
-
-# --
-# -- Fact File  => known.hosts.ini
-# -- Directory  => project-root/reusable.facts
-# -- Purpose    => Bonds workstations with the known accessible hosts
-# --               that the plugins build eco-systems on top of.
-# --
-# -- ---------------------
-# -- The LapTop Use Case
-# -- ---------------------
-# -- 
-# -- A laptop in the office may carry the IP of 192.168.5.xxx
-# -- The same laptop at home may connect using 192.168.0.xxx
-# --
-# -- Create two fact groups like [laptop.work] and [laptop.home]
-# --
-# -- [laptop.work] contains =>    wiki.dev.host = office.giant
-# -- (and)
-# -- [laptop.home] contains =>    wiki.dev.host = kitchen.pc
-# --
-# -- At work the wiki.dev plugins creates the wiki on [office.giant]
-# -- (whilst)
-# -- at home the same wiki.dev plugin puts the wiki on [kitchen.pc]
-# --
-# --
-
-
-[inca.desktop]
-username        =  apollo13
-hostnames       =  e>> [ "balloon" ]
-secrets.dir     =  I:/strings-cache
-aws.creds.dir   =  I:/aws.iam.credentials
-ssh.keydir      =  e>> File.join Home.dir, "com.laundry4j.drive/library.ssh.access.keys"
-wiki.dev.host   =  inca.server
-
-
-[inca.server]
-username        =  apollo
-hostnames       =  e>> [ "192.168.0.14", "warehouse" ]
-net.bridge      =  enp6s0
-secrets.dir     =  /media/usb_drive/cryptography.keys
-aws.creds.dir   =  e>> File.join Home.dir, "devops-hub.iam.creds"
-
-
-[little.brain]
-username        =  apollo
-hostnames       =  e>> [ "192.168.75.240", "brain-pad" ]
-net.bridge      =  enp0s31f6
-secrets.dir     =  /media/apollo/02E4-1244/cryptography.keys
-aws.creds.dir   =  /media/apollo/02E4-1244/aws.iam.credentials
-ssh.keydir      =  e>> File.join Home.dir, "eco-platform.credentials"
-wiki.dev.host   =  little.brain
-
-
-[wee.brain]
-username        =  apollo
-hostnames       =  e>> [ "192.168.82.92", "littlepc" ]
-net.bridge      =  enp6s0
-
-
-[gitlab.server]
-root.domain     =  eco-platform.co.uk
-username        =  ubuntu
-hostnames       =  e>> Array.new
-net.bridge      =  notapplicable
-key.rel.path    =  eco-platform.station/eco.gitlab.hub.1712.dec/gitlab.hub.17359.0416.335.apollo13.balloon/keypair.gitlab.hub.17359.0416.335.apollo13.balloon.pem
-ssh.key.path    =  e>> File.join Home.dir, @f[:gitlab_server][:key_rel_path]
-host.server     =  e>> LinuxHost.existing_host(                 \
-                                @f[:gitlab_server][:root_domain],  \
-                                @f[:gitlab_server][:username],     \
-				@f[:gitlab_server][:ssh_key_path], \
-				@f[:gitlab_server][:net_bridge]    \
-				)
-
-

data/lib/opensecret/factbase/published.facts/blobbolicious-facts.ini

@@ -1,553 +0,0 @@
-# ###############################################################################
-# ###############################################################################
-
-# --
-# -- The group names are the name of a mirrored resource file tree.
-# --
-# -- They contain keys that specify the
-# --
-# --   [1] - S3 bucket name at the cloud endpoint of the mirror
-# --   [2] - offset to root folder within S3 bucket (can be empty)
-# --   [3] - IAM user with permissions to read/write within S3
-# --   [4] - path to the local mirrrored folder (created if necessary)
-# --   [5] - sync options (typically --delete and --size-only)
-# --
-# -- Currently it is assumed that the user running the eco script
-# -- is the local user with the necessary permissions for accessing
-# -- and interacting with the mirror.
-# --
-
-[books]
-
-s3.bucket       =  devops.books
-buket.offset    =  e>> ""
-iam.s3.user     =  devops.librarian
-path.offset     =  e>> File.join Home.dir, "mirror.books"
-sync.options    =  e>> Array.new.push("--delete").push("--size-only")
-
-# ###############################################################################
-# ###############################################################################
-
-# ---
-# --- Note that (AND) is the operator employed
-# --- when more than one fact directive lives in
-# --- a chunk.
-# ---
-# --- To implement and (OR) type operator use
-# --- two (or more chunks).
-# ---
-# --- The Ruby eql? method is used to compare so
-# --- you can compare strings, ints, objects ...
-# ---
-# --- String comparisons are case insensitive.
-# ---
-
-
-## @@@ @@@@@@@@@@@@@@@@@ @@ ##
-## @@@ Project Namespace @@ ##
-## @@@ @@@@@@@@@@@@@@@@@ @@ ##
-
-
-[s3]
-upload.prefix   = s3put.
-uploads.dir     = e>> File.join @f[:runtime][:dir], "s3_uploads"
-
-### ===============================
-### refactor these fact names to
-### ===============================
-###  [s3.bucket] = group
-###    this.month = ...
-###    next.month = ...
-###    last.month = ...
-### ===============================
-
-month.bucket    = e>> @f[:plugin][:month_stamp]
-month.bucket.b4 = e>> @f[:plugin][:month_stamp_b4]
-monthwide.url   = e>> "s3://" + @f[:plugin][:month_stamp]
-
-bucket.name     = e>> @f[:plugin][:month_stamp] # a [deprecated] fact
-
-
-[gitlab]
-backups.dir     =  /var/opt/gitlab/backups
-backups.cache   =  e>> @f[:plugin][:month_stamp]
-backups.s3.dir  =  e>> "s3://" + @f[:plugin][:month_stamp]
-clone.suffix    =  _gitlab_backup.tar
-
-
-[docker]
-cmd.pre         = e>> "sudo docker exec --user=" + Ch.dq + "mongodb" + Ch.dq + " -i container.mongodb bash -c " + Ch.dq
-no.cache        = e>> if CmdLine.has? "--no-cache" then return "--no-cache" else return "" end
-rm.image.cmd    = e>> if CmdLine.has? "--no-cache" then return "sudo docker rmi img." + @f[:eco][:id] else return "" end
-
-
-[certbot]
-cert.name       =  hub-certificates
-email.address   =  apolloakora@gmail.com
-
-
-[gollum]
-template.dir    =  templates
-git.mirror      =  e>> "wiki." + Stamp.yyjjj_hhmm_sst
-
-
-[vagrant]
-ip.addr.file    =  vm-ip-addresses.txt
-hostname        =  e>> Stamp.yyjjj_hhmm_sst.gsub(".", "-")
-
-#--
-#-- -------------------------------------------------------------
-#-- @todo fact override missionary (trail-blazer)
-#-- -------------------------------------------------------------
-#--   [1] - change to ubuntu/xenial64 when overriding tech arrives
-#--   [2] - Then in plugin facts add the override statement (see vm.cluster)
-#--   [3] - Then in templates like below add the @ -- [vagrant|boxname] placeholder
-#--           => vagrant/Vagrantfile.kube.master
-#--           => vagrant/Vagrantfile.kube.worker
-#--
-boxname         =  geerlingguy/centos7
-vm.name         =  e>> "vm." + @f[:stamp][:time]
-
-
-[port]
-jenkins         =  42001:8081
-gollum          =  42006:4567
-
-
-# --
-# -- ---------- =  ---------------------------------------- #
-# -- The fact l =  ayout format is [16 spaces] before the
-# -- equals sig =  n then [2 spaces] after.
-# --            =
-# -- 6789012345 =  string value
-# -- 6789012345 =  e>> 3 + 4
-# -- ---------- =  ---------------------------------------- #
-# --
-
-[overwrite]
-spec.filename   =  e>> @i[:plugin] + ".overwrite.spec.json"
-spec.filepath   =  e>> File.join @f[:runtime][:dir], @f[:overwrite][:spec_filename]
-
-
-# --
-# -- The fact layout format is [16 spaces] before the
-# -- equals sign and [2 spaces] after.
-# --
-# -- 6789012345 =  string value
-# -- 6789012345 =  e>> 3 + 4
-# --
-
-
-
-# -- ---------- = ----------------------------------------- #
-# -- The fact l =  ayout format is [16 spaces] before the
-# -- equals sig =  n then [2 spaces] after.
-# --            =
-# -- 6789012345 =  string value
-# -- 6789012345 =  e>> 3 + 4
-# -- ---------- = ----------------------------------------- #
-
-#-- -----------------------------
-#-- Using "String" Umbrella Maps
-#-- -----------------------------
-#--
-#-- String umbrella maps are for creating a string key and string value map.
-#-- These maps are accessible using the [UMBRELLA] key @u
-#--
-#-- For example to import an inventory of
-#--     key = source filename and
-#--   value = destination filename
-#--
-#-- Group [u.inventory]
-#-- Access key-value map with @u[:inventory]
-#-- And you can say if exists( @u[:inventory] )
-#--
-#-- NOTE - umbrella sections can be continued in other files.
-#--      - if when they are - key/values are appended to map.
-
-#--
-#-- -------------------------------------------------------
-#-- Disallowed Group Names
-#-- -------------------------------------------------------
-#--
-#--  Some group names are not allowed because they have been
-#--  allocated for shorthand purposes.
-#--
-#--  For example [plugin]. This name is a shorthand for the
-#--  plugin id.
-#--
-#--  So "@t[plugin|root.domain]" is replaced with "devops-hub.com"
-#--
-#--  Thus we cannot create a group called [plugin].
-#--
-#--  Curently disallowed group names are everything in the
-#--  @i (identity) map ===== THINK aBOUT THIS SOME MORE.
-#--
-#--
-#--
-#-- -------------------------------------------------------
-#-- Sibling Facs ( @s )
-#-- -------------------------------------------------------
-#--
-#-- The @s[:length] is a "sibling" fact. @s is a one dimensional
-#-- array containing all (sibling) key-pairs under the umbrella
-#-- of a (parent) group - in this case [rectangle].
-#--
-#--
-#-- [rectangle]
-#--
-#-- length,width =  <<absract>>
-#-- perimeter    =  e>> (@s[:length] * 2) + (@s[:width] * 2)
-#-- area         =  e>> @s[:length] * @s[:width]
-#--
-#--
-#-- -------------------------------------------------------
-#-- The Advantage of Sibling Facts ( @s )
-#-- -------------------------------------------------------
-#--
-#-- Sibling facts are a [shorthand] way to declare facts
-#-- within an INI fact file. These 2 declarations produce
-#-- the same value.
-#--
-#--     @f[:rectangle][:length]
-#--     @s[:length]
-#--
-#-- The sibling fact must be declared in an INI fact file
-#-- within the [auspices] of or under an [umbrella] that is
-#-- the parent group.
-
-
-#--
-#-- Fact consumption can happen in five (5) different ways
-#--
-#-- -
-#-- - @p (plugin related facts)
-#-- - @l
-#-- - @u (umbrella string maps)
-#-- - @g
-#-- - @i (identity core facts) - used and reused time and again
-#-- - @n
-#-- -
-#-- - @f (file facts as 2D array) - using known facts to create new ones
-#-- - @a (ancestral, anchored, family facts) == RELATIVE (Only in fact file)
-#-- - @c (code facts) - with plugin (eco) claasss also p_fact(...) plugin fact
-#-- - @t (template facts) - template facts which can also accomodate nesting == ONLY IN TEMPLATE
-#-- - @s (sibling fact) - described above == RELATIVE (Only in fact file)
-#-- -
-#--
-
-#--
-#-- --------------------------------------------
-#-- Harvesting Facts | A Fact Finding Mission
-#-- --------------------------------------------
-#--
-#-- Many simple, useful, productive and powerful facts exist out there and
-#-- this <<fact-hub>> ( register fact-hub.com )) can go on a fact finding
-#-- (mining) mission when you give the word.
-#--
-#-- Facts can be harvested from
-#--
-#--   a) - environment variables
-#--   b) - files (INI, json, csv, yml, properties, html)
-#--   c) - REST API calls
-#--   d) - shell commands
-#--   e) - key-value stores (DynamoDB, etcd, Redis, memcached)
-#--   f) - databases (MongoDb, MySQL, PostgreSQL, Oracle)
-#--   g) - secret engines (Amazon KMS, Ansible Vault, CredStash)
-#--
-#-- The fact data can be hosted
-#--
-#--   1) - on local, removal and networked storage
-#--   2) - in memory
-#--   3) - in Amazon S3, Google Drive and other clouds
-#--   4) - dropbox
-#--   5) - git and subversion repositories
-#--   6) - 
-#--
-
-
-
-
-
-#--
-#-- -------------------
-#-- Fact Inheritance
-#-- -------------------
-#--
-#-- Fact inheritance allows us to share most of the properties of
-#-- a fact group that are either conceptually similar or derive from
-#-- the same base class.
-#--
-#-- Separating Interface from Implementation
-#-- --------------------------------------------
-#-- Fact inheritance allows fact consumers to reference a parent and
-#-- use say the polygon [interface] without knowing or caring about the
-#-- specific [implementation].
-#--
-#--
-#--
-#-- -------------------------------------------------------
-#-- Example Inheritance of Fact Implementation Behaviour
-#-- -------------------------------------------------------
-#--
-#--
-#-- [rectangle]
-#--
-#-- length,width =  <<absract>>
-#-- perimeter    =  e>> (@s[:length] * 2) + (@s[:width] * 2)
-#-- area         =  e>> @s[:length] * @s[:width]
-#--
-#--
-#-- [square < rectangle]
-#--
-#-- width     =  e>> @s[:length]
-#--
-#--
-#-- [room < square]
-#--
-#-- length    =  10
-#--
-#--
-#--
-#-- And now in a template somewhere there can be a statement
-#-- saying a square of length @[room|length] will surely have
-#-- an area of @[room|area] square metres.
-#--
-#--
-#--
-#-- -------------------------------------------------------
-#-- Notes on square inheriting rectangle fact behaviour
-#-- -------------------------------------------------------
-#--
-#-- Due to square declaring that it inherits from the rectangle
-#-- group - other fact declarations can now use this.
-#--
-#-- Both the [room] and [square] fact groupings use the
-#-- inheritance inherent in the [rectangle] declaration. 
-#--
-#--
-
-
-
-#--
-#-- -------------------
-#-- Overriding Facts
-#-- -------------------
-#--
-#-- This futuristic fact override statement overrides and imposes
-#-- a new value for the specified fact coordinate.
-#--
-#-- Notes
-#--
-#--   [1] - the first definition is just a string
-#--   [2] - the second statement string is eval'd
-#--   [3] - Every fact DEPENDENT on overriden fact will change
-#--
-#-- ---------------------------
-#-- Overriding Facts | WARNING
-#-- ---------------------------
-#--
-#-- When you override a fact's value - EVERY DEPENDENT FACT is then
-#-- [RE-DERIVED] with the new value.
-#--
-#--
-#-- It is important when the fact is used as a method or constructor
-#-- parameter. If the class ignores the second call (for example
-#-- singletons) - the new fact value does not fully propagae through
-#-- the software's pipes and wires.
-#--
-#-- vagrant|boxname =  {override} geerlingguy/centos7
-#-- runtime|dirname =  {override} e>> @f[:runtime][:dirname] + "-appended-xxx"
-
-#--
-#-- -------------------
-#-- Documenting Facts
-#-- -------------------
-#--
-#-- Fact doclet statements ARE themselves [facts].
-#-- This means that all behaviour and constraints that apply to
-#-- facts also apply to fact doclet definitions.
-#--
-#-- Fact documentation statements can appear anywhere but [always]
-#-- under the [doclet] - (little documentation) - coordinate.
-#--
-#-- It is okay for the [doclet] tag to appear multiple times in a file.
-#--
-#-- Note that the @s[] sibling construct can be used when relating to
-#-- facts under the same parent group. This is fine even when the facts
-#-- appear in different areas and different files under the same url
-#-- or email namespace eg (devops-hub.com) or (joe@devops-hub.com).
-#--
-#-- [doclet]
-#-- vagrant|boxname =  Used in Vagrantfile to specify base operating system of virtual machine.
-
-
-#--
-#-- ---------------------------
-#-- Facts from REST API Calls
-#-- ---------------------------
-#--
-#-- (use) rest>>
-#-- (instead of) e>>
-#--
-#-- You can read facts directly from a REST API call without having
-#-- to go through an intermediary Class/Method call.
-#--
-#-- ---------
-#-- Examples
-#-- ---------
-#--
-#--   england.time.now  =  rest>> https://api.devops-hub.com/world_time?country=gb
-#--   america.time.now  =  rest>> https://api.devops-hub.com/world_time?country=us
-#--
-#--
-#-- vagrant|boxname =  {override} geerlingguy/centos7
-#-- runtime|dirname =  {override} e>> @f[:runtime][:dirname] + "-appended-xxx"
-
-#--
-#-- ------------------------------------------
-#-- Fact Ordering (Files or Database Housing)
-#-- ------------------------------------------
-#--
-#-- Facts can be declared in ANY order.
-#--
-#-- ------------------------------
-#-- Fact Nesting (Templates)
-#-- ------------------------------
-#--
-#-- Facts can be nested when placed in templates with placeholders.
-#-- Nesting facts promotes re-use.
-#--
-#--
-#-- ------------------
-#-- Fact Value Types
-#-- ------------------
-#--
-#-- Yes most fact values are POST (plain old strings), but there are a few more
-#-- value types that add an expressive edge to devops facts. Fact values can be
-#--
-#--   e>> evaluated by Ruby's dynamic processing features
-#--   e>> arrays, hashes, ints, booleans - indeed any class
-#--   r>> regular expressions for use in finding matches
-#--   d>> fact documentation that can appear almost anywhere
-#--
-#--
-
-#--
-#-- ------------------------------
-#-- Iteration (Loop) Index Facts
-#-- ------------------------------
-#--
-
-
-#--
-#-- ------------------------------
-#-- I.N.F.A.C.T.S (See Notepad)
-#-- ------------------------------
-#--
-#-- Who is referencing the fact?
-#-- Where (in what) is the fact referenced?
-#--
-#--  I - Insert, Inherit, Interface and Include snippets (or whole) from Code, Files etc
-#--  N - 
-#--  F - File => appears in a file eg .ini, .json, .csv, .yml, .yaml etc
-#--  A - API => rest call => https://api.devops-hub.com/fact/@a?class=vagrant+property=hostname
-#--  C - Code => fact apppears either in commons or plugin code
-#--  T - Template => fact appears in a config file or in Vagrantfile, Dockerfile etc
-#--  S - Sibling => fact definition references a sibling in the same class
-#--
-#--  Note that the API referencing call accepts a shorthand version.
-#--     https://api.devops-hub.com/fact/@a?c=vagrant+p=hostname
-#--       (c) is for (c)lass
-#--       (p) is for (p)roperty
-#--
-#-- Note that (A) types hide the underlying fact definition statement.
-#-- This simple fact honours the "Uniform Access Principle" as stated
-#-- by Bertrand Meyer ( Object Oriented Software Engineering ).
-#--
-
-
-
-#--
-#-- ----------------------------------------------
-#-- No Nil Fact Coordinates - No Nil Fact Values
-#-- ----------------------------------------------
-#--
-#-- Neither fact coordinates nor value can be nil.
-#--
-#-- Failure occurs if any one of
-#--
-#--   the fact group coordinate OR
-#--   the fact key coordinate   OR
-#--   the fact value
-#--
-#-- shows up as nil.
-#--
-#--
-
-
-
-
-#-- ------------------------------------------
-#-- Fact Constraints | What is not allowed?
-#-- ------------------------------------------
-#--
-#-- @s (sibling facts) CAN be used in the FIRST LINE of a group declaration
-#--    if that group has been defined in ANOTHER fact file.
-#--    (currently will fail but won't once fact order parsing is implemented).
-#--
-#-- @s (sibling facts) CAN be used in the FIRST LINE of a group declaration
-#--    if the reference appears lower down in the fact group or another fact file
-#--    (currently will fail but won't once fact order parsing is implemented).
-#--
-#-- The fact compiler informs us if @s (sibling fact) is consumed and the
-#-- fact declaration is not found within the set of included files/objects.
-#--
-#--
-#--
-#--  ==> duplicate keys is illegal = throw an error to state this			  
-#--  ==> duplicate keys UNLESS one declared as <<abstract>> or inheritance or {override}
-#--
-## @todo ==> throw duplicate key EXCEPTION unless
-##
-##              (a) one declared as <<abstract>> OR
-##              (b) one block inherits from (extends) the other
-##              (c) fact annotated with {override} modifier
-##              (d) one key denoted (if) and the other (unless)
-##
-#--
-
-## ++++++++++++++++++++++++++++++++++++++++ ##
-## INVENTORY ==> Accessories After the Fact ##
-## ++++++++++++++++++++++++++++++++++++++++ ##
-##
-## Plugin [inventory] is made up of
-##   ++ Facts (INI Files)    == (middleware, platform, user, application)
-##
-##   ++ (reusable) registry of facts
-##   ++ (specific) plugin fact registry
-##   ++ (reusable) collateral files
-##   ++ (reusable) )runnable scripts
-##   ++ (specific) mission critical content
-##   ++ (reusable) commons behaviour
-##   ++ (reusable) cross cutting concerns
-## ++++++++++++++++++++++++++++++++++++++++ ##
-
-
-
-# ############################################################################################
-# #######   End of the eco-platform.co.uk Fact Database   ####################################
-# ############################################################################################
-
-
-# --
-# -- -------------------------
-# -- [[Stop Here]] Debug Tool
-# -- -------------------------
-# --
-# -- Stop processing here to examine and evaluate the
-# -- production values of the above facts.
-# --
-# -- stop.here       = e>> exit
-# --
-