Skip to content

Commit

Permalink
Merge pull request #407 from binford2k/community_fork
Browse files Browse the repository at this point in the history
Adding community fork section
  • Loading branch information
bastelfreak authored Jan 9, 2025
2 parents d71d316 + c31e2cd commit 7574dbc
Show file tree
Hide file tree
Showing 20 changed files with 283 additions and 11 deletions.
20 changes: 20 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ collections:
output: true
sponsors:
output: false
support:
output: false

# See https://fontawesome.com/search for the icon syntax
navigation:
Expand All @@ -42,6 +44,9 @@ navigation:
- title: Projects Overview
url: /projects/
icon: fas fa-signs-post
- title: OpenVox
url: /openvox/
icon: fas fa-meteor
- title: Plugins
url: /plugins/
icon: fas fa-puzzle-piece
Expand Down Expand Up @@ -79,6 +84,21 @@ footer:
- title: Dual license (CC BY-SA 4.0 + Apache 2.0)
url: /license/

subsections:
openvox:
- title: Quickstart
url: /openvox/quickstart/
icon: fas fa-hourglass-start
- title: Install
url: /openvox/install/
icon: fas fa-download
- title: Standards
url: /openvox/standards/
icon: fas fa-users-rays
- title: Support
url: /openvox/support/
icon: fas fa-headset

exclude: ["Gemfile", "Gemfile.lock", "LICENSE", "README.md", "CNAME", "vendor"]

plugins:
Expand Down
5 changes: 5 additions & 0 deletions _includes/nav.html
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@
</div>
</div>
</nav>

{% if page.subsection %}
{% include subsection.html %}
{% endif %}

<div class="container pt-3">
{% include breadcrumbs.html %}
</div>
12 changes: 12 additions & 0 deletions _includes/sponsor-card.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<div class="col-md-{{include.width}} d-flex align-items-stretch">
<div class="card">
<img class="card-img-top" src="{{ site.url }}{{ site.baseurl }}/static/images/{{include.vendor.logo}}" alt="Sponsored by {{include.vendor.name}}">
<div class="card-body d-flex flex-column">
{% if include.vendor.name %}
<h5 class="card-title">{{include.vendor.name}}</h5>
{% endif %}
<p class="card-text">{{include.vendor.content | markdownify }}</p>
<a href="{{include.vendor.website}}" class="btn btn-primary mt-auto">{{include.vendor.button}}</a>
</div>
</div>
</div>
11 changes: 11 additions & 0 deletions _includes/subsection.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<ul class="nav nav-tabs justify-content-end">
{% for link in site.subsections[page.subsection] %}
{% assign active = nil %}
{% if page.url contains link.url %}
{% assign active = 'active' %}
{% endif %}
<li class="nav-item">
<a class="nav-link {{ active }}" href="{{ link.url }}" data-proofer-ignore>{% if link.icon %}<i class="fa {{ link.icon }}"></i> {% endif %}{{ link.title }}</a>
</li>
{% endfor %}
</ul>
7 changes: 7 additions & 0 deletions _support/betadots.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
logo: sponsor-betadots.png
website: https://www.betadots.de/
button: betadots.de
---
betadots supports many Puppet and OpenVox users in EMEA region.
They offer training, custom development and consulting plans for both Puppet Enterprise and OpenVox.
8 changes: 8 additions & 0 deletions _support/overlook.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
logo: sponsor-overlook.png
website: https://overlookinfratech.com/
button: overlookinfratech.com
---

Overlook sponsored the original community builds.
They are longtime Puppet experts and offer OpenVox support plans and custom development options.
53 changes: 53 additions & 0 deletions openvox/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
layout: page
title: OpenVox Automation Framework
subsection: openvox
---

<div class="container">
<div class="row">
<div class="col align-self-center">
<p>
OpenVox is the modern open source implementation of the world's most capable configuration management platform -- trusted by everyone from the smallest hobbyist to operators of some of the largest commercial infrastructures in the business.
</p>
<p>
Try OpenVox as the engine powering your infrastructure deployment and configuration needs and see why it's the industry standard in resource abstraction and drift remediation.
</p>
</div>
<div class="col align-self-center">
<img class="img-fluid" src="/static/images/openvox/mannequin.png" />
</div>
</div>
<div class="row">
<div class="col">
<img class="img-fluid w-75" src="/static/images/openvox/fork.png" />
</div>
<div class="col align-self-center">
<p>
OpenVox started life as a Puppet™️ mirror by <a href="https://overlookinfratech.com/downloads/">Overlook InfraTech</a> to continue providing community packages when Perforce discontinued public packaging efforts in late Fall of 2024.
It soon became clear that they were also moving all further Puppet™️ development to internal forks and ceasing development on open source Puppet™️.
A community fork using Overlook InfraTech's packaging pipeline was the inevitable response.
</p>
<p>
We consider OpenVox a soft-fork because we intend to maintain downstream compatibility for as long as we are able.
As such, we've created a <i>Puppet™️ Standards Steering Committee</i> to set the direction of features and language evolutions and have invited Perforce to participate.
</p>
<p>
Find out more or get involved at our
<a href="https://github.com/openvoxproject">GitHub namespace</a>.
</p>
</div>
</div>
<div class="row">
<div class="col">
<p>
<i>You may see references to OpenPuppet, the OpenPuppet Project, OpenPhoenix, or other similar sounding names.
You may even see references to Overlook InfraTech.
These names all refer to the various stages in the evolution of this project, but what you are reading now is the most current information.</i>
</p>
<p>
<i>Photo by <a href="https://unsplash.com/photos/a-wooden-toy-holding-a-wooden-object-in-one-hand-Jj5KSZkQiok">Lidia Nemiroff</a></i>.
</p>
</div>
</div>
</div>
38 changes: 38 additions & 0 deletions openvox/install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
layout: page
title: Installing OpenVox
subsection: openvox
---

