Trim down comments for elasticPolicy.metrics except for the first sen…

…tence Signed-off-by: Yuki Iwai <[email protected]>
kubeflow · Jan 21, 2023 · f35e5a2 · f35e5a2
1 parent ee6ac70
commit f35e5a2
Show file tree

Hide file tree

Showing 8 changed files with 8,466 additions and 3,564 deletions.
diff --git a/Makefile b/Makefile
@@ -1,7 +1,7 @@
 # Image URL to use all building/pushing image targets
 IMG ?= kubeflow/training-operator:latest
 # CRD generation options
-CRD_OPTIONS ?= "crd:generateEmbeddedObjectMeta=true,maxDescLen=100"
+CRD_OPTIONS ?= "crd:generateEmbeddedObjectMeta=true,maxDescLen=200"
 
 # Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
 ifeq (,$(shell go env GOBIN))

diff --git a/manifests/base/crds/kubeflow.org_mpijobs.yaml b/manifests/base/crds/kubeflow.org_mpijobs.yaml
diff --git a/manifests/base/crds/kubeflow.org_mxjobs.yaml b/manifests/base/crds/kubeflow.org_mxjobs.yaml
diff --git a/manifests/base/crds/kubeflow.org_paddlejobs.yaml b/manifests/base/crds/kubeflow.org_paddlejobs.yaml
diff --git a/manifests/base/crds/kubeflow.org_pytorchjobs.yaml b/manifests/base/crds/kubeflow.org_pytorchjobs.yaml
diff --git a/manifests/base/crds/kubeflow.org_tfjobs.yaml b/manifests/base/crds/kubeflow.org_tfjobs.yaml
diff --git a/manifests/base/crds/kubeflow.org_xgboostjobs.yaml b/manifests/base/crds/kubeflow.org_xgboostjobs.yaml
diff --git a/pkg/apis/kubeflow.org/v1/pytorch_types.go b/pkg/apis/kubeflow.org/v1/pytorch_types.go
@@ -114,12 +114,7 @@ type ElasticPolicy struct {
 
 	// Metrics contains the specifications which are used to calculate the
 	// desired replica count (the maximum replica count across all metrics will
-	// be used).  The desired replica count is calculated with multiplying the
-	// ratio between the target value and the current value by the current
-	// number of pods. Ergo, metrics used must decrease as the pod count is
-	// increased, and vice-versa.  See the individual metric source types for
-	// more information about how each type of metric must respond.
-	// If not set, the HPA will not be created.
+	// be used).
 	// +optional
 	Metrics []autoscalingv2.MetricSpec `json:"metrics,omitempty"`
 }