diff --git a/Makefile b/Makefile index c16e5f9cf6b..3c86a2d5539 100644 --- a/Makefile +++ b/Makefile @@ -172,7 +172,7 @@ CLEANFILES += opt/manifests/* .PHONY: api-docs api-docs: crd-ref-docs ## Creates API docs using https://github.com/elastic/crd-ref-docs $(CRD_REF_DOCS) --source-path ./ --output-path ./docs/api-overview.md --renderer markdown --config ./crd-ref-docs.config.yaml && \ - egrep -v '\.io/[^v][^1].*)$$' ./docs/api-overview.md > temp.md && mv ./temp.md ./docs/api-overview.md + grep -Ev '\.io/[^v][^1].*)$$' ./docs/api-overview.md > temp.md && mv ./temp.md ./docs/api-overview.md ##@ Build diff --git a/crd-ref-docs.config.yaml b/crd-ref-docs.config.yaml index b021d19353d..bbc2c1ba282 100644 --- a/crd-ref-docs.config.yaml +++ b/crd-ref-docs.config.yaml @@ -7,4 +7,4 @@ processor: - "(DataScienceCluster|DSCInitialization)List$" render: # Version of Kubernetes to use when generating links to Kubernetes API documentation. - kubernetesVersion: 1.24 + kubernetesVersion: 1.25 diff --git a/docs/api-overview.md b/docs/api-overview.md index 895bd336a03..b4c0ac69253 100644 --- a/docs/api-overview.md +++ b/docs/api-overview.md @@ -441,7 +441,7 @@ DataScienceCluster is the Schema for the datascienceclusters API. | `kind` _string_ | `DataScienceCluster` | | | | `kind` _string_ | Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | | | `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | | -| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | | `spec` _[DataScienceClusterSpec](#datascienceclusterspec)_ | | | | | `status` _[DataScienceClusterStatus](#datascienceclusterstatus)_ | | | | @@ -477,7 +477,7 @@ _Appears in:_ | --- | --- | --- | --- | | `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. | | | -| `relatedObjects` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#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. | | | +| `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 | | | | `release` _[Release](#release)_ | Version and release type | | | @@ -586,7 +586,7 @@ DSCInitialization is the Schema for the dscinitializations API. | `kind` _string_ | `DSCInitialization` | | | | `kind` _string_ | Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | | | `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | | -| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | | `spec` _[DSCInitializationSpec](#dscinitializationspec)_ | | | | | `status` _[DSCInitializationStatus](#dscinitializationstatus)_ | | | | @@ -626,7 +626,7 @@ _Appears in:_ | --- | --- | --- | --- | | `phase` _string_ | Phase describes the Phase of DSCInitializationStatus
This is used by OLM UI to provide status information to the user | | | | `conditions` _Condition array_ | Conditions describes the state of the DSCInitializationStatus resource | | | -| `relatedObjects` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/#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 | | | +| `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_ | | | | | `release` _[Release](#release)_ | Version and release type | | |