Platform as Code Create a Project using Platform as Code

Define a Project in a YAML or JSON file and synchronize the Project with Axio from your Git repository.

Warning

Important

Ensure that your Git repository is connected to Axio before proceeding. Synchronization can be triggered manually or configured on a schedule from Platform as Code → Synchronizations

Step-by-Step Guide

1

Define Project

Create a YAML or JSON file containing the Project definition.

2

Commit and Push

Commit the Project definition file and push it to your Git repository.

3

Synchronize with Axio

Go to Platform as Code → Synchronizations and synchronize the connected repository with Axio.

Manual Synchronization

Click Sync now to immediately synchronize the repository and apply the Project definition.

Scheduled Synchronization

Enable Auto and configure a synchronization schedule to periodically synchronize the repository.

4

Project Created

After a successful synchronization, the Project appears under **Organization → Projects**.

apiVersion: platform.axio.io/v1
kind: Project

metadata:
  name: ecommerce

spec:
  displayName: Ecommerce Project
  description: Project for ecommerce services

{
  "apiVersion": "platform.axio.io/v1",
  "kind": "Project",
  "metadata": {
    "name": "ecommerce"
  },
  "spec": {
    "displayName": "Ecommerce Project",
    "description": "Project for ecommerce services"
  }
}

Repository Structure 

platform-resources/
└── projects/
    ├── ecommerce.yaml
    ├── payments.yaml

What Happens Next?

  • The Project is created in Axio after a successful synchronization.
  • The Project appears under Organization → Projects.
  • You can synchronize changes manually using Sync now.
  • You can enable scheduled synchronization to periodically apply Git changes.
  • You can begin creating Workspaces inside the Project.
Tip

Tip

Store Project definitions in Git to maintain version history and manage changes through your repository workflow.