application (38) Versions 4.1.6 Follow167

A Chef cookbook for deploying application code.

Policyfile

Berkshelf

Knife

cookbook 'application', '= 4.1.6', :supermarket

cookbook 'application', '= 4.1.6'

knife supermarket install application

knife supermarket download application

README

Dependencies

Changelog

Quality 0%

Application cookbook

This cookbook is designed to be able to describe and deploy web applications. It provides the basic infrastructure; other cookbooks are required to support specific combinations of frameworks and application servers. The following cookbooks are available at this time:

application_java (Java and Tomcat)
application_nginx (nginx reverse proxy)
application_php (PHP with mod_php_apache2)
application_python (Django with Gunicorn)
application_ruby (Rails with Passenger or Unicorn)

Backwards Compatibility

Version 4.0.0 dropped support for Chef 10
Version 2.0.0 dropped support for the apps data bag.

Requirements

The previous dependencies have been moved out to the application-stack-specific cookbooks, and this cookbook has no external dependencies.

Resources/Providers

The application LWRP configures the basic properties of most applications, regardless of the framework or application server they use. These include:

SCM information for the deployment, such as the repository URL and branch name;
deployment destination, including the filesystem path to deploy to;
any OS packages to install as dependencies;
optional callback to control the deployment.

This LWRP uses the deploy_revision LWRP to perform the bulk of its tasks, and many concepts and parameters map directly to it. Check the documentation for deploy_revision for more information.

Configuration of framework-specific aspects of the application are performed by invoking a sub-resource; see the appropriate cookbook for more documentation.

Actions

:deploy: deploy an application, including any necessary configuration, restarting the associated service if necessary
:force_deploy: same as :deploy, but it will send a :force_deploy action to the deploy resource, directing it to deploy the application even if the same revision is already deployed

Attribute Parameters

name: name attribute. The name of the application you are setting up. This will be used to derive the default value for other attribute
packages: an Array or Hash of packages to be installed before starting the deployment
path: target path of the deployment; it will be created if it does not exist
owner: the user that shall own the target path
group: the group that shall own the target path
keep_releases: count of keep releases
strategy: the underlying LWRP that will be used to perform the deployment. The default is :deploy_revision, and it should never be necessary to change it
scm_provider: the provider class to use for the deployment. It defaults to Chef::Provider::Git, you can set it to Chef::Provider::Subversion to deploy from an SVN repository
repository: the URL of the repository the application should be checked out from
revision: an identifier pointing to the revision that should be checked out
deploy_key: the private key to use to access the repository via SSH, or path to a file containing the key
rollback_on_error: if true, exceptions during a deployment will be caught and a clean rollback to the previous version will be attempted; the exception will then be re-raised. Defaults to true; change it only if you know what you are doing
environment: a Hash of environment variables to set while running migrations
purge_before_symlink: an Array of paths (relative to the checkout) to remove before creating symlinks
create_dirs_before_symlink: an Array of paths (relative to the checkout) pointing to directories to create before creating symlinks
symlinks: a Hash of shared/dir/path => release/dir/path. It determines which files and dirs in the shared directory get symlinked to the current release directory
symlink_before_migrate: similar to symlinks, except that they will be linked before any migration is run
migrate: if true then migrations will be run; defaults to false
migration_command: a command to run to migrate the application from the previous to the current state
restart_command: a command to run when restarting the application
environment_name: the name of a framework-specific "environment" (for example the Rails environment). By default it is the same as the Chef environment, unless it is _default, in which case it is set to production
enable_submodules: whether to enable git submodules in the deploy, passed into the deploy resource.

Callback Attributes

You can also set a few attributes on this LWRP that are interpreted as callback to be called at specific points during a deployment. If you pass a block, it will be evaluated within a new context. If you pass a string, it will be interpreted as a path (relative to the release directory) to a file; if it exists, it will be loaded and evaluated as though it were a Chef recipe.

The following callback attributes are available:

before_deploy: invoked immediately after initial setup and before the deployment proper is started. This callback will be invoked on every Chef run
before_migrate
before_symlink
before_restart
after_restart

Sub-resources

Anything that is not a known attribute will be interpreted as the name of a sub-resource; the resource will be looked up, and any nested attribute will be passed to it. More than one sub-resource can be added to an application; the order is significant, with the latter sub-resources overriding any sub-resource that comes before.

