orkestra/docs/api.md

layout	title	nav_order
default	API Reference	3

Orkestra API Reference

Packages:

• orkestra.azure.microsoft.com/v1alpha1

orkestra.azure.microsoft.com/v1alpha1

Package v1alpha1 contains API Schema definitions for the Orkestra v1alpha1 API group.

Resource Types:

Application

(Appears on: ApplicationGroupSpec)

Application spec and dependency on other applications

Field	Description
DAG DAG	(Members of DAG are embedded into this type.) DAG contains the dependency information
spec ApplicationSpec	Spec contains the application spec including the chart info and overlay values chart ChartRef Chart holds the values needed to pull the chart release Release Release holds the values to apply to the helm release subcharts []DAG (Optional) Subcharts provides the dependency order among the subcharts of the application workflow []Executor (Optional) Workflow provides an option to specify one or more workflow executors to run as a DAG

ApplicationGroup

ApplicationGroup is the Schema for the applicationgroups API

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec ApplicationGroupSpec	applications []Application Applications that make up the application group interval Kubernetes meta/v1.Duration (Optional) Interval specifies the between reconciliations of the ApplicationGroup Defaults to 5s for short requeue and 30s for long requeue
status ApplicationGroupStatus

ApplicationGroupSpec

(Appears on: ApplicationGroup)

ApplicationGroupSpec defines the desired state of ApplicationGroup

Field	Description
applications []Application	Applications that make up the application group
interval Kubernetes meta/v1.Duration	(Optional) Interval specifies the between reconciliations of the ApplicationGroup Defaults to 5s for short requeue and 30s for long requeue

ApplicationGroupStatus

(Appears on: ApplicationGroup)

ApplicationGroupStatus defines the observed state of ApplicationGroup

Field	Description
applications []ApplicationStatus	(Optional) Applications status
observedGeneration int64	(Optional) ObservedGeneration captures the last generation that was captured and completed by the reconciler
lastSucceededGeneration int64	(Optional) LastSucceededGeneration captures the last generation that has successfully completed a full workflow rollout of the application group
conditions []Kubernetes meta/v1.Condition	(Optional) Conditions holds the conditions of the ApplicationGroup

ApplicationSpec

(Appears on: Application)

ApplicationSpec defines the desired state of Application

Field	Description
chart ChartRef	Chart holds the values needed to pull the chart
release Release	Release holds the values to apply to the helm release
subcharts []DAG	(Optional) Subcharts provides the dependency order among the subcharts of the application
workflow []Executor	(Optional) Workflow provides an option to specify one or more workflow executors to run as a DAG

ApplicationStatus

(Appears on: ApplicationGroupStatus)

ApplicationStatus shows the current status of the application helm release

Field	Description
name string	(Optional) Name of the application
ChartStatus ChartStatus	(Members of ChartStatus are embedded into this type.) (Optional) ChartStatus for the application helm chart
subcharts map[string]./api/v1alpha1.ChartStatus	(Optional) Subcharts contains the subchart chart status

ChartRef

(Appears on: ApplicationSpec)

Field	Description
url string	The Helm repository URL, a valid URL contains at least a protocol and host.
name string	The name or path the Helm chart is available at in the SourceRef.
version string	(Optional) Version semver expression, ignored for charts from v1beta1.GitRepository and v1beta1.Bucket sources. Defaults to latest when omitted.
authSecretRef Kubernetes core/v1.ObjectReference	(Optional) AuthSecretRef is a reference to the auth secret to access a private helm repository

ChartStatus

(Appears on: ApplicationStatus)

ChartStatus shows the current status of the Application Reconciliation process

Field	Description
error string	(Optional) Error string from the error during reconciliation (if any)
version string	(Optional) Version of the chart/subchart
staged bool	(Optional) Staged if true denotes that the chart/subchart has been pushed to the staging helm repo
conditions []Kubernetes meta/v1.Condition	(Optional) Conditions holds the conditions for the ChartStatus

DAG

(Appears on: Application, ApplicationSpec, Executor)

DAG contains the dependency information

Field	Description
name string	Name of the application
dependencies []string	(Optional) Dependencies on other applications by name

Executor

(Appears on: ApplicationSpec)

Field	Description
DAG DAG	(Members of DAG are embedded into this type.) DAG contains the dependency information
type ExecutorType	Type specifies the executor type to be run
image Kubernetes core/v1.Container	(Optional) Image allows the end user to specify the docker image name and tag to be executed by the workflow node
params Kubernetes pkg/apis/apiextensions/v1.JSON	(Optional) Params hold executor specific properties

ExecutorType (string alias)

(Appears on: Executor)

ExecutorType can either refer to a native executor (helmrelease and/or keptn) or be a custom executor defined by the end-user

Release

(Appears on: ApplicationSpec)

Field	Description
interval Kubernetes meta/v1.Duration	(Optional) Interval at which to reconcile the Helm release.
targetNamespace string	(Optional) TargetNamespace to target when performing operations for the HelmRelease. Defaults to the namespace of the HelmRelease.
timeout Kubernetes meta/v1.Duration	(Optional) Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm action. Defaults to ‘5m0s’.
values Kubernetes pkg/apis/apiextensions/v1.JSON	(Optional) Values holds the values for this Helm release.
install helm-controller v2beta1.Install	(Optional) Install holds the configuration for Helm install actions for this HelmRelease.
upgrade helm-controller v2beta1.Upgrade	(Optional) Upgrade holds the configuration for Helm upgrade actions for this HelmRelease.
rollback helm-controller v2beta1.Rollback	(Optional) Rollback holds the configuration for Helm rollback actions for this HelmRelease.
uninstall helm-controller v2beta1.Uninstall	(Optional) Rollback holds the configuration for Helm uninstall actions for this HelmRelease.

WorkflowType (string alias)

This page was automatically generated with gen-crd-api-reference-docs