poise-ruby 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +11 -0
- data/.kitchen.travis.yml +9 -0
- data/.kitchen.yml +9 -0
- data/.travis.yml +20 -0
- data/.yardopts +7 -0
- data/Berksfile +28 -0
- data/Gemfile +33 -0
- data/LICENSE +201 -0
- data/README.md +290 -0
- data/Rakefile +17 -0
- data/chef/attributes/default.rb +23 -0
- data/chef/recipes/default.rb +19 -0
- data/lib/poise_ruby.rb +24 -0
- data/lib/poise_ruby/cheftie.rb +18 -0
- data/lib/poise_ruby/error.rb +21 -0
- data/lib/poise_ruby/resources.rb +29 -0
- data/lib/poise_ruby/resources/bundle_install.rb +221 -0
- data/lib/poise_ruby/resources/ruby_execute.rb +91 -0
- data/lib/poise_ruby/resources/ruby_gem.rb +118 -0
- data/lib/poise_ruby/resources/ruby_runtime.rb +87 -0
- data/lib/poise_ruby/ruby_command_mixin.rb +59 -0
- data/lib/poise_ruby/ruby_providers.rb +32 -0
- data/lib/poise_ruby/ruby_providers/base.rb +116 -0
- data/lib/poise_ruby/ruby_providers/chef.rb +53 -0
- data/lib/poise_ruby/ruby_providers/scl.rb +77 -0
- data/lib/poise_ruby/ruby_providers/system.rb +115 -0
- data/lib/poise_ruby/version.rb +20 -0
- data/poise-ruby.gemspec +41 -0
- data/test/cookbooks/poise-ruby_test/metadata.rb +18 -0
- data/test/cookbooks/poise-ruby_test/recipes/bundle_install.rb +102 -0
- data/test/cookbooks/poise-ruby_test/recipes/default.rb +85 -0
- data/test/gemfiles/chef-12.gemfile +19 -0
- data/test/gemfiles/master.gemfile +23 -0
- data/test/integration/default/serverspec/bundle_install_spec.rb +73 -0
- data/test/integration/default/serverspec/default_spec.rb +46 -0
- data/test/spec/resources/bundle_install_spec.rb +306 -0
- data/test/spec/resources/ruby_execute_spec.rb +78 -0
- data/test/spec/ruby_command_mixin_spec.rb +34 -0
- data/test/spec/spec_helper.rb +18 -0
- metadata +155 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: c4e1310672624564e0b724222292352c9595760b
|
4
|
+
data.tar.gz: 2deab93c85a22b20ba59ef408ed32c5eb4c2725b
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: cb314e2c7e86dd72e4644a44c072863b18502e4097dd1b35d17204a0b3127883aa07a9bfb69813ecb89fcad775d6f7e9a8ce48b12620c3a7234221fd4fbbcf2a
|
7
|
+
data.tar.gz: 6452dc8e984096abe9bddad62070b7efda680a170b53c6140ca73572a78080cf673ab7fc78ee619c86f88c8c00d2d81e989f2d1fe4970df6a6e14072a2aafc9c
|
data/.gitignore
ADDED
data/.kitchen.travis.yml
ADDED
data/.kitchen.yml
ADDED
data/.travis.yml
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
sudo: false
|
2
|
+
cache: bundler
|
3
|
+
language: ruby
|
4
|
+
addons:
|
5
|
+
apt:
|
6
|
+
packages:
|
7
|
+
- libgecode-dev
|
8
|
+
rvm:
|
9
|
+
- '2.2'
|
10
|
+
env:
|
11
|
+
global:
|
12
|
+
- USE_SYSTEM_GECODE=true
|
13
|
+
- KITCHEN_LOCAL_YAML=.kitchen.travis.yml
|
14
|
+
- secure: YOM++OBAaAhRGG4IkODRzmscd0JAW1w5jnfTcpF1nV9pGFEicFGGneHANzT2FdNl/xU2BDzoQd46Wv5rSPb0C+Kw00qYyadTsyWaVVggHL60FLFWGpnFq29iApHnKA+HX5qoKGgtW5ZPczJlwumuZvr+pgstUOVYTk/RJqFy+vw=
|
15
|
+
bundler_args: "--binstubs=$PWD/bin --jobs 3 --retry 3"
|
16
|
+
script:
|
17
|
+
- "./bin/rake travis"
|
18
|
+
gemfile:
|
19
|
+
- test/gemfiles/chef-12.gemfile
|
20
|
+
- test/gemfiles/master.gemfile
|
data/.yardopts
ADDED
data/Berksfile
ADDED
@@ -0,0 +1,28 @@
|
|
1
|
+
#
|
2
|
+
# Copyright 2015, Noah Kantrowitz
|
3
|
+
#
|
4
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
5
|
+
# you may not use this file except in compliance with the License.
|
6
|
+
# You may obtain a copy of the License at
|
7
|
+
#
|
8
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
9
|
+
#
|
10
|
+
# Unless required by applicable law or agreed to in writing, software
|
11
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
12
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
13
|
+
# See the License for the specific language governing permissions and
|
14
|
+
# limitations under the License.
|
15
|
+
#
|
16
|
+
|
17
|
+
source 'https://supermarket.chef.io/'
|
18
|
+
extension 'halite'
|
19
|
+
|
20
|
+
# Force the rebuild every time for development.
|
21
|
+
cookbook 'poise', gem: 'poise'
|
22
|
+
cookbook 'poise-languages', gem: 'poise-languages'
|
23
|
+
cookbook 'poise-ruby', gem: 'poise-ruby'
|
24
|
+
|
25
|
+
group :test do
|
26
|
+
cookbook 'poise-ruby_test', path: 'test/cookbooks/poise-ruby_test'
|
27
|
+
cookbook 'apt'
|
28
|
+
end
|
data/Gemfile
ADDED
@@ -0,0 +1,33 @@
|
|
1
|
+
#
|
2
|
+
# Copyright 2015, Noah Kantrowitz
|
3
|
+
#
|
4
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
5
|
+
# you may not use this file except in compliance with the License.
|
6
|
+
# You may obtain a copy of the License at
|
7
|
+
#
|
8
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
9
|
+
#
|
10
|
+
# Unless required by applicable law or agreed to in writing, software
|
11
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
12
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
13
|
+
# See the License for the specific language governing permissions and
|
14
|
+
# limitations under the License.
|
15
|
+
#
|
16
|
+
|
17
|
+
source 'https://rubygems.org/'
|
18
|
+
|
19
|
+
gemspec path: File.expand_path('..', __FILE__)
|
20
|
+
|
21
|
+
def dev_gem(name, path: File.join('..', name), github: nil)
|
22
|
+
path = File.expand_path(File.join('..', path), __FILE__)
|
23
|
+
if File.exist?(path)
|
24
|
+
gem name, path: path
|
25
|
+
elsif github
|
26
|
+
gem name, github: github
|
27
|
+
end
|
28
|
+
end
|
29
|
+
|
30
|
+
dev_gem 'halite'
|
31
|
+
dev_gem 'poise'
|
32
|
+
dev_gem 'poise-boiler'
|
33
|
+
dev_gem 'poise-languages'
|
data/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,290 @@
|
|
1
|
+
# Poise-Ruby Cookbook
|
2
|
+
|
3
|
+
[![Build Status](https://img.shields.io/travis/poise/poise-ruby.svg)](https://travis-ci.org/poise/poise-ruby)
|
4
|
+
[![Gem Version](https://img.shields.io/gem/v/poise-ruby.svg)](https://rubygems.org/gems/poise-ruby)
|
5
|
+
[![Cookbook Version](https://img.shields.io/cookbook/v/poise-ruby.svg)](https://supermarket.chef.io/cookbooks/poise-ruby)
|
6
|
+
[![Coverage](https://img.shields.io/codecov/c/github/poise/poise-ruby.svg)](https://codecov.io/github/poise/poise-ruby)
|
7
|
+
[![Gemnasium](https://img.shields.io/gemnasium/poise/poise-ruby.svg)](https://gemnasium.com/poise/poise-ruby)
|
8
|
+
[![License](https://img.shields.io/badge/license-Apache_2-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
|
9
|
+
|
10
|
+
A [Chef](https://www.chef.io/) cookbook to provide a unified interface for
|
11
|
+
installing Ruby and running things with it. This README covers the 2.x version
|
12
|
+
of the cookbook, the 1.x version is very different and no longer supported.
|
13
|
+
|
14
|
+
## Quick Start
|
15
|
+
|
16
|
+
To install the latest available version of Ruby 2.x and then use it to install
|
17
|
+
some gems:
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
ruby_runtime '2'
|
21
|
+
|
22
|
+
ruby_gem 'rake'
|
23
|
+
|
24
|
+
bundle_install '/path/to/Gemfile' do
|
25
|
+
without 'development'
|
26
|
+
deployment true
|
27
|
+
end
|
28
|
+
```
|
29
|
+
|
30
|
+
## Requirements
|
31
|
+
|
32
|
+
Chef 12 or newer is required.
|
33
|
+
|
34
|
+
## Attributes
|
35
|
+
|
36
|
+
Attributes are used to configure the default recipe.
|
37
|
+
|
38
|
+
* `node['poise-ruby']['install_ruby']` – Install a Ruby runtime. *(default: true)*
|
39
|
+
* `node['poise-ruby']['install_chef_ruby']` – Create a `ruby_runtime` using
|
40
|
+
the `:chef` provider. Doesn't actually install anything. *(default: true)*
|
41
|
+
|
42
|
+
## Recipes
|
43
|
+
|
44
|
+
### `default`
|
45
|
+
|
46
|
+
The default recipe installs Ruby based on the node attributes. It is entirely
|
47
|
+
optional and can be ignored in favor of direct use of the `ruby_runtime`
|
48
|
+
resource.
|
49
|
+
|
50
|
+
## Resources
|
51
|
+
|
52
|
+
### `ruby_runtime`
|
53
|
+
|
54
|
+
The `ruby_runtime` resource installs a Ruby interpreter.
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
ruby_runtime 'any' do
|
58
|
+
version ''
|
59
|
+
end
|
60
|
+
```
|
61
|
+
|
62
|
+
#### Actions
|
63
|
+
|
64
|
+
* `:install` – Install the Ruby interpreter. *(default)*
|
65
|
+
* `:uninstall` – Uninstall the Ruby interpreter.
|
66
|
+
|
67
|
+
#### Properties
|
68
|
+
|
69
|
+
* `version` – Version of Ruby to install. If a partial version is given, use the
|
70
|
+
latest available version matching that prefix. *(name properties)*
|
71
|
+
|
72
|
+
#### Provider Options
|
73
|
+
|
74
|
+
The `poise-ruby` library offers an additional way to pass configuration
|
75
|
+
information to the final provider called "options". Options are key/value pairs
|
76
|
+
that are passed down to the ruby_runtime provider and can be used to control how it
|
77
|
+
installs Ruby. These can be set in the `ruby_runtime`
|
78
|
+
resource using the `options` method, in node attributes or via the
|
79
|
+
`ruby_runtime_options` resource. The options from all sources are merged
|
80
|
+
together in to a single hash.
|
81
|
+
|
82
|
+
When setting options in the resource you can either set them for all providers:
|
83
|
+
|
84
|
+
```ruby
|
85
|
+
ruby_runtime 'myapp' do
|
86
|
+
version '2.1'
|
87
|
+
options dev_package: false
|
88
|
+
end
|
89
|
+
```
|
90
|
+
|
91
|
+
or for a single provider:
|
92
|
+
|
93
|
+
```ruby
|
94
|
+
ruby_runtime 'myapp' do
|
95
|
+
version '2.1'
|
96
|
+
options :system, dev_package: false
|
97
|
+
end
|
98
|
+
```
|
99
|
+
|
100
|
+
Setting via node attributes is generally how an end-user or application cookbook
|
101
|
+
will set options to customize installations in the library cookbooks they are using.
|
102
|
+
You can set options for all installations or for a single runtime:
|
103
|
+
|
104
|
+
```ruby
|
105
|
+
# Global, for all installations.
|
106
|
+
override['poise-ruby']['options']['dev_package'] = false
|
107
|
+
# Single installation.
|
108
|
+
override['poise-ruby']['myapp']['version'] = '2.2'
|
109
|
+
```
|
110
|
+
|
111
|
+
The `ruby_runtime_options` resource is also available to set node attributes
|
112
|
+
for a specific installation in a DSL-friendly way:
|
113
|
+
|
114
|
+
```ruby
|
115
|
+
ruby_runtime_options 'myapp' do
|
116
|
+
version '2.2'
|
117
|
+
end
|
118
|
+
```
|
119
|
+
|
120
|
+
Unlike resource attributes, provider options can be different for each provider.
|
121
|
+
Not all providers support the same options so make sure to the check the
|
122
|
+
documentation for each provider to see what options the use.
|
123
|
+
|
124
|
+
### `ruby_runtime_options`
|
125
|
+
|
126
|
+
The `ruby_runtime_options` resource allows setting provider options in a
|
127
|
+
DSL-friendly way. See [the Provider Options](#provider-options) section for more
|
128
|
+
information about provider options overall.
|
129
|
+
|
130
|
+
```ruby
|
131
|
+
ruby_runtime_options 'myapp' do
|
132
|
+
version '2.2'
|
133
|
+
end
|
134
|
+
```
|
135
|
+
|
136
|
+
#### Actions
|
137
|
+
|
138
|
+
* `:run` – Apply the provider options. *(default)*
|
139
|
+
|
140
|
+
#### Properties
|
141
|
+
|
142
|
+
* `resource` – Name of the `ruby_runtime` resource. *(name property)*
|
143
|
+
* `for_provider` – Provider to set options for.
|
144
|
+
|
145
|
+
All other property keys will be used as options data.
|
146
|
+
|
147
|
+
### `ruby_execute`
|
148
|
+
|
149
|
+
The `ruby_execute` resource executes a Ruby script using the configured runtime.
|
150
|
+
|
151
|
+
```ruby
|
152
|
+
ruby_execute 'myapp.rb' do
|
153
|
+
user 'myuser'
|
154
|
+
end
|
155
|
+
```
|
156
|
+
|
157
|
+
This uses the built-in `execute` resource and supports all the same properties.
|
158
|
+
|
159
|
+
#### Actions
|
160
|
+
|
161
|
+
* `:run` – Execute the script. *(default)*
|
162
|
+
|
163
|
+
#### Properties
|
164
|
+
|
165
|
+
* `command` – Script and arguments to run. Must not include the `ruby`. *(name property)*
|
166
|
+
* `ruby` – Name of the `ruby_runtime` resource to use. If not specified, the
|
167
|
+
most recently declared `ruby_runtime` will be used.
|
168
|
+
|
169
|
+
For other properties see the [Chef documentation](https://docs.chef.io/resource_execute.html#attributes).
|
170
|
+
|
171
|
+
### `ruby_gem`
|
172
|
+
|
173
|
+
The `ruby_gem` resource is a subclass of the standard `gem_package` resource to
|
174
|
+
install the gem with the configured runtime.
|
175
|
+
|
176
|
+
```ruby
|
177
|
+
ruby_gem 'rake' do
|
178
|
+
version ' 10.4.2'
|
179
|
+
end
|
180
|
+
```
|
181
|
+
|
182
|
+
All actions and attributes match the standard `gem_package` resource with the
|
183
|
+
addition of a `ruby` attribute matching `ruby_execute`.
|
184
|
+
|
185
|
+
### `bundle_install`
|
186
|
+
|
187
|
+
The `bundle_install` resource installs gems based on a Gemfile using
|
188
|
+
[bundler](http://bundler.io/).
|
189
|
+
|
190
|
+
```ruby
|
191
|
+
bundle_install '/path/to/Gemfile' do
|
192
|
+
deployment true
|
193
|
+
jobs 3
|
194
|
+
end
|
195
|
+
```
|
196
|
+
|
197
|
+
The underlying `bundle` command will run on every converge, but notifications
|
198
|
+
will only be triggered if a gem is actually installed.
|
199
|
+
|
200
|
+
#### Actions
|
201
|
+
|
202
|
+
* `:install` – Run `bundle install`. *(default)*
|
203
|
+
* `:update` – Run `bundle update`.
|
204
|
+
|
205
|
+
#### Properties
|
206
|
+
|
207
|
+
* `path` – Path to a Gemfile or a directory containing a Gemfile. *(name property)*
|
208
|
+
* `binstubs` – Enable binstubs. If set to a string it is the path to generate
|
209
|
+
stubs in.
|
210
|
+
* `bundler_version` – Version of bundler to install. If unset the latest version is used.
|
211
|
+
* `deployment` – Enable deployment mode.
|
212
|
+
* `gem_binary` – Path to the gem binary. If unset this uses the `ruby_runtime` parent.
|
213
|
+
* `jobs` – Number of parallel installations to run.
|
214
|
+
* `retry` – Number of times to retry failed installations.
|
215
|
+
* `ruby` – Name of the `ruby_runtime` resource to execute against.
|
216
|
+
* `user` – User to run bundler as.
|
217
|
+
* `vendor` – Enable local vendoring. This maps to the `--path` option in bundler,
|
218
|
+
but that attribute name is already used.
|
219
|
+
* `without` – Group or groups to not install.
|
220
|
+
|
221
|
+
## Ruby Providers
|
222
|
+
|
223
|
+
### `system`
|
224
|
+
|
225
|
+
The `system` provider installs Ruby using system packages. This is currently
|
226
|
+
only tested on platforms using `apt-get` and `yum` (Debian, Ubuntu, RHEL, CentOS
|
227
|
+
Amazon Linux, and Fedora) and is the default provider on those platforms. It
|
228
|
+
may work on other platforms but is untested.
|
229
|
+
|
230
|
+
```ruby
|
231
|
+
ruby_runtime 'myapp' do
|
232
|
+
provider :system
|
233
|
+
version '2.1'
|
234
|
+
end
|
235
|
+
```
|
236
|
+
|
237
|
+
#### Options
|
238
|
+
|
239
|
+
* `dev_package` – Install the package with the headers and other development
|
240
|
+
files. *(default: true)*
|
241
|
+
* `rubygems_package` – Install rubygems from a package. This is only needed for
|
242
|
+
Ruby 1.8. *(default: true on RHEL 6)*
|
243
|
+
* `package_name` – Override auto-detection of the package name.
|
244
|
+
* `package_upgrade` – Install using action `:upgrade`. *(default: false)*
|
245
|
+
* `package_version` – Override auto-detection of the package version.
|
246
|
+
* `version` – Override the Ruby version.
|
247
|
+
|
248
|
+
### `chef`
|
249
|
+
|
250
|
+
The `chef` provider uses the Ruby environment included in the Omnibus packages.
|
251
|
+
Great care should be taken when using this provider.
|
252
|
+
|
253
|
+
```ruby
|
254
|
+
ruby_runtime 'myapp' do
|
255
|
+
provider :chef
|
256
|
+
version '2.1'
|
257
|
+
end
|
258
|
+
```
|
259
|
+
|
260
|
+
#### Options
|
261
|
+
|
262
|
+
* `version` – Override the Ruby version.
|
263
|
+
|
264
|
+
### `ruby_build`
|
265
|
+
|
266
|
+
The `ruby_build` provider uses [ruby-build](https://github.com/sstephenson/ruby-build)
|
267
|
+
to compile and install Ruby. It can be found in the
|
268
|
+
[poise-ruby-build cookbook](https://github.com/poise/poise-ruby-build).
|
269
|
+
|
270
|
+
## Sponsors
|
271
|
+
|
272
|
+
Development sponsored by [Bloomberg](http://www.bloomberg.com/company/technology/).
|
273
|
+
|
274
|
+
The Poise test server infrastructure is sponsored by [Rackspace](https://rackspace.com/).
|
275
|
+
|
276
|
+
## License
|
277
|
+
|
278
|
+
Copyright 2015, Noah Kantrowitz
|
279
|
+
|
280
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
281
|
+
you may not use this file except in compliance with the License.
|
282
|
+
You may obtain a copy of the License at
|
283
|
+
|
284
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
285
|
+
|
286
|
+
Unless required by applicable law or agreed to in writing, software
|
287
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
288
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
289
|
+
See the License for the specific language governing permissions and
|
290
|
+
limitations under the License.
|