Merge pull request #235 from daenney/readme-license-fixes
README and licensing fixes.
This commit is contained in:
Hunter Haugen
commit
b1a6d08631
2 changed files with 52 additions and 30 deletions
15
LICENSE
15
LICENSE
|
|
@ -17,3 +17,18 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||
THE SOFTWARE.
|
||||
|
||||
|
||||
Copyright 2014 Puppet Labs
|
||||
|
||||
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.
|
||||
|
|
|
|||
67
README.md
67
README.md
|
|
@ -17,14 +17,14 @@ The APT module provides a simple interface for managing APT source, key, and def
|
|||
Module Description
|
||||
------------------
|
||||
|
||||
APT automates obtaining and installing software packages on *nix systems.
|
||||
APT automates obtaining and installing software packages on \*nix systems.
|
||||
|
||||
Setup
|
||||
-----
|
||||
|
||||
**What APT affects:**
|
||||
|
||||
* package/service/configuration files for APT
|
||||
* package/service/configuration files for APT
|
||||
* your system's `sources.list` file and `sources.list.d` directory
|
||||
* NOTE: Setting the `purge_sources_list` and `purge_sources_list_d` parameters to 'true' will destroy any existing content that was not declared with Puppet. The default for these parameters is 'false'.
|
||||
* system repositories
|
||||
|
|
@ -36,14 +36,14 @@ Setup
|
|||
To begin using the APT module with default parameters, declare the class
|
||||
|
||||
include apt
|
||||
|
||||
Puppet code that uses anything from the APT module requires that the core apt class be declared.
|
||||
|
||||
Puppet code that uses anything from the APT module requires that the core apt class be declared/\s\+$//e
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
Using the APT module consists predominantly in declaring classes that provide desired functionality and features.
|
||||
|
||||
Using the APT module consists predominantly in declaring classes that provide desired functionality and features.
|
||||
|
||||
### apt
|
||||
|
||||
`apt` provides a number of common resources and options that are shared by the various defined types in this module, so you MUST always include this class in your manifests.
|
||||
|
|
@ -61,9 +61,9 @@ The parameters for `apt` are not required in general and are predominantly for d
|
|||
update_timeout => undef
|
||||
}
|
||||
|
||||
Puppet will manage your system's `sources.list` file and `sources.list.d` directory but will do its best to respect existing content.
|
||||
Puppet will manage your system's `sources.list` file and `sources.list.d` directory but will do its best to respect existing content.
|
||||
|
||||
If you declare your apt class with `purge_sources_list` and `purge_sources_list_d` set to 'true', Puppet will unapologetically purge any existing content it finds that wasn't declared with Puppet.
|
||||
If you declare your apt class with `purge_sources_list` and `purge_sources_list_d` set to 'true', Puppet will unapologetically purge any existing content it finds that wasn't declared with Puppet.
|
||||
|
||||
### apt::builddep
|
||||
|
||||
|
|
@ -76,9 +76,9 @@ Installs the build depends of a specified package.
|
|||
Forces a package to be installed from a specific release. This class is particularly useful when using repositories, like Debian, that are unstable in Ubuntu.
|
||||
|
||||
apt::force { 'glusterfs-server':
|
||||
release => 'unstable',
|
||||
version => '3.0.3',
|
||||
require => Apt::Source['debian_unstable'],
|
||||
release => 'unstable',
|
||||
version => '3.0.3',
|
||||
require => Apt::Source['debian_unstable'],
|
||||
}
|
||||
|
||||
### apt::key
|
||||
|
|
@ -171,7 +171,7 @@ This test will set up a Puppet Labs apt repository. Start by creating a new smok
|
|||
key => '4BD6EC30',
|
||||
key_server => 'pgp.mit.edu',
|
||||
}
|
||||
|
||||
|
||||
This resource creates an apt source named puppetlabs and gives Puppet information about the repository's location and key used to sign its packages. Puppet leverages Facter to determine the appropriate release, but you can set it directly by adding the release type.
|
||||
|
||||
Check your smoke test for syntax errors
|
||||
|
|
@ -185,7 +185,7 @@ If you receive no output from that command, it means nothing is wrong. Then appl
|
|||
info: /Stage[main]//Apt::Source[puppetlabs]/File[puppetlabs.list]: Scheduling refresh of Exec[puppetlabs apt update]
|
||||
notice: /Stage[main]//Apt::Source[puppetlabs]/Exec[puppetlabs apt update]: Triggered 'refresh' from 1 events>
|
||||
|
||||
The above example used a smoke test to easily lay out a resource declaration and apply it on your system. In production, you may want to declare your APT sources inside the classes where they’re needed.
|
||||
The above example used a smoke test to easily lay out a resource declaration and apply it on your system. In production, you may want to declare your APT sources inside the classes where they’re needed.
|
||||
|
||||
Implementation
|
||||
--------------
|
||||
|
|
@ -197,7 +197,7 @@ Adds the necessary components to get backports for Ubuntu and Debian. The releas
|
|||
Limitations
|
||||
-----------
|
||||
|
||||
This module should work across all versions of Debian/Ubuntu and support all major APT repository management features.
|
||||
This module should work across all versions of Debian/Ubuntu and support all major APT repository management features.
|
||||
|
||||
Development
|
||||
------------
|
||||
|
|
@ -208,6 +208,13 @@ We want to keep it as easy as possible to contribute changes so that our modules
|
|||
|
||||
You can read the complete module contribution guide [on the Puppet Labs wiki.](http://projects.puppetlabs.com/projects/module-site/wiki/Module_contributing)
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
The original code for this module comes from Evolving Web and was licensed under the MIT license. Code added since the fork of this module is licensed under the Apache 2.0 License like the rest of the Puppet Labs products.
|
||||
|
||||
The LICENSE contains both licenses.
|
||||
|
||||
Contributors
|
||||
------------
|
||||
|
||||
|
|
@ -215,19 +222,19 @@ A lot of great people have contributed to this module. A somewhat current list f
|
|||
|
||||
* Ben Godfrey <ben.godfrey@wonga.com>
|
||||
* Branan Purvine-Riley <branan@puppetlabs.com>
|
||||
* Christian G. Warden <cwarden@xerus.org>
|
||||
* Dan Bode <bodepd@gmail.com> <dan@puppetlabs.com>
|
||||
* Garrett Honeycutt <github@garretthoneycutt.com>
|
||||
* Jeff Wallace <jeff@evolvingweb.ca> <jeff@tjwallace.ca>
|
||||
* Ken Barber <ken@bob.sh>
|
||||
* Matthaus Litteken <matthaus@puppetlabs.com> <mlitteken@gmail.com>
|
||||
* Matthias Pigulla <mp@webfactory.de>
|
||||
* Monty Taylor <mordred@inaugust.com>
|
||||
* Peter Drake <pdrake@allplayers.com>
|
||||
* Reid Vandewiele <marut@cat.pdx.edu>
|
||||
* Robert Navarro <rnavarro@phiivo.com>
|
||||
* Ryan Coleman <ryan@puppetlabs.com>
|
||||
* Scott McLeod <scott.mcleod@theice.com>
|
||||
* Spencer Krum <spencer@puppetlabs.com>
|
||||
* William Van Hevelingen <blkperl@cat.pdx.edu> <wvan13@gmail.com>
|
||||
* Zach Leslie <zach@puppetlabs.com>
|
||||
* Christian G. Warden <cwarden@xerus.org>
|
||||
* Dan Bode <bodepd@gmail.com> <dan@puppetlabs.com>
|
||||
* Garrett Honeycutt <github@garretthoneycutt.com>
|
||||
* Jeff Wallace <jeff@evolvingweb.ca> <jeff@tjwallace.ca>
|
||||
* Ken Barber <ken@bob.sh>
|
||||
* Matthaus Litteken <matthaus@puppetlabs.com> <mlitteken@gmail.com>
|
||||
* Matthias Pigulla <mp@webfactory.de>
|
||||
* Monty Taylor <mordred@inaugust.com>
|
||||
* Peter Drake <pdrake@allplayers.com>
|
||||
* Reid Vandewiele <marut@cat.pdx.edu>
|
||||
* Robert Navarro <rnavarro@phiivo.com>
|
||||
* Ryan Coleman <ryan@puppetlabs.com>
|
||||
* Scott McLeod <scott.mcleod@theice.com>
|
||||
* Spencer Krum <spencer@puppetlabs.com>
|
||||
* William Van Hevelingen <blkperl@cat.pdx.edu> <wvan13@gmail.com>
|
||||
* Zach Leslie <zach@puppetlabs.com>
|
||||
|
|
|
|||
Loading…
Reference in a new issue