Last generated December 4, 2024

Chart

Chart represents a Helm chart to be deployed as a Helm release. It is reconciled by chart-operator.

Full name:: charts.application.giantswarm.io
Group:: application.giantswarm.io
Singular name:: chart
Plural name:: charts
Scope:: Namespaced
Versions:: v1alpha1

Version v1alpha1

Example CR

apiVersion: application.giantswarm.io/v1alpha1
kind: Chart
metadata:
  creationTimestamp: null
  labels:
    chart-operator.giantswarm.io/version: 1.0.0
  name: prometheus
  namespace: default
spec:
  config:
    configMap:
      name: f2def-chart-values
      namespace: f2def
      resourceVersion: ""
    secret:
      name: f2def-chart-values
      namespace: f2def
      resourceVersion: ""
  install:
    skipCRDs: true
    timeout: 6m0s
  name: prometheus
  namespace: monitoring
  namespaceConfig:
    annotations:
      linkerd.io/inject: enabled
  rollback:
    timeout: 7m0s
  tarballURL: prometheus-1.0.1.tgz
  uninstall:
    timeout: 8m0s
  upgrade:
    timeout: 9m0s
  version: 1.0.1

Properties

.apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

.kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

.metadata

object Required

.spec

object Required

.spec.config

object

Config is the config to be applied when the chart is deployed.

.spec.config.configMap

object

ConfigMap references a config map containing values that should be applied to the chart.

.spec.config.configMap.name

string Required

Name is the name of the config map containing chart values to apply, e.g. prometheus-chart-values.

.spec.config.configMap.namespace

string Required

Namespace is the namespace of the values config map, e.g. monitoring.

.spec.config.configMap.resourceVersion

string Required

ResourceVersion is the Kubernetes resource version of the configmap. Used to detect if the configmap has changed, e.g. 12345.

.spec.config.secret

object

Secret references a secret containing secret values that should be applied to the chart.

.spec.config.secret.name

string Required

Name is the name of the secret containing chart values to apply, e.g. prometheus-chart-secret.

.spec.config.secret.namespace

string Required

Namespace is the namespace of the secret, e.g. kube-system.

.spec.config.secret.resourceVersion

string Required

ResourceVersion is the Kubernetes resource version of the secret. Used to detect if the secret has changed, e.g. 12345.

.spec.install

object

Install is the config used to deploy the app and is passed to Helm.

.spec.install.skipCRDs

boolean

SkipCRDs when true decides that CRDs which are supplied with the chart are not installed. Default: false.

.spec.install.timeout

string

Timeout for the Helm install. When not set the default timeout of 5 minutes is being enforced.

.spec.name

string Required

Name is the name of the Helm chart to be deployed. e.g. kubernetes-prometheus

.spec.namespace

string Required

Namespace is the namespace where the chart should be deployed. e.g. monitoring

.spec.namespaceConfig

object

NamespaceConfig is the namespace config to be applied to the target namespace when the chart is deployed.

.spec.namespaceConfig.annotations

object

Annotations is a string map of annotations to apply to the target namespace.

.spec.namespaceConfig.labels

object

Labels is a string map of labels to apply to the target namespace.

.spec.rollback

object

Rollback is the config used to rollback the app and is passed to Helm.

.spec.rollback.timeout

string

Timeout for the Helm rollback. When not set the default timeout of 5 minutes is being enforced.

.spec.tarballURL

string Required

TarballURL is the URL for the Helm chart tarball to be deployed. e.g. https://example.com/path/to/prom-1-0-0.tgz

.spec.uninstall

object

Uninstall is the config used to uninstall the app and is passed to Helm.

.spec.uninstall.timeout

string

Timeout for the Helm uninstall. When not set the default timeout of 5 minutes is being enforced.

.spec.upgrade

object

Upgrade is the config used to upgrade the app and is passed to Helm.

.spec.upgrade.timeout

string

Timeout for the Helm upgrade. When not set the default timeout of 5 minutes is being enforced.

.spec.version

string Required

Version is the version of the chart that should be deployed. e.g. 1.0.0

.status

object

.status.appVersion

string Required

AppVersion is the value of the AppVersion field in the Chart.yaml of the deployed chart. This is an optional field with the version of the component being deployed. e.g. 0.21.0. https://helm.sh/docs/topics/charts/#the-chartyaml-file

.status.reason

string

Reason is the description of the last status of helm release when the chart is not installed successfully, e.g. deploy resource already exists.

.status.release

object Required

Release is the status of the Helm release for the deployed chart.

.status.release.lastDeployed

string

LastDeployed is the time when the deployed chart was last deployed.

.status.release.revision

integer

Revision is the revision number for this deployed chart.

.status.release.status

string Required

Status is the status of the deployed chart, e.g. DEPLOYED.

.status.version

string Required

Version is the value of the Version field in the Chart.yaml of the deployed chart. e.g. 1.0.0.

This documentation page shows information based on apiextensions-application v0.6.2.

Need help with the Management API?

We listen in your Slack support channel. And of course, we welcome your pull requests to improve these docs!