Core
PaaS v2.x
2

Kuzzle PaaS #

Kuzzle PaaS is a managed platform for hosting Kuzzle-based applications and related services in isolated environments.

It is designed for teams that want to build and deploy their application code while Kuzzle operates the underlying infrastructure: Kubernetes namespaces, DNS, TLS, container registry integration, monitoring, backups and default service configuration.

Core concepts #

Project #

A project is the main isolation boundary in Kuzzle PaaS. It groups environments, configuration, container images, monitoring resources and access rights for one customer, product or initiative.

In the API, a project is represented as a Kuzzle tenant.

Environment #

An environment belongs to a project and contains one or more applications. Typical environments are dev, staging and production.

Each environment has a size, a lifecycle status and optional Keycloak configuration.

Application #

An application is a deployable component inside an environment.

Supported application types include:

  • kuzzle
  • kuzzleES8
  • webapp
  • custom

Applications are deployed through ArgoCD and can be updated, disabled, enabled, deleted or redeployed with a new Docker image.

Managed services #

Kuzzle PaaS integrates several managed services around your applications.

Private package registry #

Licensed Kuzzle packages are distributed through the private package registry.

See Access private packages.

Container registry #

Each project can use private container images stored in the Kuzzle PaaS registry.

The public API exposes project image listing endpoints so CI/CD tools and deployment scripts can discover available images.

Monitoring and alerting #

Projects can be connected to monitoring dashboards and Slack alert webhooks.

See Monitoring and alerts API.

Keycloak #

Kuzzle PaaS can provision a Keycloak realm for an environment and expose logout URL generation through the API.

Public API #

The backend exposes public controllers for project, environment and application management.

Start with API overview.

Responsibility split #

AreaYou handleKuzzle PaaS handles
Application codeDevelopment, tests, business logic
Container imagesBuild and push imagesRegistry integration
DeploymentsTrigger deployments through API or CI/CDArgoCD synchronization and Kubernetes resources
InfrastructureCluster operations, TLS, DNS, storage and monitoring
OperationsAlert routing and project usersPlatform maintenance and managed services

Community #