foreman_discovery 1.3.0.rc3 → 1.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +8 -8
- data/README.md +176 -33
- data/app/models/host/discovered.rb +6 -0
- data/lib/foreman_discovery/version.rb +1 -1
- metadata +4 -21
- data/extra/ovirt-node-plugin-foreman/COPYING +0 -340
- data/extra/ovirt-node-plugin-foreman/Makefile.am +0 -60
- data/extra/ovirt-node-plugin-foreman/README.md +0 -217
- data/extra/ovirt-node-plugin-foreman/autogen.sh +0 -66
- data/extra/ovirt-node-plugin-foreman/conf/Makefile.am +0 -29
- data/extra/ovirt-node-plugin-foreman/conf/foreman-plugin.firewall.in +0 -4
- data/extra/ovirt-node-plugin-foreman/conf/foreman-plugin.logs +0 -2
- data/extra/ovirt-node-plugin-foreman/configure.ac +0 -62
- data/extra/ovirt-node-plugin-foreman/ovirt-node-plugin-foreman.spec.in +0 -145
- data/extra/ovirt-node-plugin-foreman/recipe/Makefile.am +0 -33
- data/extra/ovirt-node-plugin-foreman/recipe/foreman-plugin-iso.ks +0 -5
- data/extra/ovirt-node-plugin-foreman/recipe/foreman-plugin-minimizer.ks +0 -160
- data/extra/ovirt-node-plugin-foreman/src/Makefile.am +0 -32
- data/extra/ovirt-node-plugin-foreman/src/discover-host.rb.in +0 -204
- data/extra/ovirt-node-plugin-foreman/src/discover-host.service +0 -14
- data/extra/ovirt-node-plugin-foreman/src/discovery-version-fact.rb.in +0 -25
- data/extra/ovirt-node-plugin-foreman/src/find-missing-libs +0 -35
checksums.yaml
CHANGED
@@ -1,15 +1,15 @@
|
|
1
1
|
---
|
2
2
|
!binary "U0hBMQ==":
|
3
3
|
metadata.gz: !binary |-
|
4
|
-
|
4
|
+
ODM5ZGE4MTdiMTViZDllOTAxN2QzNDQzNmE4ZDI1NGVkOGIyOTUwZA==
|
5
5
|
data.tar.gz: !binary |-
|
6
|
-
|
6
|
+
NTJlNWM3MTVjNTE5MTBiNGNmNmY2YmZiN2RmMWJjZjIzYjJlZDJkMg==
|
7
7
|
SHA512:
|
8
8
|
metadata.gz: !binary |-
|
9
|
-
|
10
|
-
|
11
|
-
|
9
|
+
ZDQ0NzQxYjFmMDgyZTgzYmQ2NDg2OTBiZjExNDY2NmQ1OGVkNWMwZmI4ZmI2
|
10
|
+
NTNmYTc0N2VlMzliNWEzZTIyOTBhZDE4NGUxODkzZTc1Y2VhMDFkMGQ3ODZk
|
11
|
+
N2ViMTA2MjZjY2I5OWZkOTc4ZGQ1NGVmOGYxZjI3ZTU3NjBlODk=
|
12
12
|
data.tar.gz: !binary |-
|
13
|
-
|
14
|
-
|
15
|
-
|
13
|
+
OGE0ZWM2ZWZlZDAxMjAwMDQ0MjhjNjFlOTk0MmVkMGY4MDk1MDIwZmNmZGJl
|
14
|
+
OWY3Y2Y3ZTI0ZjRkZjc5MDUwYTgzYzI2ZGYwZWNmNzcxZTdmM2U2ZDU0YTEy
|
15
|
+
YjI5MzVjNTA2MTMxNDdhOWFmYTY5ZTk4OTY1YmE5NDQwMGQyNTM=
|
data/README.md
CHANGED
@@ -1,8 +1,26 @@
|
|
1
1
|
# foreman\_discovery
|
2
2
|
|
3
|
-
This plugin enables MaaS hardware discovery in Foreman.
|
3
|
+
This plugin enables MaaS hardware discovery in Foreman. There are two
|
4
|
+
artifacts (and terms) used in this document:
|
4
5
|
|
5
|
-
|
6
|
+
* foreman_discovery plugin - software installed in Foreman that adds Discovered
|
7
|
+
Hosts menu entry, API and required configuration
|
8
|
+
* discovery image - net-bootable image that needs to be installed in the TFTP
|
9
|
+
server and configured in Foreman for new (unknown) hosts to boot from over
|
10
|
+
PXE
|
11
|
+
|
12
|
+
## Minimal hardware requirements
|
13
|
+
|
14
|
+
Since the bootable image runs from memory, keep in mind the following minimum
|
15
|
+
requirements on the hardware that is being discovered:
|
16
|
+
|
17
|
+
* 700 MB RAM for the CentOS image
|
18
|
+
* 900 MB RAM for the Fedora image
|
19
|
+
|
20
|
+
When testing those images on virtual machines, make sure they have allocated
|
21
|
+
enough memory, otherwise kernel panic can be seen during boot sequence.
|
22
|
+
|
23
|
+
# Installation (plugin)
|
6
24
|
|
7
25
|
Please see the Foreman wiki for appropriate instructions:
|
8
26
|
|
@@ -19,55 +37,158 @@ RPM users can install the "ruby193-rubygem-foreman_discovery" or
|
|
19
37
|
| --------------- | --------------:| -------------------:|
|
20
38
|
| <= 1.2 | 1.0.2 | N/A |
|
21
39
|
| = 1.3 | 1.1.0 | 0.1.0 |
|
22
|
-
|
|
40
|
+
| = 1.4 | 1.2.0 | 0.3.0-1 |
|
41
|
+
| >= 1.5 | 1.3.0 | 0.5.0-1 |
|
23
42
|
|
24
43
|
## Latest code
|
25
44
|
|
26
|
-
|
45
|
+
If a source-based install of Foreman is in use, the develop
|
46
|
+
branch of the plugin can be obtained by updating the Gemfile in this way:
|
27
47
|
|
28
48
|
gem 'foreman_discovery', :git => "https://github.com/theforeman/foreman_discovery.git"
|
29
49
|
|
30
|
-
|
50
|
+
# Installation (image)
|
31
51
|
|
32
|
-
|
33
|
-
|
34
|
-
|
52
|
+
The image is based on CentOS 6 & Fedora 18 (there is an image for each) and it
|
53
|
+
leverages the oVirt Node open-source project. The download site provides stable
|
54
|
+
releases as well as nightly builds for those who want to live on the edge, or
|
55
|
+
alternatively a local image can be rebuilt by the user.
|
35
56
|
|
36
|
-
|
57
|
+
The recommended option is to download a prebuilt image from the Foreman
|
58
|
+
repositories.
|
37
59
|
|
38
|
-
|
60
|
+
Nightly builds have the ssh daemon enabled and root password set to "redhat";
|
61
|
+
logging is also increased. Conversely, releases have the root account locked
|
62
|
+
and there is no ssh access. Note that the first console (tty1) is reserved for
|
63
|
+
Discovery output. For a login prompt (nightly images only) use tty2.
|
39
64
|
|
40
|
-
|
41
|
-
* [Build or download oVirt Node based image](README.ovirt_image.md)
|
65
|
+
## Downloading an image
|
42
66
|
|
43
|
-
|
44
|
-
Node image has different versioning scheme.
|
67
|
+
### Download via installer
|
45
68
|
|
46
|
-
|
69
|
+
As of Foreman 1.5, the foreman-installer is able to automatically download
|
70
|
+
latest stable CentOS6 images. For this, re-run the installer with the
|
71
|
+
following option:
|
47
72
|
|
48
|
-
|
73
|
+
# foreman-installer --foreman-plugin-discovery-install-images=true
|
49
74
|
|
50
|
-
|
51
|
-
Foreman will default to using the first Location and first Organisation for Discovered
|
52
|
-
hosts. If you wish to place them in some other Location/Organization, you can alter the
|
53
|
-
default Loc/Org in `More->Settings->Discovery Settings`
|
75
|
+
### Manual download
|
54
76
|
|
55
|
-
|
77
|
+
Images are available from:
|
56
78
|
|
57
|
-
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
|
79
|
+
* http://downloads.theforeman.org/discovery/
|
80
|
+
|
81
|
+
A choice of using an ISO or a kernel/initrd pair is available.
|
82
|
+
|
83
|
+
Kernel/initrd (recommended):
|
84
|
+
|
85
|
+
* ovirt-node-iso-3.X.0-0.999.201404XXXXXX.el6.iso-img
|
86
|
+
* ovirt-node-iso-3.X.0-0.999.201404XXXXXX.el6.iso-vmlinuz
|
87
|
+
|
88
|
+
or ISO file:
|
89
|
+
|
90
|
+
* ovirt-node-iso-3.X.0-0.999.201404XXXXXX.el6.iso
|
91
|
+
|
92
|
+
When downloading the ISO file, it must be extracted before proceeding:
|
93
|
+
|
94
|
+
# yum -y install livecd-tools
|
95
|
+
# ln -sf ovirt-node-iso-3.X.0-0.999.201404170648.el6.iso foreman.iso
|
96
|
+
# sudo livecd-iso-to-pxeboot foreman.iso
|
97
|
+
# find tftpboot/
|
98
|
+
tftpboot/
|
99
|
+
tftpboot/vmlinuz0
|
100
|
+
tftpboot/pxelinux.0
|
101
|
+
tftpboot/pxelinux.cfg
|
102
|
+
tftpboot/pxelinux.cfg/default
|
103
|
+
tftpboot/initrd0.img
|
104
|
+
|
105
|
+
Once the initrd/vmlinuz pair (whether from direct download or from ISO
|
106
|
+
extraction) is available, copy them to the TFTP BOOT directory and rename them
|
107
|
+
to *vmlinuz0* and *initrd0.img*.
|
108
|
+
|
109
|
+
### Building an image
|
110
|
+
|
111
|
+
To build a discovery image, please visit the
|
112
|
+
[ovirt-node-plugin-foreman](https://github.com/theforeman/ovirt-node-plugin-foreman)
|
113
|
+
page for further instructions.
|
114
|
+
|
115
|
+
# Configuration (image)
|
116
|
+
|
117
|
+
Foreman Discovery relies on intercepting the normal boot process for machines
|
118
|
+
not registered in Foreman. To achieve this, the PXE default.cfg file needs to
|
119
|
+
be altered to instruct new machines to boot the discovery image.
|
120
|
+
|
121
|
+
In the Foreman UI, go to Provisioning Templates, edit *PXELinux global default*
|
122
|
+
template and add:
|
123
|
+
|
124
|
+
LABEL discovery
|
125
|
+
MENU LABEL Foreman Discovery
|
126
|
+
MENU DEFAULT
|
127
|
+
KERNEL boot/tftpboot/vmlinuz0
|
128
|
+
APPEND rootflags=loop initrd=boot/tftpboot/initrd0.img root=live:/foreman.iso rootfstype=auto ro rd.live.image rd.live.check rd.lvm=0 rootflags=ro crashkernel=128M elevator=deadline max_loop=256 rd.luks=0 rd.md=0 rd.dm=0 nomodeset selinux=0 stateless foreman.url=https://foreman.example.com
|
129
|
+
IPAPPEND 2
|
130
|
+
|
131
|
+
to the end of the file. Note the `foreman.url` option on the APPEND line,
|
132
|
+
which defines where foreman instance is. Make sure this is set correctly or
|
133
|
+
discovered hosts will not register to Foreman. Then make this the default by
|
134
|
+
altering the `ONTIMEOUT` option:
|
62
135
|
|
63
|
-
|
136
|
+
ONTIMEOUT discovery
|
137
|
+
|
138
|
+
*Alternatively*, the Discovery image also searches for DNS SRV record named
|
139
|
+
`_x-foreman._tcp`. If the DNS server is configured for this (see the example
|
140
|
+
for ISC BIND below), then it is not required to provide `foreman.url` at all.
|
141
|
+
|
142
|
+
_x-foreman._tcp SRV 0 5 443 foreman
|
143
|
+
|
144
|
+
This can still be overriden with the command line opts.
|
145
|
+
|
146
|
+
It is important to have *IPAPPEND 2* option which adds BOOTIF=MAC option which
|
147
|
+
is then reported via facter as `discovery_bootif` which is key fact which is
|
148
|
+
used for provisioning.
|
149
|
+
|
150
|
+
_Warning_: For now, the selinux=0 option *must* be provided, the image is read
|
151
|
+
only anyway but we plan to enable and test with SELinux too.
|
152
|
+
|
153
|
+
An example complete *PXELinux global default* template for Discovery might look
|
154
|
+
like this:
|
155
|
+
|
156
|
+
DEFAULT menu
|
157
|
+
PROMPT 0
|
158
|
+
MENU TITLE PXE Menu
|
159
|
+
TIMEOUT 200
|
160
|
+
TOTALTIMEOUT 6000
|
161
|
+
ONTIMEOUT discovery
|
162
|
+
|
163
|
+
LABEL discovery
|
164
|
+
MENU LABEL Foreman Discovery
|
165
|
+
KERNEL boot/tftpboot/vmlinuz0
|
166
|
+
APPEND rootflags=loop initrd=boot/tftpboot/initrd0.img root=live:/foreman.iso rootfstype=auto ro rd.live.image rd.live.check rd.lvm=0 rootflags=ro crashkernel=128M elevator=deadline max_loop=256 rd.luks=0 rd.md=0 rd.dm=0 nomodeset selinux=0 stateless foreman.url=https://foreman.example.com
|
167
|
+
IPAPPEND 2
|
168
|
+
|
169
|
+
# Configuration (plugin)
|
170
|
+
|
171
|
+
No configuration of the plugin in the Foreman UI is required, but some
|
172
|
+
configuration is available.
|
173
|
+
|
174
|
+
If Locations and/or Organisations are enabled, Foreman will default to using
|
175
|
+
the first Location and first Organisation for Discovered hosts. If hosts should
|
176
|
+
be placed in some other Location/Organization, alter the default Loc/Org in
|
177
|
+
`More->Settings->Discovery Settings`
|
178
|
+
|
179
|
+
There is also setting called `discovery_fact` which defaults to
|
180
|
+
`discovery_bootif` which specifies which incoming fact should be used to get
|
181
|
+
the MAC address. By default PXELinux BOOTIF kernel command line option is used
|
182
|
+
which gives a MAC address of the interface which was booted from. Make sure
|
183
|
+
the `IPAPPEND 2` option is set correctly in the Foreman template.
|
64
184
|
|
65
185
|
# Usage
|
66
186
|
|
67
187
|
Boot a machine using the new PXE config above. It should register with Foreman.
|
68
|
-
The new Host should show up in `More->Provisioning->Discovered Hosts`. Then
|
69
|
-
and choose Provision.
|
70
|
-
discovered data filled in where possible. Fill
|
188
|
+
The new Host should show up in `More->Provisioning->Discovered Hosts`. Then
|
189
|
+
select a Discovered Host and choose Provision. This will redirect to the normal
|
190
|
+
Edit page for a Host, with the discovered data filled in where possible. Fill
|
191
|
+
in the details as normal.
|
71
192
|
|
72
193
|
On save, a reboot is sent to the discovered host, after which it should reboot into
|
73
194
|
the installer for the chosen OS, and finally into the installed OS.
|
@@ -76,14 +197,36 @@ Delete a machine and reboot it to have it move back to the Discovery Pool.
|
|
76
197
|
|
77
198
|
# Permissions
|
78
199
|
|
79
|
-
The plugin will create a Role called `Discovery` when first started.
|
80
|
-
|
81
|
-
assign the `:perform_discovery` permission to an existing Role.
|
200
|
+
The plugin will create a Role called `Discovery` when first started. This can
|
201
|
+
be assigned to roles for non-admins to allow them to use the discovery plugin.
|
202
|
+
Alternatively assign the `:perform_discovery` permission to an existing Role.
|
203
|
+
|
204
|
+
# Troubleshooting
|
205
|
+
|
206
|
+
If the booted machine fails to register with Foreman, then there are a number of common causes:
|
207
|
+
|
208
|
+
* Machine did not boot the correct image
|
209
|
+
* check your `pxelinux.cfg/default` has the right config as above
|
210
|
+
* Machine booted image but failed to contact Foreman
|
211
|
+
* Check the `foreman.url` option in `pxelinux.cfg/default` is correctly defined
|
212
|
+
* Check DNS is working for that image, or use an IP in `foreman.url`
|
213
|
+
* Check DHCP is handing IPs to the booted image correctly
|
82
214
|
|
83
215
|
# API
|
84
216
|
|
85
217
|
see the [API README](README.api.md)
|
86
218
|
|
219
|
+
## Reporting bugs
|
220
|
+
|
221
|
+
We use [RedMine instance](http://projects.theforeman.org/projects/discovery/issues)
|
222
|
+
instead of github.com issues. Please report issues there.
|
223
|
+
|
224
|
+
## Grace Note: Testing
|
225
|
+
|
226
|
+
If you only wish to test the plugin code itself, you don't need to create the PXE boot
|
227
|
+
image above, or have a TFTP server to run it from. Simply POST a hash of Host Facts to
|
228
|
+
`/api/v2/discovered_hosts/facts` to create a Discovered Host in the UI.
|
229
|
+
|
87
230
|
# TODO
|
88
231
|
|
89
232
|
* Support for downloading shell script for oVirt Node image
|
@@ -5,6 +5,7 @@ class Host::Discovered < ::Host::Base
|
|
5
5
|
belongs_to :location
|
6
6
|
belongs_to :organization
|
7
7
|
belongs_to :subnet
|
8
|
+
belongs_to :hostgroup
|
8
9
|
|
9
10
|
validates :mac, :uniqueness => true, :format => {:with => Net::Validations::MAC_REGEXP}, :presence => true
|
10
11
|
validates :ip, :format => {:with => Net::Validations::IP_REGEXP}, :uniqueness => true
|
@@ -75,6 +76,11 @@ class Host::Discovered < ::Host::Base
|
|
75
76
|
self.save
|
76
77
|
end
|
77
78
|
|
79
|
+
# no need to store anything in the db if the password is our default
|
80
|
+
def root_pass
|
81
|
+
read_attribute(:root_pass).blank? ? (hostgroup.try(:root_pass) || Setting[:root_pass]) : read_attribute(:root_pass)
|
82
|
+
end
|
83
|
+
|
78
84
|
def refresh_facts
|
79
85
|
# TODO: Can we rely on self.ip? The lease might expire/change....
|
80
86
|
begin
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: foreman_discovery
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.3.0
|
4
|
+
version: 1.3.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Greg Sutcliffe
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2014-
|
11
|
+
date: 2014-06-06 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: open4
|
@@ -91,23 +91,6 @@ files:
|
|
91
91
|
- extra/foreman_startup.rb
|
92
92
|
- extra/ovirt-node-build/Vagrantfile
|
93
93
|
- extra/ovirt-node-build/build_image.sh
|
94
|
-
- extra/ovirt-node-plugin-foreman/COPYING
|
95
|
-
- extra/ovirt-node-plugin-foreman/Makefile.am
|
96
|
-
- extra/ovirt-node-plugin-foreman/README.md
|
97
|
-
- extra/ovirt-node-plugin-foreman/autogen.sh
|
98
|
-
- extra/ovirt-node-plugin-foreman/conf/Makefile.am
|
99
|
-
- extra/ovirt-node-plugin-foreman/conf/foreman-plugin.firewall.in
|
100
|
-
- extra/ovirt-node-plugin-foreman/conf/foreman-plugin.logs
|
101
|
-
- extra/ovirt-node-plugin-foreman/configure.ac
|
102
|
-
- extra/ovirt-node-plugin-foreman/ovirt-node-plugin-foreman.spec.in
|
103
|
-
- extra/ovirt-node-plugin-foreman/recipe/Makefile.am
|
104
|
-
- extra/ovirt-node-plugin-foreman/recipe/foreman-plugin-iso.ks
|
105
|
-
- extra/ovirt-node-plugin-foreman/recipe/foreman-plugin-minimizer.ks
|
106
|
-
- extra/ovirt-node-plugin-foreman/src/Makefile.am
|
107
|
-
- extra/ovirt-node-plugin-foreman/src/discover-host.rb.in
|
108
|
-
- extra/ovirt-node-plugin-foreman/src/discover-host.service
|
109
|
-
- extra/ovirt-node-plugin-foreman/src/discovery-version-fact.rb.in
|
110
|
-
- extra/ovirt-node-plugin-foreman/src/find-missing-libs
|
111
94
|
- extra/wait_for_network.sh
|
112
95
|
- lib/discovery.rake
|
113
96
|
- lib/foreman_discovery.rb
|
@@ -146,9 +129,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
146
129
|
version: '0'
|
147
130
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
148
131
|
requirements:
|
149
|
-
- - ! '
|
132
|
+
- - ! '>='
|
150
133
|
- !ruby/object:Gem::Version
|
151
|
-
version:
|
134
|
+
version: '0'
|
152
135
|
requirements: []
|
153
136
|
rubyforge_project:
|
154
137
|
rubygems_version: 2.2.1
|
@@ -1,340 +0,0 @@
|
|
1
|
-
GNU GENERAL PUBLIC LICENSE
|
2
|
-
Version 2, June 1991
|
3
|
-
|
4
|
-
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
|
5
|
-
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
6
|
-
Everyone is permitted to copy and distribute verbatim copies
|
7
|
-
of this license document, but changing it is not allowed.
|
8
|
-
|
9
|
-
Preamble
|
10
|
-
|
11
|
-
The licenses for most software are designed to take away your
|
12
|
-
freedom to share and change it. By contrast, the GNU General Public
|
13
|
-
License is intended to guarantee your freedom to share and change free
|
14
|
-
software--to make sure the software is free for all its users. This
|
15
|
-
General Public License applies to most of the Free Software
|
16
|
-
Foundation's software and to any other program whose authors commit to
|
17
|
-
using it. (Some other Free Software Foundation software is covered by
|
18
|
-
the GNU Library General Public License instead.) You can apply it to
|
19
|
-
your programs, too.
|
20
|
-
|
21
|
-
When we speak of free software, we are referring to freedom, not
|
22
|
-
price. Our General Public Licenses are designed to make sure that you
|
23
|
-
have the freedom to distribute copies of free software (and charge for
|
24
|
-
this service if you wish), that you receive source code or can get it
|
25
|
-
if you want it, that you can change the software or use pieces of it
|
26
|
-
in new free programs; and that you know you can do these things.
|
27
|
-
|
28
|
-
To protect your rights, we need to make restrictions that forbid
|
29
|
-
anyone to deny you these rights or to ask you to surrender the rights.
|
30
|
-
These restrictions translate to certain responsibilities for you if you
|
31
|
-
distribute copies of the software, or if you modify it.
|
32
|
-
|
33
|
-
For example, if you distribute copies of such a program, whether
|
34
|
-
gratis or for a fee, you must give the recipients all the rights that
|
35
|
-
you have. You must make sure that they, too, receive or can get the
|
36
|
-
source code. And you must show them these terms so they know their
|
37
|
-
rights.
|
38
|
-
|
39
|
-
We protect your rights with two steps: (1) copyright the software, and
|
40
|
-
(2) offer you this license which gives you legal permission to copy,
|
41
|
-
distribute and/or modify the software.
|
42
|
-
|
43
|
-
Also, for each author's protection and ours, we want to make certain
|
44
|
-
that everyone understands that there is no warranty for this free
|
45
|
-
software. If the software is modified by someone else and passed on, we
|
46
|
-
want its recipients to know that what they have is not the original, so
|
47
|
-
that any problems introduced by others will not reflect on the original
|
48
|
-
authors' reputations.
|
49
|
-
|
50
|
-
Finally, any free program is threatened constantly by software
|
51
|
-
patents. We wish to avoid the danger that redistributors of a free
|
52
|
-
program will individually obtain patent licenses, in effect making the
|
53
|
-
program proprietary. To prevent this, we have made it clear that any
|
54
|
-
patent must be licensed for everyone's free use or not licensed at all.
|
55
|
-
|
56
|
-
The precise terms and conditions for copying, distribution and
|
57
|
-
modification follow.
|
58
|
-
|
59
|
-
GNU GENERAL PUBLIC LICENSE
|
60
|
-
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
61
|
-
|
62
|
-
0. This License applies to any program or other work which contains
|
63
|
-
a notice placed by the copyright holder saying it may be distributed
|
64
|
-
under the terms of this General Public License. The "Program", below,
|
65
|
-
refers to any such program or work, and a "work based on the Program"
|
66
|
-
means either the Program or any derivative work under copyright law:
|
67
|
-
that is to say, a work containing the Program or a portion of it,
|
68
|
-
either verbatim or with modifications and/or translated into another
|
69
|
-
language. (Hereinafter, translation is included without limitation in
|
70
|
-
the term "modification".) Each licensee is addressed as "you".
|
71
|
-
|
72
|
-
Activities other than copying, distribution and modification are not
|
73
|
-
covered by this License; they are outside its scope. The act of
|
74
|
-
running the Program is not restricted, and the output from the Program
|
75
|
-
is covered only if its contents constitute a work based on the
|
76
|
-
Program (independent of having been made by running the Program).
|
77
|
-
Whether that is true depends on what the Program does.
|
78
|
-
|
79
|
-
1. You may copy and distribute verbatim copies of the Program's
|
80
|
-
source code as you receive it, in any medium, provided that you
|
81
|
-
conspicuously and appropriately publish on each copy an appropriate
|
82
|
-
copyright notice and disclaimer of warranty; keep intact all the
|
83
|
-
notices that refer to this License and to the absence of any warranty;
|
84
|
-
and give any other recipients of the Program a copy of this License
|
85
|
-
along with the Program.
|
86
|
-
|
87
|
-
You may charge a fee for the physical act of transferring a copy, and
|
88
|
-
you may at your option offer warranty protection in exchange for a fee.
|
89
|
-
|
90
|
-
2. You may modify your copy or copies of the Program or any portion
|
91
|
-
of it, thus forming a work based on the Program, and copy and
|
92
|
-
distribute such modifications or work under the terms of Section 1
|
93
|
-
above, provided that you also meet all of these conditions:
|
94
|
-
|
95
|
-
a) You must cause the modified files to carry prominent notices
|
96
|
-
stating that you changed the files and the date of any change.
|
97
|
-
|
98
|
-
b) You must cause any work that you distribute or publish, that in
|
99
|
-
whole or in part contains or is derived from the Program or any
|
100
|
-
part thereof, to be licensed as a whole at no charge to all third
|
101
|
-
parties under the terms of this License.
|
102
|
-
|
103
|
-
c) If the modified program normally reads commands interactively
|
104
|
-
when run, you must cause it, when started running for such
|
105
|
-
interactive use in the most ordinary way, to print or display an
|
106
|
-
announcement including an appropriate copyright notice and a
|
107
|
-
notice that there is no warranty (or else, saying that you provide
|
108
|
-
a warranty) and that users may redistribute the program under
|
109
|
-
these conditions, and telling the user how to view a copy of this
|
110
|
-
License. (Exception: if the Program itself is interactive but
|
111
|
-
does not normally print such an announcement, your work based on
|
112
|
-
the Program is not required to print an announcement.)
|
113
|
-
|
114
|
-
These requirements apply to the modified work as a whole. If
|
115
|
-
identifiable sections of that work are not derived from the Program,
|
116
|
-
and can be reasonably considered independent and separate works in
|
117
|
-
themselves, then this License, and its terms, do not apply to those
|
118
|
-
sections when you distribute them as separate works. But when you
|
119
|
-
distribute the same sections as part of a whole which is a work based
|
120
|
-
on the Program, the distribution of the whole must be on the terms of
|
121
|
-
this License, whose permissions for other licensees extend to the
|
122
|
-
entire whole, and thus to each and every part regardless of who wrote it.
|
123
|
-
|
124
|
-
Thus, it is not the intent of this section to claim rights or contest
|
125
|
-
your rights to work written entirely by you; rather, the intent is to
|
126
|
-
exercise the right to control the distribution of derivative or
|
127
|
-
collective works based on the Program.
|
128
|
-
|
129
|
-
In addition, mere aggregation of another work not based on the Program
|
130
|
-
with the Program (or with a work based on the Program) on a volume of
|
131
|
-
a storage or distribution medium does not bring the other work under
|
132
|
-
the scope of this License.
|
133
|
-
|
134
|
-
3. You may copy and distribute the Program (or a work based on it,
|
135
|
-
under Section 2) in object code or executable form under the terms of
|
136
|
-
Sections 1 and 2 above provided that you also do one of the following:
|
137
|
-
|
138
|
-
a) Accompany it with the complete corresponding machine-readable
|
139
|
-
source code, which must be distributed under the terms of Sections
|
140
|
-
1 and 2 above on a medium customarily used for software interchange; or,
|
141
|
-
|
142
|
-
b) Accompany it with a written offer, valid for at least three
|
143
|
-
years, to give any third party, for a charge no more than your
|
144
|
-
cost of physically performing source distribution, a complete
|
145
|
-
machine-readable copy of the corresponding source code, to be
|
146
|
-
distributed under the terms of Sections 1 and 2 above on a medium
|
147
|
-
customarily used for software interchange; or,
|
148
|
-
|
149
|
-
c) Accompany it with the information you received as to the offer
|
150
|
-
to distribute corresponding source code. (This alternative is
|
151
|
-
allowed only for noncommercial distribution and only if you
|
152
|
-
received the program in object code or executable form with such
|
153
|
-
an offer, in accord with Subsection b above.)
|
154
|
-
|
155
|
-
The source code for a work means the preferred form of the work for
|
156
|
-
making modifications to it. For an executable work, complete source
|
157
|
-
code means all the source code for all modules it contains, plus any
|
158
|
-
associated interface definition files, plus the scripts used to
|
159
|
-
control compilation and installation of the executable. However, as a
|
160
|
-
special exception, the source code distributed need not include
|
161
|
-
anything that is normally distributed (in either source or binary
|
162
|
-
form) with the major components (compiler, kernel, and so on) of the
|
163
|
-
operating system on which the executable runs, unless that component
|
164
|
-
itself accompanies the executable.
|
165
|
-
|
166
|
-
If distribution of executable or object code is made by offering
|
167
|
-
access to copy from a designated place, then offering equivalent
|
168
|
-
access to copy the source code from the same place counts as
|
169
|
-
distribution of the source code, even though third parties are not
|
170
|
-
compelled to copy the source along with the object code.
|
171
|
-
|
172
|
-
4. You may not copy, modify, sublicense, or distribute the Program
|
173
|
-
except as expressly provided under this License. Any attempt
|
174
|
-
otherwise to copy, modify, sublicense or distribute the Program is
|
175
|
-
void, and will automatically terminate your rights under this License.
|
176
|
-
However, parties who have received copies, or rights, from you under
|
177
|
-
this License will not have their licenses terminated so long as such
|
178
|
-
parties remain in full compliance.
|
179
|
-
|
180
|
-
5. You are not required to accept this License, since you have not
|
181
|
-
signed it. However, nothing else grants you permission to modify or
|
182
|
-
distribute the Program or its derivative works. These actions are
|
183
|
-
prohibited by law if you do not accept this License. Therefore, by
|
184
|
-
modifying or distributing the Program (or any work based on the
|
185
|
-
Program), you indicate your acceptance of this License to do so, and
|
186
|
-
all its terms and conditions for copying, distributing or modifying
|
187
|
-
the Program or works based on it.
|
188
|
-
|
189
|
-
6. Each time you redistribute the Program (or any work based on the
|
190
|
-
Program), the recipient automatically receives a license from the
|
191
|
-
original licensor to copy, distribute or modify the Program subject to
|
192
|
-
these terms and conditions. You may not impose any further
|
193
|
-
restrictions on the recipients' exercise of the rights granted herein.
|
194
|
-
You are not responsible for enforcing compliance by third parties to
|
195
|
-
this License.
|
196
|
-
|
197
|
-
7. If, as a consequence of a court judgment or allegation of patent
|
198
|
-
infringement or for any other reason (not limited to patent issues),
|
199
|
-
conditions are imposed on you (whether by court order, agreement or
|
200
|
-
otherwise) that contradict the conditions of this License, they do not
|
201
|
-
excuse you from the conditions of this License. If you cannot
|
202
|
-
distribute so as to satisfy simultaneously your obligations under this
|
203
|
-
License and any other pertinent obligations, then as a consequence you
|
204
|
-
may not distribute the Program at all. For example, if a patent
|
205
|
-
license would not permit royalty-free redistribution of the Program by
|
206
|
-
all those who receive copies directly or indirectly through you, then
|
207
|
-
the only way you could satisfy both it and this License would be to
|
208
|
-
refrain entirely from distribution of the Program.
|
209
|
-
|
210
|
-
If any portion of this section is held invalid or unenforceable under
|
211
|
-
any particular circumstance, the balance of the section is intended to
|
212
|
-
apply and the section as a whole is intended to apply in other
|
213
|
-
circumstances.
|
214
|
-
|
215
|
-
It is not the purpose of this section to induce you to infringe any
|
216
|
-
patents or other property right claims or to contest validity of any
|
217
|
-
such claims; this section has the sole purpose of protecting the
|
218
|
-
integrity of the free software distribution system, which is
|
219
|
-
implemented by public license practices. Many people have made
|
220
|
-
generous contributions to the wide range of software distributed
|
221
|
-
through that system in reliance on consistent application of that
|
222
|
-
system; it is up to the author/donor to decide if he or she is willing
|
223
|
-
to distribute software through any other system and a licensee cannot
|
224
|
-
impose that choice.
|
225
|
-
|
226
|
-
This section is intended to make thoroughly clear what is believed to
|
227
|
-
be a consequence of the rest of this License.
|
228
|
-
|
229
|
-
8. If the distribution and/or use of the Program is restricted in
|
230
|
-
certain countries either by patents or by copyrighted interfaces, the
|
231
|
-
original copyright holder who places the Program under this License
|
232
|
-
may add an explicit geographical distribution limitation excluding
|
233
|
-
those countries, so that distribution is permitted only in or among
|
234
|
-
countries not thus excluded. In such case, this License incorporates
|
235
|
-
the limitation as if written in the body of this License.
|
236
|
-
|
237
|
-
9. The Free Software Foundation may publish revised and/or new versions
|
238
|
-
of the General Public License from time to time. Such new versions will
|
239
|
-
be similar in spirit to the present version, but may differ in detail to
|
240
|
-
address new problems or concerns.
|
241
|
-
|
242
|
-
Each version is given a distinguishing version number. If the Program
|
243
|
-
specifies a version number of this License which applies to it and "any
|
244
|
-
later version", you have the option of following the terms and conditions
|
245
|
-
either of that version or of any later version published by the Free
|
246
|
-
Software Foundation. If the Program does not specify a version number of
|
247
|
-
this License, you may choose any version ever published by the Free Software
|
248
|
-
Foundation.
|
249
|
-
|
250
|
-
10. If you wish to incorporate parts of the Program into other free
|
251
|
-
programs whose distribution conditions are different, write to the author
|
252
|
-
to ask for permission. For software which is copyrighted by the Free
|
253
|
-
Software Foundation, write to the Free Software Foundation; we sometimes
|
254
|
-
make exceptions for this. Our decision will be guided by the two goals
|
255
|
-
of preserving the free status of all derivatives of our free software and
|
256
|
-
of promoting the sharing and reuse of software generally.
|
257
|
-
|
258
|
-
NO WARRANTY
|
259
|
-
|
260
|
-
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
261
|
-
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
262
|
-
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
263
|
-
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
264
|
-
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
265
|
-
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
266
|
-
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
267
|
-
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
268
|
-
REPAIR OR CORRECTION.
|
269
|
-
|
270
|
-
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
271
|
-
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
272
|
-
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
273
|
-
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
274
|
-
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
275
|
-
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
276
|
-
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
277
|
-
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
278
|
-
POSSIBILITY OF SUCH DAMAGES.
|
279
|
-
|
280
|
-
END OF TERMS AND CONDITIONS
|
281
|
-
|
282
|
-
How to Apply These Terms to Your New Programs
|
283
|
-
|
284
|
-
If you develop a new program, and you want it to be of the greatest
|
285
|
-
possible use to the public, the best way to achieve this is to make it
|
286
|
-
free software which everyone can redistribute and change under these terms.
|
287
|
-
|
288
|
-
To do so, attach the following notices to the program. It is safest
|
289
|
-
to attach them to the start of each source file to most effectively
|
290
|
-
convey the exclusion of warranty; and each file should have at least
|
291
|
-
the "copyright" line and a pointer to where the full notice is found.
|
292
|
-
|
293
|
-
<one line to give the program's name and a brief idea of what it does.>
|
294
|
-
Copyright (C) <year> <name of author>
|
295
|
-
|
296
|
-
This program is free software; you can redistribute it and/or modify
|
297
|
-
it under the terms of the GNU General Public License as published by
|
298
|
-
the Free Software Foundation; either version 2 of the License, or
|
299
|
-
(at your option) any later version.
|
300
|
-
|
301
|
-
This program is distributed in the hope that it will be useful,
|
302
|
-
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
303
|
-
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
304
|
-
GNU General Public License for more details.
|
305
|
-
|
306
|
-
You should have received a copy of the GNU General Public License
|
307
|
-
along with this program; if not, write to the Free Software
|
308
|
-
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
309
|
-
|
310
|
-
|
311
|
-
Also add information on how to contact you by electronic and paper mail.
|
312
|
-
|
313
|
-
If the program is interactive, make it output a short notice like this
|
314
|
-
when it starts in an interactive mode:
|
315
|
-
|
316
|
-
Gnomovision version 69, Copyright (C) year name of author
|
317
|
-
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
318
|
-
This is free software, and you are welcome to redistribute it
|
319
|
-
under certain conditions; type `show c' for details.
|
320
|
-
|
321
|
-
The hypothetical commands `show w' and `show c' should show the appropriate
|
322
|
-
parts of the General Public License. Of course, the commands you use may
|
323
|
-
be called something other than `show w' and `show c'; they could even be
|
324
|
-
mouse-clicks or menu items--whatever suits your program.
|
325
|
-
|
326
|
-
You should also get your employer (if you work as a programmer) or your
|
327
|
-
school, if any, to sign a "copyright disclaimer" for the program, if
|
328
|
-
necessary. Here is a sample; alter the names:
|
329
|
-
|
330
|
-
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
331
|
-
`Gnomovision' (which makes passes at compilers) written by James Hacker.
|
332
|
-
|
333
|
-
<signature of Ty Coon>, 1 April 1989
|
334
|
-
Ty Coon, President of Vice
|
335
|
-
|
336
|
-
This General Public License does not permit incorporating your program into
|
337
|
-
proprietary programs. If your program is a subroutine library, you may
|
338
|
-
consider it more useful to permit linking proprietary applications with the
|
339
|
-
library. If this is what you want to do, use the GNU Library General
|
340
|
-
Public License instead of this License.
|