Catalog

Browse the 145+ resource kinds available for Platform as Code and learn how to define them in YAML. Open Platform as Code → Catalog in the Axio UI.

Important

The Catalog is a read-only schema registry. It documents fields, validation rules, and examples — it does not create or edit platform resources. Author manifests in Git and apply them through Platform as Code → Synchronizations.

Do not author a status block in manifests — Axio generates and manages status automatically. Optional metadata.sensitive: true requires sync plan approval before Git-driven updates or deletions.

Prerequisites

• Permission to view Platform as Code (pac:read or higher).
• For Git-managed instances to appear in the catalog — a connected repository registered under Platform as Code → Synchronizations.

1

Select a Resource Kind

Browse kinds grouped by category (Organization, Projects, Environment, Infrastructure, Automation, Governance, and more). Click a kind such as Project, Workspace, or Environment to load its documentation.

2

Review the API Version

Confirm the API version required by the selected kind. All current kinds use:

apiVersion: platform.axio.io/v1

3

Review Dependencies

Check Dependencies (parent kinds) for the resource. For example, an Environment requires a parent Workspace (and typically a Project). Synchronize parent manifests before or together with child resources.

4

Review Metadata and Spec Fields

Read Metadata Fields (common to every kind, including optional sensitive) and Spec Fields with required flags, types, and descriptions.

5

Use the Example YAML

Copy the Example YAML (or inspect the JSON Schema) as a starting point for your Git-managed manifest under the repository working directory (default: platform-config/).

6

Inspect Git-Managed Instances

The Git-Managed Instances table lists synchronized resources of the selected kind — name, status, drift, and source repository. Empty until you add manifests and run Sync now.

What is the Catalog?

The Catalog is the schema registry for every Platform as Code resource kind. For each kind it shows API version, dependencies, metadata and spec field definitions, validation rules, example YAML, JSON Schema, and synchronized instances from your Git repositories. Use it as a reference before authoring manifests — not as an editor.

Resource Categories

Explore kinds by category (145+ kinds in the product catalog)

♙ Organization ›

▣ Projects ›

▦ Environment ›

◈ Infrastructure ›

◇ Automation ›

▥ Execution Service ›

◆ Governance ›

✣ Integrations ›

▣ Identity & Security ›

… and more (FinOps, Observability, AI Platform, Marketplace, GitOps, Reconciliation)

Resource Schema Example

Resource Kind: Environment

Metadata & Spec Example YAML JSON Schema

apiVersion: platform.axio.io/v1
kind: Environment
metadata:
  name: production
  labels:
    team: platform
spec:
  displayName: Production Environment
  project: ecommerce
  workspace: development
  description: Production deployment target
  type: PRODUCTION

Schema Fields (Environment)

Representative fields — always confirm the live Catalog for the selected kind and version.

Field	Type	Required	Description
metadata.name	string	Yes	Unique environment slug within the parent workspace
metadata.sensitive	boolean	No	When true, Git-driven updates or deletions require sync plan approval
spec.displayName	string	No	Human-readable name shown in the Axio UI
spec.workspace	string	Yes	Parent workspace slug (metadata.name of the Workspace manifest)
spec.project	string	Recommended	Parent project slug; required when the workspace name is ambiguous across projects
spec.description	string	No	Optional description
spec.type	enum	No	DEVELOPMENT, STAGING, PRODUCTION, or CUSTOM (default DEVELOPMENT)
spec.deploymentGovernance	object	No	Owners, approvers, and self-approval policy for deployments

See Create Environment using Platform as Code for a full walkthrough. For Project and Workspace kinds, see the corresponding Platform as Code guides under Organization.

← Platform-As-Code Resources →