Sub-resources can set their own values for some attributes; if they do, they will be merged together with the attribute set on the main resource. The attributes that support this behavior are the following:

environment: environment variables from the application and from sub-resources will be merged together, with later resources overriding values set in the application or previous resources
migration_command: commands from the application and from sub-resources will be concatenated together joined with '&&' and run as a single shell command. The migration will only succeed if all the commands succeed
restart_command: commands from the application and from sub-resources will be evaluated in order
symlink_before_migrate: will be concatenated as a single array
callbacks: sub-resources callbacks will be invoked first, followed by the application callbacks

Usage

To use the application cookbook we recommend creating a cookbook named after the application, e.g. my_app. In metadata.rb you should declare a dependency on this cookbook and any framework cookbook the application may need. For example a Rails application may include:

depends 'application'
depends 'application_ruby'

The default recipe should describe your application using the application LWRP; you may also include additional recipes, for example to set up a database, queues, search engines and other components of your application.

A recipe using this LWRP may look like this:

application 'my_app' do
  path  '/deploy/to/dir'
  owner 'app-user'
  group 'app-group'

  repository 'http://git.example.com/my-app.git'
  revision   'production'

  # Apply the rails LWRP from application_ruby
  rails do
    # Rails-specific configuration. See the README in the
    # application_ruby cookbook for more information.
  end

  # Apply the passenger_apache2 LWRP, also from application_ruby
  passenger_apache2 do
    # Passenger-specific configuration.
  end
end

You can of course use any code necessary to determine the value of attributes:

application 'my_app' do
  repository 'http://git.example.com/my-app.git'
  revision   node.chef_environment == 'production' ? 'production' : 'develop'
end

Attributes from the application and from sub-resources are merged together:

application 'my_app' do
  restart_command 'kill -1 `cat /var/run/one.pid`'
  environment     'LC_ALL' => 'en', 'FOO' => 'bar'

  rails do
    restart_command 'touch /tmp/something'
    environment     'LC_ALL' => 'en_US'
  end

  passenger_apache2 do
    environment 'FOO' => 'baz'
  end
end

# at the end, you will have:
#
# restart_command #=> kill -1 `cat /var/run/one.pid` && touch /tmp/something
# environment #=> LC_ALL=en_US FOO=baz

Most databases have the concept of migrations (or you can just use your own):

application 'my_app' do
  path  '/deploy/to/dir'
  owner 'app-user'
  group 'app-group'

  repository 'http://git.example.com/my-app.git'
  revision   'production'

  php do
    migrate true
    migration_command 'your-applications-migrate-command'
  end
end

This will run your-applications-migrate-command, with the current directory set to the directory of the current checkout.

To use the application cookbook, we recommend creating a role named after the application, e.g. my_app. Create a Ruby DSL role in your chef-repo, or create the role directly with knife.

name 'my_app'
description 'My application deployment'
run_list([
  'recipe[my_app::default]'
])

License and Authors

Author: Adam Jacob (adam@opscode.com)
Author: Andrea Campi (andrea.campi@zephirworks.com.com)
Author: Joshua Timberman (joshua@opscode.com)
Author: Noah Kantrowitz (noah@opscode.com)
Author: Seth Chisamore (schisamo@opscode.com)

Copyright 2009-2013, Opscode, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Dependent cookbooks

This cookbook has no specified dependencies.

Contingent cookbooks

application Cookbook CHANGELOG

This file is used to list changes made in each version of the application cookbook.

v4.1.6

Support for Chef 12.
Add strict_ssh option to enable host key checking.
Add keep_releases option to control number of releases to keep.
Allow passing a path to a file for deploy_key.

v4.1.4

Bug

COOK-3343 - Can't parse release candidate version number

v4.1.2

Bug

COOK-3343 - Can't parse release candidate version number

v4.1.0

Bug

[COOK-3343] - Can't parse release candidate version number

v4.0.0

Breaking

Removes compatability with Chef 10

Improvement

COOK-3564 - Replace calls to Chef::Mixin::RecipeDefinitionDSLCore

v3.0.0

Bug

[COOK-3306]: Multiple Memory Leaks in Application Cookbook

v2.0.4

Bug

[COOK-2812]: application cookbook doesn't allow to specify a block as restart_command

