Skip to main content

Creating the Entity State Store

For Backstage to successfully discover catalog entities generated by SKE, your Kratix installation must be configured with a State Store and a Destination to write the Backstage entity data to.

The steps below assume you have a Kratix instance running, if you do not have Kratix deployed, please follow the installation instructions.

Configure the State Store​

You will need a Kratix State Store that Kratix will use to write the Backstage entity files. This will point to the s3 bucket or Git Repository you expect to populate with the entities. This can be a new State Store or one you have already created on your Platform Cluster.

You can see an example of both a BucketStateStore and GitStateStore below:

apiVersion: platform.kratix.io/v1alpha1
kind: BucketStateStore
metadata:
  name: backstage
spec:
  authMethod: accessKey
  bucketName: backstage-entities
  endpoint: YOUR_S3_ENDPOINT
  insecure: true
  secretRef:
    name: s3-credentials
    namespace: default

Configure a Destination for Backstage​

Next, create a Destination resource in Kratix. The Destination tells Kratix which state store to write entity data to, and under which path Backstage will look for it. Ensure the spec.stateStoreRef mirrors the kind and name of the State Store you created.

apiVersion: platform.kratix.io/v1alpha1
kind: Destination
metadata:
  name: backstage
  labels:
    environment: backstage
spec:
  stateStoreRef:
    kind: BucketStateStore
    name: backstage
  path: backstage
  strictMatchLabels: true
info

The path field determines the directory within the state store that Kratix writes entity files to. You will use this value when configuring catalog discovery in Backstage in the next step.

Next​

Kratix is now ready to write Backstage entity data to the state store.

In the next step you will configure Backstage to read its catalog from that same state store.