Skip to content

Commit

Permalink
chore: use grep -E than egrep and set minkube version to match produc…
Browse files Browse the repository at this point in the history
…tion (#1187)

- warning when "make api-docs": egrep: warning: egrep is obsolescent; using grep -E
- we need to use min k8s version 1.25

Signed-off-by: Wen Zhou <[email protected]>
  • Loading branch information
zdtsw authored Aug 19, 2024
1 parent a88cef0 commit 14fdb89
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion crd-ref-docs.config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
8 changes: 4 additions & 4 deletions docs/api-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.<br />Servers may infer this from the endpoint the client submits requests to.<br />Cannot be updated.<br />In CamelCase.<br />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.<br />Servers should convert recognized schemas to the latest internal value, and<br />may reject unrecognized values.<br />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)_ | | | |

Expand Down Expand Up @@ -477,7 +477,7 @@ _Appears in:_
| --- | --- | --- | --- |
| `phase` _string_ | Phase describes the Phase of DataScienceCluster reconciliation state<br />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.<br />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.<br />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 | | |
Expand Down Expand Up @@ -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.<br />Servers may infer this from the endpoint the client submits requests to.<br />Cannot be updated.<br />In CamelCase.<br />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.<br />Servers should convert recognized schemas to the latest internal value, and<br />may reject unrecognized values.<br />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)_ | | | |

Expand Down Expand Up @@ -626,7 +626,7 @@ _Appears in:_
| --- | --- | --- | --- |
| `phase` _string_ | Phase describes the Phase of DSCInitializationStatus<br />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.<br />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.<br />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 | | |

Expand Down

0 comments on commit 14fdb89

Please sign in to comment.