├── .gitignore
├── MAINTAINERS
├── .gitattributes
├── NOTICE
├── user-data.sample
├── DCO
├── CONTRIBUTING.md
├── config.rb.sample
├── README.md
├── Vagrantfile
└── LICENSE


/.gitignore:
--------------------------------------------------------------------------------
1 | .vagrant/
2 | log/
3 | user-data
4 | config.rb
5 | 


--------------------------------------------------------------------------------
/MAINTAINERS:
--------------------------------------------------------------------------------
1 | Jon Boulle <jonathan.boulle@coreos.com> (@jonboulle)
2 | Brian Waldon <brian.waldon@coreos.com> (@bcwaldon)
3 | 


--------------------------------------------------------------------------------
/.gitattributes:
--------------------------------------------------------------------------------
1 | # Detect text files automatically
2 | * text=auto
3 | 
4 | # Force Unix-style line endings on these files
5 | user-data* text eol=lf
6 | 


--------------------------------------------------------------------------------
/NOTICE:
--------------------------------------------------------------------------------
1 | CoreOS Project
2 | Copyright 2014 CoreOS, Inc
3 | 
4 | This product includes software developed at CoreOS, Inc.
5 | (http://www.coreos.com/).
6 | 


--------------------------------------------------------------------------------
/user-data.sample:
--------------------------------------------------------------------------------
 1 | #cloud-config
 2 | 
 3 | coreos:
 4 |   etcd2:
 5 |     #generate a new token for each unique cluster from https://discovery.etcd.io/new
 6 |     #discovery: https://discovery.etcd.io/<token>
 7 |     # multi-region and multi-cloud deployments need to use $public_ipv4
 8 |     advertise-client-urls: http://$public_ipv4:2379
 9 |     initial-advertise-peer-urls: http://$private_ipv4:2380
10 |     # listen on both the official ports and the legacy ports
11 |     # legacy ports can be omitted if your application doesn't depend on them
12 |     listen-client-urls: http://0.0.0.0:2379,http://0.0.0.0:4001
13 |     listen-peer-urls: http://$private_ipv4:2380,http://$private_ipv4:7001
14 |   fleet:
15 |     public-ip: $public_ipv4
16 |   flannel:
17 |     interface: $public_ipv4
18 |   units:
19 |     - name: etcd2.service
20 |       command: start
21 |     - name: fleet.service
22 |       command: start
23 |     - name: flanneld.service
24 |       drop-ins:
25 |       - name: 50-network-config.conf
26 |         content: |
27 |           [Service]
28 |           ExecStartPre=/usr/bin/etcdctl set /coreos.com/network/config '{ "Network": "10.1.0.0/16" }'
29 |       command: start
30 |     - name: docker-tcp.socket
31 |       command: start
32 |       enable: true
33 |       content: |
34 |         [Unit]
35 |         Description=Docker Socket for the API
36 | 
37 |         [Socket]
38 |         ListenStream=2375
39 |         Service=docker.service
40 |         BindIPv6Only=both
41 | 
42 |         [Install]
43 |         WantedBy=sockets.target
44 | 


--------------------------------------------------------------------------------
/DCO:
--------------------------------------------------------------------------------
 1 | Developer Certificate of Origin
 2 | Version 1.1
 3 | 
 4 | Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
 5 | 660 York Street, Suite 102,
 6 | San Francisco, CA 94110 USA
 7 | 
 8 | Everyone is permitted to copy and distribute verbatim copies of this
 9 | license document, but changing it is not allowed.
10 | 
11 | 
12 | Developer's Certificate of Origin 1.1
13 | 
14 | By making a contribution to this project, I certify that:
15 | 
16 | (a) The contribution was created in whole or in part by me and I
17 |     have the right to submit it under the open source license
18 |     indicated in the file; or
19 | 
20 | (b) The contribution is based upon previous work that, to the best
21 |     of my knowledge, is covered under an appropriate open source
22 |     license and I have the right under that license to submit that
23 |     work with modifications, whether created in whole or in part
24 |     by me, under the same open source license (unless I am
25 |     permitted to submit under a different license), as indicated
26 |     in the file; or
27 | 
28 | (c) The contribution was provided directly to me by some other
29 |     person who certified (a), (b) or (c) and I have not modified
30 |     it.
31 | 
32 | (d) I understand and agree that this project and the contribution
33 |     are public and that a record of the contribution (including all
34 |     personal information I submit with it, including my sign-off) is
35 |     maintained indefinitely and may be redistributed consistent with
36 |     this project or the open source license(s) involved.
37 | 


--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
 1 | # How to Contribute
 2 | 
 3 | CoreOS projects are [Apache 2.0 licensed](LICENSE) and accept contributions via
 4 | GitHub pull requests.  This document outlines some of the conventions on
 5 | development workflow, commit message formatting, contact points and other
 6 | resources to make it easier to get your contribution accepted.
 7 | 
 8 | # Certificate of Origin
 9 | 
10 | By contributing to this project you agree to the Developer Certificate of
11 | Origin (DCO). This document was created by the Linux Kernel community and is a
12 | simple statement that you, as a contributor, have the legal right to make the
13 | contribution. See the [DCO](DCO) file for details.
14 | 
15 | # Email and Chat
16 | 
17 | The project currently uses the general CoreOS email list and IRC channel:
18 | - Email: [coreos-dev](https://groups.google.com/forum/#!forum/coreos-dev)
19 | - IRC: #[coreos](irc://irc.freenode.org:6667/#coreos) IRC channel on freenode.org
20 | 
21 | Please avoid emailing maintainers found in the MAINTAINERS file directly. They
22 | are very busy and read the mailing lists.
23 | 
24 | ## Getting Started
25 | 
26 | - Fork the repository on GitHub
27 | - Read the [README](README.md) for build and test instructions
28 | - Play with the project, submit bugs, submit patches!
29 | 
30 | ## Contribution Flow
31 | 
32 | This is a rough outline of what a contributor's workflow looks like:
33 | 
34 | - Create a topic branch from where you want to base your work (usually master).
35 | - Make commits of logical units.
36 | - Make sure your commit messages are in the proper format (see below).
37 | - Push your changes to a topic branch in your fork of the repository.
38 | - Make sure the tests pass, and add any new tests as appropriate.
39 | - Submit a pull request to the original repository.
40 | 
41 | Thanks for your contributions!
42 | 
43 | ### Format of the Commit Message
44 | 
45 | We follow a rough convention for commit messages that is designed to answer two
46 | questions: what changed and why. The subject line should feature the what and
47 | the body of the commit should describe the why.
48 | 
49 | ```
50 | scripts: add the test-cluster command
51 | 
52 | this uses tmux to setup a test cluster that you can easily kill and
53 | start for debugging.
54 | 
55 | Fixes #38
56 | ```
57 | 
58 | The format can be described more formally as follows:
59 | 
60 | ```
61 | <subsystem>: <what changed>
62 | <BLANK LINE>
63 | <why this change was made>
64 | <BLANK LINE>
65 | <footer>
66 | ```
67 | 
68 | The first line is the subject and should be no longer than 70 characters, the
69 | second line is always blank, and other lines should be wrapped at 80 characters.
70 | This allows the message to be easier to read on GitHub as well as in various
71 | git tools.
72 | 


--------------------------------------------------------------------------------
/config.rb.sample:
--------------------------------------------------------------------------------
 1 | # Size of the CoreOS cluster created by Vagrant
 2 | $num_instances=1
 3 | 
 4 | # Used to fetch a new discovery token for a cluster of size $num_instances
 5 | $new_discovery_url="https://discovery.etcd.io/new?size=#{$num_instances}"
 6 | 
 7 | # Automatically replace the discovery token on 'vagrant up'
 8 | 
 9 | if File.exists?('user-data') && ARGV[0].eql?('up')
10 |   require 'open-uri'
11 |   require 'yaml'
12 | 
13 |   token = open($new_discovery_url).read
14 | 
15 |   data = YAML.load(IO.readlines('user-data')[1..-1].join)
16 | 
17 |   if data.key? 'coreos' and data['coreos'].key? 'etcd'
18 |     data['coreos']['etcd']['discovery'] = token
19 |   end
20 | 
21 |   if data.key? 'coreos' and data['coreos'].key? 'etcd2'
22 |     data['coreos']['etcd2']['discovery'] = token
23 |   end
24 | 
25 |   # Fix for YAML.load() converting reboot-strategy from 'off' to `false`
26 |   if data.key? 'coreos' and data['coreos'].key? 'update' and data['coreos']['update'].key? 'reboot-strategy'
27 |     if data['coreos']['update']['reboot-strategy'] == false
28 |       data['coreos']['update']['reboot-strategy'] = 'off'
29 |     end
30 |   end
31 | 
32 |   yaml = YAML.dump(data)
33 |   File.open('user-data', 'w') { |file| file.write("#cloud-config\n\n#{yaml}") }
34 | end
35 | 
36 | #
37 | # coreos-vagrant is configured through a series of configuration
38 | # options (global ruby variables) which are detailed below. To modify
39 | # these options, first copy this file to "config.rb". Then simply
40 | # uncomment the necessary lines, leaving the $, and replace everything
41 | # after the equals sign..
42 | 
43 | # Change basename of the VM
44 | # The default value is "core", which results in VMs named starting with
45 | # "core-01" through to "core-${num_instances}".
46 | #$instance_name_prefix="core"
47 | 
48 | # Change the version of CoreOS to be installed
49 | # To deploy a specific version, simply set $image_version accordingly.
50 | # For example, to deploy version 709.0.0, set $image_version="709.0.0".
51 | # The default value is "current", which points to the current version
52 | # of the selected channel
53 | #$image_version = "current"
54 | 
55 | # Official CoreOS channel from which updates should be downloaded
56 | #$update_channel='alpha'
57 | 
58 | # Log the serial consoles of CoreOS VMs to log/
59 | # Enable by setting value to true, disable with false
60 | # WARNING: Serial logging is known to result in extremely high CPU usage with
61 | # VirtualBox, so should only be used in debugging situations
62 | #$enable_serial_logging=false
63 | 
64 | # Enable port forwarding of Docker TCP socket
65 | # Set to the TCP port you want exposed on the *host* machine, default is 2375
66 | # If 2375 is used, Vagrant will auto-increment (e.g. in the case of $num_instances > 1)
67 | # You can then use the docker tool locally by setting the following env var:
68 | #   export DOCKER_HOST='tcp://127.0.0.1:2375'
69 | #$expose_docker_tcp=2375
70 | 
71 | # Enable NFS sharing of your home directory ($HOME) to CoreOS
72 | # It will be mounted at the same path in the VM as on the host.
73 | # Example: /Users/foobar -> /Users/foobar
74 | #$share_home=false
75 | 
76 | # Customize VMs
77 | #$vm_gui = false
78 | #$vm_memory = 1024
79 | #$vm_cpus = 1
80 | 
81 | # Share additional folders to the CoreOS VMs
82 | # For example,
83 | # $shared_folders = {'/path/on/host' => '/path/on/guest', '/home/foo/app' => '/app'}
84 | # or, to map host folders to guest folders of the same name,
85 | # $shared_folders = Hash[*['/home/foo/app1', '/home/foo/app2'].map{|d| [d, d]}.flatten]
86 | #$shared_folders = {}
87 | 
88 | # Enable port forwarding from guest(s) to host machine, syntax is: { 80 => 8080 }, auto correction is enabled by default.
89 | #$forwarded_ports = {}
90 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # CoreOS Vagrant
  2 | 
  3 | This repo provides a template Vagrantfile to create a CoreOS virtual machine using the VirtualBox software hypervisor.
  4 | After setup is complete you will have a single CoreOS virtual machine running on your local machine.
  5 | 
  6 | ## Streamlined setup
  7 | 
  8 | 1) Install dependencies
  9 | 
 10 | * [VirtualBox][virtualbox] 4.3.10 or greater.
 11 | * [Vagrant][vagrant] 1.6 or greater.
 12 | 
 13 | 2) Clone this project and get it running!
 14 | 
 15 | ```
 16 | git clone https://github.com/coreos/coreos-vagrant/
 17 | cd coreos-vagrant
 18 | ```
 19 | 
 20 | 3) Startup and SSH
 21 | 
 22 | There are two "providers" for Vagrant with slightly different instructions.
 23 | Follow one of the following two options:
 24 | 
 25 | **VirtualBox Provider**
 26 | 
 27 | The VirtualBox provider is the default Vagrant provider. Use this if you are unsure.
 28 | 
 29 | ```
 30 | vagrant up
 31 | vagrant ssh
 32 | ```
 33 | 
 34 | **VMware Provider**
 35 | 
 36 | The VMware provider is a commercial addon from Hashicorp that offers better stability and speed.
 37 | If you use this provider follow these instructions.
 38 | 
 39 | VMware Fusion:
 40 | ```
 41 | vagrant up --provider vmware_fusion
 42 | vagrant ssh
 43 | ```
 44 | 
 45 | VMware Workstation:
 46 | ```
 47 | vagrant up --provider vmware_workstation
 48 | vagrant ssh
 49 | ```
 50 | 
 51 | ``vagrant up`` triggers vagrant to download the CoreOS image (if necessary) and (re)launch the instance
 52 | 
 53 | ``vagrant ssh`` connects you to the virtual machine.
 54 | Configuration is stored in the directory so you can always return to this machine by executing vagrant ssh from the directory where the Vagrantfile was located.
 55 | 
 56 | 4) Get started [using CoreOS][using-coreos]
 57 | 
 58 | [virtualbox]: https://www.virtualbox.org/
 59 | [vagrant]: https://www.vagrantup.com/downloads.html
 60 | [using-coreos]: http://coreos.com/docs/using-coreos/
 61 | 
 62 | #### Shared Folder Setup
 63 | 
 64 | There is optional shared folder setup.
 65 | You can try it out by adding a section to your Vagrantfile like this.
 66 | 
 67 | ```
 68 | config.vm.network "private_network", ip: "172.17.8.150"
 69 | config.vm.synced_folder ".", "/home/core/share", id: "core", :nfs => true,  :mount_options   => ['nolock,vers=3,udp']
 70 | ```
 71 | 
 72 | After a 'vagrant reload' you will be prompted for your local machine password.
 73 | 
 74 | #### Provisioning with user-data
 75 | 
 76 | The Vagrantfile will provision your CoreOS VM(s) with [coreos-cloudinit][coreos-cloudinit] if a `user-data` file is found in the project directory.
 77 | coreos-cloudinit simplifies the provisioning process through the use of a script or cloud-config document.
 78 | 
 79 | To get started, copy `user-data.sample` to `user-data` and make any necessary modifications.
 80 | Check out the [coreos-cloudinit documentation][coreos-cloudinit] to learn about the available features.
 81 | 
 82 | [coreos-cloudinit]: https://github.com/coreos/coreos-cloudinit
 83 | 
 84 | #### Configuration
 85 | 
 86 | The Vagrantfile will parse a `config.rb` file containing a set of options used to configure your CoreOS cluster.
 87 | See `config.rb.sample` for more information.
 88 | 
 89 | ## Cluster Setup
 90 | 
 91 | Launching a CoreOS cluster on Vagrant is as simple as configuring `$num_instances` in a `config.rb` file to 3 (or more!) and running `vagrant up`.
 92 | Make sure you provide a fresh discovery URL in your `user-data` if you wish to bootstrap etcd in your cluster.
 93 | 
 94 | ## New Box Versions
 95 | 
 96 | CoreOS is a rolling release distribution and versions that are out of date will automatically update.
 97 | If you want to start from the most up to date version you will need to make sure that you have the latest box file of CoreOS.
 98 | Simply remove the old box file and vagrant will download the latest one the next time you `vagrant up`.
 99 | 
