mirrors/pinniped
1
0
Fork 0
mirror of https://github.com/vmware-tanzu/pinniped.git synced 2026-01-06 05:27:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

generate model names via gen_openapi to fix 'kubectl explain'

Browse Source 
Also fixes some kubectl client-side validation errors, which also uses
the generated openapi docs served by Pinniped.
This commit is contained in:
Ryan Richard
2025-12-19 15:15:14 -08:00
parent b04ae898ca
commit cbce243d57
1 changed files with 32 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
hack/lib/update-codegen.sh
View File

@@ -1,6 +1,6 @@
#!/usr/bin/env bash #!/usr/bin/env bash
# Copyright 2020-2024 the Pinniped contributors. All Rights Reserved. # Copyright 2020-2025 the Pinniped contributors. All Rights Reserved.
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0
set -euo pipefail set -euo pipefail
ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)" ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
@@ -69,6 +69,10 @@ KUBE_1_30_OR_NEWER="no"
if [[ "$KUBE_MAJOR_NUMBER" -gt "1" || ( "$KUBE_MAJOR_NUMBER" == "1" && "$KUBE_MINOR_NUMBER" -ge "30" ) ]]; then if [[ "$KUBE_MAJOR_NUMBER" -gt "1" || ( "$KUBE_MAJOR_NUMBER" == "1" && "$KUBE_MINOR_NUMBER" -ge "30" ) ]]; then
KUBE_1_30_OR_NEWER="yes" KUBE_1_30_OR_NEWER="yes"
fi fi
KUBE_1_35_OR_NEWER="no"
if [[ "$KUBE_MAJOR_NUMBER" -gt "1" || ( "$KUBE_MAJOR_NUMBER" == "1" && "$KUBE_MINOR_NUMBER" -ge "35" ) ]]; then
KUBE_1_35_OR_NEWER="yes"
fi
# KUBE_MODULE_VERSION is just version of client libraries (e.g., 'v0.28.9-rc-0'). # KUBE_MODULE_VERSION is just version of client libraries (e.g., 'v0.28.9-rc-0').
KUBE_MODULE_VERSION="v0.$(echo "${KUBE_VERSION}" | cut -d '.' -f 2-)" KUBE_MODULE_VERSION="v0.$(echo "${KUBE_VERSION}" | cut -d '.' -f 2-)"
@@ -226,22 +230,38 @@ if [[ "$KUBE_1_30_OR_NEWER" == "yes" ]]; then
echo "generating API clients and openapi..." echo "generating API clients and openapi..."
# Note that --extra-pkgs can be set to generate openapi docs for other k8s APIs that our types depend upon
# aside from the default k8s packages that are already added automatically by the kube::codegen::gen_openapi script
# (meta/v1, runtime, and version). E.g. TokenCredentialRequestSpec uses corev1.TypedLocalObjectReference, so we
# add core/v1 when running codegen for the Pinniped aggregated APIs here.
concierge_gen_openapi_args=(
"${OUTPUT_DIR}/apis/concierge"
--update-report
--extra-pkgs "k8s.io/api/core/v1"
--output-dir "${OUTPUT_DIR}/client/concierge/openapi"
--output-pkg "${BASE_PKG}/generated/${KUBE_MINOR_VERSION}/client/concierge"
--boilerplate "${ROOT}/hack/boilerplate.go.txt"
)
supervisor_gen_openapi_args=(
"${OUTPUT_DIR}/apis/supervisor"
--update-report
--extra-pkgs "k8s.io/api/core/v1"
--output-dir "${OUTPUT_DIR}/client/supervisor/openapi"
--output-pkg "${BASE_PKG}/generated/${KUBE_MINOR_VERSION}/client/supervisor"
--boilerplate "${ROOT}/hack/boilerplate.go.txt"
)
if [[ "$KUBE_1_35_OR_NEWER" == "yes" ]]; then
concierge_gen_openapi_args+=(--output-model-name-file "zz_generated.model_name.go")
supervisor_gen_openapi_args+=(--output-model-name-file "zz_generated.model_name.go")
fi
pushd "${OUTPUT_DIR}/apis/concierge" > /dev/null pushd "${OUTPUT_DIR}/apis/concierge" > /dev/null
kube::codegen::gen_client "${OUTPUT_DIR}/apis/concierge" \ kube::codegen::gen_client "${OUTPUT_DIR}/apis/concierge" \
--with-watch \ --with-watch \
--output-dir "${OUTPUT_DIR}/client/concierge" \ --output-dir "${OUTPUT_DIR}/client/concierge" \
--output-pkg "${BASE_PKG}/generated/${KUBE_MINOR_VERSION}/client/concierge" \ --output-pkg "${BASE_PKG}/generated/${KUBE_MINOR_VERSION}/client/concierge" \
--boilerplate "${ROOT}/hack/boilerplate.go.txt" 2>&1 | sed "s|^|gen-client-concierge > |" --boilerplate "${ROOT}/hack/boilerplate.go.txt" 2>&1 | sed "s|^|gen-client-concierge > |"
# Note that --extra-pkgs can be set to generate openapi docs for other k8s APIs that our types depend upon kube::codegen::gen_openapi "${concierge_gen_openapi_args[@]}" 2>&1 | sed "s|^|gen-openapi-concierge > |"
# aside from the default k8s packages that are already added automatically by the kube::codegen::gen_openapi script
# (meta/v1, runtime, and version). E.g. TokenCredentialRequestSpec uses corev1.TypedLocalObjectReference, so we
# add core/v1 when running codegen for the Concierge aggregated APIs here.
kube::codegen::gen_openapi "${OUTPUT_DIR}/apis/concierge" \
--update-report \
--extra-pkgs "k8s.io/api/core/v1" \
--output-dir "${OUTPUT_DIR}/client/concierge/openapi" \
--output-pkg "${BASE_PKG}/generated/${KUBE_MINOR_VERSION}/client/concierge" \
--boilerplate "${ROOT}/hack/boilerplate.go.txt" 2>&1 | sed "s|^|gen-openapi-concierge > |"
popd > /dev/null popd > /dev/null
pushd "${OUTPUT_DIR}/apis/supervisor" > /dev/null pushd "${OUTPUT_DIR}/apis/supervisor" > /dev/null
@@ -250,12 +270,7 @@ if [[ "$KUBE_1_30_OR_NEWER" == "yes" ]]; then
--output-dir "${OUTPUT_DIR}/client/supervisor" \ --output-dir "${OUTPUT_DIR}/client/supervisor" \
--output-pkg "${BASE_PKG}/generated/${KUBE_MINOR_VERSION}/client/supervisor" \ --output-pkg "${BASE_PKG}/generated/${KUBE_MINOR_VERSION}/client/supervisor" \
--boilerplate "${ROOT}/hack/boilerplate.go.txt" 2>&1 | sed "s|^|gen-client-supervisor > |" --boilerplate "${ROOT}/hack/boilerplate.go.txt" 2>&1 | sed "s|^|gen-client-supervisor > |"
kube::codegen::gen_openapi "${OUTPUT_DIR}/apis/supervisor" \ kube::codegen::gen_openapi "${supervisor_gen_openapi_args[@]}" 2>&1 | sed "s|^|gen-openapi-supervisor > |"
--update-report \
--extra-pkgs "k8s.io/api/core/v1" \
--output-dir "${OUTPUT_DIR}/client/supervisor/openapi" \
--output-pkg "${BASE_PKG}/generated/${KUBE_MINOR_VERSION}/client/supervisor" \
--boilerplate "${ROOT}/hack/boilerplate.go.txt" 2>&1 | sed "s|^|gen-openapi-supervisor > |"
popd > /dev/null popd > /dev/null
# Tidy the client module after codegen. # Tidy the client module after codegen.