Chef

Table Of Contents

subversion

A resource defines the desired state for a single configuration item present on a node that is under management by Chef. A resource collection—one (or more) individual resources—defines the desired state for the entire node. During a chef-client run, the current state of each resource is tested, after which the chef-client will take any steps that are necessary to repair the node and bring it back into the desired state.

Use the subversion resource to manage source control resources that exist in a Subversion repository.

Note

This resource is often used in conjunction with the deploy resource.

Syntax

A subversion resource block manages source control resources that exist in a Subversion repository:

subversion 'CouchDB Edge' do
  repository 'http://svn.apache.org/repos/asf/couchdb/trunk'
  revision 'HEAD'
  destination '/opt/mysources/couch'
  action :sync
end

The full syntax for all of the attributes that are available to the subversion resource is:

subversion 'name' do
  destination                String # defaults to 'name' if not specified
  group                      String, Integer
  notifies                   # see description
  provider                   Chef::Provider::Scm::Subversion
  repository                 String
  revision                   String
  subscribes                 # see description
  svn_arguments              String
  svn_info_args              String
  svn_password               String
  svn_username               String
  timeout                    Integer
  user                       String, Integer
  action                     Symbol # defaults to :sync if not specified
end

where

  • subversion is the resource
  • name is the name of the resource block and also (when destination is not specified) the location in which the source files will be placed and/or synchronized with the files under source control management
  • :action identifies the steps the chef-client will take to bring the node into the desired state
  • destination, group, provider, repository, revision, svn_arguments, svn_info_args, svn_password, svn_username, timeout, and user are attributes of this resource, with the Ruby type shown. (See “Attributes” section below for more information about all of the attributes that may be used with this resource.)

Actions

This resource has the following actions:

Action Description
:checkout Use to clone or check out the source. When a checkout is available, this provider does nothing.
:export Use to export the source, excluding or removing any version control artifacts.
:force_export Use to export the source, excluding or removing any version control artifacts and to force an export of the source that is overwriting the existing copy (if it exists).
:nothing Use to define a resource block that does nothing until it is notified by another resource to take action. When notified, this resource block is either run immediately or it is queued up to be run at the end of the chef-client run.
:sync Default. Use to update the source to the specified version, or to get a new clone or checkout.

Attributes

This resource has the following attributes:

Attribute Description
destination

Ruby Type: String

The path to the location to which the source will be cloned, checked out, or exported. Default value: the name of the resource block. (See “Syntax” section above for more information.)

group

Ruby Types: String, Integer

The system group that is responsible for the checked-out code.

ignore_failure

Ruby Types: TrueClass, FalseClass

Use to continue running a recipe if a resource fails for any reason. Default value: false.

notifies

Ruby Type: Symbol, ‘Chef::Resource[String]’, Symbol

Use to specify which resource will take action when this resource’s state changes. A resource may notify more than one resource; use a notifies statement for each resource to be notified.

Specify the :action, 'resource[name]', and timer (:delayed or :immediately). Use multiple notifies statements to notify more than one resource.

resource 'name' do
  ...
  notifies :action, 'resource[name]', :timer
end

Use the following timers to specify when a notification is triggered:

Timer Description
:delayed Use to specify that a notification should be queued up, and then executed at the very end of a chef-client run.
:immediately Use to specify that a notification should be run immediately, per resource notified.
provider

Ruby Type: Chef Class

Optional. Use to explicitly specify a provider.

repository

Ruby Type: String

The URI for the Subversion repository.

retries

Ruby Type: Integer

Use to specify the number of times to catch exceptions and retry the resource. Default value: 0.

retry_delay

Ruby Type: Integer

Use to specify the retry delay (in seconds). Default value: 2.

revision

Ruby Type: String

Use to specify a branch, tag, or commit to be synchronized with git. This can be symbolic, like HEAD or it can be a source control management-specific revision identifier. Default value: HEAD.

subscribes

Ruby Type: Symbol, ‘Chef::Resource[String]’, Symbol

Use to specify that this resource will listen to another resource, and then take action when that resource’s state changes.

Specify the :action, 'resource[name]', and timer (:delayed or :immediately). Use multiple subscribes statements to listen to more than one resource.

resource 'name' do
  ...
  subscribes :action, 'resource[name]', :timer
end

The subscribes attribute uses the same timers as the notifies attribute.

svn_arguments

Ruby Type: String

The extra arguments that are passed to the Subversion command.

svn_info_args

Ruby Type: String

Use when the svn info command is used by the chef-client and arguments need to be passed. (The svn_arguments command does not work when the svn info command is used.)

svn_password

Ruby Type: String

The password for the user that has access to the Subversion repository.

svn_username

Ruby Type: String

The user name for a user that has access to the Subversion repository.

timeout

Ruby Type: Integer

The amount of time (in seconds) to wait for a command to execute before timing out. When this attribute is specified using the deploy resource, the value of the timeout attribute is passed from the deploy resource to the subversion resource.

user

Ruby Types: String, Integer

The system user that is responsible for the checked-out code.

Examples

The following examples demonstrate various approaches for using resources in recipes. If you want to see examples of how Chef uses resources in recipes, take a closer look at the cookbooks that Chef authors and maintains: https://github.com/opscode-cookbooks.

Get the latest version of an application

subversion "CouchDB Edge" do
  repository "http://svn.apache.org/repos/asf/couchdb/trunk"
  revision "HEAD"
  destination "/opt/mysources/couch"
  action :sync
end