The types you can request

For feature teams. This page lists the types that the examples of this guide use, grouped by category. Your platform can offer other types.

See the types on your platform

Each entry of the file has a type. The control plane publishes the allowed types in its schema. The request needs no token. This command shows every line of the schema that lists allowed values:

curl -s "$JOOMIZ_SERVER_URL/schema" | grep '"enum" : \[ "'

You see:

          "enum" : [ "java-web-application", "kotlin-web-application" ]
          "enum" : [ "checkmarx", "renovate" ]
                  "enum" : [ "pull-request", "push", "schedule" ],
                  "enum" : [ "low", "medium", "high", "critical" ],
          "enum" : [ "container-image", "jar", "kong-oas" ]
          "enum" : [ "cloud-foundry-space", "kong-gateway", "kubernetes-namespace" ]
          "enum" : [ "cloud-foundry-app", "kong-api", "kubernetes-deployment" ]
          "enum" : [ "azure-key-vault", "postgres" ]
                  "enum" : [ "premium" ],
          "enum" : [ "kafka-topic", "splunk-index" ]
              "enum" : [ "pull-request", "push", "schedule" ],
              "enum" : [ "low", "medium", "high", "critical" ],
              "enum" : [ "premium" ],

Each line lists the allowed values of one key. Look for the type names that you know. For example, container-image, jar and kong-oas are the artifact types. The lines with low and premium list the values of one setting.

The editor extension reads the same schema. Which types can you use explains why the list differs between platforms.

Tools

A tool goes in the tooling list. Declare artifacts and tooling explains it.

Type	What it is	Required settings
`renovate`	Automated dependency updates	`schedule`
`checkmarx`	Static application security testing	`scan-on`, `severity-threshold`

  - id: renovate
    type: renovate
    enabled: true
    spec:
      schedule: before 6am on monday

Artifacts

An artifact goes in the artifacts list. Declare artifacts and tooling explains it.

Type	What it is	Required settings
`container-image`	A container image built from a Dockerfile	`dockerfile`, `registry`
`jar`	A JVM archive that your build produces	`path`
`kong-oas`	An OpenAPI document that describes an API for Kong	`path`

artifacts:
  - id: shop-jar
    type: jar
    spec:
      path: target/shop.jar

Targets

A target goes in the targets list of an environment. Choose where your service runs explains it.

Type	What it is	Required settings
`cloud-foundry-space`	A Cloud Foundry space	`api-endpoint`, `org`, `space`
`kong-gateway`	A Kong control plane	`control-plane-name`
`kubernetes-namespace`	A namespace in a Kubernetes cluster	`cluster`, `namespace`

      - id: test-gateway
        type: kong-gateway
        spec:
          control-plane-name: partner-apis-test

Deployments

A deployment goes in the deployments list of an environment. Choose where your service runs explains it.

Type	What it is	Required settings
`cloud-foundry-app`	A JVM archive pushed as an application into a Cloud Foundry space	`instances`, `memory`, `disk-quota`, `buildpack`
`kong-api`	An API that Kong exposes to a list of consumers	`consumers`
`kubernetes-deployment`	A container image that runs as a deployment in a Kubernetes namespace	`replicas`, `cpu`, `memory`

      - id: shop-test-deployment
        type: kubernetes-deployment
        artifact: shop-image
        target: test-cluster
        spec:
          replicas: 1
          cpu: 250m
          memory: 512Mi

Managed resources

A managed resource goes in the managed-resources list of an environment. Request and use resources explains it.

Type	What it is	Required settings
`azure-key-vault`	An Azure Key Vault that Joomiz creates for your service	`resource-group`, `location`, `sku`
`postgres`	A PostgreSQL database that Joomiz creates for your service	`flavor`, `version`, `storage-gb`, `multi-az`

      - id: shop-db
        type: postgres
        spec:
          flavor: cf-plan-small
          version: "16"
          storage-gb: 20
          multi-az: false

Consumed resources

A consumed resource goes in the consumed-resources list of an environment. Request and use resources explains it.

Type	What it is	Required settings
`kafka-topic`	A Kafka topic that another team owns	`topic`
`splunk-index`	A Splunk index that your service sends logs to	`app`, `index`

      - id: shop-events
        type: kafka-topic
        spec:
          topic: shop.test.events

Use a value of one entry in another entry in Point one value at another.