GuidesChangelogDiscussions
Log In

framework.yaml

Using Ketch's simplified definition to manage frameworks

Ketch Definition File

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

name: myframework
ingressController:
  className: istio
  serviceEndpoint: 1.2.3.4
  type: istio

Specification

Component

Type

Description

name

string

The name of the framework

Required: Yes

namespace

string

Have Ketch use an existing namespace in the cluster for the new framework instead of creating a new one.

Required: No

appQuotaLimit

Int

The number of applications that can be delivered to this framework/namespace.

Required: No
Default: Unlimited

ingressController

map

Ingress controller configuration to be used by Ketch when creating application endpoints for the applications deployed.

Required: Yes

className

string

You ingress controller class name.

Required: Yes

clusterIssuer

string

You cluster issuer name.

This will be used by Ketch when users request Ketch to automatically create and attach certificates to their application's CNAME.

Required: No

serviceEndpoint

string

You ingress controller' external IP.

Ketch will connect to the controller to automatically create an endpoint for your application during deployment and expose an endpoint so users can access it.

Required: Yes

type

string

Your ingress controller type.

Required: Yes

Adding Frameworks

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

ketch framework add framework.yaml

Updating Frameworks

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

ketch framework update framework.yaml