cookbook 'deploy_wrapper', '~> 0.2.0'
deploy_wrapper (5) Versions 0.2.0 Follow7
Provides a definition that sets up an ssh key and ssh wrapper script for use with deploy or deploy_revision resources
cookbook 'deploy_wrapper', '~> 0.2.0', :supermarket
knife supermarket install deploy_wrapper
knife supermarket download deploy_wrapper
Description
The deploy_wrapper
cookbook provides a lightweight resource provider which sets up an ssh key and ssh wrapper script for
use with deploy
or deploy_revision
resources.
Attributes
-
ssh_wrapper_path
- final path for your ssh wrapper script. -
ssh_wrapper_dir
- the ssh wrapper script will be written to this directory. -
ssh_key_file
- key file to use. -
ssh_key_dir
- the ssh key file will be written to this directory. -
ssh_key_data
- the private key data to write into the ssh key file, this overridessh_key_file
. -
owner
- the owner for ssh wrapper and key files, defaults to 'root' -
group
- the group ownership for ssh wrapper and key files, defaults to 'root' -
sloppy
- a boolean which toggles whether or not the ssh wrapper script will attempt to validate the repo's ssh key. This parameter defaults tofalse
, but the default setting will probably cause problems when executing deploy resources if~/.ssh/known_hosts
has not been pre-populated manually or via another cookbook.
Platform
Should work on any platform where Chef runs. Tested on Ubuntu.
Requirements
N/A
Usage example
include_recipe 'deploy_wrapper'
deploy_wrapper 'myapp' do
owner 'root'
group 'root'
ssh_wrapper_dir '/opt/example/shared'
ssh_key_dir '/root/.ssh'
ssh_key_data secrets['deploy_keys']['myapp']
sloppy true
end
deploy_revision '/opt/example/myapp' do
revision 'master'
repo 'https://github.com/example/myapp'
ssh_wrapper '/opt/example/shared/myapp_deploy_wrapper.sh'
end
License and Author
Author:: Cameron Johnston cameron@rootdown.net
Author:: Guilhem Lettron guilhem@lettron.fr
Copyright:: 2012, Cameron Johnston
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
There are no cookbooks that are contingent upon this one.
Collaborator Number Metric
0.2.0 failed this metric
Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.
Contributing File Metric
0.2.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
0.2.0 failed this metric
FC064: Ensure issues_url is set in metadata: deploy_wrapper/metadata.rb:1
FC065: Ensure source_url is set in metadata: deploy_wrapper/metadata.rb:1
FC066: Ensure chef_version is set in metadata: deploy_wrapper/metadata.rb:1
FC067: Ensure at least one platform supported in metadata: deploy_wrapper/metadata.rb:1
FC068: Ensure license is set in metadata: deploy_wrapper/metadata.rb:1
FC069: Ensure standardized license defined in metadata: deploy_wrapper/metadata.rb:1
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
No Binaries Metric
0.2.0 passed this metric
Testing File Metric
0.2.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.2.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
0.2.0 failed this metric
0.2.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
0.2.0 failed this metric
FC064: Ensure issues_url is set in metadata: deploy_wrapper/metadata.rb:1
FC065: Ensure source_url is set in metadata: deploy_wrapper/metadata.rb:1
FC066: Ensure chef_version is set in metadata: deploy_wrapper/metadata.rb:1
FC067: Ensure at least one platform supported in metadata: deploy_wrapper/metadata.rb:1
FC068: Ensure license is set in metadata: deploy_wrapper/metadata.rb:1
FC069: Ensure standardized license defined in metadata: deploy_wrapper/metadata.rb:1
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
No Binaries Metric
0.2.0 passed this metric
Testing File Metric
0.2.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.2.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
0.2.0 failed this metric
FC065: Ensure source_url is set in metadata: deploy_wrapper/metadata.rb:1
FC066: Ensure chef_version is set in metadata: deploy_wrapper/metadata.rb:1
FC067: Ensure at least one platform supported in metadata: deploy_wrapper/metadata.rb:1
FC068: Ensure license is set in metadata: deploy_wrapper/metadata.rb:1
FC069: Ensure standardized license defined in metadata: deploy_wrapper/metadata.rb:1
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
0.2.0 passed this metric
Testing File Metric
0.2.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.2.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
0.2.0 failed this metric
0.2.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number