diff --git a/content/en/docs/api_reference/package-operator-api.md b/content/en/docs/api_reference/package-operator-api.md
index 5bd6c58..afcf099 100644
--- a/content/en/docs/api_reference/package-operator-api.md
+++ b/content/en/docs/api_reference/package-operator-api.md
@@ -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:
@@ -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
@@ -190,7 +197,10 @@ spec:
successDelaySeconds: 42
status:
conditions:
- - metav1.Condition
+ - message: Latest Revision is Available.
+ reason: Available
+ status: "True"
+ type: Available
controllerOf:
- group: amet
kind: sit
@@ -198,7 +208,7 @@ status:
namespace: sadipscing
remotePhases:
- name: dolor
- uid: types.UID
+ uid: 3490a790-05f8-4bd7-8333-1001c49fccd2
revision: 42
```
@@ -254,7 +264,7 @@ spec:
kind: Deployment
metadata:
name: example-deployment
- paused: "true"
+ paused: true
previous:
- name: previous-revision
revision: 42
@@ -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
@@ -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
@@ -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:
@@ -446,7 +466,10 @@ spec:
status:
collisionCount: 42
conditions:
- - metav1.Condition
+ - message: ""
+ reason: Available
+ status: "True"
+ type: Available
controllerOf:
- group: nonumy
kind: diam
@@ -526,7 +549,10 @@ spec:
successDelaySeconds: 42
status:
conditions:
- - metav1.Condition
+ - message: Latest Revision is Available.
+ reason: Available
+ status: "True"
+ type: Available
controllerOf:
- group: elitr
kind: sadipscing
@@ -534,7 +560,7 @@ status:
namespace: diam
remotePhases:
- name: consetetur
- uid: types.UID
+ uid: 3490a790-05f8-4bd7-8333-1001c49fccd2
revision: 42
```
@@ -590,7 +616,7 @@ spec:
kind: Deployment
metadata:
name: example-deployment
- paused: "true"
+ paused: true
previous:
- name: previous-revision
revision: 42
@@ -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
@@ -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
@@ -738,10 +770,10 @@ ClusterObjectDeploymentSpec defines the desired state of a ClusterObjectDeployme
| Field | Description |
| ----- | ----------- |
-| `revisionHistoryLimit`
int32 | Number of old revisions in the form of archived ObjectSets to keep. |
+| `revisionHistoryLimit`
int32 | Number of old revisions in the form of archived ObjectSets to keep. |
| `selector` required
metav1.LabelSelector | Selector targets ObjectSets managed by this Deployment. |
| `template` required
ObjectSetTemplate | Template to create new ObjectSets from. |
-| `paused`
bool | If Paused is true, the object and its children will not be reconciled. |
+| `paused`
bool | If Paused is true, the object and its children will not be reconciled. |
Used in:
@@ -755,7 +787,7 @@ ClusterObjectDeploymentStatus defines the observed state of a ClusterObjectDeplo
| Field | Description |
| ----- | ----------- |
| `conditions`
[]metav1.Condition | Conditions is a list of status conditions ths object is in. |
-| `collisionCount`
int32 | Count of hash collisions of the ClusterObjectDeployment. |
+| `collisionCount`
int32 | Count of hash collisions of the ClusterObjectDeployment. |
| `templateHash`
string | Computed TemplateHash. |
| `revision`
int64 | Deployment revision. |
| `controllerOf`
[]ControlledObjectReference | ControllerOf references the owned ClusterObjectSet revisions. |
@@ -771,7 +803,7 @@ ClusterObjectSetPhaseSpec defines the desired state of a ClusterObjectSetPhase.
| Field | Description |
| ----- | ----------- |
-| `paused`
bool | Disables reconciliation of the ClusterObjectSet.
Only Status updates will still be propagated, but object changes will not be reconciled. |
+| `paused`
bool | Disables reconciliation of the ClusterObjectSet.
Only Status updates will still be propagated, but object changes will not be reconciled. |
| `revision` required
int64 | Revision of the parent ObjectSet to use during object adoption. |
| `previous`
[]PreviousRevisionReference | Previous revisions of the ClusterObjectSet to adopt objects from. |
| `availabilityProbes`
[]ObjectSetProbe | Availability Probes check objects that are part of the package.
All probes need to succeed for a package to be considered Available.
Failing probes will prevent the reconciliation of objects in later phases. |
@@ -806,7 +838,7 @@ ClusterObjectSetSpec defines the desired state of a ClusterObjectSet.
| `previous`
[]PreviousRevisionReference | Previous revisions of the ClusterObjectSet to adopt objects from. |
| `phases`
[]ObjectSetTemplatePhase | Reconcile phase configuration for a ObjectSet.
Phases will be reconciled in order and the contained objects checked
against given probes before continuing with the next phase. |
| `availabilityProbes`
[]ObjectSetProbe | Availability Probes check objects that are part of the package.
All probes need to succeed for a package to be considered Available.
Failing probes will prevent the reconciliation of objects in later phases. |
-| `successDelaySeconds`
int32 | Success Delay Seconds applies a wait period from the time an
Object Set is available to the time it is marked as successful.
This can be used to prevent false reporting of success when
the underlying objects may initially satisfy the availability
probes, but are ultimately unstable. |
+| `successDelaySeconds`
int32 | Success Delay Seconds applies a wait period from the time an
Object Set is available to the time it is marked as successful.
This can be used to prevent false reporting of success when
the underlying objects may initially satisfy the availability
probes, but are ultimately unstable. |
Used in:
@@ -871,10 +903,10 @@ ObjectDeploymentSpec defines the desired state of an ObjectDeployment.
| Field | Description |
| ----- | ----------- |
-| `revisionHistoryLimit`
int32 | Number of old revisions in the form of archived ObjectSets to keep. |
+| `revisionHistoryLimit`
int32 | Number of old revisions in the form of archived ObjectSets to keep. |
| `selector` required
metav1.LabelSelector | Selector targets ObjectSets managed by this Deployment. |
| `template` required
ObjectSetTemplate | Template to create new ObjectSets from. |
-| `paused`
bool | If Paused is true, the object and its children will not be reconciled. |
+| `paused`
bool | If Paused is true, the object and its children will not be reconciled. |
Used in:
@@ -888,7 +920,7 @@ ObjectDeploymentStatus defines the observed state of an ObjectDeployment.
| Field | Description |
| ----- | ----------- |
| `conditions`
[]metav1.Condition | Conditions is a list of status conditions ths object is in. |
-| `collisionCount`
int32 | Count of hash collisions of the ObjectDeployment. |
+| `collisionCount`
int32 | Count of hash collisions of the ObjectDeployment. |
| `templateHash`
string | Computed TemplateHash. |
| `revision`
int64 | Deployment revision. |
| `controllerOf`
[]ControlledObjectReference | ControllerOf references the owned ObjectSet revisions. |
@@ -923,7 +955,7 @@ ObjectSetPhaseSpec defines the desired state of a ObjectSetPhase.
| Field | Description |
| ----- | ----------- |
-| `paused`
bool | Disables reconciliation of the ObjectSet.
Only Status updates will still be propagated, but object changes will not be reconciled. |
+| `paused`
bool | Disables reconciliation of the ObjectSet.
Only Status updates will still be propagated, but object changes will not be reconciled. |
| `revision` required
int64 | Revision of the parent ObjectSet to use during object adoption. |
| `previous`
[]PreviousRevisionReference | Previous revisions of the ObjectSet to adopt objects from. |
| `availabilityProbes`
[]ObjectSetProbe | Availability Probes check objects that are part of the package.
All probes need to succeed for a package to be considered Available.
Failing probes will prevent the reconciliation of objects in later phases. |
@@ -976,7 +1008,7 @@ ObjectSetSpec defines the desired state of a ObjectSet.
| `previous`
[]PreviousRevisionReference | Previous revisions of the ObjectSet to adopt objects from. |
| `phases`
[]ObjectSetTemplatePhase | Reconcile phase configuration for a ObjectSet.
Phases will be reconciled in order and the contained objects checked
against given probes before continuing with the next phase. |
| `availabilityProbes`
[]ObjectSetProbe | Availability Probes check objects that are part of the package.
All probes need to succeed for a package to be considered Available.
Failing probes will prevent the reconciliation of objects in later phases. |
-| `successDelaySeconds`
int32 | Success Delay Seconds applies a wait period from the time an
Object Set is available to the time it is marked as successful.
This can be used to prevent false reporting of success when
the underlying objects may initially satisfy the availability
probes, but are ultimately unstable. |
+| `successDelaySeconds`
int32 | Success Delay Seconds applies a wait period from the time an
Object Set is available to the time it is marked as successful.
This can be used to prevent false reporting of success when
the underlying objects may initially satisfy the availability
probes, but are ultimately unstable. |
Used in:
@@ -1042,7 +1074,7 @@ also update validation rules in (Cluster)ObjectSetSpec.
| ----- | ----------- |
| `phases`
[]ObjectSetTemplatePhase | Reconcile phase configuration for a ObjectSet.
Phases will be reconciled in order and the contained objects checked
against given probes before continuing with the next phase. |
| `availabilityProbes`
[]ObjectSetProbe | Availability Probes check objects that are part of the package.
All probes need to succeed for a package to be considered Available.
Failing probes will prevent the reconciliation of objects in later phases. |
-| `successDelaySeconds`
int32 | Success Delay Seconds applies a wait period from the time an
Object Set is available to the time it is marked as successful.
This can be used to prevent false reporting of success when
the underlying objects may initially satisfy the availability
probes, but are ultimately unstable. |
+| `successDelaySeconds`
int32 | Success Delay Seconds applies a wait period from the time an
Object Set is available to the time it is marked as successful.
This can be used to prevent false reporting of success when
the underlying objects may initially satisfy the availability
probes, but are ultimately unstable. |
Used in:
@@ -1060,7 +1092,7 @@ ObjectTemplateSource defines a source for a template.
| `namespace`
string | |
| `name` required
string | |
| `items` required
[]ObjectTemplateSourceItem | |
-| `optional`
bool | Marks this source as optional.
The templated object will still be applied if optional sources are not found.
If the source object is created later on, it will be eventually picked up. |
+| `optional`
bool | Marks this source as optional.
The templated object will still be applied if optional sources are not found.
If the source object is created later on, it will be eventually picked up. |
Used in:
@@ -1135,7 +1167,7 @@ PackageSpec specifies a package.
| `image` required
string | the image containing the contents of the package
this image will be unpacked by the package-loader to render
the ObjectDeployment for propagating the installation of the package. |
| `config`
runtime.RawExtension | Package configuration parameters. |
| `component`
string | Desired component to deploy from multi-component packages. |
-| `paused`
bool | If Paused is true, the package and its children will not be reconciled. |
+| `paused`
bool | If Paused is true, the package and its children will not be reconciled. |
Used in:
@@ -1303,7 +1335,7 @@ spec:
platformVersion:
name: Kubernetes
range: '>=1.20.x'
- uniqueInScope: PackageManifestUniqueInScopeConstraint
+ uniqueInScope: {}
dependencies:
- image:
name: my-pkg
@@ -1442,7 +1474,7 @@ data:
platformVersion:
name: Kubernetes
range: '>=1.20.x'
- uniqueInScope: PackageManifestUniqueInScopeConstraint
+ uniqueInScope: {}
digest: dolor
image: ipsum
name: amet
@@ -1506,7 +1538,8 @@ https://github.com/openshift/hypershift
| Field | Description |
| ----- | ----------- |
| `metadata` required
TemplateContextObjectMeta | TemplateContextObjectMeta represents a simplified version of metav1.ObjectMeta for use in templates. |
-| `hostedClusterNamespace` required
string | Namespace of HostedCluster components belonging to this HostedCluster object. |
+| `hostedClusterNamespace` required
string | The control-plane namespace of this hosted cluster.
Note: This should actually be named HostedControlPlaneNamespace, but renaming would change our template API. |
+| `nodeSelector`
map[string]string | NodeSelector when specified in HostedCluster.spec.nodeSelector, is propagated to all control plane Deployments
and Stateful sets running management side.
Note: Upstream docs of this field specify that changing it will re-deploy
existing control-plane workloads. This is not something that PKO currently supports. |
Used in: