Content cache operators

A Juju charm deploying and managing a static web content cache with NGINX on VMs.

This machine charm manages a NGINX instance configured as a content cache. The configuration for the locations of cache is managed with the Content Cache Backends Config subordinate charm. Each Content Cache Backends Config charm stores the configuration for a location and the associated set of backends.

This charm should be used for caching static web content. When a client makes a request, this charm checks if the requested content is cached and valid. For an invalid cache, this charm will query the backends hosts for the content to refresh the cache. This process works well for static content that does not change based on the client. For this type of content, the cache can greatly reduce the load on the backend hosts.

Like any Juju charm, this charm supports one-line deployment, configuration, integration, scaling, and more. For content cache charm, this includes:

  • Support for multiple backends via the Content Cache Backends Config subordinate charm.

  • Support for HTTPS.

  • Observability with COS.

The charm simplifies the operation of an NGINX server as a static web content cache. This makes the charm suitable for users looking for a low maintenance way to reduce load on static websites.

In this documentation

How this documentation is organized

This documentation uses the Diátaxis documentation structure.

  • The Tutorial takes you step-by-step through a basic deployment of the content cache charm.

  • How-to guides assume you have basic familiarity with the content cache charm. Learn more about setting up, using, maintaining, and contributing to this charm.

  • Reference provides a guide to actions, configurations, relations, and other technical details.

  • Explanation includes topic overviews, background and context and detailed discussion.

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. See How to contribute for more information.

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 content cache charm is a member of the Ubuntu family. It’s an open-source project that warmly welcomes community projects, contributions, suggestions, fixes, and constructive feedback.

Governance and policies

Get involved

Thinking about using the content cache charm for your next project? Get in touch!