Last generated December 4, 2024
Release
Release is a Kubernetes resource (CR) representing a Giant Swarm workload cluster release.
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.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
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
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
.spec
.spec.apps
Apps describes apps used in this release.
.spec.apps[*]
.spec.apps[*].catalog
Catalog specifies the name of the app catalog that this app belongs to.
.spec.apps[*].componentVersion
Version of the upstream component used in the app.
.spec.apps[*].dependsOn
DependsOn is the list of apps that should be installed before installation of this one is attempted.
.spec.apps[*].dependsOn[*]
.spec.apps[*].name
Name of the app.
.spec.apps[*].version
Version of the app.
.spec.components
Components describes components used in this release.
.spec.components[*]
.spec.components[*].catalog
Catalog specifies the name of the app catalog that this component belongs to.
.spec.components[*].name
Name of the component.
.spec.components[*].reference
Reference is the component’s version in the catalog (e.g. 1.2.3 or 1.2.3-abc8675309).
.spec.components[*].releaseOperatorDeploy
ReleaseOperatorDeploy informs the release-operator that it should deploy the component.
.spec.components[*].version
Version of the component.
.spec.date
Date that the release became active.
.spec.endOfLifeDate
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
Notice outlines anything worth being aware of in this release.
.spec.state
State indicates the availability of the release: deprecated, active, or wip.
.status
.status.inUse
InUse indicates whether a release is actually used by a cluster.
.status.ready
Ready indicates if all components of the release have been deployed.
This documentation page shows information based on release-operator v4.2.0.
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!
