Skip to content

Commit fae3987

Browse files
authored
Merge pull request #4 from OpenVoxProject/debrand
First pass at debranding
2 parents b0ab435 + f666917 commit fae3987

31 files changed

+137
-121
lines changed

README.md

Lines changed: 23 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,53 @@
1-
# Puppet
1+
# OpenVox
22

3-
![RSpec tests](https://github.com/puppetlabs/puppet/workflows/RSpec%20tests/badge.svg)
4-
[![Gem Version](https://badge.fury.io/rb/puppet.svg)](https://badge.fury.io/rb/puppet)
5-
[![Inline docs](https://inch-ci.org/github/puppetlabs/puppet.svg)](https://inch-ci.org/github/puppetlabs/puppet)
6-
7-
Puppet, an automated administrative engine for your Linux, Unix, and Windows systems, performs
3+
OpenVox is a community implementation of Puppet, an automated administrative engine for your Linux, Unix, and Windows systems, designed to perform
84
administrative tasks (such as adding users, installing packages, and updating server
95
configurations) based on a centralized specification.
106

117
## Documentation
128

13-
Documentation for Puppet and related projects can be found online at the
14-
[Puppet Docs site](https://puppet.com/docs).
9+
As of now, OpenVox is effectively the same as the original Puppet™️ packages, aside from some minor build pipeline changes and package renaming.
10+
This means that aside from the installation, all Puppet™️ docs and tutorials will still be completely applicable.
11+
As the OpenVox project matures, we will create more documentation, guides, and tutorials.
12+
For the time being though, now you’ll want to hop over to [Puppet’s own documentation](https://puppet.com/docs) and go from there.
1513

1614
### HTTP API
1715

1816
[HTTP API Index](https://puppet.com/docs/puppet/latest/http_api/http_api_index.html)
1917

2018
## Installation
2119

22-
The best way to run Puppet is with [Puppet Enterprise (PE)](https://puppet.com/products/puppet-enterprise/),
23-
which also includes orchestration features, a web console, and professional support.
24-
The PE documentation is [available here.](https://puppet.com/docs/pe/latest)
25-
26-
To install an open source release of Puppet,
27-
[see the installation guide on the docs site.](https://puppet.com/docs/puppet/latest/installing_and_upgrading.html)
20+
To install OpenVox,
21+
[see our installation guide.](https://voxpupuli.org/openvox/install/) and [quickstart page](https://voxpupuli.org/openvox/quickstart/).
2822

29-
If you need to run Puppet from source as a tester or developer,
23+
If you need to run OpenVox from source as a tester or developer,
3024
see the [Quick Start to Developing on Puppet](docs/quickstart.md) guide.
3125

3226
## Developing and Contributing
3327

3428
We'd love to get contributions from you! For a quick guide to getting your
3529
system setup for developing, take a look at our [Quickstart
36-
Guide](https://github.com/puppetlabs/puppet/blob/main/docs/quickstart.md). Once you are up and running, take a look at the
37-
[Contribution Documents](https://github.com/puppetlabs/.github/blob/main/CONTRIBUTING.md) to see how to get your changes merged
30+
Guide](docs/quickstart.md). Once you are up and running, take a look at the
31+
[Contribution Documents](https://github.com/OpenVoxProject/.github/blob/main/CONTRIBUTING.md) to see how to get your changes merged
3832
in.
3933

4034
For more complete docs on developing with Puppet, take a look at the
41-
rest of the [developer documents](https://github.com/puppetlabs/puppet/blob/main/docs/index.md).
35+
rest of the [developer documents](docs/index.md).
4236

4337
## Licensing
4438

45-
See [LICENSE](https://github.com/puppetlabs/puppet/blob/main/LICENSE) file. Puppet is licensed by Puppet, Inc. under the Apache license. Puppet, Inc. can be contacted at: [email protected]
39+
See [LICENSE](LICENSE) file. OpenVox is licensed by Vox Pupuli as a community maintained
40+
implementation of Puppet. Vox Pupuli can be contacted at: [email protected].
41+
Puppet itself is licensed by Puppet, Inc. under the Apache license. Puppet, Inc. can be contacted at: [email protected]
4642

4743
## Support
4844

49-
Please log issues in this project's [GitHub Issues](https://github.com/puppetlabs/puppet/issues). A [mailing
50-
list](https://groups.google.com/forum/?fromgroups#!forum/puppet-users) is
51-
available for asking questions and getting help from others, or if you prefer chat, we also have a [Puppet Community slack.](https://puppetcommunity.slack.com/)
45+
Please log issues in this project's [GitHub Issues](/issues).
46+
Other channels for getting help can be found at our
47+
[support page](https://voxpupuli.org/openvox/support/),
48+
including the mailing list and other community spaces available
49+
for asking questions and getting help from others.
50+
5251

5352
We use semantic version numbers for our releases and recommend that users stay
5453
as up-to-date as possible by upgrading to patch releases and minor releases as
@@ -60,9 +59,5 @@ a best-effort basis, until the previous major version is no longer maintained.
6059

6160
For example: If a security vulnerability is discovered in Puppet 8.1.1, we
6261
would fix it in the 8 series, most likely as 8.1.2. Maintainers would then make
63-
a best effort to backport that fix onto the latest Puppet 7 release.
64-
65-
Long-term support, including security patches and bug fixes, is available for
66-
commercial customers. Please see the following page for more details:
67-
68-
[Puppet Enterprise Support Lifecycle](https://puppet.com/docs/puppet-enterprise/product-support-lifecycle/)
62+
a best effort to backport that fix onto earlier releases that haven't reached
63+
their respective end-of-life dates.

lib/puppet/application/agent.rb

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ def preinit
8181
end
8282

8383
def summary
84-
_("The puppet agent daemon")
84+
_("The puppet agent daemon provided by OpenVox")
8585
end
8686

8787
def help
@@ -92,7 +92,7 @@ def help
9292
9393
SYNOPSIS
9494
--------
95-
Retrieves the client configuration from the Puppet master and applies it to
95+
Retrieves the client configuration from the OpenVox server and applies it to
9696
the local host.
9797
9898
This service may be run as a daemon, run periodically using cron (or something
@@ -366,7 +366,9 @@ def help
366366
367367
COPYRIGHT
368368
---------
369-
Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
369+
Copyright (c) 2011 Puppet Inc.
370+
Copyright (c) 2024 Vox Pupuli
371+
Licensed under the Apache 2.0 License
370372
371373
HELP
372374
end

lib/puppet/application/apply.rb

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ class Puppet::Application::Apply < Puppet::Application
3636
end
3737

3838
def summary
39-
_("Apply Puppet manifests locally")
39+
_("Apply Puppet manifests locally via OpenVox")
4040
end
4141

4242
def help
@@ -64,11 +64,10 @@ def help
6464
individual manifests.
6565
6666
When provided with a modulepath, via command line or config file, puppet
67-
apply can effectively mimic the catalog that would be served by puppet
68-
master with access to the same modules, although there are some subtle
67+
apply can effectively mimic the catalog that would be served by OpenVox
68+
server with access to the same modules, although there are some subtle
6969
differences. When combined with scheduling and an automated system for
70-
pushing manifests, this can be used to implement a serverless Puppet
71-
site.
70+
pushing manifests, this can be used to implement a serverless site.
7271
7372
Most users should use 'puppet agent' and 'puppet master' for site-wide
7473
manifests.
@@ -166,7 +165,9 @@ def help
166165
167166
COPYRIGHT
168167
---------
169-
Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
168+
Copyright (c) 2011 Puppet Inc.
169+
Copyright (c) 2024 Vox Pupuli
170+
Licensed under the Apache 2.0 License
170171
171172
HELP
172173
end

lib/puppet/application/describe.rb

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ class Puppet::Application::Describe < Puppet::Application
174174
option("--meta", "-m")
175175

176176
def summary
177-
_("Display help about resource types")
177+
_("Display help about resource types available to OpenVox")
178178
end
179179

180180
def help
@@ -185,7 +185,8 @@ def help
185185
186186
SYNOPSIS
187187
--------
188-
Prints help about Puppet resource types, providers, and metaparameters.
188+
Prints help about Puppet resource types, providers, and metaparameters
189+
installed on an OpenVox node.
189190
190191
191192
USAGE
@@ -225,7 +226,9 @@ def help
225226
226227
COPYRIGHT
227228
---------
228-
Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
229+
Copyright (c) 2011 Puppet Inc.
230+
Copyright (c) 2024 Vox Pupuli
231+
Licensed under the Apache 2.0 License
229232
230233
HELP
231234
end

lib/puppet/application/device.rb

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ def preinit
8181
end
8282

8383
def summary
84-
_("Manage remote network devices")
84+
_("Manage remote network devices via OpenVox")
8585
end
8686

8787
def help
@@ -92,7 +92,7 @@ def help
9292
9393
SYNOPSIS
9494
--------
95-
Retrieves catalogs from the Puppet master and applies them to remote devices.
95+
Retrieves catalogs from the OpenVox server and applies them to remote devices.
9696
9797
This subcommand can be run manually; or periodically using cron,
9898
a scheduled task, or a similar tool.
@@ -110,13 +110,13 @@ def help
110110
111111
DESCRIPTION
112112
-----------
113-
Devices require a proxy Puppet agent to request certificates, collect facts,
113+
Devices require a proxy OpenVox agent to request certificates, collect facts,
114114
retrieve and apply catalogs, and store reports.
115115
116116
117117
USAGE NOTES
118118
-----------
119-
Devices managed by the puppet-device subcommand on a Puppet agent are
119+
Devices managed by the puppet-device subcommand on an OpenVox agent are
120120
configured in device.conf, which is located at $confdir/device.conf by default,
121121
and is configurable with the $deviceconfig setting.
122122
@@ -222,7 +222,8 @@ def help
222222
223223
COPYRIGHT
224224
---------
225-
Copyright (c) 2011-2018 Puppet Inc., LLC
225+
Copyright (c) 2011-2018 Puppet Inc.,
226+
Copyright (c) 2024 Vox Pupuli
226227
Licensed under the Apache 2.0 License
227228
HELP
228229
end

lib/puppet/application/doc.rb

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ def preinit
5252
end
5353

5454
def summary
55-
_("Generate Puppet references")
55+
_("Generate Puppet references for OpenVox")
5656
end
5757

5858
def help
@@ -63,8 +63,7 @@ def help
6363
6464
SYNOPSIS
6565
--------
66-
Generates a reference for all Puppet types. Largely meant for internal
67-
Puppet Inc. use. (Deprecated)
66+
Generates a reference for all Puppet types. Largely meant for internal use. (Deprecated)
6867
6968
7069
USAGE
@@ -78,7 +77,7 @@ def help
7877
This deprecated command generates a Markdown document to stdout
7978
describing all installed Puppet types or all allowable arguments to
8079
puppet executables. It is largely meant for internal use and is used to
81-
generate the reference document available on the Puppet Inc. web site.
80+
generate the reference documents which can be posted to a website.
8281
8382
For Puppet module documentation (and all other use cases) this command
8483
has been superseded by the "puppet-strings"
@@ -111,7 +110,9 @@ module - see https://github.com/puppetlabs/puppetlabs-strings for more informati
111110
112111
COPYRIGHT
113112
---------
114-
Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
113+
Copyright (c) 2011 Puppet Inc.
114+
Copyright (c) 2024 Vox Pupuli
115+
Licensed under the Apache 2.0 License
115116
116117
HELP
117118
end

lib/puppet/application/filebucket.rb

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ class Puppet::Application::Filebucket < Puppet::Application
1616
attr_reader :args
1717

1818
def summary
19-
_("Store and retrieve files in a filebucket")
19+
_("Store and retrieve files in an OpenVox filebucket")
2020
end
2121

2222
def digest_algorithm
@@ -31,7 +31,7 @@ def help
3131
3232
SYNOPSIS
3333
--------
34-
A stand-alone Puppet filebucket client.
34+
A stand-alone OpenVox filebucket client.
3535
3636
3737
USAGE
@@ -41,7 +41,7 @@ def help
4141
[-f|--fromdate <date>] [-t|--todate <date>] [-b|--bucket <directory>]
4242
<file> <file> ...
4343
44-
Puppet filebucket can operate in three modes, with only one mode per call:
44+
This filebucket client can operate in three modes, with only one mode per call:
4545
4646
backup:
4747
Send one or more files to the specified file bucket. Each sent file is
@@ -120,8 +120,7 @@ def help
120120
* --local:
121121
Use the local filebucket. This uses the default configuration
122122
information and the bucket located at the '$clientbucketdir'
123-
setting by default. If '--bucket' is set, puppet uses that
124-
path instead.
123+
setting by default. If '--bucket' is set, that path is used instead.
125124
126125
* --remote:
127126
Use a remote filebucket. This uses the default configuration
@@ -207,7 +206,9 @@ def help
207206
208207
COPYRIGHT
209208
---------
210-
Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
209+
Copyright (c) 2011 Puppet Inc.
210+
Copyright (c) 2024 Vox Pupuli
211+
Licensed under the Apache 2.0 License
211212
212213
HELP
213214
end

lib/puppet/application/lookup.rb

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ def setup
101101
end
102102

103103
def summary
104-
_("Interactive Hiera lookup")
104+
_("Interactive Hiera lookup for OpenVox")
105105
end
106106

107107
def help
@@ -115,8 +115,8 @@ def help
115115
Does Hiera lookups from the command line.
116116
117117
Since this command needs access to your Hiera data, make sure to run it on a
118-
node that has a copy of that data. This usually means logging into a Puppet
119-
Server node and running 'puppet lookup' with sudo.
118+
node that has a copy of that data. This usually means logging into an OpenVox
119+
server node and running 'puppet lookup' with sudo.
120120
121121
The most common version of this command is:
122122
@@ -264,7 +264,9 @@ def help
264264
265265
COPYRIGHT
266266
---------
267-
Copyright (c) 2015 Puppet Inc., LLC Licensed under the Apache 2.0 License
267+
Copyright (c) 2015 Puppet Inc.
268+
Copyright (c) 2024 Vox Pupuli
269+
Licensed under the Apache 2.0 License
268270
269271
270272
HELP

lib/puppet/application/resource.rb

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ def preinit
3535
end
3636

3737
def summary
38-
_("The resource abstraction layer shell")
38+
_("The OpenVox resource abstraction layer shell")
3939
end
4040

4141
def help
@@ -46,7 +46,7 @@ def help
4646
4747
SYNOPSIS
4848
--------
49-
Uses the Puppet RAL to directly interact with the system.
49+
Uses the OpenVox RAL to directly interact with the system.
5050
5151
5252
USAGE
@@ -137,7 +137,9 @@ def help
137137
138138
COPYRIGHT
139139
---------
140-
Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
140+
Copyright (c) 2011 Puppet Inc.
141+
Copyright (c) 2024 Vox Pupuli
142+
Licensed under the Apache 2.0 License
141143
142144
HELP
143145
end

lib/puppet/application/script.rb

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,9 @@ def help
107107
108108
COPYRIGHT
109109
---------
110-
Copyright (c) 2017 Puppet Inc., LLC Licensed under the Apache 2.0 License
110+
Copyright (c) 2017 Puppet Inc.
111+
Copyright (c) 2024 Vox Pupuli
112+
Licensed under the Apache 2.0 License
111113
112114
HELP
113115
end

0 commit comments

Comments
 (0)