API Reference

The Package Operator APIs are an extension of the Kubernetes API using CustomResourceDefinitions. These new APIs can be interacted with like any other Kubernetes object using e.g. kubectl.

APIs follow the same API versioning guidelines as the main Kubernetes project.

Group versions #

• package-operator.run/v1alpha1\
• manifests.package-operator.run/v1alpha1

package-operator.run/v1alpha1 #

Package v1alpha1 contains API Schema definitions for the v1alpha1 version of the core Package Operator API group, containing basic building blocks that other auxiliary APIs can build on top of.

• ClusterObjectDeployment
• ClusterObjectSet
• ClusterObjectSetPhase
• ClusterObjectSlice
• ClusterObjectTemplate
• ClusterPackage
• HostedClusterPackage
• ObjectDeployment
• ObjectSet
• ObjectSetPhase
• ObjectSlice
• ObjectTemplate
• Package

ClusterObjectDeployment #

ClusterObjectDeployment is the Schema for the ClusterObjectDeployments API

Example

apiVersion: package-operator.run/v1alpha1
kind: ClusterObjectDeployment
metadata:
  name: example
spec:
  paused: true
  revisionHistoryLimit: 10
  selector:
    matchLabels:
      test: test
  template:
    metadata:
      labels:
        test: test
    spec:
      availabilityProbes:
      - probes:
        - cel:
            message: Object must be named Hans
            rule: self.metadata.name == "Hans"
          condition:
            status: "True"
            type: Available
          fieldsEqual:
            fieldA: .spec.fieldA
            fieldB: .status.fieldB
        selector:
          kind:
            group: apps
            kind: Deployment
          selector:
            matchLabels:
              app.kubernetes.io/name: example-operator
      phases:
      - class: ipsum
        name: lorem
        objects:
        - collisionProtection: Prevent
          conditionMappings:
          - destinationType: sit
            sourceType: dolor
          object:
            apiVersion: apps/v1
            kind: Deployment
            metadata:
              name: example-deployment
        slices:
        - amet
      successDelaySeconds: 42
status:
  collisionCount: 42
  conditions:
  - message: Latest Revision is Available.
    reason: Available
    status: "True"
    type: Available
  controllerOf:
  - group: elitr
    kind: sadipscing
    name: sed
    namespace: diam
    version: nonumy
  revision: 42
  templateHash: consetetur

ClusterObjectSet #

ClusterObjectSet reconciles a collection of objects through ordered phases and aggregates their status.

ClusterObjectSets behave similarly to Kubernetes ReplicaSets, by managing a collection of objects and being itself mostly immutable. This object type is able to suspend/pause reconciliation of specific objects to facilitate the transition between revisions.

Archived ClusterObjectSets may stay on the cluster, to store information about previous revisions.

A Namespace-scoped version of this API is available as ObjectSet.

Example

apiVersion: package-operator.run/v1alpha1
kind: ClusterObjectSet
metadata:
  name: example
spec:
  availabilityProbes:
  - probes:
    - cel:
        message: Object must be named Hans
        rule: self.metadata.name == "Hans"
      condition:
        status: "True"
        type: Available
      fieldsEqual:
        fieldA: .spec.fieldA
        fieldB: .status.fieldB
    selector:
      kind:
        group: apps
        kind: Deployment
      selector:
        matchLabels:
          app.kubernetes.io/name: example-operator
  lifecycleState: Active
  phases:
  - class: tempor
    name: eirmod
    objects:
    - collisionProtection: Prevent
      conditionMappings:
      - destinationType: ipsum
        sourceType: lorem
      object:
        apiVersion: apps/v1
        kind: Deployment
        metadata:
          name: example-deployment
    slices:
    - dolor
  previous:
  - name: previous-revision
  revision: 42
  successDelaySeconds: 42
status:
  conditions:
  - message: Latest Revision is Available.
    reason: Available
    status: "True"
    type: Available
  controllerOf:
  - group: consetetur
    kind: amet
    name: sadipscing
    namespace: elitr
    version: sed
  remotePhases:
  - name: sit
    uid: 3490a790-05f8-4bd7-8333-1001c49fccd2
  revision: 42

ClusterObjectSetPhase #

ClusterObjectSetPhase is an internal API, allowing a ClusterObjectSet to delegate a single phase to another custom controller. ClusterObjectSets will create subordinate ClusterObjectSetPhases when .class is set within the phase specification.