OpenVox package downloads are currently sponsored by [Overlook InfraTech](https://overlookinfratech.com).
Following Perforce's suggestions, these are straight rebuilds of the original packages with no branding or name changes.
Be aware that this will change as soon as the OpenVox pipelines are running.

🚨 Before you enable and install the packages, be forewarned that these are preliminary kick-the-tires packages only.
We do not yet have a fully robust test pipeline, although with the community interest that will be forthcoming.

## Installation

First enable the repository, based on your Linux distribution.
Choose the appropriate repo package from either of these locations and install it.

* Debian family:
* [https://apt.overlookinfratech.com](https://apt.overlookinfratech.com)
* RedHat family:
* [https://yum.overlookinfratech.com](https://yum.overlookinfratech.com)

Then install the packages you want.

* Debian
* `apt install puppet-agent`
* `apt install puppetserver`
* `apt install puppetdb`
* RedHat
* `yum install puppet-agent`
* `yum install puppetserver`
* `yum install puppetdb`

### Sponsorship

Many thanks to Lance and the [OSU Open Source Lab](https://osuosl.org).
They do so much for the open source world and deserve far far more recognition for it.
78 changes: 78 additions & 0 deletions openvox/quickstart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
---
layout: page
title: OpenVox Quickstart Guide
subsection: openvox
---

<img class="float-end w-33 mx-5 img-thumbnail shadow-lg" src="/static/images/openvox/workshop.jpg" />

As of now, OpenVox is effectively the same as the original Puppet™️ packages, aside from some minor build pipeline changes and package renaming.
This means that aside from the installation, all Puppet™️ docs and tutorials will still be completely applicable.

## Installation

Start by following the instructions on the [install page](/openvox/install) and installing the `puppet-agent` package only.
Then come back here to continue.

## Explore the resources on your system

Now that you have OpenVox installed, explore around and take a look at how it
sees your system.
This command will show you how OpenVox represents the current state of a specific kind of resource, in this case the `user` resources.
The output will be your first view of the Puppet™️ DSL (domain specific language).

```
# puppet resource user
```

Pick the name of one of your user resources and run again.
This shows the same output, but scoped to a single user.

```
# puppet resource user binford2k
```

Try a similar command with the `file` resource and the name of a file on your computer, maybe `/etc/hosts`.

```
# puppet resource file /etc/hosts
```

Now you see how OpenVox sees resources as the *type* and *title* of the resource and then a list of *attributes* of that resource.

Just for fun, try using `puppet resource` to list all the `file` resources.
This doesn't work because unlike users which are easily *enumerable*, all the files on a modern computer are not computationally feasible to enumerate.

## Manage state of a resource

You'll notice that the output of the `puppet resource` commands is extremely thorough.
That's because it's exhaustively describing all the state known about every resource.
Generally speaking, you don't really care about all the details.
When you write Puppet™️ code, you only need to describe the things you *do* care about.

Let's try that now. Create a *manifest*, or a source file of Puppet™️ code.

``` puppet
# hello.pp
file { '/tmp/foo':
ensure => file,
owner => 'root',
mode => '0664', # mode is a nerdy word for "permissions"
content => "Hello there from OpenVox!\n",
}
```

```
$ puppet apply hello.pp
```

Now examine `/tmp/foo` and see that it meets all the specifications you described in your manifest, including the string of content.

## Go forth and experiment!

As the OpenVox project matures, we will create more documentation, guides, and tutorials.
For the time being though, now you'll want to hop over to Puppet's own [documentation](http://puppet.com/docs) and go from there.

Please use the *Connect* resources in the menubar to engage with us and share any questions or thoughts you have!

<i>Photo by <a href="https://unsplash.com/photos/man-in-black-and-white-plaid-dress-shirt-wearing-black-framed-eyeglasses-tnYWFvk-frU">Carter Yocham</a></i>.
17 changes: 17 additions & 0 deletions openvox/standards.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
layout: page
title: Puppet™️ Standards Steering Committee
subsection: openvox
---

<img class="float-end w-33 mx-5 img-thumbnail shadow-lg" src="/static/images/openvox/fox-cubs.jpg" />

OpenVox is backwards compatible with the Puppet language and configuration files.
As we evolve, we intend to do so in ways that benefit the whole community of users, whether paid Perforce customers or open source OpenVox users.

To do this, we have established a standards steering committee which will make all major roadmap decisions on features and language design to ensure the maximum interoperability between the difference implementations of the Puppet standards.
As warranted, feedback from the broader community will be requested using Vox Pupuli's standard lazy consensus model.

This group represents the diverse interests involved in the project, from companies participating in OpenVox's development to Perforce to community users and developers.

<i>Photo by <a href="https://www.facebook.com/photo?fbid=2279692095485870&set=gm.877780715914184">Igor Shpilenok</a></i>.
21 changes: 21 additions & 0 deletions openvox/support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
layout: page
title: OpenVox Support Options
subsection: openvox
---

<img class="float-end w-33 mx-5 img-thumbnail shadow-lg" src="/static/images/openvox/dog.jpg" />

Vox Pupuli is an open source community group and offers no commercial support.
You are invited to connect with us using the options at the top of the page.
In the spirit of the open source ethos, you will find peer support from others in the ecosystem and we hope you stick around to help others solve their problems afterwards too.

If your business needs include enhanced commercial support, then connect with the friendly companies below who offer plans that might fit your needs.

<div class="row">
{% for sponsor in site.support %}
{% include sponsor-card.html width=6 vendor=sponsor %}
{% endfor %}
</div>

<i>Photo by <a href="https://unsplash.com/photos/grayscale-photo-of-person-and-dog-holding-hands-cbIKeuURaq8">Fabian Gieske</a></i>.
8 changes: 7 additions & 1 deletion projects.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
layout: default
layout: page
---

# Projects Overview
Expand Down Expand Up @@ -63,3 +63,9 @@ the [Hacktoberfest](https://hacktoberfest.com) project to see how it works.

* [See all projects participating in Hacktoberfest]({% include github-repo-search.html topic="hacktoberfest" %})


## OpenVox project

Like the mythical bird, OpenVox has risen from the ashes of what used to be Open Source Puppet.
We are still in the process of forming and architecting the governance, so follow this space, or just jump in and get involved at [its project space](https://github.com/openvoxproject).
You can also find out more using the *Projects* menu in the navbar.
11 changes: 1 addition & 10 deletions sponsoring/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,6 @@ companies sponsor our cloud/CI resources.

<div class="row">
{% for sponsor in site.sponsors %}
<div class="col-md-4 d-flex align-items-stretch">
<div class="card">
<img class="card-img-top" src="{{ site.url }}{{ site.baseurl }}/static/images/{{sponsor.logo}}" alt="Sponsored by {{sponsor.name}}">
<div class="card-body d-flex flex-column">
<h5 class="card-title">Sponsored by {{sponsor.name}}</h5>
<p class="card-text">{{sponsor.content | markdownify }}</p>
<a href="{{sponsor.website}}" class="btn btn-primary mt-auto">{{sponsor.button}}</a>
</div>
</div>
</div>
{% include sponsor-card.html width=4 vendor=sponsor %}
{% endfor %}
</div>
5 changes: 5 additions & 0 deletions static/css/site.css
Original file line number Diff line number Diff line change
Expand Up @@ -117,3 +117,8 @@ section.content {
.card {
margin: 1em 0;
}

/* bootstrap customizations */
.w-33 {
width: 33%!important;
}
Binary file added static/images/openvox/dog.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/openvox/fork.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/openvox/fox-cubs.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/openvox/mannequin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/openvox/workshop.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/sponsor-overlook.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7574dbc

Please sign in to comment.