Skip to content

Update apidocs #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thetechnick merged 1 commit into from
Jun 10, 2025
Merged

Update apidocs #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
113 changes: 73 additions & 40 deletions content/en/docs/api_reference/package-operator-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,15 @@ kind: ClusterObjectDeployment
metadata:
name: example
spec:
paused: "true"
paused: true
revisionHistoryLimit: 10
selector: metav1.LabelSelector
selector:
matchLabels:
test: test
template:
metadata: metav1.ObjectMeta
metadata:
labels:
test: test
spec:
availabilityProbes:
- probes:
Expand Down Expand Up @@ -111,7 +115,10 @@ spec:
status:
collisionCount: 42
conditions:
- metav1.Condition
- message: Latest Revision is Available.
reason: Available
status: "True"
type: Available
controllerOf:
- group: elitr
kind: sadipscing
Expand Down Expand Up @@ -190,15 +197,18 @@ spec:
successDelaySeconds: 42
status:
conditions:
- metav1.Condition
- message: Latest Revision is Available.
reason: Available
status: "True"
type: Available
controllerOf:
- group: amet
kind: sit
name: consetetur
namespace: sadipscing
remotePhases:
- name: dolor
uid: types.UID
uid: 3490a790-05f8-4bd7-8333-1001c49fccd2
revision: 42

```
Expand Down Expand Up @@ -254,7 +264,7 @@ spec:
kind: Deployment
metadata:
name: example-deployment
paused: "true"
paused: true
previous:
- name: previous-revision
revision: 42
Expand Down Expand Up @@ -335,11 +345,14 @@ spec:
kind: amet
name: sadipscing
namespace: consetetur
optional: "true"
optional: true
template: dolor
status:
conditions:
- metav1.Condition
- message: Latest Revision is Available.
reason: Available
status: "True"
type: Available
controllerOf:
group: nonumy
kind: diam
Expand Down Expand Up @@ -370,12 +383,15 @@ metadata:
name: example
spec:
component: ipsum
config: runtime.RawExtension
config: {}
image: lorem
paused: "true"
paused: true
status:
conditions:
- metav1.Condition
- message: Latest Revision is Available.
reason: Available
status: "True"
type: Available
revision: 42
unpackedHash: dolor

Expand Down Expand Up @@ -403,11 +419,15 @@ metadata:
name: example
namespace: default
spec:
paused: "true"
paused: true
revisionHistoryLimit: 10
selector: metav1.LabelSelector
selector:
matchLabels:
test: test
template:
metadata: metav1.ObjectMeta
metadata:
labels:
test: test
spec:
availabilityProbes:
- probes:
Expand Down Expand Up @@ -446,7 +466,10 @@ spec:
status:
collisionCount: 42
conditions:
- metav1.Condition
- message: ""
reason: Available
status: "True"
type: Available
controllerOf:
- group: nonumy
kind: diam
Expand Down Expand Up @@ -526,15 +549,18 @@ spec:
successDelaySeconds: 42
status:
conditions:
- metav1.Condition
- message: Latest Revision is Available.
reason: Available
status: "True"
type: Available
controllerOf:
- group: elitr
kind: sadipscing
name: sed
namespace: diam
remotePhases:
- name: consetetur
uid: types.UID
uid: 3490a790-05f8-4bd7-8333-1001c49fccd2
revision: 42

```
Expand Down Expand Up @@ -590,7 +616,7 @@ spec:
kind: Deployment
metadata:
name: example-deployment
paused: "true"
paused: true
previous:
- name: previous-revision
revision: 42
Expand Down Expand Up @@ -673,11 +699,14 @@ spec:
kind: elitr
name: diam
namespace: sed
optional: "true"
optional: true
template: consetetur
status:
conditions:
- metav1.Condition
- message: Latest Revision is Available.
reason: Available
status: "True"
type: Available
controllerOf:
group: lorem
kind: tempor
Expand Down Expand Up @@ -709,12 +738,15 @@ metadata:
namespace: default
spec:
component: amet
config: runtime.RawExtension
config: {}
image: sit
paused: "true"
paused: true
status:
conditions:
- metav1.Condition
- message: Latest Revision is Available.
reason: Available
status: "True"
type: Available
revision: 42
unpackedHash: consetetur

