Requesting a Resource

One of the components of a Kratix Promise is the api. api sets the contract between the Platform and its users, and it defines what properties the user can configure in the Promised service.

The request is a document Platform Users write, following the api contract, to request Resources from the Promised service. Each Promise has its own contract, so each Promise will have its own format.

Consider a Promise with the following api, paying special attention to the highlighted fields:

apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  name: someservice.example.promise.syntasso.io
spec:
  group: example.promise.syntasso.io
  names:
    kind: someservice
    plural: someservices
    singular: someservice
  scope: Namespaced
  versions:
    - name: v1
      served: true
      storage: true
      schema:
        openAPIV3Schema:
          type: object
          properties:
            spec:
              type: object
              properties:
                region: { type: string }
                storageGB: { type: integer }

The Schema in this Promise defines, as the contract, two properties under spec: a string region and a integer storageGB.

An example request to get a Resource from this Promise would look like:

# Promise spec.group and versions
apiVersion: example.promise.syntasso.io/v1

# Promise spec.names.kind
kind: someservice

# Name of this Resource
metadata:
  name: some-name

# From the spec.versions.v1 Schema
spec:
  region: some-region
  storageGB: 10

When applied to the platform cluster, Kratix will trigger the associated Workflows. For more details on the Workflows, see the Workflow reference.

For a in-depth exploration of requesting a Resource and Kratix Workflows, check the Writing a Promise guide.