Skip to content
RAPD Documentation

How to Write Manifest Spec

Within the Manifest, the spec section is used to describe the specifications of the applications/clusters you want RAPD to help you deploy. RAPD defines specifications using YAML format, detailing the composition of the application components, relationships between components, and so on. For detailed specifications, please refer to the link below. The following will explain how to write a simple Spec from the perspective of an application.

Composition

The basic composition consists of the following three parts:

  • version
  • revisionHistory
  • components

Version

Specifies the version of the spec document.

RevisionHistory

Specifies the number of deployment history records to retain.

Components

This is the most important part within the spec, defining the composition of each component in the application, the type of each component, required parameters, and so on. The following example continues from the Manifest file.

components:
  - type: networking.api-gateway
    name: kong
    target: my_aws_k8s

In this application example, the type of this component is declared as networking.api-gateway, its name is kong, and it is deployed to the target my_aws_k8s. RAPD will launch an api-gateway service named kong on the Deployment target named my_aws_k8s for us.

Currently, RAPD can deploy six types of components. For detailed information, please refer to the documentation.

  • webservice.container
  • worker.container
  • database.mysql
  • database.postgredql
  • caching.redis
  • networking.api-gateway

In the next stage, we will introduce how to write Components.