Expand All @@ -738,10 +770,10 @@ ClusterObjectDeploymentSpec defines the desired state of a ClusterObjectDeployme

| Field | Description |
| ----- | ----------- |
| `revisionHistoryLimit` <br><a href="#int32">int32</a> | Number of old revisions in the form of archived ObjectSets to keep. |
| `revisionHistoryLimit` <br>int32 | Number of old revisions in the form of archived ObjectSets to keep. |
| `selector` <b>required</b><br>metav1.LabelSelector | Selector targets ObjectSets managed by this Deployment. |
| `template` <b>required</b><br><a href="#objectsettemplate">ObjectSetTemplate</a> | Template to create new ObjectSets from. |
| `paused` <br><a href="#bool">bool</a> | If Paused is true, the object and its children will not be reconciled. |
| `paused` <br>bool | If Paused is true, the object and its children will not be reconciled. |


Used in:
Expand All @@ -755,7 +787,7 @@ ClusterObjectDeploymentStatus defines the observed state of a ClusterObjectDeplo
| Field | Description |
| ----- | ----------- |
| `conditions` <br>[]metav1.Condition | Conditions is a list of status conditions ths object is in. |
| `collisionCount` <br><a href="#int32">int32</a> | Count of hash collisions of the ClusterObjectDeployment. |
| `collisionCount` <br>int32 | Count of hash collisions of the ClusterObjectDeployment. |
| `templateHash` <br>string | Computed TemplateHash. |
| `revision` <br>int64 | Deployment revision. |
| `controllerOf` <br><a href="#controlledobjectreference">[]ControlledObjectReference</a> | ControllerOf references the owned ClusterObjectSet revisions. |
Expand All @@ -771,7 +803,7 @@ ClusterObjectSetPhaseSpec defines the desired state of a ClusterObjectSetPhase.

| Field | Description |
| ----- | ----------- |
| `paused` <br><a href="#bool">bool</a> | Disables reconciliation of the ClusterObjectSet.<br>Only Status updates will still be propagated, but object changes will not be reconciled. |
| `paused` <br>bool | Disables reconciliation of the ClusterObjectSet.<br>Only Status updates will still be propagated, but object changes will not be reconciled. |
| `revision` <b>required</b><br>int64 | Revision of the parent ObjectSet to use during object adoption. |
| `previous` <br><a href="#previousrevisionreference">[]PreviousRevisionReference</a> | Previous revisions of the ClusterObjectSet to adopt objects from. |
| `availabilityProbes` <br><a href="#objectsetprobe">[]ObjectSetProbe</a> | Availability Probes check objects that are part of the package.<br>All probes need to succeed for a package to be considered Available.<br>Failing probes will prevent the reconciliation of objects in later phases. |
Expand Down Expand Up @@ -806,7 +838,7 @@ ClusterObjectSetSpec defines the desired state of a ClusterObjectSet.
| `previous` <br><a href="#previousrevisionreference">[]PreviousRevisionReference</a> | Previous revisions of the ClusterObjectSet to adopt objects from. |
| `phases` <br><a href="#objectsettemplatephase">[]ObjectSetTemplatePhase</a> | Reconcile phase configuration for a ObjectSet.<br>Phases will be reconciled in order and the contained objects checked<br>against given probes before continuing with the next phase. |
| `availabilityProbes` <br><a href="#objectsetprobe">[]ObjectSetProbe</a> | Availability Probes check objects that are part of the package.<br>All probes need to succeed for a package to be considered Available.<br>Failing probes will prevent the reconciliation of objects in later phases. |
| `successDelaySeconds` <br><a href="#int32">int32</a> | Success Delay Seconds applies a wait period from the time an<br>Object Set is available to the time it is marked as successful.<br>This can be used to prevent false reporting of success when<br>the underlying objects may initially satisfy the availability<br>probes, but are ultimately unstable. |
| `successDelaySeconds` <br>int32 | Success Delay Seconds applies a wait period from the time an<br>Object Set is available to the time it is marked as successful.<br>This can be used to prevent false reporting of success when<br>the underlying objects may initially satisfy the availability<br>probes, but are ultimately unstable. |


