Docs

Replication Controller

OCM Controller API reference v1alpha1

Packages:

delivery.ocm.software/v1alpha1

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

Resource Types:

    Component

    Component gathers together reconciled information about a component.

    FieldDescription
    name
    string
    version
    string
    registry
    Registry

    ComponentSubscription

    ComponentSubscription is the Schema for the componentsubscriptions API

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

    interval
    Kubernetes meta/v1.Duration

    Interval is the reconciliation interval, i.e. at what interval shall a reconciliation happen. This is used to requeue objects for reconciliation in case of success as well as already reconciling objects.

    source
    OCMRepository
    destination
    OCMRepository
    component
    string
    serviceAccountName
    string    		(Optional)

    ServiceAccountName can be used to configure access to both destination and source repositories. If service account is defined, it’s usually redundant to define access to either source or destination, but it is still allowed to do so. https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#add-imagepullsecrets-to-a-service-account

    semver
    string    		(Optional)
    verify
    []Signature
    status
    ComponentSubscriptionStatus

    ComponentSubscriptionSpec

    (Appears on: ComponentSubscription)

    ComponentSubscriptionSpec defines the desired state of ComponentSubscription

    FieldDescription
    interval
    Kubernetes meta/v1.Duration

    Interval is the reconciliation interval, i.e. at what interval shall a reconciliation happen. This is used to requeue objects for reconciliation in case of success as well as already reconciling objects.

    source
    OCMRepository
    destination
    OCMRepository
    component
    string
    serviceAccountName
    string    		(Optional)

    ServiceAccountName can be used to configure access to both destination and source repositories. If service account is defined, it’s usually redundant to define access to either source or destination, but it is still allowed to do so. https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#add-imagepullsecrets-to-a-service-account

    semver
    string    		(Optional)
    verify
    []Signature

    ComponentSubscriptionStatus

    (Appears on: ComponentSubscription)

    ComponentSubscriptionStatus defines the observed state of ComponentSubscription

    FieldDescription
    lastAttemptedVersion
    string    		(Optional)

    LastAttemptedVersion defines the latest version encountered while checking component versions. This might be different from last applied version which should be the latest applied/replicated version. The difference might be caused because of semver constraint or failures during replication.

    observedGeneration
    int64    		(Optional)

    ObservedGeneration is the last reconciled generation.

    lastAppliedVersion
    string    		(Optional)

    LastAppliedVersion defines the final version that has been applied to the destination component version.

    replicatedRepositoryURL
    string    		(Optional)

    ReplicatedRepositoryURL defines the final location of the reconciled Component.

    conditions
    []Kubernetes meta/v1.Condition    		(Optional)

    OCMRepository

    (Appears on: ComponentSubscriptionSpec)

    OCMRepository defines details for a repository, such as access keys and the url.

    FieldDescription
    url
    string
    secretRef
    github.com/fluxcd/pkg/apis/meta.LocalObjectReference    		(Optional)

    Registry

    (Appears on: Component)

    Registry defines information about the location of a component.

    FieldDescription
    url
    string

    SecretRef

    (Appears on: Signature)

    SecretRef clearly denotes that the requested option is a Secret.

    FieldDescription
    secretRef
    github.com/fluxcd/pkg/apis/meta.LocalObjectReference

    Signature

    (Appears on: ComponentSubscriptionSpec)

    Signature defines the details of a signature to use for verification.

    FieldDescription
    name
    string

    Name of the signature.

    publicKey
    SecretRef

    Key which is used for verification.

    This page was automatically generated with gen-crd-api-reference-docs