Skip to content
BETA Try it now Email us
Email us

sales@joomiz.com

Feature teams

Start a new service on the golden path

Describe a new service in one file, joomiz.yaml. Name a golden path that your platform team offers. Then register, check, preview and apply the change with the Joomiz CLI (command line interface).

Email us Try it in the simulator Read the docs

With Joomiz

  1. Create the file

    joomiz init writes a joomiz.yaml with the application block. The golden-path value is one of the names your platform team offers. The command does not contact the control plane.

    $ joomiz init
    joomiz init --name=quick-start-shop \
  --description="A small shop service for the quick start." \
  --repository=https://github.com/example/quick-start-shop \
  --golden-path=java-web-application \
  --owner-id=finance-team \
  --owner-name="Finance Team"

  2. Register the application

    Registration stores the identity of the application, its owner, and the artifacts and tooling lists. You do it once.

    $ joomiz register
    joomiz register
Registered quick-start-shop with ...
  golden-path:  java-web-application
  owner.id:     finance-team

  3. Check and preview

    joomiz validate checks the whole file. joomiz plan lists what apply would create, and changes nothing. Your editor shows the same checks while you type.

    $ joomiz plan --environment test
      target/cloud-foundry-space: succeeded — Planned 1 change ...
  deployment/cloud-foundry-app: succeeded — Planned 1 change ...
  2 resource types, 2 resources

  4. Apply the change

    Run joomiz apply with the same file. Joomiz saves every plan and every apply as a run, and joomiz runs lists them.

    $ joomiz apply
    joomiz apply --environment test
apply succeeded (plan efa320ac-..., apply 4253081c-...)

What you get

  • A registered application with an owner, a golden path and a first environment.
  • A plan that shows every change before anything is applied.
  • Checks in your editor and in joomiz validate before the first apply.

The rules that still hold

  • The platform team decides which golden paths and types exist.
  • You act only for your own team. Other teams' applications are refused.
  • joomiz apply refuses a file you did not plan. Plan again with the changed file.

Read more in the docs

Talk to us

Tell us about your platform and the services your teams ship.

Email us