# Project Capsule

> Capsule is a multi-tenancy and policy-based framework for Kubernetes. It groups namespaces into tenants, lets tenant owners self-provision namespaces within the quotas, network, security and placement rules set by the cluster administrator, and ships with an optional API-server proxy (capsule-proxy) that scopes kubectl access to a tenant. This site is the project documentation at https://projectcapsule.dev.

Every page listed below is also published as Markdown. Append `index.md` to a page URL (for example `/docs/overview/index.md`), replace the trailing slash with `.md` (`/docs/overview.md`), or request the page URL with the header `Accept: text/markdown`. The HTML page is linked from each Markdown file.

## Documentation

- [Documentation](https://projectcapsule.dev/docs/index.md)
- [What's New ✨](https://projectcapsule.dev/docs/whats-new/index.md): Discover new features from the current version in one place.
- [Overview](https://projectcapsule.dev/docs/overview/index.md): Run multiple teams on a single Kubernetes cluster with strong isolation, self-service, and zero cluster sprawl.
- [Quickstart 🚀](https://projectcapsule.dev/docs/quickstart/index.md): Create your first Capsule Tenant and start using it
- [Quickstart 🚀 / Going Further](https://projectcapsule.dev/docs/quickstart/extended/index.md): Optional deep-dive into Capsule rules, permissions, and resource distribution.
- [Operating](https://projectcapsule.dev/docs/operating/index.md): Get started with using tenancy on Kubernetes
- [Operating / Setup](https://projectcapsule.dev/docs/operating/setup/index.md): Setting up your environment for Capsule
- [Operating / Setup / Installation](https://projectcapsule.dev/docs/operating/setup/installation/index.md): Installing the Capsule Controller
- [Operating / Setup / Configuration](https://projectcapsule.dev/docs/operating/setup/configuration/index.md): Understand the Capsule configuration options and how to use them.
- [Operating / Setup / Authentication](https://projectcapsule.dev/docs/operating/setup/authentication/index.md): Integrate Capsule with Authentication of your Kubernetes cluster
- [Operating / Setup / OpenShift](https://projectcapsule.dev/docs/operating/setup/openshift/index.md): How to install Capsule and the Capsule Proxy on OpenShift
- [Operating / Setup / Rancher](https://projectcapsule.dev/docs/operating/setup/rancher/index.md): How to install Capsule and the Capsule Proxy on Rancher
- [Operating / Setup / Managed Kubernetes](https://projectcapsule.dev/docs/operating/setup/managed-kubernetes/index.md): Capsule on managed Kubernetes offerings
- [Operating / Best Practices](https://projectcapsule.dev/docs/operating/best-practices/index.md): Best Practices when running Capsule in production
- [Operating / Best Practices / Admission Policies](https://projectcapsule.dev/docs/operating/best-practices/admission-policies/index.md): Recommended Admission Policies to enforce best practices in multi-tenant environments.
- [Operating / Best Practices / Workloads](https://projectcapsule.dev/docs/operating/best-practices/workloads/index.md): Define safe resource and security defaults for workloads running in tenant namespaces
- [Operating / Best Practices / Networking](https://projectcapsule.dev/docs/operating/best-practices/networking/index.md): Multi-Tenant Networking considerations
- [Operating / Best Practices / Container Images](https://projectcapsule.dev/docs/operating/best-practices/images/index.md): Multi-Tenant Container Images considerations
- [Operating / Concepts](https://projectcapsule.dev/docs/operating/concepts/index.md): Key design decisions, personas, templating, and metadata reference for Capsule
- [Operating / Concepts / Architecture](https://projectcapsule.dev/docs/operating/concepts/architecture/index.md): Architecture references and considerations
- [Operating / Concepts / Known Metadata](https://projectcapsule.dev/docs/operating/concepts/known-metadata/index.md): Labels and Annotations in Capsule Items
- [Operating / Concepts / Templating](https://projectcapsule.dev/docs/operating/concepts/templating/index.md): Templating in Capsule Items
- [Operating / Authentication](https://projectcapsule.dev/docs/operating/authentication/index.md): Integrate Capsule with Authentication of your Kubernetes cluster
- [Operating / Backup & Restore](https://projectcapsule.dev/docs/operating/backup-restore/index.md): Run Backups and Restores of Tenants
- [Operating / Day-2 Operations](https://projectcapsule.dev/docs/operating/operations/index.md): Monitoring, backup and restore, and troubleshooting for production Capsule clusters
- [Operating / Day-2 Operations / Monitoring](https://projectcapsule.dev/docs/operating/operations/monitoring/index.md): Monitoring Capsule Items and Tenants
- [Operating / Day-2 Operations / Backup & Restore](https://projectcapsule.dev/docs/operating/operations/backup-restore/index.md): Run Backups and Restores of Tenants
- [Tenants](https://projectcapsule.dev/docs/tenants/index.md): Understand principles and concepts of Capsule Tenants
- [Tenants / Namespaces](https://projectcapsule.dev/docs/tenants/namespaces/index.md): Namespace to Tenant relation
- [Tenants / Permissions](https://projectcapsule.dev/docs/tenants/permissions/index.md): Grant permissions for tenants
- [Tenants / Administration](https://projectcapsule.dev/docs/tenants/administration/index.md): Administrative controls on tenants
- [Tenants / Metadata](https://projectcapsule.dev/docs/tenants/metadata/index.md): Inherit additional metadata on Tenant resources.
- [Tenants / Rules](https://projectcapsule.dev/docs/tenants/rules/index.md): Configure policies and restrictions on a per-Namespace basis with Rules
- [Tenants / Enforcement](https://projectcapsule.dev/docs/tenants/enforcement/index.md): Configure policies and restrictions on tenant-basis
- [Tenants / Quotas](https://projectcapsule.dev/docs/tenants/quotas/index.md): Strategies on granting quotas on tenant-basis
- [Rules](https://projectcapsule.dev/docs/rules/index.md): Configure policies and restrictions on a per-Namespace basis with Rules
- [Rules / Enforcement](https://projectcapsule.dev/docs/rules/enforcement/index.md): Enforcement policies and restrictions on a per-Namespace basis with Rules
- [Rules / Enforcement / Metadata](https://projectcapsule.dev/docs/rules/enforcement/metadata/index.md): Metadata Enforcement
- [Rules / Enforcement / Workloads](https://projectcapsule.dev/docs/rules/enforcement/workloads/index.md): Workload enforcement
- [Rules / Enforcement / Services](https://projectcapsule.dev/docs/rules/enforcement/services/index.md): Service enforcement
- [Rules / Enforcement / Ingress](https://projectcapsule.dev/docs/rules/enforcement/ingress/index.md): Ingress enforcement
- [Replications](https://projectcapsule.dev/docs/replications/index.md): Replicate resources across tenants or namespaces
- [Replications / GlobalTenantResources](https://projectcapsule.dev/docs/replications/global/index.md): Replicate resources across tenants or namespaces as Cluster Administrator.
- [Replications / TenantResources](https://projectcapsule.dev/docs/replications/tenant/index.md): Replicate resources across a Tenant's Namespaces as Tenant Owner
- [Resource Management](https://projectcapsule.dev/docs/resource-management/index.md): Manage resources across tenants and namespaces, including replication, quotas, and limits with custom quota mechanisms.
- [Resource Management / GlobalResourceQuota](https://projectcapsule.dev/docs/resource-management/globalresourcequota/index.md): Share one atomic Kubernetes resource budget across multiple namespaces.
- [Resource Management / Resource Pools](https://projectcapsule.dev/docs/resource-management/resourcepools/index.md): Resource Pools are our answer to manage resources in a multi-tenant Kubernetes cluster. Strategies on granting quotas on tenant-basis
- [Resource Management / Custom Quotas](https://projectcapsule.dev/docs/resource-management/customquotas/index.md): CustomQuotas let you define and enforce arbitrary, label-scoped limits for any Kubernetes resource kind or CRD, at namespace or cluster scope.
- [Proxy](https://projectcapsule.dev/docs/proxy/index.md): Improve the User-Experience with the capsule-proxy
- [Proxy / Setup](https://projectcapsule.dev/docs/proxy/setup/index.md): Install and configure the Capsule Proxy
- [Proxy / Setup / Installation](https://projectcapsule.dev/docs/proxy/setup/installation/index.md): Installation guide for the capsule-proxy
- [Proxy / Setup / Controller Options](https://projectcapsule.dev/docs/proxy/setup/options/index.md): Configure the Capsule Proxy Controller
- [Proxy / ProxySettings](https://projectcapsule.dev/docs/proxy/proxysettings/index.md): Configure proxy settings for your tenants
- [Proxy / Reflection](https://projectcapsule.dev/docs/proxy/reflection/index.md): Leverage the RoleBinding Reflector to grant LIST capabilities to non-owners across namespaces.
- [Proxy / Gangplank](https://projectcapsule.dev/docs/proxy/gangplank/index.md): Capsule Integration with Gangplank
- [Proxy / API Reference](https://projectcapsule.dev/docs/proxy/reference/index.md): API Reference
- [API Reference](https://projectcapsule.dev/docs/reference/index.md): API Reference
## Adopters

- [Adopters](https://projectcapsule.dev/adopters/index.md)
## Ecosystem

- [Ecosystem](https://projectcapsule.dev/ecosystem/index.md)
- [Integrations](https://projectcapsule.dev/ecosystem/integrations/index.md): Integrate Capsule with other platforms and solutions
- [Integrations / ArgoCD](https://projectcapsule.dev/ecosystem/integrations/argocd/index.md): Capsule Integration with ArgoCD
- [Integrations / Crossplane](https://projectcapsule.dev/ecosystem/integrations/crossplane/index.md): Capsule Integration with Crossplane
- [Integrations / Dashboard](https://projectcapsule.dev/ecosystem/integrations/dashboard/index.md): Capsule Integration with Kubernetes Dashboard
- [Integrations / Envoy-Gateway](https://projectcapsule.dev/ecosystem/integrations/envoy-gateway/index.md): Capsule Integration with Envoy (Gateway API)
- [Integrations / External Secrets Operator](https://projectcapsule.dev/ecosystem/integrations/eso/index.md): Integrate shared and per-Tenant secret stores, generate passwords, and distribute credentials with Capsule.
- [Integrations / Headlamp](https://projectcapsule.dev/ecosystem/integrations/headlamp/index.md): Capsule Integration with Headlamp
- [Integrations / Kyverno](https://projectcapsule.dev/ecosystem/integrations/kyverno/index.md): Capsule integration with Kyverno
- [Integrations / Lens](https://projectcapsule.dev/ecosystem/integrations/lens/index.md): Capsule extension for Lens
- [Integrations / Monitoring](https://projectcapsule.dev/ecosystem/integrations/monitoring/index.md): Capsule integration with Monitoring Solutions
- [Integrations / OpenCost](https://projectcapsule.dev/ecosystem/integrations/opencost/index.md): OpenCost Integration for Tenants
- [Integrations / OpenSearch](https://projectcapsule.dev/ecosystem/integrations/opensearch/index.md): Provision OpenSearch tenants, roles, index policies, and writer credentials with Capsule.
- [Integrations / Openshift](https://projectcapsule.dev/ecosystem/integrations/openshift/index.md)
- [Integrations / Rancher](https://projectcapsule.dev/ecosystem/integrations/rancher/index.md)
- [Integrations / Tekton](https://projectcapsule.dev/ecosystem/integrations/tekton/index.md): Capsule integration with Tekton
- [Integrations / Teleport](https://projectcapsule.dev/ecosystem/integrations/teleport/index.md): Capsule Proxy integration with Teleport
- [Integrations / Velero](https://projectcapsule.dev/ecosystem/integrations/velero/index.md)
## Project

- [Project](https://projectcapsule.dev/project/index.md)
- [Resources](https://projectcapsule.dev/project/resources/index.md)
- [Community](https://projectcapsule.dev/project/community/index.md)
- [Contributions](https://projectcapsule.dev/project/contributions/index.md)
- [Contributions / Guidelines](https://projectcapsule.dev/project/contributions/guidelines/index.md): Guidelines for submitting changes to the Capsule project
- [Contributions / Adoption](https://projectcapsule.dev/project/contributions/adoption/index.md): Add your project/company to the list of adopters
- [Contributions / Addons](https://projectcapsule.dev/project/contributions/addons/index.md): Add your addon to the ecosystem
- [Governance](https://projectcapsule.dev/project/governance/index.md)
- [Branding](https://projectcapsule.dev/project/branding/index.md): Branding and logos for the project
- [Commitment](https://projectcapsule.dev/project/commitment/index.md): Commitment for the project
## Support

- [Support](https://projectcapsule.dev/support/index.md): Commercial support for Project Capsule