Skip to content

Commit

Permalink
docs: aligning docs with multitenancy verbiage (#57)
Browse files Browse the repository at this point in the history
  • Loading branch information
galenmarchetti authored Jul 30, 2024
1 parent 20da94e commit 7c91a30
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 4 additions & 2 deletions website/app/docs/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@ export const metadata = {

# Introduction

Kardinal is an _open-source traffic routing and state isolation layer_ for Kubernetes that enables engineers to efficiently do development, test, and QA work within a single stable Kubernetes cluster.
Kardinal is an _open-source multitenancy framework_ for Kubernetes-deployed applications that enables engineers to efficiently do development, test, and QA work within a single stable Kubernetes cluster.

Previously, developers would spin up separate Kubernetes clusters where every resource is duplicated for development, test, and QA workflows. With Kardinal, developers deploy only the absolute minimum resources necessary to validate changes within a single, prod-like cluster.

Kardinal achieves this by rethinking the idea of isolated application deploys, and replacing them with logical environments with a single cluster, called [flows](concepts/flows). Every resource that can be shared between flows is shared at fine-grained level. This includes stateless microservices and any stateful dependencies like test databases, caches, and queues.
Kardinal achieves this by defining development "environments" by the path a request takes through a single cluster, in which every version of a service that is needed for development work across the team is deployed and available.

Within the cluster, services (including databases and queues) are reused as much as possible between separate development or testing workflows.

There are a few techniques outside of Kardinal for isolating dev, test, and QA environments. To see how Kardinal fits in to other options, see the table below:

Expand Down
4 changes: 1 addition & 3 deletions website/components/LandingPageTemplate.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,7 @@ const LandingPageTemplate = ({
fullWidthImageUrl={architectureDiagram}
mobileFullWidthImageUrl={architectureDiagramMobile}
>
Kardinal uses a sidecar - control plane architecture. Just drop sidecars
next to your services in your environment and configure your traffic
flows in the control plane.
Kardinal integrates with your existing distributed tracing, and will handle the heavy lifting of configuring a service mesh for traffic routing for you.
</Content>

<CTASmall heading={heading} myPrecious={iAmTheLordOfTheRings}>
Expand Down

0 comments on commit 7c91a30

Please sign in to comment.