DOCSEARCHbyAlgolia
Submit Docs

Kratix Documentation

website·Indexed 34 days ago

https://docs.kratix.io/

Kratix is a platform for defining and managing APIs using Kubernetes Custom Resource Definitions (CRDs) and a Promise API. It leverages Kubernetes RBAC for access control and provides Promise-writing SDKs for Go and Python. The platform features a resiliency model based on reconciliation and eventual consistency, supports multi-tenancy via Kubernetes namespaces, and includes a CLI for managing resources and workflows.

Tokens
169.2K
Snippets
671
Records
1.1K
Agent score
66%

What's inside Kratix

  1. Overview of the Kratix platform framework

    Kratix is an open-source platform orchestrator and framework used to build tailored internal developer platforms. It enables platform teams to deliver resources as-a-service via APIs, embedding security, compliance, and governance rules directly into automated workflows. It is designed to reduce manual ticketing, prevent 'Shadow IT', and manage platform resources as a unified, automated fleet to reduce operational overhead.

  3. Overview of SKE Health Agent

    The SKE Health Agent is a health check agent installed in Kubernetes Destinations. It is responsible for scheduling the execution of Health Check Workflows from the Destination and persisting the resulting health check data into a state store.

  4. Overview of Kratix

    Kratix is a framework designed to facilitate the co-creation of capabilities between application and platform teams. It establishes a clear contract through the definition and creation of "Promises," empowering platform engineers to build more effective platforms.

  5. Overview of SKE GUI

    The SKE GUI is a user interface designed for viewing and managing Kratix Promises and Resources. It provides platform engineers with a unified view of the entire platform, allowing them to monitor resources and their states at a glance.

  6. Overview of Syntasso Kratix Enterprise (SKE)

    Syntasso Kratix Enterprise (SKE) is an enterprise-grade version of Kratix designed for enterprise environments. It provides enhanced security, dedicated business-hours support, and specialized integrations. Key features include:

    • Long-lived, at-scale testing
    • Fully supported integrations with Backstage and Terraform Enterprise / HCP Terraform
    • Secure software base images and software supply chain validation
    • A package of core Promises and key enterprise integrations (currently under development)

  7. Overview of SKE Aspects and Integrations

    SKE Aspects are pre-built pipeline images that can be integrated into Kratix Promises to support specific use-cases and tool integrations. Available integrations include:

    • Terraform Enterprise/Cloud: Via the SKE TF State Finder Aspect for Hashicorp Cloud Platform integration.
    • Backstage: Integration via the SKE plugin and Portal Controller to auto-populate the Backstage catalog.
    • Cortex: Integration via the SKE Integration CRD and Portal Controller to manage Entities and Workflows for Resource Requests.
    • Portal Controller: A unified integration used to sync Promises and Resources into developer portals like Backstage or Cortex.
    • Port: Managed via the SKE Port Controller to align Port configuration with platform APIs (distinct from the Portal Controller).
    • SKE Lift: A set of agent skills and CLI plugins used to migrate an existing cloud estate into governed Kratix Promises.

  9. Overview of Kratix MCP Server

    The Kratix MCP Server allows AI agents to interact with a Kratix platform by browsing Promises, checking Destinations, and submitting requests using the Model Context Protocol. It runs inside the Kubernetes cluster in the kratix-platform-system namespace and is available in both Syntasso Kratix Enterprise (SKE) and Syntasso Kratix Agentic (SKA).

  10. Overview of the Portal Controller integration

    The Portal Controller is a unified integration that syncs Kratix Promises and Resource requests into developer portals such as Backstage or Cortex. It replaces the deprecated standalone Backstage and Cortex controllers. It allows platform teams to connect to multiple portals via a single SKEIntegration, publish Promises and Resources as entities, and route developer requests through review processes (e.g., pull requests) instead of direct application.

  11. Overview of the SKE Platform Architecture

    The SKE Platform consists of a central Platform Cluster and one or more Worker Clusters. The Platform Cluster is where Kratix is installed, where Promises are managed, and where user requests are received. Kratix schedules workloads to Destinations (Worker Clusters) via a State Store (such as a Git Repository or S3-Compatible storage). Worker Clusters monitor the State Store for changes and apply them using a local GitOps Agent.

  12. Overview of the kratix-go SDK

    The kratix-go SDK is used for writing Kratix promises. It provides capabilities for resource management (reading/writing resources and promises), status handling (updating resource status and writing status files), output generation for workflows, destination selector configuration, and access to workflow context via environment variables (such as action, type, promise name, and pipeline name). It also includes built-in testing utilities and mocks.