100 | ```
101 | vagrant box remove coreos --provider vmware_fusion
102 | vagrant box remove coreos --provider vmware_workstation
103 | vagrant box remove coreos --provider virtualbox
104 | ```
105 | 
106 | ## Docker Forwarding
107 | 
108 | By setting the `$expose_docker_tcp` configuration value you can forward a local TCP port to docker on
109 | each CoreOS machine that you launch. The first machine will be available on the port that you specify
110 | and each additional machine will increment the port by 1.
111 | 
112 | Follow the [Enable Remote API instructions][coreos-enabling-port-forwarding] to get the CoreOS VM setup to work with port forwarding.
113 | 
114 | [coreos-enabling-port-forwarding]: https://coreos.com/docs/launching-containers/building/customizing-docker/#enable-the-remote-api-on-a-new-socket
115 | 
116 | Then you can then use the `docker` command from your local shell by setting `DOCKER_HOST`:
117 | 
118 |     export DOCKER_HOST=tcp://localhost:2375
119 | 


--------------------------------------------------------------------------------
/Vagrantfile:
--------------------------------------------------------------------------------
  1 | # -*- mode: ruby -*-
  2 | # # vi: set ft=ruby :
  3 | 
  4 | require 'fileutils'
  5 | 
  6 | Vagrant.require_version ">= 1.6.0"
  7 | 
  8 | CLOUD_CONFIG_PATH = File.join(File.dirname(__FILE__), "user-data")
  9 | CONFIG = File.join(File.dirname(__FILE__), "config.rb")
 10 | 
 11 | # Defaults for config options defined in CONFIG
 12 | $num_instances = 1
 13 | $instance_name_prefix = "core"
 14 | $update_channel = "alpha"
 15 | $image_version = "current"
 16 | $enable_serial_logging = false
 17 | $share_home = false
 18 | $vm_gui = false
 19 | $vm_memory = 1024
 20 | $vm_cpus = 1
 21 | $shared_folders = {}
 22 | $forwarded_ports = {}
 23 | 
 24 | # Attempt to apply the deprecated environment variable NUM_INSTANCES to
 25 | # $num_instances while allowing config.rb to override it
 26 | if ENV["NUM_INSTANCES"].to_i > 0 && ENV["NUM_INSTANCES"]
 27 |   $num_instances = ENV["NUM_INSTANCES"].to_i
 28 | end
 29 | 
 30 | if File.exist?(CONFIG)
 31 |   require CONFIG
 32 | end
 33 | 
 34 | # Use old vb_xxx config variables when set
 35 | def vm_gui
 36 |   $vb_gui.nil? ? $vm_gui : $vb_gui
 37 | end
 38 | 
 39 | def vm_memory
 40 |   $vb_memory.nil? ? $vm_memory : $vb_memory
 41 | end
 42 | 
 43 | def vm_cpus
 44 |   $vb_cpus.nil? ? $vm_cpus : $vb_cpus
 45 | end
 46 | 
 47 | Vagrant.configure("2") do |config|
 48 |   # always use Vagrants insecure key
 49 |   config.ssh.insert_key = false
 50 | 
 51 |   config.vm.box = "coreos-%s" % $update_channel
 52 |   if $image_version != "current"
 53 |       config.vm.box_version = $image_version
 54 |   end
 55 |   config.vm.box_url = "http://%s.release.core-os.net/amd64-usr/%s/coreos_production_vagrant.json" % [$update_channel, $image_version]
 56 | 
 57 |   ["vmware_fusion", "vmware_workstation"].each do |vmware|
 58 |     config.vm.provider vmware do |v, override|
 59 |       override.vm.box_url = "http://%s.release.core-os.net/amd64-usr/%s/coreos_production_vagrant_vmware_fusion.json" % [$update_channel, $image_version]
 60 |     end
 61 |   end
 62 | 
 63 |   config.vm.provider :virtualbox do |v|
 64 |     # On VirtualBox, we don't have guest additions or a functional vboxsf
 65 |     # in CoreOS, so tell Vagrant that so it can be smarter.
 66 |     v.check_guest_additions = false
 67 |     v.functional_vboxsf     = false
 68 |   end
 69 | 
 70 |   # plugin conflict
 71 |   if Vagrant.has_plugin?("vagrant-vbguest") then
 72 |     config.vbguest.auto_update = false
 73 |   end
 74 | 
 75 |   (1..$num_instances).each do |i|
 76 |     config.vm.define vm_name = "%s-%02d" % [$instance_name_prefix, i] do |config|
 77 |       config.vm.hostname = vm_name
 78 | 
 79 |       if $enable_serial_logging
 80 |         logdir = File.join(File.dirname(__FILE__), "log")
 81 |         FileUtils.mkdir_p(logdir)
 82 | 
 83 |         serialFile = File.join(logdir, "%s-serial.txt" % vm_name)
 84 |         FileUtils.touch(serialFile)
 85 | 
 86 |         ["vmware_fusion", "vmware_workstation"].each do |vmware|
 87 |           config.vm.provider vmware do |v, override|
 88 |             v.vmx["serial0.present"] = "TRUE"
 89 |             v.vmx["serial0.fileType"] = "file"
 90 |             v.vmx["serial0.fileName"] = serialFile
 91 |             v.vmx["serial0.tryNoRxLoss"] = "FALSE"
 92 |           end
 93 |         end
 94 | 
 95 |         config.vm.provider :virtualbox do |vb, override|
 96 |           vb.customize ["modifyvm", :id, "--uart1", "0x3F8", "4"]
 97 |           vb.customize ["modifyvm", :id, "--uartmode1", serialFile]
 98 |         end
 99 |       end
