1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00

Add API resources

This commit is contained in:
Jason Boxman
2020-06-08 00:50:23 -04:00
committed by openshift-cherrypick-robot
parent c2ed23b88a
commit 962356bb7c
201 changed files with 75891 additions and 13 deletions

View File

@@ -0,0 +1,32 @@
[id="autoscale-apis"]
= Autoscale APIs
ifdef::product-title[]
include::modules/common-attributes.adoc[]
endif::[]
toc::[]
== ClusterAutoscaler [autoscaling.openshift.io/v1]
Description::
Type::
`object`
== MachineAutoscaler [autoscaling.openshift.io/v1beta1]
Description::
Type::
`object`
== HorizontalPodAutoscaler [autoscaling/v1]
Description::
configuration of a horizontal pod autoscaler.
Type::
`object`

View File

@@ -0,0 +1,19 @@
[id="clusterautoscaler-autoscaling-openshift-io-v1"]
= ClusterAutoscaler [autoscaling.openshift.io/v1]
ifdef::product-title[]
include::modules/common-attributes.adoc[]
endif::[]
toc::[]
Description::
Type::
`object`
== Specification

View File

@@ -0,0 +1,146 @@
[id="horizontalpodautoscaler-autoscaling-v1"]
= HorizontalPodAutoscaler [autoscaling/v1]
ifdef::product-title[]
include::modules/common-attributes.adoc[]
endif::[]
toc::[]
Description::
configuration of a horizontal pod autoscaler.
Type::
`object`
== Specification
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `.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
| `.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
| `.metadata`
| xref:../objects/index.adoc#objectmeta-meta-v1[`ObjectMeta meta/v1`]
| Standard object metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
| `.spec`
| `object`
| specification of a horizontal pod autoscaler.
| `.status`
| `object`
| current status of a horizontal pod autoscaler
|===
..spec
Description::
specification of a horizontal pod autoscaler.
Type::
`object`
Required::
- `scaleTargetRef`
- `maxReplicas`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `maxReplicas`
| `integer`
| upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas.
| `minReplicas`
| `integer`
| minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is enabled and at least one Object or External metric is configured. Scaling is active as long as at least one metric value is available.
| `scaleTargetRef`
| `object`
| CrossVersionObjectReference contains enough information to let you identify the referred resource.
| `targetCPUUtilizationPercentage`
| `integer`
| target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified the default autoscaling policy will be used.
|===
..spec.scaleTargetRef
Description::
CrossVersionObjectReference contains enough information to let you identify the referred resource.
Type::
`object`
Required::
- `kind`
- `name`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `apiVersion`
| `string`
| API version of the referent
| `kind`
| `string`
| Kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"
| `name`
| `string`
| Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
|===
..status
Description::
current status of a horizontal pod autoscaler
Type::
`object`
Required::
- `currentReplicas`
- `desiredReplicas`
[cols="1,1,1",options="header"]
|===
| Property | Type | Description
| `currentCPUUtilizationPercentage`
| `integer`
| current average CPU utilization over all pods, represented as a percentage of requested CPU, e.g. 70 means that an average pod is using now 70% of its requested CPU.
| `currentReplicas`
| `integer`
| current number of replicas of pods managed by this autoscaler.
| `desiredReplicas`
| `integer`
| desired number of replicas of pods managed by this autoscaler.
| `lastScaleTime`
| xref:../objects/index.adoc#time-meta-v1[`Time meta/v1`]
| last time the HorizontalPodAutoscaler scaled the number of pods; used by the autoscaler to control how often the number of pods is changed.
| `observedGeneration`
| `integer`
| most recent generation observed by this autoscaler.
|===

View File

@@ -0,0 +1,19 @@
[id="machineautoscaler-autoscaling-openshift-io-v1beta1"]
= MachineAutoscaler [autoscaling.openshift.io/v1beta1]
ifdef::product-title[]
include::modules/common-attributes.adoc[]
endif::[]
toc::[]
Description::
Type::
`object`
== Specification