v2.0.2

Bug

[COOK-2537]: Provide proper respond_to behavior when using method_missing
[COOK-2713]: application resource should Allow sub-resource attributes to propogate up

Improvement

[COOK-2597]: Allow customization for shallow_clone when doing a git deploy

v2.0.0

This release is incompatible with previous releases (hence major version change). The recipes used in older versions are deprecated and completely removed. See README.md for further detail.

[COOK-1673] - deploy_revision in the application cookbook gives an argument error
[COOK-1820] - Application cookbook: remove deprecated recipes

v1.0.4

[COOK-1567] - Add git submodules to application cookbook

v1.0.2

[COOK-1312] - string callbacks fail with method not found (really included this time)
[COOK-1332] - add release_path and shared_path methods
[COOK-1333] - add example for running migrations
[COOK-1360] - fix minor typos in README
[COOK-1374] - use runit attributes in unicorn run script

v1.0.0

This release introduces the LWRP for application deployment, as well as other improvements. The recipes will be deprecated in August 2012 as indicated by their warning messages and in the README.md.

[COOK-634] - Implement LWRP for application deployment
[COOK-1116] - use other SCMs than git
[COOK-1252] - add :force_deploy that maps to corresponding action of deploy resource
[COOK-1253] - fix rollback error
[COOK-1312] - string callbacks fail with method not found
[COOK-1313] - implicit file based hooks aren't invoked
[COOK-1318] - Create to_ary method to resolve issue in resources() lookup on "application[foo]" resources

v0.99.14

[COOK-1065] - use pip in virtualenv during deploy

v0.99.12

[COOK-606] application cookbook deployment recipes should use ipaddress instead of fqdn

v0.99.11

make the _default chef_environment look like production rails env

v0.99.10

Use Chef 0.10's node.chef_environment instead of node['app_environment'].

Foodcritic Metric

4.1.6 failed this metric

FC003: Check whether you are running with chef server before using server-specific features: /tmp/cook/e56c620a4cd2c63388426a3a/application/libraries/default.rb:102
FC017: LWRP does not notify when updated: /tmp/cook/e56c620a4cd2c63388426a3a/application/providers/default.rb:23
FC017: LWRP does not notify when updated: /tmp/cook/e56c620a4cd2c63388426a3a/application/providers/default.rb:33
FC017: LWRP does not notify when updated: /tmp/cook/e56c620a4cd2c63388426a3a/application/providers/default.rb:43
FC031: Cookbook without metadata file: /tmp/cook/e56c620a4cd2c63388426a3a/application/metadata.rb:1
FC045: Consider setting cookbook name in metadata: /tmp/cook/e56c620a4cd2c63388426a3a/application/metadata.rb:1

Adoptable Cookbooks List

Supermarket Belongs to the Community

View our collection of guides, documentation, and articles

Select Badges

Select Supported Platforms

Select Status

application (38) Versions 4.1.6 5.2.0 5.1.0 5.0.0 4.1.6 4.1.4 4.1.2 4.1.0 4.0.0 3.0.0 2.0.4 2.0.2 2.0.0 1.0.4 1.0.2 1.0.0 0.99.14 0.99.12 0.99.11 0.99.10 0.99.9 0.99.8 0.99.7 0.99.6 0.99.5 0.99.4 0.99.3 0.99.2 0.99.1 0.99.0 0.8.1 0.8.0 0.7.0 0.6.3 0.6.2 0.6.0 0.5.0 0.4.0 0.3.0 Follow167

Application cookbook

Backwards Compatibility

Requirements

Resources/Providers

Actions

Attribute Parameters

Callback Attributes

Sub-resources

Usage

License and Authors

Dependent cookbooks

Contingent cookbooks

application Cookbook CHANGELOG

v4.1.6

v4.1.4

Bug

v4.1.2

Bug

v4.1.0

Bug

v4.0.0

Breaking

Improvement

v3.0.0

Bug

v2.0.4

Bug

v2.0.2

Bug

Improvement

v2.0.0

v1.0.4

v1.0.2

v1.0.0

v0.99.14

v0.99.12

v0.99.11

v0.99.10

Details

Updated January 14, 2015 Created on April 29, 2010

Supported Platforms

License

application (38) Versions 4.1.6 Follow167