Register a Blueprint
Before you begin
Before registering a blueprint you need:
- A Git repository — either already populated with your blueprint content (manifest, templates, IaC, notebooks, pipelines) or an empty one that Blindata will create for you.
- A valid
manifest.yamlat a known path in that repository. See Blueprint Structure for the full schema. - A personal secret configured for the Git provider used by the Blueprint service (e.g. a GitHub Personal Access Token). Personal secrets are managed from your user profile and are referenced in the registration wizard by their type.
Register a new blueprint
The Blueprint catalog is the central place where all registered Blueprints are listed and managed.
It acts as a self-service marketplace for data product templates, where users can: browse available Blueprints, understand their purpose and configuration, select a specific version, launch the instantiation process
For platform teams, the catalog is also where Blueprints are:
- Maintained and documented
- Versioned and published
- Controlled and shared across the organization
The Blueprint catalog is reached from DataOps in the left-hand sidebar and from Blueprints section in the upper navbar. It lists every registered blueprint in the current tenant.
To register a new blueprint click the floating + button in the bottom right corner and fill in the three-step wizard described below.
The registration wizard is a single scrollable form split into three main sections: Blueprint identity, Git secrets and Repository settings. All three must be completed before the blueprint is saved.
Blueprint identity
Define how the blueprint is presented and identified in the catalog.
| Field | Description |
|---|---|
| Display Name (required) | Human-readable name shown in lists and in the detail view. |
| Identifier (required) | Unique technical name. Blindata auto-generates it from the display name; keep the generated value unless your organization has a specific naming convention. |
| Description | Short summary shown on the catalog card and at the top of the detail page. |
Git secrets
The Blueprint service uses your personal secrets to authenticate against the Git provider. The wizard displays one row per secret type (e.g. github-pat); for each row pick the stored secret Blindata should use.
Manage secrets from your user profile: create a new one on the fly with the + button, or edit an existing one with the pencil icon.
Repository settings
Pick the Git repository that will host the blueprint content. You can either create a new one or point Blindata to one you already own.
Create new repository
Blindata will create the repository in your provider on save, using the credentials provided in the step before.
| Field | Description |
|---|---|
| Organization (required) | Git provider organization or account that will own the repository. |
| Repository Name (required) | Name of the new repository. Defaults to the blueprint identifier. |
| Repository Description | Optional. Shown in your Git provider next to the repository. |
| Visibility | Repository visibility (e.g. Private, Public). |
Select existing repository
Choose this option when the repository already contains your blueprint content or when it is prepared by another automation.
| Field | Description |
|---|---|
| Organization (required) | Git provider organization or account that owns the repository. |
| Repository (required) | Existing repository that will hold the blueprint manifest and templates. |
Advanced settings
The Advanced Settings panel lets you override where Blindata looks for the manifest and related files inside the repository. All fields have defaults and can be left unchanged for standard setups.
| Field | Default | Description |
|---|---|---|
| Manifest Branch | main |
Branch where Blindata reads the blueprint manifest. Usually the default branch. |
| Manifest Path (required) | blueprint/manifest.yaml |
Path to the blueprint manifest, relative to the repository root. |
| Descriptor Template Path | descriptor.json.vm |
Path to the Apache Velocity descriptor template, required for root blueprints that generate a Data Product Descriptor. |
| Readme Path | blueprint/README.md |
Path to the README rendered in the Documentation tab of the blueprint detail page. |
Press SAVE to register the blueprint. On success Blindata validates the manifest, creates the catalog entry, and redirects you to the blueprint detail page, where you can publish the first version .