kitchen-kubernetes 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: ce9d583074708f5f29f30010010062540cde4999
4
+ data.tar.gz: 9b055d6ebdfb15e5c1fb9bbb9b0f31eab0430058
5
+ SHA512:
6
+ metadata.gz: 4e21cd70c6f82a6f0b37f87ebdee03bcd2c885815a454315d184504435cf610116ebd0c11b2997975da04f653eb4112454a5f504c8fdb62a787f58a333dc0161
7
+ data.tar.gz: b75f0e328bc8fe7055be3082e94aac5aa3128dfe471c329f62da822e461bce541356b091d99b657addbed5a89cd01534b2d62325fd33f244684aeba1103ef7cd
data/.gitignore ADDED
@@ -0,0 +1,2 @@
1
+ Gemfile.lock
2
+ .kitchen/
data/.travis.yml ADDED
@@ -0,0 +1,50 @@
1
+ #
2
+ # Copyright 2017, 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
+ sudo: required
18
+ language: ruby
19
+ rvm: 2.4.3
20
+ gemfile:
21
+ - Gemfile
22
+ - test/gemfiles/train-old.gemfile
23
+ - test/gemfiles/train-new.gemfile
24
+ - test/gemfiles/master.gemfile
25
+
26
+ services:
27
+ - docker
28
+
29
+ env:
30
+ - CHANGE_MINIKUBE_NONE_USER=true
31
+
32
+ before_install:
33
+ - 'if [[ $BUNDLE_GEMFILE == *master.gemfile ]]; then gem update --system; fi'
34
+ - gem --version
35
+ - gem install bundler
36
+ - bundle --version
37
+ - 'bundle config --local path ${BUNDLE_PATH:-$(dirname $BUNDLE_GEMFILE)/vendor/bundle}'
38
+ install: bundle update --jobs=3 --retry=3
39
+
40
+ before_script:
41
+ - curl -Lo kubectl https://storage.googleapis.com/kubernetes-release/release/v1.7.0/bin/linux/amd64/kubectl && chmod +x kubectl && sudo mv kubectl /usr/local/bin
42
+ - curl -Lo minikube https://storage.googleapis.com/minikube/releases/latest/minikube-linux-amd64 && chmod +x minikube && sudo mv minikube /usr/local/bin
43
+ - sudo minikube start --vm-driver=none --kubernetes-version=v1.8.0
44
+ - minikube update-context
45
+ - JSONPATH='{range .items[*]}{@.metadata.name}:{range @.status.conditions[*]}{@.type}={@.status};{end}{end}'; until kubectl get nodes -o jsonpath="$JSONPATH" 2>&1 | grep -q "Ready=True"; do sleep 1; done
46
+
47
+ script:
48
+ - bundle exec kitchen --version
49
+ - bundle exec inspec --version
50
+ - cd test/ && bundle exec kitchen test -d always
data/Gemfile ADDED
@@ -0,0 +1,21 @@
1
+ #
2
+ # Copyright 2017, 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
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
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,191 @@
1
+ # Kitchen-Kubernetes
2
+
3
+ [![Build Status](https://img.shields.io/travis/coderanger/kitchen-kubernetes.svg)](https://travis-ci.org/coderanger/kitchen-kubernetes)
4
+ [![Gem Version](https://img.shields.io/gem/v/kitchen-kubernetes.svg)](https://rubygems.org/gems/kitchen-kubernetes)
5
+ [![Gemnasium](https://img.shields.io/gemnasium/coderanger/kitchen-kubernetes.svg)](https://gemnasium.com/coderanger/kitchen-kubernetes)
6
+ [![License](https://img.shields.io/badge/license-Apache_2-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
7
+
8
+ A [Test Kitchen](https://kitchen.ci/) driver for testing on top of a Kubernetes
9
+ cluster. It is currently aimed at Chef cookbook testing, though see the [FAQ](#FAQ)
10
+ for more information on other testing targets.
11
+
12
+ ## Quick Start
13
+
14
+ First install the driver:
15
+
16
+ ```bash
17
+ chef gem install kitchen-kubernetes
18
+ ```
19
+
20
+ Then configure your `.kitchen.yml` to use the driver:
21
+
22
+ ```yaml
23
+ driver:
24
+ name: kubernetes
25
+ ```
26
+
27
+ No other options should be required for the default case but [see below](#options)
28
+ for more information on available configuration options.
29
+
30
+ ## Options
31
+
32
+ You can customize things by setting additional options in the `driver` section,
33
+ for example:
34
+
35
+ ```yaml
36
+ driver:
37
+ name: kubernetes
38
+ kubectl_command: ~/bin/kubectl
39
+ chef_version: 13.5.21
40
+ ```
41
+
42
+ * `cache_path` - Host path for the Chef installation cache. See [below](#chef-install). *(default: /data/chef/%{chef_version})*
43
+ * `cache_volume` - Kubernetes [volume](https://kubernetes.io/docs/api-reference/v1.8/#volume-v1-core) description for the Chef install volume. *(default: auto-generated)*
44
+ * `chef_image` - Docker data image to get the Chef installation from. *(default: chef/chef)*
45
+ * `chef_version` - Version of the Chef data image to use. *(default: latest)*
46
+ * `context` - Kubectl configuration context to use. *(default: current-context)*
47
+ * `image` - Docker image for the main container in the pod, where Chef is run. *(default: based on the platform name and version)*
48
+ * `init_system` - Init system to activate in the default container. See #systemd. *(default: nil)*
49
+ * `kubectl_command` - Path to the `kubectl` command to use. *(default: kubectl)*
50
+ * `pod_name` - Name of the generated pod. *(default: auto-generate)*
51
+ * `pod_template` - Path to the Erb template to create the pod. See [below](#pod). *(default: internal)*
52
+ * `rsync_command` - Path to the `rsync` command to use. *(default: rsync)*
53
+ * `rsync_image` - Docker image to use for the rsync container in the pod. *(default: kitchenkubernetes/rsync)*
54
+
55
+ ## Chef Install
56
+
57
+ In a similar fashion to [`kitchen-dokken`](https://github.com/someara/kitchen-dokken/),
58
+ this driver uses the `chef/chef` Docker Hub images instead of the normal Chef
59
+ installers. Unfortunately Kubernetes doesn't support using Docker images as
60
+ volumes directly, so there has to be some copying from the data container in to a
61
+ volume shared between the data container and main container.
62
+
63
+ So as to reduce the disk I/O from launching our test pods (a Chef install is
64
+ about 50MB so this is ~100MB of file I/O each time) we use a hostPath volume to
65
+ give the cache some persistence between test runs. You can control the location
66
+ of this hostPath volume using the `cache_path` configuration option:
67
+
68
+ ```yaml
69
+ driver:
70
+ name: kubernetes
71
+ cache_path: /home/k8s/chef_cache/%{chef_version}
72
+ ```
73
+
74
+ You can also unset `cache_path` to totally disable the cache and use an
75
+ `emptyDir` volume instead:
76
+
77
+ ```yaml
78
+ driver:
79
+ name: kubernetes
80
+ cache_path: null
81
+ ```
82
+
83
+ If you have another shared storage option available, you can also set
84
+ `cache_volume` to a Kuberenetes [Volume object]((https://kubernetes.io/docs/api-reference/v1.8/#volume-v1-core))
85
+ (minus the `name` field) and that will be used instead:
86
+
87
+ ```yaml
88
+ driver:
89
+ name: kubernetes
90
+ cache_volume:
91
+ persistentVolumeClaim:
92
+ claimName: myclaim
93
+ ```
94
+
95
+ ## Pod
96
+
97
+ The default pod created for testing involves three containers and two volumes.
98
+
99
+ The `chef` volume is [discussed above](#chef-install) and contains the `/opt/chef`
100
+ folder of the Chef installation. The `kitchen` volume is an `emptyDir` used for
101
+ sending files in to the test container.
102
+
103
+ The `chef` container is an initContainer (meaning it runs before the other two)
104
+ which handles copying the Chef install from the data container to the `chef`
105
+ volume (with some caching by default so most of the time it does nothing, as mentioned
106
+ above). The `rsync` container runs a small image containing nothing but Rsync,
107
+ used [as part of the file upload system](#transport). The `default` container is
108
+ where Chef is run, as well as the eventual tests.
109
+
110
+ If overriding the `pod_template` configuration option, make sure your pod template
111
+ also includes containers named `default` and `rsync`.
112
+
113
+ ## Transport
114
+
115
+ Careful observers will note that their `kitchen list` output shows that not just
116
+ the driver is set to `Kubernetes`, but the transport is too:
117
+
118
+ ```bash
119
+ $ kitchen list
120
+ Instance Driver Provisioner Verifier Transport Last Action Last Error
121
+ default-centos-7 Kubernetes ChefSolo Busser Kubernetes <Not Created> <None>
122
+ ```
123
+
124
+ This transport plugin is configured automatically by the driver for your convenience
125
+ and uses `kubectl exec` for running commands on the test container. For sending
126
+ files, rsync is used. The rsync data is also sent over `kubectl exec` to avoid
127
+ needing to configure any additional network login services. This uses the `rsync`
128
+ container in the pod and the `kitchen` volume. This does require `rsync` is also
129
+ installed on your workstation (or where ever `kitchen` is running from).
130
+
131
+ ## Systemd
132
+
133
+ If you want to enable systemd inside the container, set `init_system: systemd`.
134
+ For example:
135
+
136
+ ```yaml
137
+ driver:
138
+ name: kubernetes
139
+
140
+ platforms:
141
+ - name: centos-7
142
+ driver:
143
+ init_system: systemd
144
+ - name: ubuntu-16.04
145
+ driver:
146
+ init_system: systemd
147
+ ```
148
+
149
+ As a word of warning, the default `debian` Docker images do not include systemd,
150
+ so you will need to make your own that have it installed if you want to test on
151
+ systemd and Debian.
152
+
153
+ ## FAQ
154
+
155
+ ### Can I use this for testing things other than Chef?
156
+
157
+ Not currently, but it could definitely be added. If you're interested in a
158
+ particular provisioner, open an issue so I know there is user demand.
159
+
160
+ ### Can I test Kubernetes objects like deployments and services?
161
+
162
+ Not yet, though it is planned. If you have a specific use case in mind, please
163
+ open an issue and let me know.
164
+
165
+ ### Will this work with GKE/AKE/etc?
166
+
167
+ I think so but haven't tested it myself.
168
+
169
+ ### Will this work with minkube?
170
+
171
+ Yes, just make sure you have the minikube config context activated.
172
+
173
+ ## Sponsors
174
+
175
+ Development sponsored by [SAP](https://www.sap.com/).
176
+
177
+ ## License
178
+
179
+ Copyright 2017, Noah Kantrowitz
180
+
181
+ Licensed under the Apache License, Version 2.0 (the "License");
182
+ you may not use this file except in compliance with the License.
183
+ You may obtain a copy of the License at
184
+
185
+ http://www.apache.org/licenses/LICENSE-2.0
186
+
187
+ Unless required by applicable law or agreed to in writing, software
188
+ distributed under the License is distributed on an "AS IS" BASIS,
189
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
190
+ See the License for the specific language governing permissions and
191
+ limitations under the License.