Skip to main content

Onboard a Project (Wizard)

The Onboard Project wizard creates a project and links its applications, environments, and targets in one guided flow — instead of assembling them across several pages. It's in the sidebar as Onboard Project (/onboard), available to ANALYST and ADMIN.

The flow​

The wizard has five steps:

  1. Start — choose how to begin:
    • Start blank — an empty form, or
    • Start from a template — pick a PROJECT_SETUP playbook. It asks you its parameter prompts (base URL, auth type, …); the backend then returns a filled onboarding payload that seeds the form. Every seeded field stays editable.
  2. Project — name + description.
  3. Applications — one or more apps (name, type, tech, git URL, swagger path, app tag). Existing canonical apps are linked by name, never duplicated.
  4. Environments & Targets — one or more environments (name, authRequirement), each with one or more targets (name, type, base URL, swagger path, app tag).
  5. Review — see the exact payload, then Onboard Project.

The result​

The result view shows the backend's honest verdict:

  • SUCCESS — everything requested was created.
  • PARTIAL — some steps failed or were skipped (e.g. a duplicate already present, or a field that couldn't be applied). The per-step log tells you which; the verdict is never a false green.
  • FAILED — the onboard could not complete.

From here, Open Project takes you to the new project.

What onboarding does not do​

Onboarding scaffolds project → app → environment → target. It does not set up credentials — an authenticated target still needs a credential added to its environment afterward. See Access & Credentials.