Skip to content

Commit 6627da5

Browse files
committed
rename gem to openvoxserver-ca and consume openfact gem rather than facter
- rename and update gemspec and docs to reflect new gem name and the move to community maintenance under the OpenVox Project - includes changes by Romain Tartière <romain@blogreen.org>
1 parent 382cf18 commit 6627da5

4 files changed

Lines changed: 28 additions & 35 deletions

File tree

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
/pkg/
77
/spec/reports/
88
/tmp/
9-
puppetserver-ca-*.gem
9+
openvoxserver-ca-*.gem
1010
Gemfile.lock
1111

1212
# rspec failure tracking

CONTRIBUTING.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,15 @@
11
# Contributing
22

3-
Issues should be filed in the Puppet Server project of Puppetlabs' JIRA instance:
4-
...
5-
3+
Issues should be filed in [openvox-server GitHub Issues](https://github.com/OpenVoxProject/openvox-server/issues).
64

75
All changes should have appropriate unit tests.
86

9-
107
Commits should follow the format of:
118
```
12-
(SERVER-XXXX) Imperative statement
9+
Imperative statement
1310
1411
Longer description broken into paragraphs for what existed previously,
1512
why that was undesirable, what changed and why it is desirable.
1613
```
1714

18-
Where `SERVER-XXXX` is an issue number from JIRA. If there is no ticket that
19-
matches the contribution please use `(maint)` instead.
20-
21-
Feel free to submit Pull Requests for any issue that interests you, but
22-
please be aware that requests not linked to prioritize work within our
23-
tracker will be responded to as we have time.
15+
Feel free to submit Pull Requests for any issue that interests you.

README.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
# Puppet Server's CA CLI Library
1+
# OpenVox Server's CA CLI Library
22

3-
This gem provides the functionality behind the Puppet Server CA interactions.
4-
The actual CLI executable lives within the Puppet Server project.
3+
This gem provides the functionality behind the OpenVox Server CA interactions.
4+
The actual CLI executable lives within the OpenVox Server project.
5+
This is a community implementation of the `puppetserver-ca` gem.
56

67

78
## Installation
89

910
You may install it yourself with:
1011

11-
$ gem install puppetserver-ca
12+
$ gem install openvoxserver-ca
1213

1314

1415
## Usage
@@ -26,9 +27,9 @@ To import a custom CA:
2627
puppetserver ca import --cert-bundle certs.pem --crl-chain crls.pem --private-key ca_key.pem
2728
```
2829

29-
The remaining actions provided by this gem require a running Puppet Server, since
30+
The remaining actions provided by this gem require a running OpenVox Server (Puppet Server), since
3031
it primarily uses the CA's API endpoints to do its work. The following examples
31-
assume that you are using the gem packaged within Puppet Server.
32+
assume that you are using the gem packaged within OpenVox Server.
3233

3334
To sign a pending certificate request:
3435
```
@@ -71,7 +72,7 @@ puppetserver ca --help
7172
```
7273

7374
This code in this project is licensed under the Apache Software License v2,
74-
please see the included [License](https://github.com/puppetlabs/puppetserver-ca-cli/blob/main/LICENSE.md)
75+
please see the included [License](https://github.com/OpenVoxProject/openvoxserver-ca-cli/blob/main/LICENSE.md)
7576
for more details.
7677

7778

@@ -85,19 +86,19 @@ To install this gem onto your local machine, run `bundle exec rake install`.
8586

8687
### Testing
8788
To test your changes on a VM:
88-
1. Build the gem with your changes: `gem build puppetserver-ca.gemspec`
89-
1. Copy the gem to your VM: `scp puppetserver-ca-<version>.gem <your-vm>:.`
90-
1. Install puppetserver (FOSS) by installing the relevant release package and then installing the puppetserver package. For example:
89+
1. Build the gem with your changes: `gem build openvoxserver-ca.gemspec`
90+
1. Copy the gem to your VM: `scp openvoxserver-ca-<version>.gem <your-vm>:.`
91+
1. Install openvox-server by installing the relevant release package and then installing the openvox-server package. For example:
9192
```
92-
$ wget http://nightlies.puppet.com/yum/puppet-nightly-release-el-7.noarch.rpm
93-
$ rpm -i puppet-nightly-release-el-7.noarch.rpm
93+
$ wget https://yum.voxpupuli.org/openvox8-release-el-9.noarch.rpm
94+
$ rpm -i openvox8-release-el-9.noarch.rpm
9495
$ yum update
95-
$ yum install -y puppetserver
96+
$ yum install -y openvox-server
9697
```
9798
1. Restart your shell so that puppet's bin dir is on your $PATH: `exec bash`
9899
1. Install the gem into puppet's gem directory using puppet's gem command:
99100
```
100-
$ /opt/puppetlabs/puppet/bin/gem install --install-dir "/opt/puppetlabs/puppet/lib/ruby/vendor_gems" puppetserver-ca-<version>.gem
101+
$ /opt/puppetlabs/puppet/bin/gem install --install-dir "/opt/puppetlabs/puppet/lib/ruby/vendor_gems" openvoxserver-ca-<version>.gem
101102
```
102103
1. To confirm that installation was successful, run `puppetserver ca --help`
103104
@@ -107,11 +108,11 @@ Bug reports and feature requests are welcome via GitHub issues.
107108
108109
For interactive questions feel free to post to #puppet or #puppet-dev on the Puppet Community Slack channel.
109110
110-
Contributions are welcome at https://github.com/puppetlabs/puppetserver-ca-cli/pulls.
111+
Contributions are welcome at https://github.com/OpenVoxProject/openvoxserver-ca-cli/pulls.
111112
Contributors should both be sure to read the
112-
[contributing document](https://github.com/puppetlabs/puppetserver-ca-cli/blob/main/CONTRIBUTING.md)
113+
[contributing document](https://github.com/OpenVoxProject/openvoxserver-ca-cli/blob/main/CONTRIBUTING.md)
113114
and sign the [contributor license agreement](https://cla.puppet.com/).
114115
115116
Everyone interacting with the project’s codebase, issue tracker, etc is expected
116117
to follow the
117-
[code of conduct](https://github.com/puppetlabs/puppetserver-ca-cli/blob/main/CODE_OF_CONDUCT.md).
118+
[code of conduct](https://github.com/OpenVoxProject/openvoxserver-ca-cli/blob/main/CODE_OF_CONDUCT.md).
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
44
require "puppetserver/ca/version"
55

66
Gem::Specification.new do |spec|
7-
spec.name = "puppetserver-ca"
7+
spec.name = "openvoxserver-ca"
88
spec.version = Puppetserver::Ca::VERSION
9-
spec.authors = ["Puppet, Inc."]
10-
spec.email = ["release@puppet.com"]
9+
spec.authors = ["OpenVox Project"]
10+
spec.email = ["openvox@voxpupuli.org"]
1111
spec.license = "Apache-2.0"
1212

13-
spec.summary = %q{A simple CLI tool for interacting with Puppet Server's Certificate Authority}
14-
spec.homepage = "https://github.com/puppetlabs/puppetserver-ca-cli/"
13+
spec.summary = %q{A simple CLI tool for interacting with OpenVox Server's Certificate Authority}
14+
spec.homepage = "https://github.com/OpenVoxProject/openvoxserver-ca/"
1515

1616
spec.files = `git ls-files -z`.split("\x0").reject do |f|
1717
f.match(%r{^(test|spec|features)/})
@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
2020
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
2121
spec.require_paths = ["lib"]
2222

23-
spec.add_runtime_dependency "facter", [">= 2.0.1", "< 5"]
23+
spec.add_runtime_dependency "openfact", [">= 5.0.0", "< 6"]
2424

2525
spec.add_development_dependency "bundler", ">= 1.16"
2626
spec.add_development_dependency "rake", ">= 12.3.3"

0 commit comments

Comments
 (0)