Kratix Documentation

To verify that a Promise is installed correctly, first install Kratix, then apply the generated promise.yaml and run the test script targeting the promise type.

kubectl apply -f promise.yaml
./scripts/test promise

The NGINX Ingress Promise provides access to the NGINX Ingress Controller (NIC) in the global deployment configuration. Note that this Promise installs NGINX directly as part of the installation process; it is not provided 'as-a-Service', so there is no need to submit individual Resource Requests after installation.

To install, run the following command targeting your Platform cluster:

kubectl apply -f https://raw.githubusercontent.com/syntasso/kratix-marketplace/main/nginx-ingress/promise.yaml

To begin using Kratix, follow the official quick start guide to set up your environment and get the platform running. Detailed instructions are available at the Kratix documentation site.

https://docs.kratix.io/main/quick-start

To verify that the Promise is installed correctly, first install Kratix, then apply the generated promise.yaml and run the test script.

kubectl apply -f promise.yaml
./scripts/test promise

The kratix-pipeline-debugger image is a utility designed to pause a Promise pipeline execution. It waits for the presence of the file /tmp/continue before exiting with code 0. This allows you to SSH into the running container to perform manual troubleshooting, inspection, or debugging steps. Once you have completed your manual tasks, you can trigger the pipeline to proceed by creating the /tmp/continue file inside the container.

To use it, insert the debugger image as a step in your Promise pipeline definition.

- image: ghcr.io/syntasso/kratix-pipeline-debugger:v0.0.1
  name: manual-debug

The pipeline image relies on resources downloaded via ./scripts/fetch-pipeline-resources. You can build, load, or push the image using the pipeline-image script with the following commands:

./scripts/pipeline-image build
./scripts/pipeline-image load
./scripts/pipeline-image push

The Paved Path Demo is a Compound Promise designed to demonstrate how Kratix can encapsulate multiple resources into a single request. This specific Promise bundles Knative and PostgreSQL together. When a user sends a resource request to this Promise, Kratix automatically provisions both a new Knative Serving instance and a new PostgreSQL instance on the registered Destination.

Prerequisite: To use this Promise, the Kubernetes cluster where the resources should be deployed must be registered as a Destination within Kratix. If your cluster is not registered, refer to the Compound Promises guide in the official Kratix documentation to set up your platform.

To verify that resource requests are handled correctly by the Promise, apply a resource-request.yaml and run the test script targeting the resource-request type.

kubectl apply -f resource-request.yaml
./scripts/test resource-request

To install the 'App as a Service' Paved-Path Promise, apply the following YAML definition to your cluster.

Prerequisite: The Kubernetes cluster running Kratix must be registered as a Destination. If you haven't configured this, refer to the Kratix documentation on Compound Promises.

This is a compound Promise that orchestrates the installation of:

• Nginx-ingress
• Postgres
• A Deployment (which deploys the sample application to the Destination using the configured ingress)

kubectl create -f https://raw.githubusercontent.com/syntasso/kratix/main/samples/paved-path-nginx/promise.yaml

To add the PostgreSQL-as-a-Service capability to your Kratix instance, apply the Promise definition from the Kratix marketplace repository using kubectl.

kubectl apply -f https://raw.githubusercontent.com/syntasso/kratix-marketplace/main/postgresql/promise.yaml

Once the Promise is installed, you can make a resource request to deploy the sample application. This request deploys a sample Golang application to the configured Destination.

To make the request, apply the following resource request YAML:

kubectl apply -f https://raw.githubusercontent.com/syntasso/kratix/main/samples/paved-path-nginx/resource-request.yaml

The promise.yaml file is constructed by interpolating the contents of the resources/ directory into the dependencies section. Before building, ensure all required resources have been downloaded using ./scripts/fetch-deps. To generate the final promise.yaml, run the injection script.

./scripts/inject-deps