diff --git a/docs/api-overview.md b/docs/api-overview.md index 67cc598155d..137ebbb6f5a 100644 --- a/docs/api-overview.md +++ b/docs/api-overview.md @@ -147,8 +147,8 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | | `phase` _string_ | | | | -| `observedGeneration` _integer_ | | | | -| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) array_ | | | | +| `observedGeneration` _integer_ | The generation observed by the resource controller. | | | +| `conditions` _[Condition](#condition) array_ | | | | | `releases` _[ComponentRelease](#componentrelease) array_ | | | | @@ -659,8 +659,8 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | | `phase` _string_ | | | | -| `observedGeneration` _integer_ | | | | -| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) array_ | | | | +| `observedGeneration` _integer_ | The generation observed by the resource controller. | | | +| `conditions` _[Condition](#condition) array_ | | | | | `url` _string_ | | | | @@ -772,8 +772,8 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | | `phase` _string_ | | | | -| `observedGeneration` _integer_ | | | | -| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) array_ | | | | +| `observedGeneration` _integer_ | The generation observed by the resource controller. | | | +| `conditions` _[Condition](#condition) array_ | | | | | `releases` _[ComponentRelease](#componentrelease) array_ | | | | @@ -903,8 +903,8 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | | `phase` _string_ | | | | -| `observedGeneration` _integer_ | | | | -| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) array_ | | | | +| `observedGeneration` _integer_ | The generation observed by the resource controller. | | | +| `conditions` _[Condition](#condition) array_ | | | | | `releases` _[ComponentRelease](#componentrelease) array_ | | | | @@ -1022,8 +1022,8 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | | `phase` _string_ | | | | -| `observedGeneration` _integer_ | | | | -| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) array_ | | | | +| `observedGeneration` _integer_ | The generation observed by the resource controller. | | | +| `conditions` _[Condition](#condition) array_ | | | | | `defaultDeploymentMode` _string_ | DefaultDeploymentMode is the value of the defaultDeploymentMode field
as read from the "deploy" JSON in the inferenceservice-config ConfigMap | | | | `serverlessMode` _[ManagementState](#managementstate)_ | | | | | `releases` _[ComponentRelease](#componentrelease) array_ | | | | @@ -1135,8 +1135,8 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | | `phase` _string_ | | | | -| `observedGeneration` _integer_ | | | | -| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) array_ | | | | +| `observedGeneration` _integer_ | The generation observed by the resource controller. | | | +| `conditions` _[Condition](#condition) array_ | | | | | `releases` _[ComponentRelease](#componentrelease) array_ | | | | @@ -1248,8 +1248,8 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | | `phase` _string_ | | | | -| `observedGeneration` _integer_ | | | | -| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) array_ | | | | +| `observedGeneration` _integer_ | The generation observed by the resource controller. | | | +| `conditions` _[Condition](#condition) array_ | | | | #### ModelMeshServing @@ -1358,8 +1358,8 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | | `phase` _string_ | | | | -| `observedGeneration` _integer_ | | | | -| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) array_ | | | | +| `observedGeneration` _integer_ | The generation observed by the resource controller. | | | +| `conditions` _[Condition](#condition) array_ | | | | | `releases` _[ComponentRelease](#componentrelease) array_ | | | | @@ -1472,8 +1472,8 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | | `phase` _string_ | | | | -| `observedGeneration` _integer_ | | | | -| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) array_ | | | | +| `observedGeneration` _integer_ | The generation observed by the resource controller. | | | +| `conditions` _[Condition](#condition) array_ | | | | | `registriesNamespace` _string_ | | | | | `releases` _[ComponentRelease](#componentrelease) array_ | | | | @@ -1603,8 +1603,8 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | | `phase` _string_ | | | | -| `observedGeneration` _integer_ | | | | -| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) array_ | | | | +| `observedGeneration` _integer_ | The generation observed by the resource controller. | | | +| `conditions` _[Condition](#condition) array_ | | | | | `releases` _[ComponentRelease](#componentrelease) array_ | | | | @@ -1714,8 +1714,8 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | | `phase` _string_ | | | | -| `observedGeneration` _integer_ | | | | -| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) array_ | | | | +| `observedGeneration` _integer_ | The generation observed by the resource controller. | | | +| `conditions` _[Condition](#condition) array_ | | | | | `releases` _[ComponentRelease](#componentrelease) array_ | | | | @@ -1825,8 +1825,8 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | | `phase` _string_ | | | | -| `observedGeneration` _integer_ | | | | -| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) array_ | | | | +| `observedGeneration` _integer_ | The generation observed by the resource controller. | | | +| `conditions` _[Condition](#condition) array_ | | | | | `releases` _[ComponentRelease](#componentrelease) array_ | | | | @@ -1936,8 +1936,8 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | | `phase` _string_ | | | | -| `observedGeneration` _integer_ | | | | -| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) array_ | | | | +| `observedGeneration` _integer_ | The generation observed by the resource controller. | | | +| `conditions` _[Condition](#condition) array_ | | | | | `releases` _[ComponentRelease](#componentrelease) array_ | | | | @@ -2133,9 +2133,9 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | -| `phase` _string_ | Phase describes the Phase of DataScienceCluster reconciliation state
This is used by OLM UI to provide status information to the user | | | -| `conditions` _Condition array_ | Conditions describes the state of the DataScienceCluster resource. | | | -| `observedGeneration` _integer_ | The generation observed by the deployment controller. | | | +| `phase` _string_ | | | | +| `observedGeneration` _integer_ | The generation observed by the resource controller. | | | +| `conditions` _[Condition](#condition) array_ | | | | | `relatedObjects` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectreference-v1-core) array_ | RelatedObjects is a list of objects created and maintained by this operator.
Object references will be added to this list after they have been created AND found in the cluster. | | | | `errorMessage` _string_ | | | | | `installedComponents` _object (keys:string, values:boolean)_ | List of components with status if installed or not | | | @@ -2400,8 +2400,8 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | | `phase` _string_ | | | | -| `observedGeneration` _integer_ | | | | -| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) array_ | | | | +| `observedGeneration` _integer_ | The generation observed by the resource controller. | | | +| `conditions` _[Condition](#condition) array_ | | | | #### DSCMonitoring @@ -2510,8 +2510,8 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | | `phase` _string_ | | | | -| `observedGeneration` _integer_ | | | | -| `conditions` _[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#condition-v1-meta) array_ | | | | +| `observedGeneration` _integer_ | The generation observed by the resource controller. | | | +| `conditions` _[Condition](#condition) array_ | | | | | `url` _string_ | | | |