X-Git-Url: https://git.adam-barratt.org.uk/?p=mirror%2Fdsa-puppet.git;a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Ftype%2Fanchor.rb;h=7458a4b98c05e75245b02cce2a11968573562f3b;hp=60cfa6451af8a688744b6626ea1b46d6a4da48bd;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hpb=6f656bd4265e3dab13b9af2bf96e9044322e9d8f diff --git a/3rdparty/modules/stdlib/lib/puppet/type/anchor.rb b/3rdparty/modules/stdlib/lib/puppet/type/anchor.rb index 60cfa6451..7458a4b98 100644 --- a/3rdparty/modules/stdlib/lib/puppet/type/anchor.rb +++ b/3rdparty/modules/stdlib/lib/puppet/type/anchor.rb @@ -1,6 +1,7 @@ Puppet::Type.newtype(:anchor) do - desc <<-'DESCRIPTION' - A simple resource type intended to be used as an anchor in a composite class. + desc <<-DOC + @summary + A simple resource type intended to be used as an anchor in a composite class. In Puppet 2.6, when a class declares another class, the resources in the interior class are not contained by the exterior class. This interacts badly @@ -12,32 +13,35 @@ Puppet::Type.newtype(:anchor) do classes between two no-op resources that _are_ contained by the exterior class, you can ensure that all resources in the module are contained. - class ntp { - # These classes will have the correct order relationship with each - # other. However, without anchors, they won't have any order - # relationship to Class['ntp']. - class { 'ntp::package': } - -> class { 'ntp::config': } - -> class { 'ntp::service': } - - # These two resources "anchor" the composed classes within the ntp - # class. - anchor { 'ntp::begin': } -> Class['ntp::package'] - Class['ntp::service'] -> anchor { 'ntp::end': } - } + ``` + class ntp { + # These classes will have the correct order relationship with each + # other. However, without anchors, they won't have any order + # relationship to Class['ntp']. + class { 'ntp::package': } + -> class { 'ntp::config': } + -> class { 'ntp::service': } + + # These two resources "anchor" the composed classes within the ntp + # class. + anchor { 'ntp::begin': } -> Class['ntp::package'] + Class['ntp::service'] -> anchor { 'ntp::end': } + } + ``` This allows the end user of the ntp module to establish require and before relationships with Class['ntp']: - class { 'ntp': } -> class { 'mcollective': } - class { 'mcollective': } -> class { 'ntp': } + ``` + class { 'ntp': } -> class { 'mcollective': } + class { 'mcollective': } -> class { 'ntp': } + ``` - DESCRIPTION + DOC newparam :name do desc 'The name of the anchor resource.' end - def refresh # We don't do anything with them, but we need this to # show that we are "refresh aware" and not break the