100 | 
101 |       if $expose_docker_tcp
102 |         config.vm.network "forwarded_port", guest: 2375, host: ($expose_docker_tcp + i - 1), auto_correct: true
103 |       end
104 | 
105 |       $forwarded_ports.each do |guest, host|
106 |         config.vm.network "forwarded_port", guest: guest, host: host, auto_correct: true
107 |       end
108 | 
109 |       ["vmware_fusion", "vmware_workstation"].each do |vmware|
110 |         config.vm.provider vmware do |v|
111 |           v.gui = vm_gui
112 |           v.vmx['memsize'] = vm_memory
113 |           v.vmx['numvcpus'] = vm_cpus
114 |         end
115 |       end
116 | 
117 |       config.vm.provider :virtualbox do |vb|
118 |         vb.gui = vm_gui
119 |         vb.memory = vm_memory
120 |         vb.cpus = vm_cpus
121 |       end
122 | 
123 |       ip = "172.17.8.#{i+100}"
124 |       config.vm.network :private_network, ip: ip
125 | 
126 |       # Uncomment below to enable NFS for sharing the host machine into the coreos-vagrant VM.
127 |       #config.vm.synced_folder ".", "/home/core/share", id: "core", :nfs => true, :mount_options => ['nolock,vers=3,udp']
128 |       $shared_folders.each_with_index do |(host_folder, guest_folder), index|
129 |         config.vm.synced_folder host_folder.to_s, guest_folder.to_s, id: "core-share%02d" % index, nfs: true, mount_options: ['nolock,vers=3,udp']
130 |       end
131 | 
132 |       if $share_home
133 |         config.vm.synced_folder ENV['HOME'], ENV['HOME'], id: "home", :nfs => true, :mount_options => ['nolock,vers=3,udp']
134 |       end
135 | 
136 |       if File.exist?(CLOUD_CONFIG_PATH)
137 |         config.vm.provision :file, :source => "#{CLOUD_CONFIG_PATH}", :destination => "/tmp/vagrantfile-user-data"
138 |         config.vm.provision :shell, :inline => "mv /tmp/vagrantfile-user-data /var/lib/coreos-vagrant/", :privileged => true
139 |       end
140 | 
141 |     end
142 |   end
143 | end
144 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  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 | 
203 | 


--------------------------------------------------------------------------------