Docs

Replication Controller API v1

Packages:

delivery.ocm.software/v1alpha1

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

Resource Types:

    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

    component
    string

    Component specifies the name of the Component that should be replicated.

    semver
    string    		(Optional)

    Semver specifies an optional semver constraint that is used to evaluate the component versions that should be replicated.

    source
    OCMRepository

    Source holds the OCM Repository details for the replication source.

    destination
    OCMRepository    		(Optional)

    Destination holds the destination or target OCM Repository details. The ComponentVersion will be transfered into this repository.

    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.

    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

    verify
    []Signature    		(Optional)

    Verify specifies a list signatures that must be verified before a ComponentVersion is replicated.

    status
    ComponentSubscriptionStatus

    ComponentSubscriptionSpec

    (Appears on: ComponentSubscription)

    ComponentSubscriptionSpec defines the desired state of ComponentSubscription. It specifies the parameters that the replication controller will use to replicate a desired Component from a source OCM repository to a destination OCM repository.

    FieldDescription
    component
    string

    Component specifies the name of the Component that should be replicated.

    semver
    string    		(Optional)

    Semver specifies an optional semver constraint that is used to evaluate the component versions that should be replicated.

    source
    OCMRepository

    Source holds the OCM Repository details for the replication source.

    destination
    OCMRepository    		(Optional)

    Destination holds the destination or target OCM Repository details. The ComponentVersion will be transfered into this repository.

    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.

    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

    verify
    []Signature    		(Optional)

    Verify specifies a list signatures that should be validated before the ComponentVersion is marked Verified.

    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 specifies access details for an OCI based OCM Repository.

    FieldDescription
    url
    string

    URL specifies the URL of the OCI registry.

    secretRef
    Kubernetes core/v1.LocalObjectReference    		(Optional)

    SecretRef specifies the credentials used to access the OCI registry.

    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 specifies the name of the signature. An OCM component may have multiple signatures.

    publicKey
    SecretRef

    PublicKey provides a reference to a Kubernetes Secret that contains a public key which will be used to validate the named signature.

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

    Prev
    OCM Controller API v1
    Next
    Component Version