This document is automatically generated from the API definition in the code.
Table of Contents
- App
- AppDeployment
- AppDeploymentList
- AppDeploymentSpec
- AppList
- ClusterApp
- ClusterAppList
- CrossNamespaceGitRepositoryReference
- GenericAppSpec
- TypedLocalObjectReference
App
App is the Schema for a Service or Application in Kommander.
Field | Description | Scheme | Required |
---|---|---|---|
metadata | metav1.ObjectMeta | false | |
spec | GenericAppSpec | false | |
status | AppStatus | false |
AppDeployment
AppDeployment is the Schema for a concrete installation of a Service or Application in Kommander.
Field | Description | Scheme | Required |
---|---|---|---|
metadata | metav1.ObjectMeta | false | |
spec | AppDeploymentSpec | false | |
status | AppDeploymentStatus | false |
AppDeploymentList
AppDeploymentList contains a list of AppDeployments.
Field | Description | Scheme | Required |
---|---|---|---|
items | []AppDeployment | true | |
metadata | metav1.ListMeta | false |
AppDeploymentSpec
AppDeploymentSpec defines an instance of an Application.
Field | Description | Scheme | Required |
---|---|---|---|
appRef | AppRef provides reference to a ClusterApp or App object. | TypedLocalObjectReference | true |
configOverrides | ConfigOverrides allows a user to define a ConfigMap that contains configuration overrides | corev1.LocalObjectReference | false |
AppDeploymentStatus
AppDeploymentStatus defines the current state of the AppDeployment.
AppList
AppList contains a list of Apps.
Field | Description | Scheme | Required |
---|---|---|---|
items | []App | true | |
metadata | metav1.ListMeta | false |
AppStatus
AppStatus defines the current state of an App.
ClusterApp
ClusterApp is the Schema for a Service or Application in Kommander.
Field | Description | Scheme | Required |
---|---|---|---|
metadata | metav1.ObjectMeta | false | |
spec | GenericAppSpec | false | |
status | ClusterAppStatus | false |
ClusterAppList
ClusterAppList contains a list of ClusterApps.
Field | Description | Scheme | Required |
---|---|---|---|
items | []ClusterApp | true | |
metadata | metav1.ListMeta | false |
ClusterAppStatus
ClusterAppStatus defines the current state of an App.
CrossNamespaceGitRepositoryReference
CrossNamespaceGitRepositoryReference contains enough information to let you locate the typed referenced object at cluster level.
Field | Description | Scheme | Required |
---|---|---|---|
apiVersion | API version of the referent | string | false |
kind | Kind of the referent | string | true |
name | Name of the referent | string | true |
namespace | Namespace of the referent, defaults to the Kustomization namespace | string | false |
GenericAppSpec
GenericAppSpec defines the actual Application spec.
Field | Description | Scheme | Required |
---|---|---|---|
appId | AppID specifies the name of the application/workload | string | true |
gitRepositoryRef | GitRepository is reference to the Flux’s GitRepository, which in turn describes Git repository where the service resides | CrossNamespaceGitRepositoryReference | true |
version | Version depicts the version of the service in the semantic versioning format. | string | true |
TypedLocalObjectReference
TypedLocalObjectReference contains enough information to let you locate the typed referenced object at cluster or local level.
Field | Description | Scheme | Required |
---|---|---|---|
apiVersion | API version of the referent | string | false |
kind | Kind of the referent | string | true |
name | Name of the referent | string | true |