From ed9973a5246c1664609db46a92fdae4620e493ff Mon Sep 17 00:00:00 2001 From: "Dr. Stefan Schimanski" Date: Tue, 23 Jul 2019 09:57:32 +0200 Subject: [PATCH 1/3] config/v1: improve APIServer description --- config/v1/types_apiserver.go | 4 +++- config/v1/zz_generated.swagger_doc_generated.go | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/config/v1/types_apiserver.go b/config/v1/types_apiserver.go index fc430d69f5a..ea76aec02c4 100644 --- a/config/v1/types_apiserver.go +++ b/config/v1/types_apiserver.go @@ -8,7 +8,9 @@ import ( // +genclient:nonNamespaced // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object -// APIServer holds cluster-wide information about api-servers. The canonical name is `cluster` +// APIServer holds configuration (like serving certificates, client CA and CORS domains) +// shared by all API servers in the system, among them especially kube-apiserver +// and openshift-apiserver. The canonical name of an instance is 'cluster'. type APIServer struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` diff --git a/config/v1/zz_generated.swagger_doc_generated.go b/config/v1/zz_generated.swagger_doc_generated.go index d577aaba338..829e5c18da0 100644 --- a/config/v1/zz_generated.swagger_doc_generated.go +++ b/config/v1/zz_generated.swagger_doc_generated.go @@ -244,7 +244,7 @@ func (StringSourceSpec) SwaggerDoc() map[string]string { } var map_APIServer = map[string]string{ - "": "APIServer holds cluster-wide information about api-servers. The canonical name is `cluster`", + "": "APIServer holds configuration (like serving certificates, client CA and CORS domains) shared by all API servers in the system, among them especially kube-apiserver and openshift-apiserver. The canonical name of an instance is 'cluster'.", } func (APIServer) SwaggerDoc() map[string]string { From d1ad8078869e3b5ac41d33bf579f3b0cf45473aa Mon Sep 17 00:00:00 2001 From: "Dr. Stefan Schimanski" Date: Tue, 23 Jul 2019 10:03:03 +0200 Subject: [PATCH 2/3] config/v1: improve Authentication description --- config/v1/types_authentication.go | 3 ++- config/v1/zz_generated.swagger_doc_generated.go | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/config/v1/types_authentication.go b/config/v1/types_authentication.go index 508469d0ff5..6d32b9d827b 100644 --- a/config/v1/types_authentication.go +++ b/config/v1/types_authentication.go @@ -6,7 +6,8 @@ import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" // +genclient:nonNamespaced // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object -// Authentication holds cluster-wide information about Authentication. The canonical name is `cluster` +// Authentication specifies cluster-wide settings for authentication (like OAuth and +// webhook token authenticators). The canonical name of an instance is `cluster`. type Authentication struct { metav1.TypeMeta `json:",inline"` // Standard object's metadata. diff --git a/config/v1/zz_generated.swagger_doc_generated.go b/config/v1/zz_generated.swagger_doc_generated.go index 829e5c18da0..a52d45c4222 100644 --- a/config/v1/zz_generated.swagger_doc_generated.go +++ b/config/v1/zz_generated.swagger_doc_generated.go @@ -280,7 +280,7 @@ func (APIServerSpec) SwaggerDoc() map[string]string { } var map_Authentication = map[string]string{ - "": "Authentication holds cluster-wide information about Authentication. The canonical name is `cluster`", + "": "Authentication specifies cluster-wide settings for authentication (like OAuth and webhook token authenticators). The canonical name of an instance is `cluster`.", "metadata": "Standard object's metadata.", "spec": "spec holds user settable values for configuration", "status": "status holds observed values from the cluster. They may not be overridden.", From 97c23e61d610523d1e042c6c5552b6a7c59f4bd9 Mon Sep 17 00:00:00 2001 From: "Dr. Stefan Schimanski" Date: Tue, 23 Jul 2019 12:08:33 +0200 Subject: [PATCH 3/3] DEBUG --- Makefile | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Makefile b/Makefile index 1667fa5f9d7..ba83ccb1433 100644 --- a/Makefile +++ b/Makefile @@ -13,9 +13,9 @@ test: .PHONY: test verify: - hack/verify-deepcopy.sh - hack/verify-protobuf.sh - hack/verify-swagger-docs.sh + bash -x hack/verify-deepcopy.sh + bash -x hack/verify-protobuf.sh + bash -x hack/verify-swagger-docs.sh .PHONY: verify update-deps: