From 024b8d2345df6957c93b35b1ed4a8d6ddb9f5573 Mon Sep 17 00:00:00 2001 From: Adrian Moisey Date: Thu, 12 Dec 2024 21:13:17 +0200 Subject: [PATCH 1/4] Generate API docs --- .../hack/api-docs/config.yaml | 8 ++++ .../hack/generate-api-docs.sh | 47 +++++++++++++++++++ 2 files changed, 55 insertions(+) create mode 100644 vertical-pod-autoscaler/hack/api-docs/config.yaml create mode 100755 vertical-pod-autoscaler/hack/generate-api-docs.sh diff --git a/vertical-pod-autoscaler/hack/api-docs/config.yaml b/vertical-pod-autoscaler/hack/api-docs/config.yaml new file mode 100644 index 000000000000..d220dd5d19dd --- /dev/null +++ b/vertical-pod-autoscaler/hack/api-docs/config.yaml @@ -0,0 +1,8 @@ +processor: + ignoreGroupVersions: + - "poc.autoscaling.k8s.io/v1alpha1" + - "autoscaling.k8s.io/v1beta1" + - "autoscaling.k8s.io/v1beta2" + +render: + kubernetesVersion: 1.32 diff --git a/vertical-pod-autoscaler/hack/generate-api-docs.sh b/vertical-pod-autoscaler/hack/generate-api-docs.sh new file mode 100755 index 000000000000..0f7ca97ad608 --- /dev/null +++ b/vertical-pod-autoscaler/hack/generate-api-docs.sh @@ -0,0 +1,47 @@ +#!/bin/bash + +# Copyright 2024 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. + + +set -o errexit +set -o nounset +set -o pipefail + +REPOSITORY_ROOT=$(realpath $(dirname ${BASH_SOURCE})/..) +OUTPUT=${REPOSITORY_ROOT}/docs/api.md +WORKSPACE=$(mktemp -d) + +function cleanup() { + rm -r ${WORKSPACE} +} +trap cleanup EXIT + +if [[ -z $(which crd-ref-docs) ]]; then + ( + cd $WORKSPACE + go install github.com/elastic/crd-ref-docs@latest + ) + CONTROLLER_GEN=${GOBIN:-$(go env GOPATH)/bin}/crd-ref-docs +else + CONTROLLER_GEN=$(which crd-ref-docs) +fi + +crd-ref-docs \ + --source-path=pkg/apis/ \ + --config=./hack/api-docs/config.yaml \ + --renderer=markdown \ + --output-path=${WORKSPACE} + +mv ${WORKSPACE}/out.md ${OUTPUT} From f544d94fe760b05d7066dfa5b3bec90c3d175f18 Mon Sep 17 00:00:00 2001 From: Adrian Moisey Date: Sun, 15 Dec 2024 08:21:07 +0200 Subject: [PATCH 2/4] Add generated API docs and link to them --- vertical-pod-autoscaler/README.md | 7 +- vertical-pod-autoscaler/docs/api.md | 399 ++++++++++++++++++++++++++++ 2 files changed, 402 insertions(+), 4 deletions(-) create mode 100644 vertical-pod-autoscaler/docs/api.md diff --git a/vertical-pod-autoscaler/README.md b/vertical-pod-autoscaler/README.md index d64097275a51..e8d41078c72d 100644 --- a/vertical-pod-autoscaler/README.md +++ b/vertical-pod-autoscaler/README.md @@ -47,7 +47,6 @@ You can also read about the [features](./docs/features.md) and [known limitation ## Related links -- [Design - proposal](https://github.com/kubernetes/design-proposals-archive/blob/main/autoscaling/vertical-pod-autoscaler.md) -- [API - definition](pkg/apis/autoscaling.k8s.io/v1/types.go) +- [Design proposal](https://github.com/kubernetes/design-proposals-archive/blob/main/autoscaling/vertical-pod-autoscaler.md) +- [API definition](pkg/apis/autoscaling.k8s.io/v1/types.go) +- [API reference](./docs/api.md) diff --git a/vertical-pod-autoscaler/docs/api.md b/vertical-pod-autoscaler/docs/api.md new file mode 100644 index 000000000000..843d595e4975 --- /dev/null +++ b/vertical-pod-autoscaler/docs/api.md @@ -0,0 +1,399 @@ +# API Reference + +## Packages +- [autoscaling.k8s.io/v1](#autoscalingk8siov1) + + +## autoscaling.k8s.io/v1 + +Package v1 contains definitions of Vertical Pod Autoscaler related objects. + +Package v1 contains definitions of Vertical Pod Autoscaler related objects. + + + +#### ContainerControlledValues + +_Underlying type:_ _string_ + +ContainerControlledValues controls which resource value should be autoscaled. + +_Validation:_ +- Enum: [RequestsAndLimits RequestsOnly] + +_Appears in:_ +- [ContainerResourcePolicy](#containerresourcepolicy) + +| Field | Description | +| --- | --- | +| `RequestsAndLimits` | ContainerControlledValuesRequestsAndLimits means resource request and limits
are scaled automatically. The limit is scaled proportionally to the request.
| +| `RequestsOnly` | ContainerControlledValuesRequestsOnly means only requested resource is autoscaled.
| + + +#### ContainerResourcePolicy + + + +ContainerResourcePolicy controls how autoscaler computes the recommended +resources for a specific container. + + + +_Appears in:_ +- [PodResourcePolicy](#podresourcepolicy) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `containerName` _string_ | Name of the container or DefaultContainerResourcePolicy, in which
case the policy is used by the containers that don't have their own
policy specified. | | | +| `mode` _[ContainerScalingMode](#containerscalingmode)_ | Whether autoscaler is enabled for the container. The default is "Auto". | | Enum: [Auto Off]
| +| `minAllowed` _[ResourceList](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#resourcelist-v1-core)_ | Specifies the minimal amount of resources that will be recommended
for the container. The default is no minimum. | | | +| `maxAllowed` _[ResourceList](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#resourcelist-v1-core)_ | Specifies the maximum amount of resources that will be recommended
for the container. The default is no maximum. | | | +| `controlledResources` _[ResourceName](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#resourcename-v1-core)_ | Specifies the type of recommendations that will be computed
(and possibly applied) by VPA.
If not specified, the default of [ResourceCPU, ResourceMemory] will be used. | | | +| `controlledValues` _[ContainerControlledValues](#containercontrolledvalues)_ | Specifies which resource values should be controlled.
The default is "RequestsAndLimits". | | Enum: [RequestsAndLimits RequestsOnly]
| + + +#### ContainerScalingMode + +_Underlying type:_ _string_ + +ContainerScalingMode controls whether autoscaler is enabled for a specific +container. + +_Validation:_ +- Enum: [Auto Off] + +_Appears in:_ +- [ContainerResourcePolicy](#containerresourcepolicy) + +| Field | Description | +| --- | --- | +| `Auto` | ContainerScalingModeAuto means autoscaling is enabled for a container.
| +| `Off` | ContainerScalingModeOff means autoscaling is disabled for a container.
| + + +#### EvictionChangeRequirement + +_Underlying type:_ _string_ + +EvictionChangeRequirement refers to the relationship between the new target recommendation for a Pod and its current requests, what kind of change is necessary for the Pod to be evicted + +_Validation:_ +- Enum: [TargetHigherThanRequests TargetLowerThanRequests] + +_Appears in:_ +- [EvictionRequirement](#evictionrequirement) + +| Field | Description | +| --- | --- | +| `TargetHigherThanRequests` | TargetHigherThanRequests means the new target recommendation for a Pod is higher than its current requests, i.e. the Pod is scaled up
| +| `TargetLowerThanRequests` | TargetLowerThanRequests means the new target recommendation for a Pod is lower than its current requests, i.e. the Pod is scaled down
| + + +#### EvictionRequirement + + + +EvictionRequirement defines a single condition which needs to be true in +order to evict a Pod + + + +_Appears in:_ +- [PodUpdatePolicy](#podupdatepolicy) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `resources` _[ResourceName](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#resourcename-v1-core) array_ | Resources is a list of one or more resources that the condition applies
to. If more than one resource is given, the EvictionRequirement is fulfilled
if at least one resource meets `changeRequirement`. | | | +| `changeRequirement` _[EvictionChangeRequirement](#evictionchangerequirement)_ | | | Enum: [TargetHigherThanRequests TargetLowerThanRequests]
| + + +#### HistogramCheckpoint + + + +HistogramCheckpoint contains data needed to reconstruct the histogram. + + + +_Appears in:_ +- [VerticalPodAutoscalerCheckpointStatus](#verticalpodautoscalercheckpointstatus) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `referenceTimestamp` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#time-v1-meta)_ | Reference timestamp for samples collected within this histogram. | | | +| `bucketWeights` _object (keys:integer, values:integer)_ | Map from bucket index to bucket weight. | | Type: object
XPreserveUnknownFields: \{\}
| +| `totalWeight` _float_ | Sum of samples to be used as denominator for weights from BucketWeights. | | | + + +#### PodResourcePolicy + + + +PodResourcePolicy controls how autoscaler computes the recommended resources +for containers belonging to the pod. There can be at most one entry for every +named container and optionally a single wildcard entry with `containerName` = '*', +which handles all containers that don't have individual policies. + + + +_Appears in:_ +- [VerticalPodAutoscalerSpec](#verticalpodautoscalerspec) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `containerPolicies` _[ContainerResourcePolicy](#containerresourcepolicy) array_ | Per-container resource policies. | | | + + +#### PodUpdatePolicy + + + +PodUpdatePolicy describes the rules on how changes are applied to the pods. + + + +_Appears in:_ +- [VerticalPodAutoscalerSpec](#verticalpodautoscalerspec) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `updateMode` _[UpdateMode](#updatemode)_ | Controls when autoscaler applies changes to the pod resources.
The default is 'Auto'. | | Enum: [Off Initial Recreate Auto]
| +| `minReplicas` _integer_ | Minimal number of replicas which need to be alive for Updater to attempt
pod eviction (pending other checks like PDB). Only positive values are
allowed. Overrides global '--min-replicas' flag. | | | +| `evictionRequirements` _[EvictionRequirement](#evictionrequirement) array_ | EvictionRequirements is a list of EvictionRequirements that need to
evaluate to true in order for a Pod to be evicted. If more than one
EvictionRequirement is specified, all of them need to be fulfilled to allow eviction. | | | + + +#### RecommendedContainerResources + + + +RecommendedContainerResources is the recommendation of resources computed by +autoscaler for a specific container. Respects the container resource policy +if present in the spec. In particular the recommendation is not produced for +containers with `ContainerScalingMode` set to 'Off'. + + + +_Appears in:_ +- [RecommendedPodResources](#recommendedpodresources) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `containerName` _string_ | Name of the container. | | | +| `target` _[ResourceList](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#resourcelist-v1-core)_ | Recommended amount of resources. Observes ContainerResourcePolicy. | | | +| `lowerBound` _[ResourceList](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#resourcelist-v1-core)_ | Minimum recommended amount of resources. Observes ContainerResourcePolicy.
This amount is not guaranteed to be sufficient for the application to operate in a stable way, however
running with less resources is likely to have significant impact on performance/availability. | | | +| `upperBound` _[ResourceList](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#resourcelist-v1-core)_ | Maximum recommended amount of resources. Observes ContainerResourcePolicy.
Any resources allocated beyond this value are likely wasted. This value may be larger than the maximum
amount of application is actually capable of consuming. | | | +| `uncappedTarget` _[ResourceList](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#resourcelist-v1-core)_ | The most recent recommended resources target computed by the autoscaler
for the controlled pods, based only on actual resource usage, not taking
into account the ContainerResourcePolicy.
May differ from the Recommendation if the actual resource usage causes
the target to violate the ContainerResourcePolicy (lower than MinAllowed
or higher that MaxAllowed).
Used only as status indication, will not affect actual resource assignment. | | | + + +#### RecommendedPodResources + + + +RecommendedPodResources is the recommendation of resources computed by +autoscaler. It contains a recommendation for each container in the pod +(except for those with `ContainerScalingMode` set to 'Off'). + + + +_Appears in:_ +- [VerticalPodAutoscalerStatus](#verticalpodautoscalerstatus) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `containerRecommendations` _[RecommendedContainerResources](#recommendedcontainerresources) array_ | Resources recommended by the autoscaler for each container. | | | + + +#### UpdateMode + +_Underlying type:_ _string_ + +UpdateMode controls when autoscaler applies changes to the pod resources. + +_Validation:_ +- Enum: [Off Initial Recreate Auto] + +_Appears in:_ +- [PodUpdatePolicy](#podupdatepolicy) + +| Field | Description | +| --- | --- | +| `Off` | UpdateModeOff means that autoscaler never changes Pod resources.
The recommender still sets the recommended resources in the
VerticalPodAutoscaler object. This can be used for a "dry run".
| +| `Initial` | UpdateModeInitial means that autoscaler only assigns resources on pod
creation and does not change them during the lifetime of the pod.
| +| `Recreate` | UpdateModeRecreate means that autoscaler assigns resources on pod
creation and additionally can update them during the lifetime of the
pod by deleting and recreating the pod.
| +| `Auto` | UpdateModeAuto means that autoscaler assigns resources on pod creation
and additionally can update them during the lifetime of the pod,
using any available update method. Currently this is equivalent to
Recreate, which is the only available update method.
| + + +#### VerticalPodAutoscaler + + + +VerticalPodAutoscaler is the configuration for a vertical pod +autoscaler, which automatically manages pod resources based on historical and +real time resource utilization. + + + +_Appears in:_ +- [VerticalPodAutoscalerList](#verticalpodautoscalerlist) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `kind` _string_ | Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
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.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
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.32/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | +| `spec` _[VerticalPodAutoscalerSpec](#verticalpodautoscalerspec)_ | Specification of the behavior of the autoscaler.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. | | | +| `status` _[VerticalPodAutoscalerStatus](#verticalpodautoscalerstatus)_ | Current information about the autoscaler. | | | + + +#### VerticalPodAutoscalerCheckpoint + + + +VerticalPodAutoscalerCheckpoint is the checkpoint of the internal state of VPA that +is used for recovery after recommender's restart. + + + +_Appears in:_ +- [VerticalPodAutoscalerCheckpointList](#verticalpodautoscalercheckpointlist) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `kind` _string_ | Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
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.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
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.32/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | +| `spec` _[VerticalPodAutoscalerCheckpointSpec](#verticalpodautoscalercheckpointspec)_ | Specification of the checkpoint.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status. | | | +| `status` _[VerticalPodAutoscalerCheckpointStatus](#verticalpodautoscalercheckpointstatus)_ | Data of the checkpoint. | | | + + + + +#### VerticalPodAutoscalerCheckpointSpec + + + +VerticalPodAutoscalerCheckpointSpec is the specification of the checkpoint object. + + + +_Appears in:_ +- [VerticalPodAutoscalerCheckpoint](#verticalpodautoscalercheckpoint) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `vpaObjectName` _string_ | Name of the VPA object that stored VerticalPodAutoscalerCheckpoint object. | | | +| `containerName` _string_ | Name of the checkpointed container. | | | + + +#### VerticalPodAutoscalerCheckpointStatus + + + +VerticalPodAutoscalerCheckpointStatus contains data of the checkpoint. + + + +_Appears in:_ +- [VerticalPodAutoscalerCheckpoint](#verticalpodautoscalercheckpoint) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `lastUpdateTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#time-v1-meta)_ | The time when the status was last refreshed. | | | +| `version` _string_ | Version of the format of the stored data. | | | +| `cpuHistogram` _[HistogramCheckpoint](#histogramcheckpoint)_ | Checkpoint of histogram for consumption of CPU. | | | +| `memoryHistogram` _[HistogramCheckpoint](#histogramcheckpoint)_ | Checkpoint of histogram for consumption of memory. | | | +| `firstSampleStart` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#time-v1-meta)_ | Timestamp of the fist sample from the histograms. | | | +| `lastSampleStart` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#time-v1-meta)_ | Timestamp of the last sample from the histograms. | | | +| `totalSamplesCount` _integer_ | Total number of samples in the histograms. | | | + + +#### VerticalPodAutoscalerCondition + + + +VerticalPodAutoscalerCondition describes the state of +a VerticalPodAutoscaler at a certain point. + + + +_Appears in:_ +- [VerticalPodAutoscalerStatus](#verticalpodautoscalerstatus) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `type` _[VerticalPodAutoscalerConditionType](#verticalpodautoscalerconditiontype)_ | type describes the current condition | | | +| `status` _[ConditionStatus](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#conditionstatus-v1-core)_ | status is the status of the condition (True, False, Unknown) | | | +| `lastTransitionTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#time-v1-meta)_ | lastTransitionTime is the last time the condition transitioned from
one status to another | | | +| `reason` _string_ | reason is the reason for the condition's last transition. | | | +| `message` _string_ | message is a human-readable explanation containing details about
the transition | | | + + +#### VerticalPodAutoscalerConditionType + +_Underlying type:_ _string_ + +VerticalPodAutoscalerConditionType are the valid conditions of +a VerticalPodAutoscaler. + + + +_Appears in:_ +- [VerticalPodAutoscalerCondition](#verticalpodautoscalercondition) + + + + + +#### VerticalPodAutoscalerRecommenderSelector + + + +VerticalPodAutoscalerRecommenderSelector points to a specific Vertical Pod Autoscaler recommender. +In the future it might pass parameters to the recommender. + + + +_Appears in:_ +- [VerticalPodAutoscalerSpec](#verticalpodautoscalerspec) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `name` _string_ | Name of the recommender responsible for generating recommendation for this object. | | | + + +#### VerticalPodAutoscalerSpec + + + +VerticalPodAutoscalerSpec is the specification of the behavior of the autoscaler. + + + +_Appears in:_ +- [VerticalPodAutoscaler](#verticalpodautoscaler) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `targetRef` _[CrossVersionObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#crossversionobjectreference-v1-autoscaling)_ | TargetRef points to the controller managing the set of pods for the
autoscaler to control - e.g. Deployment, StatefulSet. VerticalPodAutoscaler
can be targeted at controller implementing scale subresource (the pod set is
retrieved from the controller's ScaleStatus) or some well known controllers
(e.g. for DaemonSet the pod set is read from the controller's spec).
If VerticalPodAutoscaler cannot use specified target it will report
ConfigUnsupported condition.
Note that VerticalPodAutoscaler does not require full implementation
of scale subresource - it will not use it to modify the replica count.
The only thing retrieved is a label selector matching pods grouped by
the target resource. | | | +| `updatePolicy` _[PodUpdatePolicy](#podupdatepolicy)_ | Describes the rules on how changes are applied to the pods.
If not specified, all fields in the `PodUpdatePolicy` are set to their
default values. | | | +| `resourcePolicy` _[PodResourcePolicy](#podresourcepolicy)_ | Controls how the autoscaler computes recommended resources.
The resource policy may be used to set constraints on the recommendations
for individual containers.
If any individual containers need to be excluded from getting the VPA recommendations, then
it must be disabled explicitly by setting mode to "Off" under containerPolicies.
If not specified, the autoscaler computes recommended resources for all containers in the pod,
without additional constraints. | | | +| `recommenders` _[VerticalPodAutoscalerRecommenderSelector](#verticalpodautoscalerrecommenderselector) array_ | Recommender responsible for generating recommendation for this object.
List should be empty (then the default recommender will generate the
recommendation) or contain exactly one recommender. | | | + + +#### VerticalPodAutoscalerStatus + + + +VerticalPodAutoscalerStatus describes the runtime state of the autoscaler. + + + +_Appears in:_ +- [VerticalPodAutoscaler](#verticalpodautoscaler) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `recommendation` _[RecommendedPodResources](#recommendedpodresources)_ | The most recently computed amount of resources recommended by the
autoscaler for the controlled pods. | | | +| `conditions` _[VerticalPodAutoscalerCondition](#verticalpodautoscalercondition) array_ | Conditions is the set of conditions required for this autoscaler to scale its target,
and indicates whether or not those conditions are met. | | | + + From 391174612b316451e1147ef37df96a6b5eccbb3f Mon Sep 17 00:00:00 2001 From: Adrian Moisey Date: Sat, 28 Dec 2024 20:26:19 +0200 Subject: [PATCH 3/4] Remove unnessesary comment to make generated docs look better --- vertical-pod-autoscaler/docs/api.md | 2 -- vertical-pod-autoscaler/pkg/apis/autoscaling.k8s.io/v1/types.go | 1 - 2 files changed, 3 deletions(-) diff --git a/vertical-pod-autoscaler/docs/api.md b/vertical-pod-autoscaler/docs/api.md index 843d595e4975..53863e326d5e 100644 --- a/vertical-pod-autoscaler/docs/api.md +++ b/vertical-pod-autoscaler/docs/api.md @@ -8,8 +8,6 @@ Package v1 contains definitions of Vertical Pod Autoscaler related objects. -Package v1 contains definitions of Vertical Pod Autoscaler related objects. - #### ContainerControlledValues diff --git a/vertical-pod-autoscaler/pkg/apis/autoscaling.k8s.io/v1/types.go b/vertical-pod-autoscaler/pkg/apis/autoscaling.k8s.io/v1/types.go index c1a686371e68..c479fb75f208 100644 --- a/vertical-pod-autoscaler/pkg/apis/autoscaling.k8s.io/v1/types.go +++ b/vertical-pod-autoscaler/pkg/apis/autoscaling.k8s.io/v1/types.go @@ -14,7 +14,6 @@ See the License for the specific language governing permissions and limitations under the License. */ -// Package v1 contains definitions of Vertical Pod Autoscaler related objects. package v1 import ( From 9ba9113ec920a5df3ebf7b88e3c6a47237df7fa3 Mon Sep 17 00:00:00 2001 From: Adrian Moisey Date: Sat, 28 Dec 2024 20:29:48 +0200 Subject: [PATCH 4/4] Ensure that script can be called from anywhere --- vertical-pod-autoscaler/hack/generate-api-docs.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/vertical-pod-autoscaler/hack/generate-api-docs.sh b/vertical-pod-autoscaler/hack/generate-api-docs.sh index 0f7ca97ad608..bb97ba661429 100755 --- a/vertical-pod-autoscaler/hack/generate-api-docs.sh +++ b/vertical-pod-autoscaler/hack/generate-api-docs.sh @@ -38,6 +38,7 @@ else CONTROLLER_GEN=$(which crd-ref-docs) fi +cd "$(dirname "${BASH_SOURCE[0]}")/.." crd-ref-docs \ --source-path=pkg/apis/ \ --config=./hack/api-docs/config.yaml \