summaryrefslogtreecommitdiff
path: root/chef-utils/lib/chef-utils/dsl/cloud.rb
diff options
context:
space:
mode:
Diffstat (limited to 'chef-utils/lib/chef-utils/dsl/cloud.rb')
-rw-r--r--chef-utils/lib/chef-utils/dsl/cloud.rb50
1 files changed, 29 insertions, 21 deletions
diff --git a/chef-utils/lib/chef-utils/dsl/cloud.rb b/chef-utils/lib/chef-utils/dsl/cloud.rb
index 24f09d638c..734c7412aa 100644
--- a/chef-utils/lib/chef-utils/dsl/cloud.rb
+++ b/chef-utils/lib/chef-utils/dsl/cloud.rb
@@ -24,7 +24,8 @@ module ChefUtils
# Determine if the current node is "in the cloud".
#
- # @param [Chef::Node] node
+ # @param [Chef::Node] node the node to check
+ # @since 15.8
#
# @return [Boolean]
#
@@ -32,9 +33,10 @@ module ChefUtils
node.key?("cloud")
end
- # Return true if the current current node is in EC2
+ # Return true if the current current node is in EC2.
#
- # @param [Chef::Node] node
+ # @param [Chef::Node] node the node to check
+ # @since 15.8
#
# @return [Boolean]
#
@@ -42,9 +44,10 @@ module ChefUtils
node.key?("ec2")
end
- # Return true if the current current node is in GCE
+ # Return true if the current current node is in GCE.
#
- # @param [Chef::Node] node
+ # @param [Chef::Node] node the node to check
+ # @since 15.8
#
# @return [Boolean]
#
@@ -52,9 +55,10 @@ module ChefUtils
node.key?("gce")
end
- # Return true if the current current node is in Rackspace
+ # Return true if the current current node is in Rackspace.
#
- # @param [Chef::Node] node
+ # @param [Chef::Node] node the node to check
+ # @since 15.8
#
# @return [Boolean]
#
@@ -62,9 +66,10 @@ module ChefUtils
node.key?("rackspace")
end
- # Return true if the current current node is in Eucalyptus
+ # Return true if the current current node is in Eucalyptus.
#
- # @param [Chef::Node] node
+ # @param [Chef::Node] node the node to check
+ # @since 15.8
#
# @return [Boolean]
#
@@ -74,9 +79,10 @@ module ChefUtils
# chef-sugar backcompat method
alias_method :euca?, :eucalyptus?
- # Return true if the current current node is in Linode
+ # Return true if the current current node is in Linode.
#
- # @param [Chef::Node] node
+ # @param [Chef::Node] node the node to check
+ # @since 15.8
#
# @return [Boolean]
#
@@ -84,9 +90,10 @@ module ChefUtils
node.key?("linode")
end
- # Return true if the current current node is in Openstack
+ # Return true if the current current node is in OpenStack.
#
- # @param [Chef::Node] node
+ # @param [Chef::Node] node the node to check
+ # @since 15.8
#
# @return [Boolean]
#
@@ -94,9 +101,10 @@ module ChefUtils
node.key?("openstack")
end
- # Return true if the current current node is in Azure
+ # Return true if the current current node is in Azure.
#
- # @param [Chef::Node] node
+ # @param [Chef::Node] node the node to check
+ # @since 15.8
#
# @return [Boolean]
#
@@ -104,10 +112,10 @@ module ChefUtils
node.key?("azure")
end
- # Return true if the current current node is in DigitalOcean
+ # Return true if the current current node is in DigitalOcean.
#
- # @param [Chef::Node] node
- # the node to check
+ # @param [Chef::Node] node the node to check
+ # @since 15.8
#
# @return [Boolean]
#
@@ -117,10 +125,10 @@ module ChefUtils
# chef-sugar backcompat method
alias_method :digitalocean?, :digital_ocean?
- # Return true if the current current node is in SoftLayer
+ # Return true if the current current node is in SoftLayer.
#
- # @param [Chef::Node] node
- # the node to check
+ # @param [Chef::Node] node the node to check
+ # @since 15.8
#
# @return [Boolean]
#