Example

apiVersion: package-operator.run/v1alpha1
kind: ClusterObjectSetPhase
metadata:
  name: example
spec:
  availabilityProbes:
  - probes:
    - cel:
        message: Object must be named Hans
        rule: self.metadata.name == "Hans"
      condition:
        status: "True"
        type: Available
      fieldsEqual:
        fieldA: .spec.fieldA
        fieldB: .status.fieldB
    selector:
      kind:
        group: apps
        kind: Deployment
      selector:
        matchLabels:
          app.kubernetes.io/name: example-operator
  objects:
  - collisionProtection: Prevent
    conditionMappings:
    - destinationType: nonumy
      sourceType: diam
    object:
      apiVersion: apps/v1
      kind: Deployment
      metadata:
        name: example-deployment
  paused: true
  previous:
  - name: previous-revision
  revision: 42
status:
  conditions:
  - status: "True"
    type: Available
  controllerOf:
  - group: tempor
    kind: eirmod
    name: lorem
    namespace: ipsum
    version: dolor

ClusterObjectSlice #

ClusterObjectSlice is referenced by ObjectSets or ObjectDeployments and contain objects to limit the size of ObjectSet and ObjectDeployments when big packages are installed. This is necessary to work around the etcd object size limit of ~1.5MiB and to reduce load on the kube-apiserver.

Example

apiVersion: package-operator.run/v1alpha1
kind: ClusterObjectSlice
metadata:
  name: example
objects:
- collisionProtection: Prevent
  conditionMappings:
  - destinationType: amet
    sourceType: sit
  object:
    apiVersion: apps/v1
    kind: Deployment
    metadata:
      name: example-deployment

ClusterObjectTemplate #

ClusterObjectTemplate contain a go template of a Kubernetes manifest. The manifest is then templated with the sources provided in the .Spec.Sources. The sources can come from objects from any namespace or cluster scoped objects.

Example

apiVersion: package-operator.run/v1alpha1
kind: ClusterObjectTemplate
metadata:
  name: example
spec:
  sources:
  - apiVersion: sadipscing
    items:
    - destination: eirmod
      key: nonumy
    kind: elitr
    name: diam
    namespace: sed
    optional: true
  template: consetetur
status:
  conditions:
  - message: Latest Revision is Available.
    reason: Available
    status: "True"
    type: Available
  controllerOf:
    group: lorem
    kind: tempor
    name: ipsum
    namespace: dolor
    version: sit

ClusterPackage #

ClusterPackage defines a cluster scoped package installation.

Example

apiVersion: package-operator.run/v1alpha1
kind: ClusterPackage
metadata:
  name: example
spec:
  component: consetetur
  config: {}
  image: amet
  paused: true
status:
  conditions:
  - message: Latest Revision is Available.
    reason: Available
    status: "True"
    type: Available
  revision: 42
  unpackedHash: sadipscing

HostedClusterPackage #

HostedClusterPackage defines package to be rolled out on every HyperShift HostedCluster. Experimental: Subject to change.

Example

apiVersion: package-operator.run/v1alpha1
kind: HostedClusterPackage
metadata:
  name: example
spec:
  hostedClusterSelector: {}
  partition:
    labelKey: diam
    order:
      alphanumericAsc: {}
      static:
      - nonumy
  strategy:
    instant: {}
  template:
    metadata: {}
    spec:
      component: sed
      config: {}
      image: elitr
      paused: true
status:
  availablePackages: 42
  conditions:
  - message: Latest Revision is Available.
    reason: Available
    status: "True"
    type: Available
  observedGeneration: 42
  partitions:
  - availablePackages: 42
    name: eirmod
    observedGeneration: 42
    progressedPackages: 42
    totalPackages: 42
    updatedPackages: 42
  processing:
  - name: tempor
    namespace: lorem
    uid: 3490a790-05f8-4bd7-8333-1001c49fccd2
  progressedPackages: 42
  totalPackages: 42
  updatedPackages: 42

ObjectDeployment #

ObjectDeployment is the Schema for the ObjectDeployments API

Example

apiVersion: package-operator.run/v1alpha1
kind: ObjectDeployment
metadata:
  name: example
  namespace: default
