Merge pull request #30823 from nikhiljindal/swaggerDocs

Automatic merge from submit-queue Adding a script to fetch swagger spec from federation apiserver First step for https://github.com/kubernetes/kubernetes/issues/30541. Next step is to generate docs like http://kubernetes.io/docs/api-reference/v1/definitions/ from this swagger spec. cc @kubernetes/sig-cluster-federation @kubernetes/sig-api-machinery
2025-11-03 11:48:15 +00:00 · 2016-08-20 18:09:58 -07:00
parent 1de858290d d76cdc7482
commit ada58f5ff2
13 changed files with 9827 additions and 31 deletions
--- a/hack/lib/util.sh
+++ b/hack/lib/util.sh
@@ -325,6 +325,43 @@ kube::util::gv-to-swagger-name() {
  esac
 }

+
+# Fetches swagger spec from apiserver.
+# Assumed vars:
+# SWAGGER_API_PATH: Base path for swaggerapi on apiserver. Ex:
+# http://localhost:8080/swaggerapi.
+# SWAGGER_ROOT_DIR: Root dir where we want to to save the fetched spec.
+# VERSIONS: Array of group versions to include in swagger spec.
+kube::util::fetch-swagger-spec() {
+  for ver in ${VERSIONS}; do
+    # fetch the swagger spec for each group version.
+    if [[ ${ver} == "v1" ]]; then
+      SUBPATH="api"
+    else
+      SUBPATH="apis"
+    fi
+    SUBPATH="${SUBPATH}/${ver}"
+    SWAGGER_JSON_NAME="$(kube::util::gv-to-swagger-name ${ver}).json"
+    curl -w "\n" -fs "${SWAGGER_API_PATH}${SUBPATH}" > "${SWAGGER_ROOT_DIR}/${SWAGGER_JSON_NAME}"
+
+    # fetch the swagger spec for the discovery mechanism at group level.
+    if [[ ${ver} == "v1" ]]; then
+      continue
+    fi
+    SUBPATH="apis/"${ver%/*}
+    SWAGGER_JSON_NAME="${ver%/*}.json"
+    curl -w "\n" -fs "${SWAGGER_API_PATH}${SUBPATH}" > "${SWAGGER_ROOT_DIR}/${SWAGGER_JSON_NAME}"
+  done
+
+  # fetch swagger specs for other discovery mechanism.
+  curl -w "\n" -fs "${SWAGGER_API_PATH}" > "${SWAGGER_ROOT_DIR}/resourceListing.json"
+  curl -w "\n" -fs "${SWAGGER_API_PATH}version" > "${SWAGGER_ROOT_DIR}/version.json"
+  curl -w "\n" -fs "${SWAGGER_API_PATH}api" > "${SWAGGER_ROOT_DIR}/api.json"
+  curl -w "\n" -fs "${SWAGGER_API_PATH}apis" > "${SWAGGER_ROOT_DIR}/apis.json"
+  curl -w "\n" -fs "${SWAGGER_API_PATH}logs" > "${SWAGGER_ROOT_DIR}/logs.json"
+}
+
+
 # Returns the name of the upstream remote repository name for the local git
 # repo, e.g. "upstream" or "origin".
 kube::util::git_upstream_remote_name() {
--- a/hack/update-federation-swagger-spec.sh
+++ b/hack/update-federation-swagger-spec.sh
@@ -0,0 +1,81 @@
+#!/bin/bash
+
+# Copyright 2015 The Kubernetes Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Script to fetch latest swagger spec from federation-apiserver
+# Puts the updated spec at federation/apis/swagger-spec/
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+cat << __EOF__
+Note: This assumes that the 'types_swagger_doc_generated.go' file has been
+updated for all API group versions. If you are unsure, please run
+hack/update-generated-swagger-docs.sh first.
+__EOF__
+
+KUBE_ROOT=$(dirname "${BASH_SOURCE}")/..
+SWAGGER_ROOT_DIR="${KUBE_ROOT}/federation/apis/swagger-spec"
+source "${KUBE_ROOT}/hack/lib/init.sh"
+
+kube::golang::setup_env
+
+make -C "${KUBE_ROOT}" WHAT="cmd/hyperkube"
+
+function cleanup()
+{
+    [[ -n ${APISERVER_PID-} ]] && kill ${APISERVER_PID} 1>&2 2>/dev/null
+
+    kube::etcd::cleanup
+
+    kube::log::status "Clean up complete"
+}
+
+trap cleanup EXIT SIGINT
+
+kube::golang::setup_env
+
+ETCD_HOST=${ETCD_HOST:-127.0.0.1}
+ETCD_PORT=${ETCD_PORT:-2379}
+API_PORT=${API_PORT:-8050}
+API_HOST=${API_HOST:-127.0.0.1}
+
+kube::etcd::start
+
+# Start federation-apiserver
+kube::log::status "Starting federation-apiserver"
+sudo -E "${KUBE_OUTPUT_HOSTBIN}/hyperkube" federation-apiserver \
+  --insecure-bind-address="${API_HOST}" \
+  --bind-address="${API_HOST}" \
+  --insecure-port="${API_PORT}" \
+  --etcd-servers="http://${ETCD_HOST}:${ETCD_PORT}" \
+  --advertise-address="10.10.10.10" \
+  --service-cluster-ip-range="10.0.0.0/24" >/tmp/swagger-federation-api-server.log 2>&1 &
+APISERVER_PID=$!
+
+kube::util::wait_for_url "${API_HOST}:${API_PORT}/" "apiserver: "
+
+SWAGGER_API_PATH="${API_HOST}:${API_PORT}/swaggerapi/"
+DEFAULT_GROUP_VERSIONS="v1 extensions/v1beta1 federation/v1beta1"
+VERSIONS=${VERSIONS:-$DEFAULT_GROUP_VERSIONS}
+
+kube::log::status "Updating " ${SWAGGER_ROOT_DIR}
+
+SWAGGER_API_PATH="${SWAGGER_API_PATH}" SWAGGER_ROOT_DIR="${SWAGGER_ROOT_DIR}" VERSIONS="${VERSIONS}" kube::util::fetch-swagger-spec
+
+kube::log::status "SUCCESS"
+
+# ex: ts=2 sw=2 et filetype=sh
--- a/hack/update-swagger-spec.sh
+++ b/hack/update-swagger-spec.sh
@@ -15,7 +15,7 @@
 # limitations under the License.

 # Script to fetch latest swagger spec.
-# Puts the updated spec at swagger-spec/
+# Puts the updated spec at api/swagger-spec/

 set -o errexit
 set -o nounset
@@ -55,15 +55,14 @@ ETCD_HOST=${ETCD_HOST:-127.0.0.1}
 ETCD_PORT=${ETCD_PORT:-2379}
 API_PORT=${API_PORT:-8050}
 API_HOST=${API_HOST:-127.0.0.1}
-KUBELET_PORT=${KUBELET_PORT:-10250}

 kube::etcd::start

 # Start kube-apiserver
 kube::log::status "Starting kube-apiserver"
 "${KUBE_OUTPUT_HOSTBIN}/kube-apiserver" \
-  --insecure-bind-address="127.0.0.1" \
-  --bind-address="127.0.0.1" \
+  --insecure-bind-address="${API_HOST}" \
+  --bind-address="${API_HOST}" \
  --insecure-port="${API_PORT}" \
  --etcd-servers="http://${ETCD_HOST}:${ETCD_PORT}" \
  --advertise-address="10.10.10.10" \
@@ -71,40 +70,16 @@ kube::log::status "Starting kube-apiserver"
  --service-cluster-ip-range="10.0.0.0/24" >/tmp/swagger-api-server.log 2>&1 &
 APISERVER_PID=$!

-kube::util::wait_for_url "http://127.0.0.1:${API_PORT}/healthz" "apiserver: "
+kube::util::wait_for_url "${API_HOST}:${API_PORT}/healthz" "apiserver: "

-SWAGGER_API_PATH="http://127.0.0.1:${API_PORT}/swaggerapi/"
+SWAGGER_API_PATH="${API_HOST}:${API_PORT}/swaggerapi/"
 DEFAULT_GROUP_VERSIONS="v1 apps/v1alpha1 authentication.k8s.io/v1beta1 authorization.k8s.io/v1beta1 autoscaling/v1 batch/v1 batch/v2alpha1 extensions/v1beta1 certificates/v1alpha1 policy/v1alpha1 rbac.authorization.k8s.io/v1alpha1"
 VERSIONS=${VERSIONS:-$DEFAULT_GROUP_VERSIONS}

 kube::log::status "Updating " ${SWAGGER_ROOT_DIR}

-for ver in ${VERSIONS}; do
-  # fetch the swagger spec for each group version.
-  if [[ ${ver} == "v1" ]]; then
-    SUBPATH="api"
-  else
-    SUBPATH="apis"
-  fi
-  SUBPATH="${SUBPATH}/${ver}"
-  SWAGGER_JSON_NAME="$(kube::util::gv-to-swagger-name ${ver}).json"
-  curl -w "\n" -fs "${SWAGGER_API_PATH}${SUBPATH}" > "${SWAGGER_ROOT_DIR}/${SWAGGER_JSON_NAME}"
+SWAGGER_API_PATH="${SWAGGER_API_PATH}" SWAGGER_ROOT_DIR="${SWAGGER_ROOT_DIR}" VERSIONS="${VERSIONS}" kube::util::fetch-swagger-spec

-  # fetch the swagger spec for the discovery mechanism at group level.
-  if [[ ${ver} == "v1" ]]; then
-    continue
-  fi
-  SUBPATH="apis/"${ver%/*}
-  SWAGGER_JSON_NAME="${ver%/*}.json"
-  curl -w "\n" -fs "${SWAGGER_API_PATH}${SUBPATH}" > "${SWAGGER_ROOT_DIR}/${SWAGGER_JSON_NAME}"
-done
-
-# fetch swagger specs for other discovery mechanism.
-curl -w "\n" -fs "${SWAGGER_API_PATH}" > "${SWAGGER_ROOT_DIR}/resourceListing.json"
-curl -w "\n" -fs "${SWAGGER_API_PATH}version" > "${SWAGGER_ROOT_DIR}/version.json"
-curl -w "\n" -fs "${SWAGGER_API_PATH}api" > "${SWAGGER_ROOT_DIR}/api.json"
-curl -w "\n" -fs "${SWAGGER_API_PATH}apis" > "${SWAGGER_ROOT_DIR}/apis.json"
-curl -w "\n" -fs "${SWAGGER_API_PATH}logs" > "${SWAGGER_ROOT_DIR}/logs.json"
 kube::log::status "SUCCESS"

 # ex: ts=2 sw=2 et filetype=sh