Kratix

https://github.com/syntasso/kratix
Admin
Kratix is an open-source platform framework created by Syntasso that combines the flexibility and...
Tokens:3,361
Snippets:55
Trust Score:7.5
License:Apache-2.0
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install golangci-lint

Source: https://github.com/syntasso/kratix/blob/main/CONTRIBUTING.md

Installs the required version of golangci-lint for linting Go code. Ensure the binary is in your PATH.

```bash
go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@v2.1.6
```

--------------------------------

### Test Promise Installation

Source: https://github.com/syntasso/kratix/blob/main/samples/easy-app/internal/README.md

Installs Kratix and then applies the promise.yaml to assert correct installation. Ensure kubectl is configured.

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

--------------------------------

### Install Paved Path Promise

Source: https://github.com/syntasso/kratix/blob/main/samples/easy-app/README.md

Use this command to install the Paved-Path Promise which includes Nginx and PostgreSQL.

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

--------------------------------

### Install PostgreSQL Promise

Source: https://github.com/syntasso/kratix/blob/main/samples/easy-app/internal/promises/postgresql/README.md

Installs the PostgreSQL Promise using kubectl. Ensure you have kubectl configured to interact with your Kratix environment.

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

--------------------------------

### Install NGINX Ingress Promise

Source: https://github.com/syntasso/kratix/blob/main/samples/easy-app/internal/promises/nginx-ingress/README.md

Install the NGINX Ingress Controller Promise by applying the provided YAML file to your Platform cluster.

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

--------------------------------

### Run Linting

Source: https://github.com/syntasso/kratix/blob/main/CONTRIBUTING.md

Executes the linting process for Go code using the installed golangci-lint tool.

```bash
make lint
```

--------------------------------

### Verify NGINX Ingress Promise Installation

Source: https://github.com/syntasso/kratix/blob/main/samples/easy-app/internal/promises/nginx-ingress/README.md

Verify that the NGINX Ingress Controller Promise has been successfully installed on a worker cluster by checking for the deployment.

```bash
kubectl get --namespace default deployment/nginx-nginx-ingress
```

--------------------------------

### Create Resource Request

Source: https://github.com/syntasso/kratix/blob/main/samples/easy-app/README.md

Apply this resource request to deploy the sample application and its dependencies.

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

--------------------------------

### Port Forward to Sample App

Source: https://github.com/syntasso/kratix/blob/main/samples/easy-app/README.md

Forward traffic to the Nginx service to access the deployed sample application locally. Ensure the 'Host: todo.example.com' header is set in your browser.

```bash
kubectl --context kind-worker port-forward svc/nginx-nginx-ingress 8080:80
```

--------------------------------

### Build Pipeline Image

Source: https://github.com/syntasso/kratix/blob/main/samples/easy-app/internal/README.md

Builds the Docker image for the pipeline. Execute this command from the project root.

```bash
./scripts/pipeline-image build
```

--------------------------------

### Build promise.yaml

Source: https://github.com/syntasso/kratix/blob/main/samples/easy-app/internal/README.md

Generates the promise.yaml file by interpolating resources into dependencies. Run this command in the project root.

```bash
./scripts/inject-deps
```

--------------------------------

### Run Work Creator with Specific Inputs

Source: https://github.com/syntasso/kratix/blob/main/work-creator/README.md

Execute the work creator tool, specifying the input directory for samples, and the promise and pipeline names. Ensure the input directory path is absolute.

```bash
go run cmd/main.go work-creator --input-directory=${PWD}/test/integration/samples --promise-name=yourPromise --pipeline-name=yourPipeline
```

--------------------------------

### Load Pipeline Image to Kind Cluster

Source: https://github.com/syntasso/kratix/blob/main/samples/easy-app/internal/README.md

Loads the built pipeline image into a local Kind cluster. Ensure Kind is running before executing.

```bash
./scripts/pipeline-image load
```

--------------------------------

### Test Resource Request

Source: https://github.com/syntasso/kratix/blob/main/samples/easy-app/internal/README.md

Applies a resource-request.yaml file and runs tests to validate resource request handling. Ensure kubectl is configured.

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

--------------------------------

### Push Pipeline Image to GHCR.io

Source: https://github.com/syntasso/kratix/blob/main/samples/easy-app/internal/README.md

Pushes the pipeline image to the GitHub Container Registry. Authentication may be required.

```bash
./scripts/pipeline-image push
```

--------------------------------

### SDK Interface Functions

Source: https://github.com/syntasso/kratix/blob/main/sdk/contract.md

Provides core functions for interacting with Kratix SDKs, including reading input, writing output and status, and accessing workflow information.

