Last generated December 4, 2024

Catalog

Catalog represents a catalog of managed apps. It stores general information for potential apps to install. It is reconciled by app-operator.

Full name:: catalogs.application.giantswarm.io
Group:: application.giantswarm.io
Singular name:: catalog
Plural name:: catalogs
Scope:: Namespaced
Versions:: v1alpha1

Version v1alpha1

Example CR

apiVersion: application.giantswarm.io/v1alpha1
kind: Catalog
metadata:
  creationTimestamp: null
  name: my-playground-catalog
  namespace: default
spec:
  config:
    configMap:
      name: my-playground-catalog
      namespace: my-namespace
    secret:
      name: my-playground-catalog
      namespace: my-namespace
  description: A catalog to store all new application packages.
  logoURL: https://my-org.github.com/logo.png
  repositories: null
  storage:
    URL: https://my-org.github.com/my-playground-catalog/
    type: helm
  title: My Playground Catalog

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

.spec

object Required

.spec.config

object

Config is the config to be applied when apps belonging to this catalog are deployed.

.spec.config.configMap

object

ConfigMap references a config map containing catalog values that should be applied to apps in this catalog.

.spec.config.configMap.name

string Required

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

.spec.config.configMap.namespace

string Required

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

.spec.config.secret

object

Secret references a secret containing catalog values that should be applied to apps in this catalog.

.spec.config.secret.name

string Required

Name is the name of the secret containing catalog values to apply, e.g. app-catalog-secret.

.spec.config.secret.namespace

string Required

Namespace is the namespace of the secret, e.g. giantswarm.

.spec.description

string Required

.spec.logoURL

string Required

LogoURL contains the links for logo image file for this catalog

.spec.repositories

array Required

Repositories is an array of objects defining catalog repositories.

.spec.repositories[*]

object

.spec.repositories[*].URL

string Required

URL is the link to where this Catalog’s repository is located e.g. https://example.com/app-catalog/

.spec.repositories[*].type

string Required

Type indicates which repository type would be used for this Catalog. e.g. helm

.spec.storage

object Required

Storage references an object defining catalog repository. This field is deprecated and replaced by Repositories.

.spec.storage.URL

string Required

URL is the link to where this Catalog’s repository is located e.g. https://example.com/app-catalog/

.spec.storage.type

string Required

Type indicates which repository type would be used for this Catalog. e.g. helm

.spec.title

string Required

Title is the name of the catalog for this CR e.g. Catalog of Apps by Giant Swarm

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!