Skip to content
This repository has been archived by the owner on May 14, 2021. It is now read-only.

Latest commit

 

History

History
108 lines (77 loc) · 3.54 KB

README.md

File metadata and controls

108 lines (77 loc) · 3.54 KB
Raw

Application_Git Cookbook

Build Status Gem Version Cookbook Version Coverage Gemnasium License

A Chef cookbook to handle deploying code from git when using the application cookbook.

Quick Start

To deploy from a private GitHub repository:

application '/srv/myapp' do
  git '[email protected]:example/myapp.git' do
    deploy_key chef_vault_item('deploy_keys', 'myapp')['key']
  end
end

Requirements

Chef 12.1 or newer is required.

Resources

application_git

The application_git resource deploys code from git. It extends the core git resource to support deploy keys and disabling strict host key verification.

application '/srv/myapp' do
  git '[email protected]:example/myapp.git'
end

Actions

All actions work the same as the core git resource.

  • :sync – Clone and checkout the requested revision (default)
  • :checkout – Checkout the request revision. If the repository isn't already cloned, this action does nothing.
  • :export – Export the repository without the .git folder.

Properties

All properties from the core git resource work the same way with the following additions:

  • deploy_key – SSH key to use with git. Can be specified either as a path to key file already created or as a string value containing the key directly.
  • strict_ssh – Enable strict SSH host key checking. (default: false)

DSL Usage

The application_git resource can be used directly as a replacement for the core git resource:

application_git '/srv/myapp' do
  repository '[email protected]:example/myapp.git'
  deploy_key chef_vault_item('deploy_keys', 'myapp')['key']
end

Within the application resource, a simplified DSL is available. As with other application plugins, the default name of the resource if unspecified is the application path. The following two examples are equivalent:

application '/srv/myapp' do
  git do
    repository '[email protected]:example/myapp.git'
  end
end

application '/srv/myapp' do
  git '[email protected]:example/myapp.git'
end

Sponsors

Development sponsored by Chef Software, Symonds & Son, and Orion.

The Poise test server infrastructure is sponsored by Rackspace.

License

Copyright 2015-2017, Noah Kantrowitz

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.