Content cache charms

This repository contains the code for two charms:

1. content-cache: A machine charm managing a nginx instance configured as a content cache. See the content-cache README for more information.
2. content-cache-backends-config: A subordinate charm providing the configuration required to expose a set of backend services. See the content-cache-backends-config README for more information.

For published user documentation, see the official Content cache charms documentation.

Repository layout

content-cache/                         # Principal machine charm that deploys and manages NGINX content cache
  src/                                 # Charm source code
  tests/                               # Unit and integration tests for content-cache

content-cache-backends-config/         # Subordinate charm for backend configuration
  src/                                 # Charm source code
  tests/                               # Unit and integration tests for content-cache-backends-config

docs/                                  # Product documentation

terraform/
  charm/
    content_cache/                     # Base Terraform module for deploying content-cache
    content_cache_backends_config/     # Base Terraform module for deploying content-cache-backends-config

Components

Component	Path	Role
content-cache	content-cache/	A machine charm managing a nginx instance configured as a content cache.
content-cache-backends-config	content-cache-backends-config/	A subordinate charm providing the configuration required to expose a set of backend services.

Charmhub

Name	Listing
content-cache	https://charmhub.io/content-cache
content-cache-backends-config	https://charmhub.io/content-cache-backends-config

Get started

To begin, refer to the in-repo Content Cache tutorial for step-by-step instructions. For component-specific context, see the content-cache README and the content-cache-backends-config README.

For Terraform-based deployments, use the component base modules in terraform/charm/content_cache/README.md and terraform/charm/content_cache_backends_config/README.md.

Integrations

See docs/reference/deployment-architecture.md and docs/reference/components.md for relations and deployment details.

Documentation

Our documentation is stored in the docs directory and can be viewed at https://canonical.com/juju/docs/content-cache-charms. It is based on the Canonical Sphinx Stack and hosted on Read the Docs. In structuring, the documentation employs the Diátaxis approach.

You may open a pull request with your documentation changes, or you can file a bug to provide constructive feedback or suggestions.

To run the documentation locally before submitting your changes:

cd docs
make run

GitHub runs automatic checks on the documentation to verify spelling, validate links and style guide compliance.

You can (and should) run the same checks locally:

make spelling
make linkcheck
make vale
make lint-md

Project and community

The Content Cache Project is a member of the Ubuntu family. It is an open source project that warmly welcomes community projects, contributions, suggestions, fixes and constructive feedback.

• Code of conduct
• Get support
• Issues
• Matrix

Licensing and trademark

See LICENSE.