spec:
  paused: true
  revisionHistoryLimit: 10
  selector:
    matchLabels:
      test: test
  template:
    metadata:
      labels:
        test: test
    spec:
      availabilityProbes:
      - probes:
        - cel:
            message: Object must be named Hans
            rule: self.metadata.name == "Hans"
          condition:
            status: "True"
            type: Available
          fieldsEqual:
            fieldA: .spec.fieldA
            fieldB: .status.fieldB
        selector:
          kind:
            group: apps
            kind: Deployment
          selector:
            matchLabels:
              app.kubernetes.io/name: example-operator
      phases:
      - class: dolor
        name: ipsum
        objects:
        - collisionProtection: Prevent
          conditionMappings:
          - destinationType: amet
            sourceType: sit
          object:
            apiVersion: apps/v1
            kind: Deployment
            metadata:
              name: example-deployment
        slices:
        - consetetur
      successDelaySeconds: 42
status:
  collisionCount: 42
  conditions:
  - message: ""
    reason: Available
    status: "True"
    type: Available
  controllerOf:
  - group: sed
    kind: elitr
    name: diam
    namespace: nonumy
    version: eirmod
  revision: 42
  templateHash: sadipscing

ObjectSet #

ObjectSet reconciles a collection of objects through ordered phases and aggregates their status.

ObjectSets behave similarly to Kubernetes ReplicaSets, by managing a collection of objects and being itself mostly immutable. This object type is able to suspend/pause reconciliation of specific objects to facilitate the transition between revisions.

Archived ObjectSets may stay on the cluster, to store information about previous revisions.

A Cluster-scoped version of this API is available as ClusterObjectSet.

Example

apiVersion: package-operator.run/v1alpha1
kind: ObjectSet
metadata:
  name: example
  namespace: default
spec:
  availabilityProbes:
  - probes:
    - cel:
        message: Object must be named Hans
        rule: self.metadata.name == "Hans"
      condition:
        status: "True"
        type: Available
      fieldsEqual:
        fieldA: .spec.fieldA
        fieldB: .status.fieldB
    selector:
      kind:
        group: apps
        kind: Deployment
      selector:
        matchLabels:
          app.kubernetes.io/name: example-operator
  lifecycleState: Active
  phases:
  - class: lorem
    name: tempor
    objects:
    - collisionProtection: Prevent
      conditionMappings:
      - destinationType: dolor
        sourceType: ipsum
      object:
        apiVersion: apps/v1
        kind: Deployment
        metadata:
          name: example-deployment
    slices:
    - sit
  previous:
  - name: previous-revision
  revision: 42
  successDelaySeconds: 42
status:
  conditions:
  - message: Latest Revision is Available.
    reason: Available
    status: "True"
    type: Available
  controllerOf:
  - group: sadipscing
    kind: consetetur
    name: elitr
    namespace: sed
    version: diam
  remotePhases:
  - name: amet
    uid: 3490a790-05f8-4bd7-8333-1001c49fccd2
  revision: 42

ObjectSetPhase #

ObjectSetPhase is an internal API, allowing an ObjectSet to delegate a single phase to another custom controller. ObjectSets will create subordinate ObjectSetPhases when .class within the phase specification is set.

Example

apiVersion: package-operator.run/v1alpha1
kind: ObjectSetPhase
metadata:
  name: example
  namespace: default
spec:
  availabilityProbes:
  - probes:
    - cel:
        message: Object must be named Hans
        rule: self.metadata.name == "Hans"
      condition:
        status: "True"
        type: Available
      fieldsEqual:
        fieldA: .spec.fieldA
        fieldB: .status.fieldB
    selector:
      kind:
        group: apps
        kind: Deployment
      selector:
        matchLabels:
          app.kubernetes.io/name: example-operator
  objects:
  - collisionProtection: Prevent
    conditionMappings:
    - destinationType: eirmod
      sourceType: nonumy
    object:
      apiVersion: apps/v1
      kind: Deployment
      metadata:
        name: example-deployment
  paused: true
  previous:
  - name: previous-revision
  revision: 42
status:
  conditions:
  - status: "True"
    type: Available
  controllerOf:
  - group: lorem
    kind: tempor
    name: ipsum
    namespace: dolor
    version: sit

ObjectSlice #

ObjectSlice is referenced by ObjectSets or ObjectDeployments and contain objects to limit the size of ObjectSets and ObjectDeployments when big packages are installed. This is necessary to work around the etcd object size limit of ~1.5MiB and to reduce load on the kube-apiserver.

Example