Used in:
Expand Down Expand Up @@ -871,10 +903,10 @@ ObjectDeploymentSpec defines the desired state of an ObjectDeployment.

| Field | Description |
| ----- | ----------- |
| `revisionHistoryLimit` <br><a href="#int32">int32</a> | Number of old revisions in the form of archived ObjectSets to keep. |
| `revisionHistoryLimit` <br>int32 | Number of old revisions in the form of archived ObjectSets to keep. |
| `selector` <b>required</b><br>metav1.LabelSelector | Selector targets ObjectSets managed by this Deployment. |
| `template` <b>required</b><br><a href="#objectsettemplate">ObjectSetTemplate</a> | Template to create new ObjectSets from. |
| `paused` <br><a href="#bool">bool</a> | If Paused is true, the object and its children will not be reconciled. |
| `paused` <br>bool | If Paused is true, the object and its children will not be reconciled. |


Used in:
Expand All @@ -888,7 +920,7 @@ ObjectDeploymentStatus defines the observed state of an ObjectDeployment.
| Field | Description |
| ----- | ----------- |
| `conditions` <br>[]metav1.Condition | Conditions is a list of status conditions ths object is in. |
| `collisionCount` <br><a href="#int32">int32</a> | Count of hash collisions of the ObjectDeployment. |
| `collisionCount` <br>int32 | Count of hash collisions of the ObjectDeployment. |
| `templateHash` <br>string | Computed TemplateHash. |
| `revision` <br>int64 | Deployment revision. |
| `controllerOf` <br><a href="#controlledobjectreference">[]ControlledObjectReference</a> | ControllerOf references the owned ObjectSet revisions. |
Expand Down Expand Up @@ -923,7 +955,7 @@ ObjectSetPhaseSpec defines the desired state of a ObjectSetPhase.

| Field | Description |
| ----- | ----------- |
| `paused` <br><a href="#bool">bool</a> | Disables reconciliation of the ObjectSet.<br>Only Status updates will still be propagated, but object changes will not be reconciled. |
| `paused` <br>bool | Disables reconciliation of the ObjectSet.<br>Only Status updates will still be propagated, but object changes will not be reconciled. |
| `revision` <b>required</b><br>int64 | Revision of the parent ObjectSet to use during object adoption. |
| `previous` <br><a href="#previousrevisionreference">[]PreviousRevisionReference</a> | Previous revisions of the ObjectSet to adopt objects from. |
| `availabilityProbes` <br><a href="#objectsetprobe">[]ObjectSetProbe</a> | Availability Probes check objects that are part of the package.<br>All probes need to succeed for a package to be considered Available.<br>Failing probes will prevent the reconciliation of objects in later phases. |
Expand Down Expand Up @@ -976,7 +1008,7 @@ ObjectSetSpec defines the desired state of a ObjectSet.
| `previous` <br><a href="#previousrevisionreference">[]PreviousRevisionReference</a> | Previous revisions of the ObjectSet to adopt objects from. |
| `phases` <br><a href="#objectsettemplatephase">[]ObjectSetTemplatePhase</a> | Reconcile phase configuration for a ObjectSet.<br>Phases will be reconciled in order and the contained objects checked<br>against given probes before continuing with the next phase. |
| `availabilityProbes` <br><a href="#objectsetprobe">[]ObjectSetProbe</a> | Availability Probes check objects that are part of the package.<br>All probes need to succeed for a package to be considered Available.<br>Failing probes will prevent the reconciliation of objects in later phases. |
| `successDelaySeconds` <br><a href="#int32">int32</a> | Success Delay Seconds applies a wait period from the time an<br>Object Set is available to the time it is marked as successful.<br>This can be used to prevent false reporting of success when<br>the underlying objects may initially satisfy the availability<br>probes, but are ultimately unstable. |
| `successDelaySeconds` <br>int32 | Success Delay Seconds applies a wait period from the time an<br>Object Set is available to the time it is marked as successful.<br>This can be used to prevent false reporting of success when<br>the underlying objects may initially satisfy the availability<br>probes, but are ultimately unstable. |


