Hockeypuck Documentation Overview

Hockeypuck K8s Operator

A Juju charm deploying and managing Hockeypuck on Kubernetes. Hockeypuck is an OpenPGP public keyserver tool used to manage public key infrastructure for PGP (Pretty Good Privacy). PGP is a system for securing communication through encryption and digital signatures.

The server provides interfaces to add, look up, replace and delete public keys from the keyserver. Hockeypuck can synchronize public key material with SKS (Synchronizing Key Server) and other Hockeypuck servers. It implements the HTTP Keyserver Protocol and the SKS database reconciliation protocol.

For DevOps and SRE teams, this charm will make operating Hockeypuck simple and straightforward through Juju’s clean interface.

In this documentation

Tutorials
Get started - a hands-on introduction to using the charm for new users
How-to guides
Step-by-step guides covering key operations and common tasks
Reference
Technical information - specifications, APIs, architecture
Explanation
Concepts - discussion and clarification of key topics

Contributing to this documentation

Documentation is an important part of this project, and we take the same open-source approach to the documentation as the code. As such, we welcome community contributions, suggestions and constructive feedback on our documentation. Our documentation is hosted on the Charmhub forum to enable easy collaboration. Please use the “Help us improve this documentation” links on each documentation page to either directly change something you see that’s wrong, ask a question or make a suggestion about a potential change via the comments section.

If there’s a particular area of documentation that you’d like to see that’s missing, please file a bug.

Project and community

The Hockeypuck K8s Operator is a member of the Ubuntu family. It’s an open-source project that warmly welcomes community projects, contributions, suggestions, fixes, and constructive feedback.

Thinking about using the Hockeypuck K8s Operator for your next project? Get in touch!

Navigation

Level Path Navlink
1 changelog Changelog
1 explanation Explanation
2 explanation-charm-architecture Charm architecture
2 explanation-security Security
1 how-to How To
2 how-to-backup-and-restore-hockeypuck Back up and restore
2 how-to-contribute How to contribute
2 how-to-integrate-with-cos Integrate with COS
2 how-to-manage-admin-keys Manage admin keys in Hockeypuck
2 how-to-manage-gpg-keys Manage GPG keys
2 how-to-reconcile-between-two-keyservers Reconcile between two keyservers
2 how-to-upgrade Upgrade
1 reference Reference
2 reference-actions Actions
2 reference-configurations Configurations
2 reference-integrations Integrations
2 reference-metrics ## Metrics
2 reference-ports Hockeypuck ports
1 tutorial Tutorial
2 tutorial-getting-started Deploy the Hockeypuck charm for the first time