GuidesChangelogDiscussions
Log In

application.yaml

Ketch Application Definition

In addition to using the Ketch CLI or external providers to manage applications, you can also leverage a simplified Ketch definition that you can store in a YAML file.

Here is an application definition file example:

framework: 
image: 
name: 
type: 
environment: 
  - key: value
builder:

Specification

Component

Type

Description

framework

string

The name of the framework/namespace where Ketch should deploy the application.

Required: Yes

image

string

Your Docker image URL for deployment.

Required: Yes

name

string

The name of your application.

Required: Yes

environment

Array of key value combinations that should be used by Ketch when creating the application.

Required: No

builder

string

The name of buildpack builder. Default heroku/buildpacks:20. Only needed when deploying from source

Required: No

Example

name: bulletinboard
framework: framework1
image: docker.io/shipasoftware/bulletinboard:1.0
environment:
- foo1=bar1

Deploying Applications

You can use the command below in combination with your Ketch application definition file to have your application deployed:

ketch app deploy app.yaml