Joomiz documentation

For feature teams and platform teams. A feature team builds and runs a service, for example a billing API. It asks for the resources that the service needs, such as a database. A platform team runs the shared platform. It decides which resources exist and offers them to feature teams.

Joomiz is a tool that allows platform teams to offer resources from a golden path to feature teams. A golden path is a supported way to build a service. You describe a service in one file, joomiz.yaml. Joomiz checks the file, shows what a change would do, and then makes the change.

I'm part of a feature team

You use resources. You write joomiz.yaml, and you check, preview and apply it with the Joomiz CLI.

Start with Feature teams: start here. It shows the six steps from an empty folder to a running service. Then read how to write each part of the file, from The shape of a joomiz.yaml file to Use outputs and secrets. After that, the pages from Check your file to Questions and troubleshooting show how to run a change.

I'm part of a platform team

You offer resources. You run the control plane, register provisioners, own the catalog of types, and read the audit trail.

Start with Platform teams: start here. It shows what the platform is made of and what you decide. Then read What a provisioner is, and follow the pages to Own the catalog of types. Provisioner API reference lists every call that a provisioner answers. To run the platform every day, start with Use the Platform dashboard. To run the platform for real, read Deploy the control plane, Deploy the dashboard and Connect an identity provider. Then read Release a stuck apply lock, Investigate a failed run, Read and manage the audit trail and Check health and follow a run.

I want to try it first

Deploy your first service is a guide for one small Java service. You register it, check it, preview a change and apply it. Then you add a database.

I want to understand the ideas

• What Joomiz is explains the problem that Joomiz solves and the parts it is made of.
• How Joomiz works names each thing in Joomiz and shows how the things relate.

Reference

• CLI reference lists every command and option.
• Control plane API reference lists the calls of the control plane.
• The joomiz.yaml schema says where the schema is and what it holds.
• Provisioner API reference lists the calls that a provisioner answers.
• Settings reference lists the settings that you set to run the control plane.
• Run results, refusal reasons and exit codes explains the words that the CLI prints.

Example files

Each example is a complete joomiz.yaml file:

• quick-start: a jar service on Cloud Foundry.
• quick-start-with-database: the same service with a PostgreSQL database.
• references: a service whose settings read values from other parts of its file.
• partner-api: a service that partners call through a Kong gateway.
• container-service: a container image on Kubernetes, with a key vault and a Splunk index.
• order-service: a service on Kubernetes.
• billing-service: a service on Cloud Foundry with a managed secret store.