Last generated December 9, 2021

Release

Release is a Kubernetes resource (CR) representing a Giant Swarm workload cluster release.

Full name:
releases.release.giantswarm.io
Group:
release.giantswarm.io
Singular name:
release
Plural name:
releases
Scope:
Cluster
Versions:
v1alpha1

Version v1alpha1

Example CR

apiVersion: release.giantswarm.io/v1alpha1
kind: Release
metadata:
  annotations:
    giantswarm.io/docs: https://docs.giantswarm.io/ui-api/management-api/crd/releases.release.giantswarm.io/
    giantswarm.io/release-notes: https://docs.giantswarm.io/changes/workload-cluster-releases-aws/releases/aws-v11.2.0/
  creationTimestamp: null
  name: v11.2.0
spec:
  apps:
  - name: cert-exporter
    version: 1.2.1
  - name: chart-operator
    version: 0.11.4
  - componentVersion: 1.6.5
    name: coredns
    version: 1.1.3
  - componentVersion: 1.9.2
    name: kube-state-metrics
    version: 1.0.2
  - componentVersion: 0.3.3
    name: metrics-server
    version: 1.0.0
  - name: net-exporter
    version: 1.6.0
  - componentVersion: 0.29.0
    name: nginx-ingress-controller
    version: 1.5.0
  - componentVersion: 0.18.1
    name: node-exporter
    version: 1.2.0
  components:
  - name: app-operator
    version: 1.0.0
  - name: cert-operator
    version: 0.1.0
  - name: cluster-operator
    version: 0.23.1
  - name: flannel-operator
    version: 0.2.0
  - name: kvm-operator
    version: 3.10.0
  - name: kubernetes
    version: 1.16.3
  - name: containerlinux
    version: 2247.6.0
  - name: coredns
    version: 1.6.5
  - name: calico
    version: 3.10.1
  - name: etcd
    version: 3.3.17
  date: "2020-03-03T11:12:13Z"
  endOfLifeDate: "2020-10-03T00:00:00Z"
  state: active

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.apps

array Required

Apps describes apps used in this release.

.spec.apps[*]

object

.spec.apps[*].catalog

string

Catalog specifies the name of the app catalog that this app belongs to.

.spec.apps[*].componentVersion

string

Version of the upstream component used in the app.

.spec.apps[*].name

string Required

Name of the app.

.spec.apps[*].version

string Required

Version of the app.

.spec.components

array Required

Components describes components used in this release.

.spec.components[*]

object

.spec.components[*].catalog

string

Catalog specifies the name of the app catalog that this component belongs to.

.spec.components[*].name

string Required

Name of the component.

.spec.components[*].reference

string

Reference is the component’s version in the catalog (e.g. 1.2.3 or 1.2.3-abc8675309).

.spec.components[*].releaseOperatorDeploy

boolean

ReleaseOperatorDeploy informs the release-operator that it should deploy the component.

.spec.components[*].version

string Required

Version of the component.

.spec.date

string Required

Date that the release became active.

.spec.endOfLifeDate

string

EndOfLifeDate is the date and time when support for a workload cluster using this release ends. This may not be set at the time of release creation and can be specififed later.

.spec.notice

string

Notice outlines anything worth being aware of in this release.

.spec.state

string Required

State indicates the availability of the release: deprecated, active, or wip.

.status

object

.status.inUse

boolean

InUse indicates whether a release is actually used by a cluster.

.status.ready

boolean

Ready indicates if all components of the release have been deployed.


This documentation page shows information based on apiextensions v3.0.1.