chef-partial_search 1.0.7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +21 -0
- data/CHANGELOG.md +26 -0
- data/CONTRIBUTING.md +257 -0
- data/Gemfile +4 -0
- data/LICENSE +202 -0
- data/README.md +79 -0
- data/chef-partial_search.gemspec +21 -0
- data/libraries/partial_search.rb +147 -0
- data/metadata.rb +7 -0
- data/recipes/default.rb +1 -0
- metadata +69 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 02e417307dfcad832169aa7f7bf20808ae56f483
|
4
|
+
data.tar.gz: bdc712172e853d6a0c4d7941137b6c9be8925437
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 599d0cc4e02f39086be4d293b5cb4c5f3563c5d556d09f9394abfa786982ead0cee45c9b5640e1b34d18cb550a0be31274a28c63ea0efad1658951ac08f0fdb9
|
7
|
+
data.tar.gz: 0914b5b6c79751fa589cbb30fac1853c351ef7c60e33f0b04f3fa5efb5b3a16b263c26e5bbd8d35cc2d9e3ac9c683ccf8d9e0f59a275756fc5c6effd996a70f3
|
data/.gitignore
ADDED
data/CHANGELOG.md
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
partial_search Cookbook CHANGELOG
|
2
|
+
=================================
|
3
|
+
This file is used to list changes made in each version of the partial_search cookbook.
|
4
|
+
|
5
|
+
|
6
|
+
v1.0.6
|
7
|
+
------
|
8
|
+
- **Hotfix** - Revert client-side caching bug
|
9
|
+
|
10
|
+
|
11
|
+
v1.0.4
|
12
|
+
------
|
13
|
+
### New Feature
|
14
|
+
- **[COOK-2584](https://tickets.opscode.com/browse/COOK-2584)** - Add client-side result cache
|
15
|
+
|
16
|
+
|
17
|
+
v1.0.2
|
18
|
+
------
|
19
|
+
### Bug
|
20
|
+
|
21
|
+
- [COOK-3164]: `partial_search` should use
|
22
|
+
`Chef::Config[:chef_server_url]` instead of `search_url`
|
23
|
+
|
24
|
+
v1.0.0
|
25
|
+
------
|
26
|
+
- Initial release
|
data/CONTRIBUTING.md
ADDED
@@ -0,0 +1,257 @@
|
|
1
|
+
# Contributing to Opscode Cookbooks
|
2
|
+
|
3
|
+
We are glad you want to contribute to Opscode Cookbooks! The first
|
4
|
+
step is the desire to improve the project.
|
5
|
+
|
6
|
+
You can find the answers to additional frequently asked questions
|
7
|
+
[on the wiki](http://wiki.opscode.com/display/chef/How+to+Contribute).
|
8
|
+
|
9
|
+
You can find additional information about
|
10
|
+
[contributing to cookbooks](http://wiki.opscode.com/display/chef/How+to+Contribute+to+Opscode+Cookbooks)
|
11
|
+
on the wiki as well.
|
12
|
+
|
13
|
+
## Quick-contribute
|
14
|
+
|
15
|
+
* Create an account on our [bug tracker](http://tickets.opscode.com)
|
16
|
+
* Sign our contributor agreement (CLA)
|
17
|
+
[ online](https://secure.echosign.com/public/hostedForm?formid=PJIF5694K6L)
|
18
|
+
(keep reading if you're contributing on behalf of your employer)
|
19
|
+
* Create a ticket for your change on the
|
20
|
+
[bug tracker](http://tickets.opscode.com)
|
21
|
+
* Link to your patch as a rebased git branch or pull request from the
|
22
|
+
ticket
|
23
|
+
* Resolve the ticket as fixed
|
24
|
+
|
25
|
+
We regularly review contributions and will get back to you if we have
|
26
|
+
any suggestions or concerns.
|
27
|
+
|
28
|
+
## The Apache License and the CLA/CCLA
|
29
|
+
|
30
|
+
Licensing is very important to open source projects, it helps ensure
|
31
|
+
the software continues to be available under the terms that the author
|
32
|
+
desired. Chef uses the Apache 2.0 license to strike a balance between
|
33
|
+
open contribution and allowing you to use the software however you
|
34
|
+
would like to.
|
35
|
+
|
36
|
+
The license tells you what rights you have that are provided by the
|
37
|
+
copyright holder. It is important that the contributor fully
|
38
|
+
understands what rights they are licensing and agrees to them.
|
39
|
+
Sometimes the copyright holder isn't the contributor, most often when
|
40
|
+
the contributor is doing work for a company.
|
41
|
+
|
42
|
+
To make a good faith effort to ensure these criteria are met, Opscode
|
43
|
+
requires a Contributor License Agreement (CLA) or a Corporate
|
44
|
+
Contributor License Agreement (CCLA) for all contributions. This is
|
45
|
+
without exception due to some matters not being related to copyright
|
46
|
+
and to avoid having to continually check with our lawyers about small
|
47
|
+
patches.
|
48
|
+
|
49
|
+
It only takes a few minutes to complete a CLA, and you retain the
|
50
|
+
copyright to your contribution.
|
51
|
+
|
52
|
+
You can complete our contributor agreement (CLA)
|
53
|
+
[ online](https://secure.echosign.com/public/hostedForm?formid=PJIF5694K6L).
|
54
|
+
If you're contributing on behalf of your employer, have your employer
|
55
|
+
fill out our
|
56
|
+
[Corporate CLA](https://secure.echosign.com/public/hostedForm?formid=PIE6C7AX856)
|
57
|
+
instead.
|
58
|
+
|
59
|
+
## Ticket Tracker (JIRA)
|
60
|
+
|
61
|
+
The [ticket tracker](http://tickets.opscode.com) is the most important
|
62
|
+
documentation for the code base. It provides significant historical
|
63
|
+
information, such as:
|
64
|
+
|
65
|
+
* Which release a bug fix is included in
|
66
|
+
* Discussion regarding the design and merits of features
|
67
|
+
* Error output to aid in finding similar bugs
|
68
|
+
|
69
|
+
Each ticket should aim to fix one bug or add one feature.
|
70
|
+
|
71
|
+
## Using git
|
72
|
+
|
73
|
+
You can get a quick copy of the repository for this cookbook by
|
74
|
+
running `git clone
|
75
|
+
git://github.com/opscode-coobkooks/COOKBOOKNAME.git`.
|
76
|
+
|
77
|
+
For collaboration purposes, it is best if you create a Github account
|
78
|
+
and fork the repository to your own account. Once you do this you will
|
79
|
+
be able to push your changes to your Github repository for others to
|
80
|
+
see and use.
|
81
|
+
|
82
|
+
If you have another repository in your GitHub account named the same
|
83
|
+
as the cookbook, we suggest you suffix the repository with -cookbook.
|
84
|
+
|
85
|
+
### Branches and Commits
|
86
|
+
|
87
|
+
You should submit your patch as a git branch named after the ticket,
|
88
|
+
such as COOK-1337. This is called a _topic branch_ and allows users to
|
89
|
+
associate a branch of code with the ticket.
|
90
|
+
|
91
|
+
It is a best practice to have your commit message have a _summary
|
92
|
+
line_ that includes the ticket number, followed by an empty line and
|
93
|
+
then a brief description of the commit. This also helps other
|
94
|
+
contributors understand the purpose of changes to the code.
|
95
|
+
|
96
|
+
[COOK-1757] - platform_family and style
|
97
|
+
|
98
|
+
* use platform_family for platform checking
|
99
|
+
* update notifies syntax to "resource_type[resource_name]" instead of
|
100
|
+
resources() lookup
|
101
|
+
* COOK-692 - delete config files dropped off by packages in conf.d
|
102
|
+
* dropped debian 4 support because all other platforms have the same
|
103
|
+
values, and it is older than "old stable" debian release
|
104
|
+
|
105
|
+
Remember that not all users use Chef in the same way or on the same
|
106
|
+
operating systems as you, so it is helpful to be clear about your use
|
107
|
+
case and change so they can understand it even when it doesn't apply
|
108
|
+
to them.
|
109
|
+
|
110
|
+
### Github and Pull Requests
|
111
|
+
|
112
|
+
All of Opscode's open source cookbook projects are available on
|
113
|
+
[Github](http://www.github.com/opscode-cookbooks).
|
114
|
+
|
115
|
+
We don't require you to use Github, and we will even take patch diffs
|
116
|
+
attached to tickets on the tracker. However Github has a lot of
|
117
|
+
convenient features, such as being able to see a diff of changes
|
118
|
+
between a pull request and the main repository quickly without
|
119
|
+
downloading the branch.
|
120
|
+
|
121
|
+
If you do choose to use a pull request, please provide a link to the
|
122
|
+
pull request from the ticket __and__ a link to the ticket from the
|
123
|
+
pull request. Because pull requests only have two states, open and
|
124
|
+
closed, we can't easily filter pull requests that are waiting for a
|
125
|
+
reply from the author for various reasons.
|
126
|
+
|
127
|
+
### More information
|
128
|
+
|
129
|
+
Additional help with git is available on the
|
130
|
+
[Working with Git](http://wiki.opscode.com/display/chef/Working+with+Git)
|
131
|
+
wiki page.
|
132
|
+
|
133
|
+
## Functional and Unit Tests
|
134
|
+
|
135
|
+
This cookbook is set up to run tests under
|
136
|
+
[Opscode's test-kitchen](https://github.com/opscode/test-kitchen). It
|
137
|
+
uses minitest-chef to run integration tests after the node has been
|
138
|
+
converged to verify that the state of the node.
|
139
|
+
|
140
|
+
Test kitchen should run completely without exception using the default
|
141
|
+
[baseboxes provided by Opscode](https://github.com/opscode/bento).
|
142
|
+
Because Test Kitchen creates VirtualBox machines and runs through
|
143
|
+
every configuration in the Kitchenfile, it may take some time for
|
144
|
+
these tests to complete.
|
145
|
+
|
146
|
+
If your changes are only for a specific recipe, run only its
|
147
|
+
configuration with Test Kitchen. If you are adding a new recipe, or
|
148
|
+
other functionality such as a LWRP or definition, please add
|
149
|
+
appropriate tests and ensure they run with Test Kitchen.
|
150
|
+
|
151
|
+
If any don't pass, investigate them before submitting your patch.
|
152
|
+
|
153
|
+
Any new feature should have unit tests included with the patch with
|
154
|
+
good code coverage to help protect it from future changes. Similarly,
|
155
|
+
patches that fix a bug or regression should have a _regression test_.
|
156
|
+
Simply put, this is a test that would fail without your patch but
|
157
|
+
passes with it. The goal is to ensure this bug doesn't regress in the
|
158
|
+
future. Consider a regular expression that doesn't match a certain
|
159
|
+
pattern that it should, so you provide a patch and a test to ensure
|
160
|
+
that the part of the code that uses this regular expression works as
|
161
|
+
expected. Later another contributor may modify this regular expression
|
162
|
+
in a way that breaks your use cases. The test you wrote will fail,
|
163
|
+
signalling to them to research your ticket and use case and accounting
|
164
|
+
for it.
|
165
|
+
|
166
|
+
If you need help writing tests, please ask on the Chef Developer's
|
167
|
+
mailing list, or the #chef-hacking IRC channel.
|
168
|
+
|
169
|
+
## Code Review
|
170
|
+
|
171
|
+
Opscode regularly reviews code contributions and provides suggestions
|
172
|
+
for improvement in the code itself or the implementation.
|
173
|
+
|
174
|
+
We find contributions by searching the ticket tracker for _resolved_
|
175
|
+
tickets with a status of _fixed_. If we have feedback we will reopen
|
176
|
+
the ticket and you should resolve it again when you've made the
|
177
|
+
changes or have a response to our feedback. When we believe the patch
|
178
|
+
is ready to be merged, we will tag the _Code Reviewed_ field with
|
179
|
+
_Reviewed_.
|
180
|
+
|
181
|
+
Depending on the project, these tickets are then merged within a week
|
182
|
+
or two, depending on the current release cycle.
|
183
|
+
|
184
|
+
## Release Cycle
|
185
|
+
|
186
|
+
The versioning for Opscode Cookbook projects is X.Y.Z.
|
187
|
+
|
188
|
+
* X is a major release, which may not be fully compatible with prior
|
189
|
+
major releases
|
190
|
+
* Y is a minor release, which adds both new features and bug fixes
|
191
|
+
* Z is a patch release, which adds just bug fixes
|
192
|
+
|
193
|
+
A released version of a cookbook will end in an even number, e.g.
|
194
|
+
"1.2.4" or "0.8.0". When development for the next version of the
|
195
|
+
cookbook begins, the "Z" patch number is incremented to the next odd
|
196
|
+
number, however the next release of the cookbook may be a major or
|
197
|
+
minor incrementing version.
|
198
|
+
|
199
|
+
Releases of Opscode's cookbooks are usually announced on the Chef user
|
200
|
+
mailing list. Releases of several cookbooks may be batched together
|
201
|
+
and announced on the [Opscode Blog](http://www.opscode.com/blog).
|
202
|
+
|
203
|
+
## Working with the community
|
204
|
+
|
205
|
+
These resources will help you learn more about Chef and connect to
|
206
|
+
other members of the Chef community:
|
207
|
+
|
208
|
+
* [chef](http://lists.opscode.com/sympa/info/chef) and
|
209
|
+
[chef-dev](http://lists.opscode.com/sympa/info/chef-dev) mailing
|
210
|
+
lists
|
211
|
+
* #chef and #chef-hacking IRC channels on irc.freenode.net
|
212
|
+
* [Community Cookbook site](http://community.opscode.com)
|
213
|
+
* [Chef wiki](http://wiki.opscode.com/display/chef)
|
214
|
+
* Opscode Chef [product page](http://www.opscode.com/chef)
|
215
|
+
|
216
|
+
|
217
|
+
## Cookbook Contribution Do's and Don't's
|
218
|
+
|
219
|
+
Please do include tests for your contribution. If you need help, ask
|
220
|
+
on the
|
221
|
+
[chef-dev mailing list](http://lists.opscode.com/sympa/info/chef-dev)
|
222
|
+
or the
|
223
|
+
[#chef-hacking IRC channel](http://community.opscode.com/chat/chef-hacking).
|
224
|
+
Not all platforms that a cookbook supports may be supported by Test
|
225
|
+
Kitchen. Please provide evidence of testing your contribution if it
|
226
|
+
isn't trivial so we don't have to duplicate effort in testing. Chef
|
227
|
+
10.14+ "doc" formatted output is sufficient.
|
228
|
+
|
229
|
+
Please do indicate new platform (families) or platform versions in the
|
230
|
+
commit message, and update the relevant ticket.
|
231
|
+
|
232
|
+
If a contribution adds new platforms or platform versions, indicate
|
233
|
+
such in the body of the commit message(s), and update the relevant
|
234
|
+
COOK ticket. When writing commit messages, it is helpful for others if
|
235
|
+
you indicate the COOK ticket. For example:
|
236
|
+
|
237
|
+
git commit -m '[COOK-1041] - Updated pool resource to correctly
|
238
|
+
delete.'
|
239
|
+
|
240
|
+
Please do use [foodcritic](http://acrmp.github.com/foodcritic) to
|
241
|
+
lint-check the cookbook. Except FC007, it should pass all correctness
|
242
|
+
rules. FC007 is okay as long as the dependent cookbooks are *required*
|
243
|
+
for the default behavior of the cookbook, such as to support an
|
244
|
+
uncommon platform, secondary recipe, etc.
|
245
|
+
|
246
|
+
Please do ensure that your changes do not break or modify behavior for
|
247
|
+
other platforms supported by the cookbook. For example if your changes
|
248
|
+
are for Debian, make sure that they do not break on CentOS.
|
249
|
+
|
250
|
+
Please do not modify the version number in the metadata.rb, Opscode
|
251
|
+
will select the appropriate version based on the release cycle
|
252
|
+
information above.
|
253
|
+
|
254
|
+
Please do not update the CHANGELOG.md for a new version. Not all
|
255
|
+
changes to a cookbook may be merged and released in the same versions.
|
256
|
+
Opscode will update the CHANGELOG.md when releasing a new version of
|
257
|
+
the cookbook.
|
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,202 @@
|
|
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.
|
202
|
+
|
data/README.md
ADDED
@@ -0,0 +1,79 @@
|
|
1
|
+
Partial Search Cookbook
|
2
|
+
=======================
|
3
|
+
[Partial Search](http://docs.opscode.com/essentials_search.html#partial-search)
|
4
|
+
is a search API available on Chef Server. (see Notes below for version compatibility)
|
5
|
+
It can be used to reduce the network bandwidth and the memory used by
|
6
|
+
chef-client to process search results.
|
7
|
+
|
8
|
+
This cookbook provides an experimental interface to the partial search
|
9
|
+
API by providing a `partial_search` method that can be used instead of
|
10
|
+
the `search` method in your recipes.
|
11
|
+
|
12
|
+
The `partial_search` method allows you to retrieve just the attributes
|
13
|
+
of interest. For example, you can execute a search to return just the
|
14
|
+
name and IP addresses of the nodes in your infrastructure rather than
|
15
|
+
receiving an array of complete node objects and post-processing them.
|
16
|
+
|
17
|
+
|
18
|
+
Install
|
19
|
+
-------
|
20
|
+
Upload this cookbook and include it in the dependencies of any
|
21
|
+
cookbook where you would like to use `partial_search`.
|
22
|
+
|
23
|
+
|
24
|
+
Usage
|
25
|
+
-----
|
26
|
+
When you call `partial_search`, you need to specify the key paths of the
|
27
|
+
attributes you want returned. Key paths are specified as an array
|
28
|
+
of strings. Each key path is mapped to a short name of your
|
29
|
+
choosing. Consider the following example:
|
30
|
+
|
31
|
+
```ruby
|
32
|
+
partial_search(:node, 'role:web',
|
33
|
+
:keys => { 'name' => [ 'name' ],
|
34
|
+
'ip' => [ 'ipaddress' ],
|
35
|
+
'kernel_version' => [ 'kernel', 'version' ]
|
36
|
+
}
|
37
|
+
).each do |result|
|
38
|
+
puts result['name']
|
39
|
+
puts result['ip']
|
40
|
+
puts result['kernel_version']
|
41
|
+
end
|
42
|
+
```
|
43
|
+
|
44
|
+
In the example above, two attributes will be extracted (on the
|
45
|
+
server) from the nodes that match the search query. The result will
|
46
|
+
be a simple hash with keys 'name' and 'ip'.
|
47
|
+
|
48
|
+
|
49
|
+
Notes
|
50
|
+
-----
|
51
|
+
* We would like your feedback on this feature and the interface
|
52
|
+
provided by this cookbook. Please send comments to the chef-dev
|
53
|
+
mailing list.
|
54
|
+
|
55
|
+
* The partial search API is available in the Open Source Chef Server since 11.0.4
|
56
|
+
|
57
|
+
* The partial search API is available in Enterprise Chef Server since 1.2.2
|
58
|
+
|
59
|
+
|
60
|
+
License & Authors
|
61
|
+
-----------------
|
62
|
+
- Author:: Adam Jacob (<adam@opscode.com>)
|
63
|
+
- Author:: John Keiser (<jkeiser@opscode.com>)
|
64
|
+
|
65
|
+
```text
|
66
|
+
Copyright:: 2012-2013, Opscode, Inc.
|
67
|
+
|
68
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
69
|
+
you may not use this file except in compliance with the License.
|
70
|
+
You may obtain a copy of the License at
|
71
|
+
|
72
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
73
|
+
|
74
|
+
Unless required by applicable law or agreed to in writing, software
|
75
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
76
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
77
|
+
See the License for the specific language governing permissions and
|
78
|
+
limitations under the License.
|
79
|
+
```
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
|
5
|
+
Gem::Specification.new do |spec|
|
6
|
+
spec.name = "chef-partial_search"
|
7
|
+
spec.version = "1.0.7"
|
8
|
+
spec.authors = ["Opscode, Inc"]
|
9
|
+
spec.email = ["cookbooks@opscode.com"]
|
10
|
+
spec.summary = "Provides experimental interface to partial search API in Opscode Hosted Chef"
|
11
|
+
spec.description = spec.summary
|
12
|
+
spec.homepage = "https://github.com/opscode-cookbooks/partial_search"
|
13
|
+
spec.license = "Apache 2.0"
|
14
|
+
|
15
|
+
spec.files = `git ls-files`.split($/)
|
16
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
17
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
18
|
+
spec.require_paths = ["libraries"]
|
19
|
+
|
20
|
+
spec.add_dependency 'chef', ">= 11.0.0"
|
21
|
+
end
|
@@ -0,0 +1,147 @@
|
|
1
|
+
#
|
2
|
+
# Author:: Adam Jacob (<adam@opscode.com>)
|
3
|
+
# Author:: John Keiser (<jkeiser@opscode.com>)
|
4
|
+
# Copyright:: Copyright (c) 2012 Opscode, Inc.
|
5
|
+
# License:: Apache License, Version 2.0
|
6
|
+
#
|
7
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
8
|
+
# you may not use this file except in compliance with the License.
|
9
|
+
# You may obtain a copy of the License at
|
10
|
+
#
|
11
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
12
|
+
#
|
13
|
+
# Unless required by applicable law or agreed to in writing, software
|
14
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
15
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
16
|
+
# See the License for the specific language governing permissions and
|
17
|
+
# limitations under the License.
|
18
|
+
#
|
19
|
+
|
20
|
+
require 'chef/config'
|
21
|
+
require 'uri'
|
22
|
+
require 'chef/rest'
|
23
|
+
# These are needed so that JSON can inflate search results
|
24
|
+
require 'chef/node'
|
25
|
+
require 'chef/role'
|
26
|
+
require 'chef/environment'
|
27
|
+
require 'chef/data_bag'
|
28
|
+
require 'chef/data_bag_item'
|
29
|
+
|
30
|
+
class Chef
|
31
|
+
class PartialSearch
|
32
|
+
|
33
|
+
attr_accessor :rest
|
34
|
+
|
35
|
+
def initialize(url=nil)
|
36
|
+
@rest = ::Chef::REST.new(url || ::Chef::Config[:chef_server_url])
|
37
|
+
end
|
38
|
+
|
39
|
+
# Search Solr for objects of a given type, for a given query. If you give
|
40
|
+
# it a block, it will handle the paging for you dynamically.
|
41
|
+
def search(type, query='*:*', args={}, &block)
|
42
|
+
raise ArgumentError, "Type must be a string or a symbol!" unless (type.kind_of?(String) || type.kind_of?(Symbol))
|
43
|
+
|
44
|
+
sort = args.include?(:sort) ? args[:sort] : 'X_CHEF_id_CHEF_X asc'
|
45
|
+
start = args.include?(:start) ? args[:start] : 0
|
46
|
+
rows = args.include?(:rows) ? args[:rows] : 1000
|
47
|
+
query_string = "search/#{type}?q=#{escape(query)}&sort=#{escape(sort)}&start=#{escape(start)}&rows=#{escape(rows)}"
|
48
|
+
if args[:keys]
|
49
|
+
response = @rest.post_rest(query_string, args[:keys])
|
50
|
+
response_rows = response['rows'].map { |row| row['data'] }
|
51
|
+
else
|
52
|
+
response = @rest.get_rest(query_string)
|
53
|
+
response_rows = response['rows']
|
54
|
+
end
|
55
|
+
if block
|
56
|
+
response_rows.each { |o| block.call(o) unless o.nil?}
|
57
|
+
unless (response["start"] + response_rows.length) >= response["total"]
|
58
|
+
nstart = response["start"] + rows
|
59
|
+
args_hash = {
|
60
|
+
:keys => args[:keys],
|
61
|
+
:sort => sort,
|
62
|
+
:start => nstart,
|
63
|
+
:rows => rows
|
64
|
+
}
|
65
|
+
search(type, query, args_hash, &block)
|
66
|
+
end
|
67
|
+
true
|
68
|
+
else
|
69
|
+
[ response_rows, response["start"], response["total"] ]
|
70
|
+
end
|
71
|
+
end
|
72
|
+
|
73
|
+
def list_indexes
|
74
|
+
response = @rest.get_rest("search")
|
75
|
+
end
|
76
|
+
|
77
|
+
private
|
78
|
+
def escape(s)
|
79
|
+
s && URI.escape(s.to_s)
|
80
|
+
end
|
81
|
+
end
|
82
|
+
end
|
83
|
+
|
84
|
+
# partial_search(type, query, options, &block)
|
85
|
+
#
|
86
|
+
# Searches for nodes, roles, etc. and returns the results. This method may
|
87
|
+
# perform more than one search request, if there are a large number of results.
|
88
|
+
#
|
89
|
+
# ==== Parameters
|
90
|
+
# * +type+: index type (:role, :node, :client, :environment, data bag name)
|
91
|
+
# * +query+: SOLR query. "*:*", "role:blah", "not role:blah", etc. Defaults to '*:*'
|
92
|
+
# * +options+: hash with options:
|
93
|
+
# ** +:start+: First row to return (:start => 50, :rows => 100 means "return the
|
94
|
+
# 50th through 150th result")
|
95
|
+
# ** +:rows+: Number of rows to return. Defaults to 1000.
|
96
|
+
# ** +:sort+: a SOLR sort specification. Defaults to 'X_CHEF_id_CHEF_X asc'.
|
97
|
+
# ** +:keys+: partial search keys. If this is not specified, the search will
|
98
|
+
# not be partial.
|
99
|
+
#
|
100
|
+
# ==== Returns
|
101
|
+
#
|
102
|
+
# This method returns an array of search results. Partial search results will
|
103
|
+
# be JSON hashes with the structure specified in the +keys+ option. Other
|
104
|
+
# results include +Chef::Node+, +Chef::Role+, +Chef::Client+, +Chef::Environment+,
|
105
|
+
# +Chef::DataBag+ and +Chef::DataBagItem+ objects, depending on the search type.
|
106
|
+
#
|
107
|
+
# If a block is specified, the block will be called with each result instead of
|
108
|
+
# returning an array. This method will not block if it returns
|
109
|
+
#
|
110
|
+
# If start or row is specified, and no block is given, the result will be a
|
111
|
+
# triple containing the list, the start and total:
|
112
|
+
#
|
113
|
+
# [ [ row1, row2, ... ], start, total ]
|
114
|
+
#
|
115
|
+
# ==== Example
|
116
|
+
#
|
117
|
+
# partial_search(:node, 'role:webserver',
|
118
|
+
# keys: {
|
119
|
+
# name: [ 'name' ],
|
120
|
+
# ip: [ 'amazon', 'ip', 'public' ]
|
121
|
+
# }
|
122
|
+
# ).each do |node|
|
123
|
+
# puts "#{node[:name]}: #{node[:ip]}"
|
124
|
+
# end
|
125
|
+
#
|
126
|
+
def partial_search(type, query='*:*', *args, &block)
|
127
|
+
# Support both the old (positional args) and new (hash args) styles of calling
|
128
|
+
if args.length == 1 && args[0].is_a?(Hash)
|
129
|
+
args_hash = args[0]
|
130
|
+
else
|
131
|
+
args_hash = {}
|
132
|
+
args_hash[:sort] = args[0] if args.length >= 1
|
133
|
+
args_hash[:start] = args[1] if args.length >= 2
|
134
|
+
args_hash[:rows] = args[2] if args.length >= 3
|
135
|
+
end
|
136
|
+
# If you pass a block, or have the start or rows arguments, do raw result parsing
|
137
|
+
if Kernel.block_given? || args_hash[:start] || args_hash[:rows]
|
138
|
+
Chef::PartialSearch.new.search(type, query, args_hash, &block)
|
139
|
+
# Otherwise, do the iteration for the end user
|
140
|
+
else
|
141
|
+
results = Array.new
|
142
|
+
Chef::PartialSearch.new.search(type, query, args_hash) do |o|
|
143
|
+
results << o
|
144
|
+
end
|
145
|
+
results
|
146
|
+
end
|
147
|
+
end
|
data/metadata.rb
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
name "partial_search"
|
2
|
+
maintainer "Opscode, Inc."
|
3
|
+
maintainer_email "cookbooks@opscode.com"
|
4
|
+
license "Apache 2.0"
|
5
|
+
description "Provides experimental interface to partial search API in Opscode Hosted Chef"
|
6
|
+
long_description IO.read(File.join(File.dirname(__FILE__), 'README.md'))
|
7
|
+
version "1.0.7"
|
data/recipes/default.rb
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
#
|
metadata
ADDED
@@ -0,0 +1,69 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: chef-partial_search
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.0.7
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Opscode, Inc
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2014-07-03 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: chef
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: 11.0.0
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: 11.0.0
|
27
|
+
description: Provides experimental interface to partial search API in Opscode Hosted
|
28
|
+
Chef
|
29
|
+
email:
|
30
|
+
- cookbooks@opscode.com
|
31
|
+
executables: []
|
32
|
+
extensions: []
|
33
|
+
extra_rdoc_files: []
|
34
|
+
files:
|
35
|
+
- ".gitignore"
|
36
|
+
- CHANGELOG.md
|
37
|
+
- CONTRIBUTING.md
|
38
|
+
- Gemfile
|
39
|
+
- LICENSE
|
40
|
+
- README.md
|
41
|
+
- chef-partial_search.gemspec
|
42
|
+
- libraries/partial_search.rb
|
43
|
+
- metadata.rb
|
44
|
+
- recipes/default.rb
|
45
|
+
homepage: https://github.com/opscode-cookbooks/partial_search
|
46
|
+
licenses:
|
47
|
+
- Apache 2.0
|
48
|
+
metadata: {}
|
49
|
+
post_install_message:
|
50
|
+
rdoc_options: []
|
51
|
+
require_paths:
|
52
|
+
- libraries
|
53
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
54
|
+
requirements:
|
55
|
+
- - ">="
|
56
|
+
- !ruby/object:Gem::Version
|
57
|
+
version: '0'
|
58
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
59
|
+
requirements:
|
60
|
+
- - ">="
|
61
|
+
- !ruby/object:Gem::Version
|
62
|
+
version: '0'
|
63
|
+
requirements: []
|
64
|
+
rubyforge_project:
|
65
|
+
rubygems_version: 2.2.2
|
66
|
+
signing_key:
|
67
|
+
specification_version: 4
|
68
|
+
summary: Provides experimental interface to partial search API in Opscode Hosted Chef
|
69
|
+
test_files: []
|