Reference

API reference

  4 minute read  

Packages:

operator.sme.sap.com/v1alpha1

Package v1alpha1 contains API Schema definitions for the operator v1alpha1 API group

Resource Types:

    CAPOperator

    CAPOperator is the Schema for the CAPOperators API

    FieldDescription
    metadata
    Kubernetes meta/v1.ObjectMeta    		Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    CAPOperatorSpec

    subscriptionServer
    SubscriptionServer

    SubscriptionServer specification

    dnsTarget
    string

    Public ingress URL for the cluster Load Balancer

    ingressGatewayLabels
    []NameValue

    Labels used to identify the istio ingress-gateway component and its corresponding namespace. Usually {“app”:“istio-ingressgateway”,“istio”:“ingressgateway”}

    controller
    Controller

    Controller specification

    monitoring
    Monitoring

    Monitoring specification

    webhook
    Webhook

    Webhook specification

    status
    CAPOperatorStatus

    CAPOperatorSpec

    (Appears on: CAPOperator)

    CAPOperatorSpec defines the desired state of CAPOperator

    FieldDescription
    subscriptionServer
    SubscriptionServer

    SubscriptionServer specification

    dnsTarget
    string

    Public ingress URL for the cluster Load Balancer

    ingressGatewayLabels
    []NameValue

    Labels used to identify the istio ingress-gateway component and its corresponding namespace. Usually {“app”:“istio-ingressgateway”,“istio”:“ingressgateway”}

    controller
    Controller

    Controller specification

    monitoring
    Monitoring

    Monitoring specification

    webhook
    Webhook

    Webhook specification

    CAPOperatorStatus

    (Appears on: CAPOperator)

    FieldDescription
    Status
    github.com/sap/component-operator-runtime/pkg/component.Status

    (Members of Status are embedded into this type.)

    add other fields to status subresource here

    CertManager

    (Appears on: CertificateConfig)

    FieldDescription
    issuerName
    string

    Issuer name

    issuerKind
    string

    Issuer kind

    issuerGroup
    string

    Issuer group

    CertificateConfig

    (Appears on: SubscriptionServer, Webhook)

    FieldDescription
    gardener
    Gardener

    Gardener configuration

    certManager
    CertManager

    CertManager configuration

    CertificateManager (string alias)

    (Appears on: SubscriptionServer, Webhook)

    Supported values are Gardener, CertManager, or Default For the subscription server, it can be either Gardener or CertManager, while for the webhook, it can be either Default or CertManager

    CommonConfig

    (Appears on: Controller, SubscriptionServer, Webhook)

    Common aspects for Controller, SubscriptionServer and Webhook

    FieldDescription
    replicas
    int32

    Number of replicas

    resources
    Kubernetes core/v1.ResourceRequirements

    Resource Requirements configuration

    nodeSelector
    map[string]string

    Node selector

    affinity
    Kubernetes core/v1.Affinity

    Affinity settings

    tolerations
    []Kubernetes core/v1.Toleration

    Tolerations

    priorityClassName
    string

    Priority class name

    topologySpreadConstraints
    []Kubernetes core/v1.TopologySpreadConstraint

    Topology spread constraints

    podSecurityContext
    Kubernetes core/v1.PodSecurityContext

    Pod Security context

    securityContext
    Kubernetes core/v1.SecurityContext

    Security context

    volumes
    []Kubernetes core/v1.Volume

    Optionally specify list of additional volumes for the controller pod(s)

    volumeMounts
    []Kubernetes core/v1.VolumeMount

    Optionally specify list of additional volumeMounts for the controller container(s)

    Controller

    (Appears on: CAPOperatorSpec)

    FieldDescription
    CommonConfig
    CommonConfig

    (Members of CommonConfig are embedded into this type.)

    detailedOperationalMetrics
    bool

    Optionally enable detailed opertational metrics for the controller by setting this to true

    maxConcurrentReconciles
    MaxConcurrentReconciles

    Configuration of maximum number of concurrent reconciles for the resources managed by the controller

    versionMonitoring
    VersionMonitoring

    Version monitoring configuration

    Duration (string alias)

    (Appears on: VersionMonitoring)

    Duration is a valid time duration that can be parsed by Prometheus Supported units: y, w, d, h, m, s, ms Examples: 30s, 1m, 1h20m15s, 15d

    Gardener

    (Appears on: CertificateConfig)

    FieldDescription
    issuerName
    string

    Issuer name

    issuerNamespace
    string

    Issuer namespace

    Grafana

    (Appears on: Monitoring)

    FieldDescription
    dashboard
    GrafanaDashboard

    Dashboard configuration

    GrafanaDashboard

    (Appears on: Grafana)

    FieldDescription
    configMapLabels
    map[string]string

    Labels for selecting ConfigMaps with dashboards in Grafana

    MaxConcurrentReconciles

    (Appears on: Controller)

    FieldDescription
    capApplication
    string

    Maximum number of concurrent reconciles for the cap application

    capApplicationVersion
    string

    Maximum number of concurrent reconciles for the cap application version

    capTenant
    string

    Maximum number of concurrent reconciles for the cap tenant

    capTenantOperation
    string

    Maximum number of concurrent reconciles for the cap tenant operation

    domain
    string

    Maximum number of concurrent reconciles for the domain

    clusterDomain
    string

    Maximum number of concurrent reconciles for the cluster domain

    Monitoring

    (Appears on: CAPOperatorSpec)

    FieldDescription
    enabled
    bool

    Optionally enable Prometheus monitoring for all components

    serviceMonitorSelectorLabels
    map[string]string

    Prometheus service monitor selector labels

    grafana
    Grafana

    Grafana configuration

    NameValue

    (Appears on: CAPOperatorSpec)

    Generic Name/Value configuration

    FieldDescription
    name
    string
    value
    string

    SubscriptionServer

    (Appears on: CAPOperatorSpec)

    FieldDescription
    CommonConfig
    CommonConfig

    (Members of CommonConfig are embedded into this type.)

    subDomain
    string
    certificateManager
    CertificateManager

    Certificate manager which can be either Gardener or CertManager

    certificateConfig
    CertificateConfig

    Certificate configuration

    VersionMonitoring

    (Appears on: Controller)

    FieldDescription
    prometheusAddress
    string

    URL of the Prometheus server from which metrics related to managed application versions can be queried

    metricsEvaluationInterval
    Duration

    The duration (example 2h) after which versions are evaluated for deletion; based on specified workload metrics

    promClientAcquireRetryDelay
    Duration

    The duration (example 10m) to wait before retrying to acquire Prometheus client and verify connection, after a failed attempt

    Webhook

    (Appears on: CAPOperatorSpec)

    FieldDescription
    CommonConfig
    CommonConfig

    (Members of CommonConfig are embedded into this type.)

    certificateManager
    CertificateManager

    Certificate manager which can be either Default or CertManager

    certificateConfig
    CertificateConfig

    Certificate configuration

    Generated with gen-crd-api-reference-docs .

    Last modified June 30, 2026: Add index.yaml to website (95721f3)