```APIDOC
## SDK Interface

### `ReadResourceInput() (Resource, error)`

Reads the file in `/kratix/input/object.yaml` and returns a Resource.

### `ReadPromiseInput() (Promise, error)`

Reads the file in `/kratix/input/object.yaml` and returns a Resource.

### `ReadDestinationSelectors() ([]DestinationSelector, error)`

Reads from file `/kratix/metadata/destination_selectors.yaml` and returns a list of DestinationSelector.

### `WriteOutput(string, []byte) error`

Writes the content to the specified file at the path `/kratix/output/filepath`.

### `WriteStatus(Status) error`

Writes the specified status to the `/kratix/metadata/status.yaml`.

### `WriteDestinationSelectors([]DestinationSelector) error`

Writes the specified Destination Selectors to the `/kratix/metadata/destination_selectors.yaml`.

### `WorkflowAction() string`

Returns the value of the `KRATIX_WORKFLOW_ACTION` environment variable.

### `WorkflowType() string`

Returns the value of the `KRATIX_WORKFLOW_TYPE` environment variable.

### `PromiseName() string`

Returns the value of the `KRATIX_PROMISE_NAME` environment variable.

### `IsPromiseWorkflow() bool`

Returns true if the `KRATIX_WORKFLOW_TYPE` environment variable is set to "promise".

### `IsResourceWorkflow() bool`

Returns true if the `KRATIX_WORKFLOW_TYPE` environment variable is set to "resource".

### `IsConfigureAction() bool`

Returns true if the `KRATIX_WORKFLOW_ACTION` environment variable is set to "configure".

### `IsDeleteAction() bool`

Returns true if the `KRATIX_WORKFLOW_ACTION` environment variable is set to "delete".

### `WriteSuspend(message string) error`

Suspends the Workflow by writing `workflow-control.yaml` with `suspend: true`. Kratix will stop any further pipeline execution and set the current pipeline execution phase to Suspended. If a message is provided, it will be surfaced in the object's status.

### `WriteRetryAfter(duration string, message string) error`

Configures the current pipeline to be retried after the given duration. The duration must be a valid Go duration string (e.g. "5m", "1h30m", "300ms"). Kratix will requeue this pipeline after the specified duration and increment the attempt counter in the object's status. If a message is provided, it will be surfaced in the object's status.

### `PipelineName() string`

Returns the value of the `KRATIX_PIPELINE_NAME` environment variable.

### `PublishStatus(Resource, Status) error`

Updates the status of the provided resource with the provided status.

### `ReadStatus() (Status, error)`

Reads the `/kratix/metadata/status.yaml`.
```

--------------------------------

### Request PostgreSQL Resource

Source: https://github.com/syntasso/kratix/blob/main/samples/easy-app/internal/promises/postgresql/README.md

Applies a resource request for the PostgreSQL Promise. This is used to provision a PostgreSQL instance, with a small default size.

```bash
kubectl apply -f https://raw.githubusercontent.com/syntasso/kratix-marketplace/main/postgresql/resource-request.yaml
```

--------------------------------

### Add Debugger to Promise Pipeline

Source: https://github.com/syntasso/kratix/blob/main/hack/kratix-pipeline-debugger-image/README.md

Include this image in your Promise pipeline to enable manual debugging. The pipeline will pause until you manually signal it to continue.

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

--------------------------------

### Resource Interface Functions

Source: https://github.com/syntasso/kratix/blob/main/sdk/contract.md

Provides functions for interacting with a Resource object, allowing retrieval of its attributes and status.

```APIDOC
## Resource Interface

### `GetValue(string) (any, error)`

Queries the resource and returns the value at the specified path e.g. `spec.dbConfig.size`.

### `GetStatus() (Status, error)`

Queries the resource and returns the `resource.status`.

### `GetName() string`

Queries the resource and returns the name.

### `GetNamespace() string`

Queries the resource and returns the namespace.

### `GetGroupVersionKind() schema.GroupVersionKind`

Queries the resource and returns the `GroupVersionKind`.

### `GetLabels() map[string]string`

Queries the resource and returns the labels.

### `GetAnnotations() map[string]string`

Queries the resource and returns the annotations.
```

--------------------------------

### Status Interface Functions

Source: https://github.com/syntasso/kratix/blob/main/sdk/contract.md

Provides helper functions for manipulating a structured status object.

```APIDOC
## Status Interface

### `Get(string) any`

Queries the Status and retrieves the value at the specified path e.g. `healthStatus.state`.

### `Set(string, any) error`

Updates the value at the specified path e.g. `healthStatus.state`.

### `Remove(string) error`

Removes the value at the specified path e.g. `healthStatus.state`.
```
Tokens:
Raw