Last generated December 4, 2024
AppCatalogEntry
AppCatalogEntry represents an entry of an app in a catalog of managed apps. It stores metadata for specific versions and apps. It is generated by app-operator and consumed by app-admission-controller.
Version v1alpha1
Example CR
apiVersion: application.giantswarm.io/v1alpha1
kind: AppCatalogEntry
metadata:
creationTimestamp: null
name: giantswarm-ingress-nginx-3.0.0
namespace: default
spec:
appName: ingress-nginx
appVersion: v1.8.1
catalog:
name: giantswarm
namespace: ""
chart:
apiVersion: v1
home: https://github.com/giantswarm/ingress-nginx-app
icon: https://s.giantswarm.io/app-icons/ingress-nginx/2/icon_dark.svg
dateCreated: "2020-09-02T09:40:39Z"
dateUpdated: "2020-09-02T09:40:39Z"
restrictions:
clusterSingleton: true
compatibleProviders:
- aws
fixedNamespace: giantswarm
version: 3.0.0
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.appName
AppName is the name of the app this entry belongs to. e.g. ingress-nginx
.spec.appVersion
AppVersion is the upstream version of the app for this entry. e.g. v1.8.1
.spec.catalog
Catalog is the name of the app catalog this entry belongs to. e.g. giantswarm
.spec.catalog.name
Name is the name of the app catalog this entry belongs to. e.g. giantswarm-catalog
.spec.catalog.namespace
Namespace is the namespace of the catalog.
.spec.chart
Chart is metadata from the Chart.yaml of the app this entry belongs to.
.spec.chart.apiVersion
APIVersion is the Helm chart API version.
.spec.chart.description
Description is the Helm chart description.
.spec.chart.home
Home is the URL of this projects home page.
.spec.chart.icon
Icon is a URL to an SVG or PNG image to be used as an icon.
.spec.chart.keywords
Keywords is the keyword strings from the helm chart.
.spec.chart.keywords[*]
.spec.chart.upstreamChartVersion
UpstreamChartVersion is the original version of upstream chart in this app.
.spec.dateCreated
DateCreated is when this entry was first created. e.g. 2020-09-02T09:40:39.223638219Z
.spec.dateUpdated
DateUpdated is when this entry was last updated. e.g. 2020-09-02T09:40:39.223638219Z
.spec.restrictions
Restrictions is metadata from Chart.yaml for this app and is used to validate app CRs.
.spec.restrictions.clusterSingleton
ClusterSingleton is a flag for whether this app can be installed at most once per cluster. Default is false.
.spec.restrictions.compatibleProviders
CompatibleProviders is a list of provider names which this app is compatible with. Default is empty. Empty list means app is compatible with all providers.
.spec.restrictions.compatibleProviders[*]
.spec.restrictions.fixedNamespace
FixedNamespace is the namespace which this app must be installed in.
.spec.restrictions.gpuInstances
GpuInstances is a flag for whether this app requires GPU instances to run. Default is false.
.spec.restrictions.namespaceSingleton
NamespaceSingleton is a flag for whether this app can be installed at most once per namespace. Default is false.
.spec.version
Version is the version of the app chart for this entry. e.g. 3.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!