Application

The Application custom resource enables features such as branding, release notes, port forwarding, dashboard buttons, app status indicators, and custom graphs.

There is some overlap between the Application custom resource manifest file and the Kubernetes SIG Application custom resource. For example, enabling features such as adding a button to the dashboard requires the use of both the Application and SIG Application custom resources.

The following is an example manifest file for the Application custom resource:

apiVersion: kots.io/v1beta1
kind: Application
metadata:
  name: my-application
spec:
  title: My Application
  icon: https://support.io/img/logo.png
  releaseNotes: These are our release notes
  allowRollback: false
  kubectlVersion: ">=1.22.0 <1.25.0"
  kustomizeVersion: ">= 4.0.0"
  targetKotsVersion: "1.60.0"
  minKotsVersion: "1.40.0"
  requireMinimalRBACPrivileges: false
  additionalImages:
    - jenkins/jenkins:lts
  additionalNamespaces:
    - "*"
  ports:
    - serviceName: web
      servicePort: 9000
      localPort: 9000
      applicationUrl: "http://web"
  statusInformers:
    - deployment/my-web-svc
    - deployment/my-worker
  graphs:
    - title: User Signups
      query: 'sum(user_signup_events_total)'

title

Description	The application title. Used on the license upload and in various places in the Replicated admin console.
Example	`title: My Application`
Supports Go templates?	No

icon

Description	The icon file for the application. Used on the license upload and in various places in the admin console.
Example	`icon: https://support.io/img/logo.png`
Supports Go templates?	No

releaseNotes

Description	The release notes for this version. These can also be set when promoting a release.
Example	`releaseNotes: Fixes a bug and adds a new feature.`
Supports Go templates?	No

allowRollback

Description	Enable this flag to create a Rollback button on the admin console Version History page. If an application is guaranteed not to introduce backwards-incompatible versions, such as through database migrations, then the `allowRollback` flag can allow end users to easily roll back to previous versions from the admin console. Rollback does not revert any state. Rather, it recovers the YAML manifests that are applied to the cluster.
Example	`allowRollback: false`
Default	`false`
Supports Go templates?	No

additionalNamespaces

Description

Description	An array of additional namespaces as strings that the app manager creates on the cluster. For more information, see Defining Additional Namespaces. In addition to creating the additional namespaces, the app manager ensures that the application secret exists in the namespaces. The app manager also ensures that this application secret has access to pull the application images, including both images that are used and any images you add in the `additionalImages` field. This pull secret is automatically added to all manifest files that use private images. For dynamically created namespaces, specify `"*"`.
Example	`additionalNamespaces: - "*"`
Supports Go templates?	No

An array of additional namespaces as strings that the app manager creates on the cluster. For more information, see Defining Additional Namespaces.

In addition to creating the additional namespaces, the app manager ensures that the application secret exists in the namespaces. The app manager also ensures that this application secret has access to pull the application images, including both images that are used and any images you add in the additionalImages field. This pull secret is automatically added to all manifest files that use private images.

For dynamically created namespaces, specify "*".

Example

additionalNamespaces:
    - "*"

Supports Go templates? No

additionalImages

Description

Description	An array of strings that reference images to be included in air gap bundles and pushed to the local registry during installation. The app manager detects images from the PodSpecs in the application. Some applications, such as Operators, might need to include additional images that are not referenced until runtime. For more information, see Defining Additional Images.
Example	`additionalImages: - jenkins/jenkins:lts`
Supports Go templates?	No

An array of strings that reference images to be included in air gap bundles and pushed to the local registry during installation.

The app manager detects images from the PodSpecs in the application. Some applications, such as Operators, might need to include additional images that are not referenced until runtime. For more information, see Defining Additional Images.

Example

additionalImages:
  - jenkins/jenkins:lts

Supports Go templates? No

kubectlVersion

Description	Specifies the version of the kubectl command-line tool that the app manager uses. You can specify an optional Semantic Version range for `kubectlVersion`, as defined by blang. See Ranges in the blang GitHub repository. The latest supported version in the provided range is used. If the specified version or range does not match any supported versions, the latest version from the above list of supported versions is used. For backwards compatibility, exact versions are also supported. When an exact version is specified, the app manager chooses the matching version if it is supported. If the specific version is not supported, the app manager chooses the latest supported minor and patch version for the specified major version.
Example	`kubectlVersion: ">=1.22.0 <1.25.0"`
Default	When `kubectlVersion` is unspecified, the app manager uses the latest supported version of kubectl. The following minor versions are supported: 1.24.x (Added in app manager v1.71.0) 1.23.x (Added in app manager v1.61.0) 1.22.x (Added in app manager v1.59.3) 1.21.x (Added in app manager v1.48.0) 1.20.x (Added in app manager v1.48.0) 1.19.x (Added in app manager v1.22.0) 1.18.x (Added in app manager v1.22.0) 1.17.x (Added in app manager v1.22.0) 1.16.x 1.14.x
Supports Go templates?	No

kustomizeVersion

Description	Specifies the version of Kustomize that the app manager uses. You can specify a Semantic Version range, as defined by blang. See Ranges in the blang GitHub repository. The latest supported version in the provided range is used. For backwards compatibility, exact versions are also supported. When an exact version is specified, the app manager chooses the matching version if it is supported. If the specific version is not supported, the app manager chooses the latest supported minor and patch version for the specified major version.
Example	`kustomizeVersion: ">= 4.0.0"`
Default	When `kustomizeVersion` is unspecified, the app manager uses the latest supported version of Kustomize. The following major versions of Kustomize are supported: 4.x.x.
Supports Go templates?	No

requireMinimalRBACPrivileges

Description	`requireMinimalRBACPrivileges` applies to existing clusters only. Requires minimal role-based access control (RBAC) be used for all customer installations. When set to `true`, the app manager creates a namespace-scoped Role and RoleBinding, instead of the default cluster-scoped ClusterRole and ClusterRoleBinding. For additional requirements and limitations related to using namespace-scoped RBAC, see About Namespace-scoped RBAC in Configuring App Manager RBAC.
Example	`requireMinimalRBACPrivileges: false`
Default	`false`
Supports Go templates?	No

supportMinimalRBACPrivileges

Description	`supportMinimalRBACPrivileges` applies to existing clusters only. Allows minimal role-based access control (RBAC) be used for all customer installations. When set to `true`, the app manager supports creating a namespace-scoped Role and RoleBinding, instead of the default cluster-scoped ClusterRole and ClusterRoleBinding. Minimal RBAC is not used by default. It is only used when the `--use-minimal-rbac` flag is passed to the `kots install` command. For additional requirements and limitations related to using namespace-scoped RBAC, see About Namespace-scoped RBAC in Configuring App Manager RBAC.
Example	`supportMinimalRBACPrivileges: true`
Default	`false`
Supports Go templates?	No

ports

Description

Description	Extra ports (additional to the :8800 admin console port) that are port-forwarded when running the `kots admin-console` command. With ports specified, the kots CLI can establish port-forwarding to simplify connections to the deployed application. You can use the `ports` field to create a port-forward to a service that has a `ClusterIP` type. For clusters provisioned by the Kubernetes installer, you can also create a custom link to a service that has a `NodePort` type. For more information about configuring a custom link in Kubernetes installer clusters to a `NodePort` type service, see Adding Buttons and Links. `ports` has the following fields: `ports.serviceName`: The name of the service that has a `ClusterIP` type or `NodePort` type if using the Kubernetes installer, that receives the traffic. `ports.servicePort`: The `ClusterIP` port to forward traffic. `ports.localPort`: If set, the port to map on the local workstation. If not set, this is the same as `servicePort`. `ports.applicationUrl`: Must match a service found in the `k8s.io` Application manifest.
Example	`ports: - serviceName: web servicePort: 9000 localPort: 9000 applicationUrl: "http://web"`
Supports Go templates?	No

Extra ports (additional to the :8800 admin console port) that are port-forwarded when running the kots admin-console command. With ports specified, the kots CLI can establish port-forwarding to simplify connections to the deployed application.

You can use the ports field to create a port-forward to a service that has a ClusterIP type. For clusters provisioned by the Kubernetes installer, you can also create a custom link to a service that has a NodePort type.

For more information about configuring a custom link in Kubernetes installer clusters to a NodePort type service, see Adding Buttons and Links.

ports has the following fields:

ports.serviceName: The name of the service that has a ClusterIP type or NodePort type if using the Kubernetes installer, that receives the traffic.
ports.servicePort: The ClusterIP port to forward traffic.
ports.localPort: If set, the port to map on the local workstation. If not set, this is the same as servicePort.
ports.applicationUrl: Must match a service found in the k8s.io Application manifest.

Example

ports:
  - serviceName: web
    servicePort: 9000
    localPort: 9000
    applicationUrl: "http://web"

Supports Go templates? No

statusInformers

Description

Description	Resources to watch and report application status back to the user. When you include `statusInformers`, the dashboard can indicate when the application deployment is complete and the application is ready for use. `statusInformers` use the format `[namespace/]type/name`, where namespace is optional. For more information about including statusInformers, see Displaying Application Status.
Example	`statusInformers: - deployment/my-web-svc - deployment/my-worker` The following example shows excluding a specific status informer based on a user-supplied value from the admin console Configuration screen: `statusInformers: - deployment/my-web-svc - '{{repl if ConfigOptionEquals "option" "value"}}deployment/my-worker{{repl else}}{{repl end}}'`
Supports Go templates?	Yes