apiVersion: package-operator.run/v1alpha1
kind: ObjectSlice
metadata:
  name: example
  namespace: default
objects:
- collisionProtection: Prevent
  conditionMappings:
  - destinationType: consetetur
    sourceType: amet
  object:
    apiVersion: apps/v1
    kind: Deployment
    metadata:
      name: example-deployment

ObjectTemplate #

ObjectTemplate contain a go template of a Kubernetes manifest. This manifest is then templated with the sources provided in the .Spec.Sources. The sources can only come from objects within the same namespace as the ObjectTemplate.

Example

apiVersion: package-operator.run/v1alpha1
kind: ObjectTemplate
metadata:
  name: example
  namespace: default
spec:
  sources:
  - apiVersion: elitr
    items:
    - destination: tempor
      key: eirmod
    kind: sed
    name: nonumy
    namespace: diam
    optional: true
  template: sadipscing
status:
  conditions:
  - message: Latest Revision is Available.
    reason: Available
    status: "True"
    type: Available
  controllerOf:
    group: ipsum
    kind: lorem
    name: dolor
    namespace: sit
    version: amet

Package #

Package defines a namespaced package installation.

Example

apiVersion: package-operator.run/v1alpha1
kind: Package
metadata:
  name: example
  namespace: default
spec:
  component: sadipscing
  config: {}
  image: consetetur
  paused: true
status:
  conditions:
  - message: Latest Revision is Available.
    reason: Available
    status: "True"
    type: Available
  revision: 42
  unpackedHash: elitr

ClusterObjectDeploymentSpec #

ClusterObjectDeploymentSpec defines the desired state of a ClusterObjectDeployment.

Used in:

• ClusterObjectDeployment

ClusterObjectDeploymentStatus #

ClusterObjectDeploymentStatus defines the observed state of a ClusterObjectDeployment.

Used in:

• ClusterObjectDeployment

ClusterObjectSetPhaseSpec #

ClusterObjectSetPhaseSpec defines the desired state of a ClusterObjectSetPhase.

Used in:

• ClusterObjectSetPhase

ClusterObjectSetPhaseStatus #

ClusterObjectSetPhaseStatus defines the observed state of a ClusterObjectSetPhase.

Used in:

• ClusterObjectSetPhase

ClusterObjectSetSpec #

ClusterObjectSetSpec defines the desired state of a ClusterObjectSet.

Used in:

• ClusterObjectSet

ClusterObjectSetStatus #

ClusterObjectSetStatus defines the observed state of a ClusterObjectSet.

Used in:

• ClusterObjectSet

ConditionMapping #

ConditionMapping maps one condition type to another.

Used in:

• ObjectSetObject

ControlledObjectReference #

ControlledObjectReference an object controlled by this object.

Used in:

• ClusterObjectDeploymentStatus
• ClusterObjectSetPhaseStatus
• ClusterObjectSetStatus
• ObjectDeploymentStatus
• ObjectSetPhaseStatus
• ObjectSetStatus
• ObjectTemplateStatus

HostedClusterPackagePartitionOrderSpec #

HostedClusterPackagePartitionOrderSpec describes ordering for a partition.

Used in:

• HostedClusterPackagePartitionSpec

HostedClusterPackagePartitionSpec #

HostedClusterPackagePartitionSpec describes settings to partition HostedClusters into groups for upgrades. Partitions will be upgraded after each other: Upgrades in the next partition will only start after the previous has finished. HostedClusters without the label will be put into an implicit “unknown” group and will get upgraded LAST.

Used in:

• HostedClusterPackageSpec

HostedClusterPackagePartitionStatus #

HostedClusterPackagePartitionStatus describes the status of a partition.

Used in:

• HostedClusterPackageStatus

HostedClusterPackageRefStatus #

HostedClusterPackageRefStatus holds a reference to upgrades in-flight.

Used in:

• HostedClusterPackageStatus

HostedClusterPackageSpec #

HostedClusterPackageSpec is the description of a HostedClusterPackage.

Used in:

• HostedClusterPackage

HostedClusterPackageStatus #

HostedClusterPackageStatus describes the status of a HostedClusterPackage.

Used in:

• HostedClusterPackage

HostedClusterPackageStrategy #

HostedClusterPackageStrategy describes the rollout strategy for a HostedClusterPackage.

Used in:

• HostedClusterPackageSpec

HostedClusterPackageStrategyRollingUpgrade #

