cookbook 'flannel', '~> 1.1.1'
flannel (7) Versions 1.1.1 Follow0
A library cookbook to setup flanneld
cookbook 'flannel', '~> 1.1.1', :supermarket
knife supermarket install flannel
knife supermarket download flannel
Flannel Cookbook
This is a library cookbook that provides resources for setting up
flannel instances.
Requirements
- Chef 12.5.0 or higher.
- Network accessible web server hosting the flannel binaries.
Platform Support
Tested on the following platforms with test-kitchen:
- debian-8.4
- centos-7.2
- ubuntu-16.04
Usage
- Add
depends 'flannel', '~> 0.3'to your cookbook'smetadata.rb. - Use the resources shipped in this cookbook.
Custom Resources
flannel_service
flannel_service
Downloads pre-compiled Go binaries of flanneld onto disk.
- The
:createaction downloads the pre-compiled go binary of flanneld onto disk. - The
:configureaction connects to etcd and loads the flanneld configuration to it. - The
:startaction runs flanneld as a systemd service
It has the following properties corresponding to
flannel's commandline options
public_ipetcd_endpointsetcd_prefixetcd_keyfileetcd_certfileetcd_cafileifacesubnet_fileip_masqlistenremoteremote_keyfileremote_certfilenetworks-
vorlog_level
Another property called config corresponds to
flannel's etcd-stored configuration
Additionally, if you are using TLS with etcd, you can pass extra options to the
etcdctl tool using the etcdctl_options property
Helper
The [libraries/subnet_parser.rb](libraries/subnet_parser.rb) file extends the
flannel_service resource to read and parse the subnet file. An example
approach on integrating with the docker cookbook
is found in
[test/cookbooks/flannel_test/recipes/docker.rb](test/cookbooks/flannel_test/recipes/docker.rb).
License
Copyright 2016 Allan Espinosa
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Dependent cookbooks
This cookbook has no specified dependencies.
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
1.1.1
- Add documents and metadata to pass Supermarket quality metrics.
1.1.0
- Add etcdctl_options as a resource parameter.
1.0.0
- Move out etcd backend configuration to the
:configureaction.
0.3.1
- Mostly test and tooling enhancements.
- Fix problem of not invoking flanneld with the proper flags.
0.3.0
- Add resource properties to customize flanneld's invocation.
0.2.0
- Add
:startaction to launch flannel as a systemd service. - Provide helpers to parse the subnet file.
0.1.0
- Basic layout of the
flannel_serviceresource. - A
:createaction to install flanneld.
Collaborator Number Metric
1.1.1 failed this metric
Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.
Contributing File Metric
1.1.1 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
1.1.1 passed this metric
No Binaries Metric
1.1.1 passed this metric
Testing File Metric
1.1.1 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
1.1.1 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
1.1.1 failed this metric
1.1.1 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
1.1.1 passed this metric
No Binaries Metric
1.1.1 passed this metric
Testing File Metric
1.1.1 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
1.1.1 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
1.1.1 passed this metric
1.1.1 passed this metric
Testing File Metric
1.1.1 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
1.1.1 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
1.1.1 failed this metric
1.1.1 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number