Chapter 9

Frequently asked questions.

Two questions that come up as soon as people see a profile.

How is this different from Docker Compose?

A compose.yaml says how an app is run today. A profile says what the app needs, so a platform team can decide how to provide it.

compose.yamlRuntime Conditions Profile
What it describesOne chosen setupThe need behind it
Examplepostgres:16 on port 5432"needs a relational database"
Another team's API, which has no imageA mock, and readers must guess what it stands forDeclared as an API, with the operations the app calls
Who can change the real thingThe developer rewrites the fileThe platform team, without touching the app
Can you get one from the other?No. The intent was never written downYes. A compose.yaml could be generated from a profile

Can a company write its own catalog of extensions?

Yes. An extension is a YAML document with its own id, so a company can define its own, as the AWS Object Store example does. Our first-party extensions are one catalog among others, in the extensions repository.

  1. 1
    Write an extension.A YAML definition of the kinds, interface types, fields, and allowed values your company needs, with JSON Schema to check them.
  2. 2
    Build on the existing ones.Depend on an extension that already owns a word instead of defining it again. An extension owns only what it introduces.
  3. 3
    Generate bindings.rc bindings generate turns the extension into packages for Go, Python, TypeScript, and Java.
  4. 4
    Publish it.Put the packages in your registries and the definition at its id. A profile lists the id, and tools find the definition there, or in a local catalog directory.

The rules for writing one are in the extension authoring guide, and Extensions shows what an extension owns.