HostedClusterPackageStrategyRollingUpgrade describes the rolling upgrade strategy for HostedClusterPackages.

Used in:

• HostedClusterPackageStrategy

ObjectDeploymentSpec #

ObjectDeploymentSpec defines the desired state of an ObjectDeployment.

Used in:

• ObjectDeployment

ObjectDeploymentStatus #

ObjectDeploymentStatus defines the observed state of an ObjectDeployment.

Used in:

• ObjectDeployment

ObjectSetObject #

ObjectSetObject is an object that is part of the phase of an ObjectSet.

Used in:

• ClusterObjectSetPhaseSpec
• ObjectSetPhaseSpec
• ObjectSetTemplatePhase
• ClusterObjectSlice
• ObjectSlice

ObjectSetPhaseSpec #

ObjectSetPhaseSpec defines the desired state of a ObjectSetPhase.

Used in:

• ObjectSetPhase

ObjectSetPhaseStatus #

ObjectSetPhaseStatus defines the observed state of a ObjectSetPhase.

Used in:

• ObjectSetPhase

ObjectSetProbe #

ObjectSetProbe define how ObjectSets check their children for their status.

Used in:

• ClusterObjectSetPhaseSpec
• ClusterObjectSetSpec
• ObjectSetPhaseSpec
• ObjectSetSpec
• ObjectSetTemplateSpec

ObjectSetSpec #

ObjectSetSpec defines the desired state of a ObjectSet.

Used in:

• ObjectSet

ObjectSetStatus #

ObjectSetStatus defines the observed state of a ObjectSet.

Used in:

• ObjectSet

ObjectSetTemplate #

ObjectSetTemplate describes the template to create new ObjectSets from.

Used in:

• ClusterObjectDeploymentSpec
• ObjectDeploymentSpec

ObjectSetTemplatePhase #

ObjectSetTemplatePhase configures the reconcile phase of ObjectSets.

Used in:

• ClusterObjectSetSpec
• ObjectSetSpec
• ObjectSetTemplateSpec

ObjectSetTemplateSpec #

ObjectSetTemplateSpec defines an object set. WARNING: when modifying fields in ObjectSetTemplateSpec also update validation rules in (Cluster)ObjectSetSpec.

Used in:

• ObjectSetTemplate

ObjectTemplateSource #

ObjectTemplateSource defines a source for a template.

Used in:

• ObjectTemplateSpec

ObjectTemplateSourceItem #

ObjectTemplateSourceItem defines a source item for an object template.

Used in:

• ObjectTemplateSource

ObjectTemplateSpec #

ObjectTemplateSpec specification.

Used in:

• ClusterObjectTemplate
• ObjectTemplate

ObjectTemplateStatus #

ObjectTemplateStatus defines the observed state of a ObjectTemplate ie the status of the templated object.

Used in:

• ClusterObjectTemplate
• ObjectTemplate

PackageProbeKindSpec #

PackageProbeKindSpec package probe parameters. selects objects based on Kind and API Group.

Used in:

• ProbeSelector

PackageSpec #

PackageSpec specifies a package.

Used in:

• PackageTemplateSpec
• ClusterPackage
• Package

PackageStatus #

PackageStatus defines the observed state of a Package.

Used in:

• ClusterPackage
• Package

PackageTemplateSpec #

PackageTemplateSpec describes the data a package should have when created from a template.

Used in:

• HostedClusterPackageSpec

PreviousRevisionReference #

PreviousRevisionReference references a previous revision of an ObjectSet or ClusterObjectSet.

Used in:

• ClusterObjectSetPhaseSpec
• ClusterObjectSetSpec
• ObjectSetPhaseSpec
• ObjectSetSpec

Probe #

Probe defines probe parameters. Only one can be filled.

Used in:

• ObjectSetProbe

ProbeCELSpec #

ProbeCELSpec uses Common Expression Language (CEL) to probe an object. CEL rules have to evaluate to a boolean to be valid. See: https://kubernetes.io/docs/reference/using-api/cel https://github.com/google/cel-go

Used in:

• Probe

ProbeConditionSpec #

ProbeConditionSpec checks whether or not the object reports a condition with given type and status.

Used in:

• Probe

ProbeFieldsEqualSpec #

ProbeFieldsEqualSpec compares two fields specified by JSON Paths.

Used in:

• Probe

ProbeSelector #