Resources to watch and report application status back to the user. When you include statusInformers, the dashboard can indicate when the application deployment is complete and the application is ready for use.

statusInformers use the format [namespace/]type/name, where namespace is optional.

For more information about including statusInformers, see Displaying Application Status.

Example

statusInformers:
    - deployment/my-web-svc
    - deployment/my-worker

The following example shows excluding a specific status informer based on a user-supplied value from the admin console Configuration screen:

statusInformers:
    - deployment/my-web-svc
    - '{{repl if ConfigOptionEquals "option" "value"}}deployment/my-worker{{repl else}}{{repl end}}'

Supports Go templates? Yes

graphs

Description

Description	Custom graphs to include on the admin console application dashboard. For more information about how to create custom graphs, see Adding Custom Graphs. `graphs` has the following fields: `graphs.title`: The graph title. `graphs.query`: The Prometheus query. `graphs.legend`: The legend to use for the query line. You can use Prometheus templating in the `legend` fields with each element returned from the Prometheus query. The template escape sequence is `{{}}`. Use `{{ value }}`. For more information, see Template Reference in the Prometheus documentation. `graphs.queries`: A list of queries containing a `query` and `legend`. `graphs.yAxisFormat`: The format of the Y axis labels with support for all Grafana units. For more information, see Visualizations in the Grafana documentation. `graphs.yAxisTemplate`: Y axis labels template.
Example	`graphs: - title: User Signups query: 'sum(user_signup_events_total)'`
Supports Go templates?	Yes

Custom graphs to include on the admin console application dashboard. For more information about how to create custom graphs, see Adding Custom Graphs.

graphs has the following fields:

graphs.title: The graph title.
graphs.query: The Prometheus query.
graphs.legend: The legend to use for the query line. You can use Prometheus templating in the legend fields with each element returned from the Prometheus query.
The template escape sequence is {{}}. Use {{ value }}. For more information, see Template Reference in the Prometheus documentation.
graphs.queries: A list of queries containing a query and legend.
graphs.yAxisFormat: The format of the Y axis labels with support for all Grafana units. For more information, see Visualizations in the Grafana documentation.
graphs.yAxisTemplate: Y axis labels template.

Example

graphs:
    - title: User Signups
      query: 'sum(user_signup_events_total)'

Supports Go templates?

Yes

proxyRegistryDomain

Description

Description	The custom domain used for proxy.replicated.com. For more information, see Custom Registry Domains. Introduced in app manager v1.91.1.
Example	`proxyRegistryDomain: "proxy.mycompany.com"`
Supports Go templates?	No

The custom domain used for proxy.replicated.com. For more information, see Custom Registry Domains.

Introduced in app manager v1.91.1.

Example

proxyRegistryDomain: "proxy.mycompany.com"

Supports Go templates? No

targetKotsVersion

Description

Description	The app manager (KOTS) version that is targeted by the release. For more information, see Setting Minimum and Target Versions for KOTS. Introduced in app manager v1.62.0.
Example	`targetKotsVersion: "1.85.0"`
Supports Go templates?	No

The app manager (KOTS) version that is targeted by the release. For more information, see Setting Minimum and Target Versions for KOTS.

Introduced in app manager v1.62.0.

Example

targetKotsVersion: "1.85.0"

Supports Go templates? No

minKotsVersion (Beta)

Description

Description	The minimum app manager (KOTS) version that is required by the release. For more information, see Setting Minimum and Target Versions for KOTS. Introduced in app manager v1.62.0.
Example	`minKotsVersion: "1.71.0"`
Supports Go templates?	No

The minimum app manager (KOTS) version that is required by the release. For more information, see Setting Minimum and Target Versions for KOTS.

Introduced in app manager v1.62.0.

Example

minKotsVersion: "1.71.0"

Supports Go templates? No

title​

icon​

releaseNotes​

allowRollback​

additionalNamespaces​

additionalImages​

kubectlVersion​

kustomizeVersion​

requireMinimalRBACPrivileges​

supportMinimalRBACPrivileges​

ports​

statusInformers​

graphs​

proxyRegistryDomain​

targetKotsVersion​

minKotsVersion (Beta)​

title

icon

releaseNotes

allowRollback

additionalNamespaces

additionalImages

kubectlVersion

kustomizeVersion

requireMinimalRBACPrivileges

supportMinimalRBACPrivileges

ports

statusInformers

graphs

proxyRegistryDomain

targetKotsVersion

minKotsVersion (Beta)