Used in:
Expand Down Expand Up @@ -1042,7 +1074,7 @@ also update validation rules in (Cluster)ObjectSetSpec.
| ----- | ----------- |
| `phases` <br><a href="#objectsettemplatephase">[]ObjectSetTemplatePhase</a> | Reconcile phase configuration for a ObjectSet.<br>Phases will be reconciled in order and the contained objects checked<br>against given probes before continuing with the next phase. |
| `availabilityProbes` <br><a href="#objectsetprobe">[]ObjectSetProbe</a> | Availability Probes check objects that are part of the package.<br>All probes need to succeed for a package to be considered Available.<br>Failing probes will prevent the reconciliation of objects in later phases. |
| `successDelaySeconds` <br><a href="#int32">int32</a> | Success Delay Seconds applies a wait period from the time an<br>Object Set is available to the time it is marked as successful.<br>This can be used to prevent false reporting of success when<br>the underlying objects may initially satisfy the availability<br>probes, but are ultimately unstable. |
| `successDelaySeconds` <br>int32 | Success Delay Seconds applies a wait period from the time an<br>Object Set is available to the time it is marked as successful.<br>This can be used to prevent false reporting of success when<br>the underlying objects may initially satisfy the availability<br>probes, but are ultimately unstable. |


Used in:
Expand All @@ -1060,7 +1092,7 @@ ObjectTemplateSource defines a source for a template.
| `namespace` <br>string | |
| `name` <b>required</b><br>string | |
| `items` <b>required</b><br><a href="#objecttemplatesourceitem">[]ObjectTemplateSourceItem</a> | |
| `optional` <br><a href="#bool">bool</a> | Marks this source as optional.<br>The templated object will still be applied if optional sources are not found.<br>If the source object is created later on, it will be eventually picked up. |
| `optional` <br>bool | Marks this source as optional.<br>The templated object will still be applied if optional sources are not found.<br>If the source object is created later on, it will be eventually picked up. |


Used in:
Expand Down Expand Up @@ -1135,7 +1167,7 @@ PackageSpec specifies a package.
| `image` <b>required</b><br>string | the image containing the contents of the package<br>this image will be unpacked by the package-loader to render<br>the ObjectDeployment for propagating the installation of the package. |
| `config` <br>runtime.RawExtension | Package configuration parameters. |
| `component` <br>string | Desired component to deploy from multi-component packages. |
| `paused` <br><a href="#bool">bool</a> | If Paused is true, the package and its children will not be reconciled. |
| `paused` <br>bool | If Paused is true, the package and its children will not be reconciled. |


Used in:
Expand Down Expand Up @@ -1303,7 +1335,7 @@ spec:
platformVersion:
name: Kubernetes
range: '>=1.20.x'
uniqueInScope: PackageManifestUniqueInScopeConstraint
uniqueInScope: {}
dependencies:
- image:
name: my-pkg
Expand Down Expand Up @@ -1442,7 +1474,7 @@ data:
platformVersion:
name: Kubernetes
range: '>=1.20.x'
uniqueInScope: PackageManifestUniqueInScopeConstraint
uniqueInScope: {}
digest: dolor
image: ipsum
name: amet
Expand Down Expand Up @@ -1506,7 +1538,8 @@ https://github.com/openshift/hypershift
| Field | Description |
| ----- | ----------- |
| `metadata` <b>required</b><br><a href="#templatecontextobjectmeta">TemplateContextObjectMeta</a> | TemplateContextObjectMeta represents a simplified version of metav1.ObjectMeta for use in templates. |
| `hostedClusterNamespace` <b>required</b><br>string | Namespace of HostedCluster components belonging to this HostedCluster object. |
| `hostedClusterNamespace` <b>required</b><br>string | The control-plane namespace of this hosted cluster.<br>Note: This should actually be named HostedControlPlaneNamespace, but renaming would change our template API. |
| `nodeSelector` <br><a href="#map[string]string">map[string]string</a> | NodeSelector when specified in HostedCluster.spec.nodeSelector, is propagated to all control plane Deployments<br>and Stateful sets running management side.<br><br>Note: Upstream docs of this field specify that changing it will re-deploy<br>existing control-plane workloads. This is not something that PKO currently supports. |


Used in:
Expand Down