Skip to main content
Version: v4.4.0

Yaml Files

What are the .yaml files?

The template.yaml and plugin.yaml files are used to configure both Templates and Plugins. The task.yaml file receives the configurations from Tasks.
Some information is used to:

  1. Display Templates/Plugin information to the user.
  2. Inputs configuration expected from Template/Plugin.
  3. Operations configuration performed by Tasks, using the stk run command.

Yaml files examples

name: my-template
description: Describe your template explaining its purpose
types:
- app-template
inputs:
- label: Input Example
type: text
name: example
default: any text
required: true
danger

When you use the int type in the type field, you need to adjust one of the two fields below:

  1. default: Put an associated value.
  2. Required must be true.

See the example below:

name: my-template
description: Describe your template explaining its purpose
types:
- app-template
inputs:
- label: Input Example
type: int
name: example
default: 1
required: true

Required Attributes

AttributeDescription
nameString that defines the name of the Plugin, Template or Stack. This information defines the identifier of the Plugin that is used in your application.
descriptionString that describes the purpose of the Plugin, Template or Stack, and should contain information that is relevant to be displayed to consumers in the stk list plugin, stk list template, and stk list stack commands.
typesList of strings defining the types of the Plugin/Template. The valid value is app-template.

Optional Attributes

AttributeDescription
display-nameA string that defines the Plugin's name that will be displayed on the Studio's website, Template, or Stack.
pictureA string that defines the image's name file that will be displayed on the Studio's website. This file must be inside the repository.
CategoryA string that defines the Plugin or Stack category. For Plugins, any category can be entered. But for Stacks, it is mandatory to use one of the categories: Analytics; Back-end; Front-end; Full Stack; SRE;
CompatibilityString list that defines compatible terms, technologies, or applications.
aboutPath to a markdown file in the repository, it details the Stack or Plugin.
UsagePath to a markdown file in the repository, it details the Stack or Plugin usage.
Use-casePath to a markdown file in the repository, it details a Stack use case.
use-casesList of Stack use cases.
use-cases.titleString with use case title.
use-cases.contentPath to a markdown file in the repository, it details the use case.
use-cases.stackfilePath to a stackfile in the repository related to a use case.
implementationPath to a markdown file in the repository, it details the Stack implementation.

Technologies

String list of technologies related to a Stack or a Plugin.

The technologies allowed are:

  • .NET
  • Allure
  • Angular
  • Apache Spark
  • Api
  • AWS DynamoDB
  • AWS ECS/Fargate
  • AWS EventBridge
  • AWS Glue
  • AWS Kafka
  • AWS Kinesis
  • AWS Lake Formation
  • AWS Lambda
  • AWS S3
  • AWS SNS
  • AWS SQS
  • Citric
  • CocoaPods
  • Cucumber
  • C#
  • Docker
  • Gradle
  • Jaeger
  • Java
  • JavaScript
  • Junit
  • Kakfa
  • Kotlin
  • Maven
  • Microfrontend
  • MySql
  • NextJS
  • Observability
  • OpenAPI
  • OpenTelemetry
  • Parquet
  • PostgreSql
  • Prometheus
  • Python
  • Queue
  • React
  • Redis
  • Rest
  • Rest Assured
  • Robot Framework
  • Secrets
  • Serenity BDD
  • Splunk
  • Springboot
  • Swift
  • Terraform
  • Typescript
  • Web

Next Steps

Check plugin.yaml references.

Was this page helpful?