ProbeSelector selects a subset of objects to apply probes to. e.g. ensures that probes defined for apps/Deployments are not checked against ConfigMaps.

Used in:

• ObjectSetProbe

RemotePhaseReference #

RemotePhaseReference remote phases aka ObjectSetPhase/ClusterObjectSetPhase objects to which a phase is delegated.

Used in:

• ClusterObjectSetStatus
• ObjectSetStatus

manifests.package-operator.run/v1alpha1 #

Package v1alpha1 contains API Schema definitions for the v1alpha1 version of the manifests API group, containing file-based manifests for the packaging infrastructure.

• PackageManifest
• PackageManifestLock
• Repository
• RepositoryEntry

PackageManifest #

PackageManifest defines the manifest of a package.

Example

apiVersion: manifests.package-operator.run/v1alpha1
kind: PackageManifest
metadata:
  name: example
  namespace: default
spec:
  availabilityProbes: []
  components: {}
  config:
    openAPIV3Schema:
      properties:
        testProp:
          type: string
      type: object
  constraints:
  - platform:
    - Kubernetes
    platformVersion:
      name: Kubernetes
      range: '>=1.20.x'
    uniqueInScope: {}
  dependencies:
  - image:
      name: my-pkg
      package: my-pkg.my-repo
      range: '>=2.1'
  filter:
    conditions:
    - expression: has(environment.openShift)
      name: isOpenShift
    paths:
    - expression: cond.isOpenShift && environment.openShift.version.startsWith('4.15')
      glob: openshift/v4.15/**
  images:
  - image: quay.io/package-operator/test-stub:v1.11.0
    name: test-stub
  phases:
  - class: hosted-cluster
    name: deploy
  repositories:
  - file: ../myrepo.yaml
    image: quay.io/package-operator/my-repo:latest
  scopes:
  - Cluster
  - Namespaced
test:
  kubeconform:
    kubernetesVersion: v1.29.5
    schemaLocations:
    - https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/{{.NormalizedKubernetesVersion}}-standalone{{.StrictSuffix}}/{{.ResourceKind}}{{.KindSuffix}}.json
  template:
  - context:
      config:
        testProp: Hans
      environment:
        hyperShift:
          hostedCluster:
            hostedClusterNamespace: clusters-banana
            metadata:
              name: banana
              namespace: clusters
        kubernetes:
          version: v1.29.5
        openShift:
          managed:
            data:
              test: test
          version: v4.13.2
        proxy:
          httpProxy: http://proxy_server_address:port
          httpsProxy: https://proxy_server_address:port
          noProxy: .example.com,.local,localhost
      package:
        image: quay.io/package-operator/test-stub-package:v1.11.0
        metadata:
          name: test
    name: lorem

PackageManifestLock #

PackageManifestLock allows locking packages to specific versions.

Example

apiVersion: manifests.package-operator.run/v1alpha1
kind: PackageManifestLock
metadata:
  name: example
  namespace: default
spec:
  dependencies:
  - digest: sha256:00e48c32b3cdcf9e2c66467f2beb0ef33b43b54e2b56415db4ee431512c406ea
    image: quay.io/package-operator/remote-phase-package
    name: my-pkg
    version: v1.12.3
  images:
  - digest: sha256:00e48c32b3cdcf9e2c66467f2beb0ef33b43b54e2b56415db4ee431512c406ea
    image: quay.io/package-operator/remote-phase-package
    name: my-pkg

Repository #

Repository is the k8s resource that represents a package repository.

Example

apiVersion: manifests.package-operator.run/v1alpha1
kind: Repository
metadata:
  name: example
  namespace: default

RepositoryEntry #

RepositoryEntry contains metadata on one image belonging to the repository.

Example

apiVersion: manifests.package-operator.run/v1alpha1
data:
  constraints:
  - platform:
    - Kubernetes
    platformVersion:
      name: Kubernetes
      range: '>=1.20.x'
    uniqueInScope: {}
  digest: dolor
  image: ipsum
  name: amet
  versions:
  - sit
kind: RepositoryEntry
metadata:
  name: example
  namespace: default

PackageEnvironment #

PackageEnvironment information.

Used in:

• TemplateContext

PackageEnvironmentHyperShift #

PackageEnvironmentHyperShift contains HyperShift specific information. Only available when installed alongside HyperShift. https://github.com/openshift/hypershift

Used in:

• PackageEnvironment

PackageEnvironmentHyperShiftHostedCluster #

PackageEnvironmentHyperShiftHostedCluster contains HyperShift HostedCluster specific information. This information is only available when installed alongside HyperShift within a HostedCluster Namespace. https://github.com/openshift/hypershift

Used in:

• PackageEnvironmentHyperShift

PackageEnvironmentKubernetes #

PackageEnvironmentKubernetes configures kubernetes environments.

Used in:

• PackageEnvironment

PackageEnvironmentManagedOpenShift #

PackageEnvironmentManagedOpenShift describes managed OpenShift environments.

Used in:

• PackageEnvironmentOpenShift

PackageEnvironmentOpenShift #

PackageEnvironmentOpenShift configures openshift environments.

Used in:

• PackageEnvironment

PackageEnvironmentProxy #

PackageEnvironmentProxy configures proxy environments. On OpenShift, this config is taken from the cluster Proxy object. https://docs.openshift.com/container-platform/4.13/networking/enable-cluster-wide-proxy.html

Used in:

• PackageEnvironment

PackageManifestConstraint #

PackageManifestConstraint configures environment constraints to block package installation.

Used in:

• PackageManifestSpec
• RepositoryEntryData

PackageManifestDependency #

PackageManifestDependency uses a solver to find the latest version package image.

Used in:

• PackageManifestSpec

PackageManifestDependencyImage #

PackageManifestDependencyImage represents a dependency image found by the solver.

Used in:

• PackageManifestDependency

PackageManifestFilter #

PackageManifestFilter is used to conditionally render objects based on CEL expressions.

Used in:

• PackageManifestSpec

PackageManifestImage #

PackageManifestImage specifies an image tag to be resolved.

Used in:

• PackageManifestSpec

PackageManifestLockDependency #

PackageManifestLockDependency defines a dependency of this package.

Used in:

• PackageManifestLockSpec

PackageManifestLockImage #

PackageManifestLockImage contains information about a resolved image.

Used in:

• PackageManifestLockSpec

PackageManifestLockSpec #

PackageManifestLockSpec defines a set of packages that are locked to a specific version.

Used in:

• PackageManifestLock

PackageManifestNamedCondition #

PackageManifestNamedCondition is a reusable named CEL expression. It is injected as a variable into the CEL evaluation environment, and its value is set to the result of Expression (“true”/“false”).

Used in:

• PackageManifestFilter

PackageManifestPath #

PackageManifestPath is used to conditionally render package objects based on their path.

Used in:

• PackageManifestFilter

PackageManifestPhase #

PackageManifestPhase defines a package phase.

Used in:

• PackageManifestSpec

PackageManifestPlatformVersionConstraint #

PackageManifestPlatformVersionConstraint enforces that the platform matches the given version range. This constraint is ignored when running on a different platform. e.g. a PlatformVersionConstraint OpenShift>=4.13.x is ignored when installed on a plain Kubernetes cluster. Use the Platform constraint to enforce running on a specific platform.

Used in:

• PackageManifestConstraint

PackageManifestRepository #

PackageManifestRepository contains information about one package repository which could be loaded either from a local file or from a container image.

Used in:

• PackageManifestSpec

PackageManifestSpec #

PackageManifestSpec represents the spec of the packagemanifest containing the details about phases and availability probes.

Used in:

• PackageManifest

PackageManifestSpecConfig #

PackageManifestSpecConfig configutes a package manifest.

Used in:

• PackageManifestSpec

PackageManifestTest #

PackageManifestTest configures test cases.

Used in:

• PackageManifest

PackageManifestTestCaseTemplate #

PackageManifestTestCaseTemplate template testing configuration.

Used in:

• PackageManifestTest

PackageManifestTestKubeconform #

PackageManifestTestKubeconform configures kubeconform testing.

Used in:

• PackageManifestTest

RepositoryEntryData #

RepositoryEntryData is the part of RepositoryEntry containing the actual data.

Used in:

• RepositoryEntry

TemplateContext #

TemplateContext is available within the package templating process.

Used in:

• PackageManifestTestCaseTemplate

TemplateContextObjectMeta #

TemplateContextObjectMeta represents a simplified version of metav1.ObjectMeta for use in templates.

Used in:

• PackageEnvironmentHyperShiftHostedCluster
• TemplateContextPackage

TemplateContextPackage #

TemplateContextPackage represents the (Cluster)Package object requesting this package content.

Used in:

• TemplateContext