Production-Grade Container Scheduling and Management
Go to file
Kubernetes Submit Queue 94795b3931
Merge pull request #54998 from tengqm/autoscale-api-doc
Automatic merge from submit-queue (batch tested with PRs 56410, 56707, 56661, 54998, 56722). If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>.

Fix autoscaling API documentation

**What this PR does / why we need it**:
This PR fixes the API documentation generated for HorizontalPodAutoscaler resource.

**Which issue(s) this PR fixes**:
The current API doc for `MetricSpec` and `MetricStatus` is confusing. Users get no idea what can be used as the value for the `type` field, because the doc says this:

```
type is the type of metric source. It should match one of the fields below.
```

While acceptable in the source code, it makes no senses when reading the API doc, especially when the "`type`" field is listed as the last row in a table (see: https://kubernetes.io/docs/api-reference/v1.8/#metricspec-v2beta1-autoscaling )

**Special notes for your reviewer**:
This PR makes no changes to the code behavior.

**Release note**:
```release-note
NONE
```
2017-12-16 05:46:37 -08:00
.github Merge pull request #54114 from xiangpengzhao/fix-pr-template 2017-10-30 18:37:06 -07:00
api Merge pull request #54998 from tengqm/autoscale-api-doc 2017-12-16 05:46:37 -08:00
build Add hyperkube to make quick-release 2017-11-30 15:17:46 -05:00
cluster Merge pull request #56633 from juju-solutions/bug/restarts 2017-12-16 01:53:52 -08:00
cmd Merge pull request #56410 from stewart-yu/cloudeprovider-fixcloudnil 2017-12-16 04:11:02 -08:00
docs Merge pull request #54998 from tengqm/autoscale-api-doc 2017-12-16 05:46:37 -08:00
examples Update generated files 2017-11-09 12:14:08 +01:00
Godeps Merge pull request #56161 from ericchiang/go-jose-import 2017-12-15 04:33:38 -08:00
hack Merge pull request #55598 from xiangpengzhao/fix-cp-title 2017-12-15 22:51:45 -08:00
logo Don't use strokes in the logo SVG 2017-10-12 09:38:56 -07:00
pkg Merge pull request #54998 from tengqm/autoscale-api-doc 2017-12-16 05:46:37 -08:00
plugin Merge pull request #56707 from brunomcustodio/kube-scheduler-config-file-warning 2017-12-16 04:58:24 -08:00
staging Merge pull request #54998 from tengqm/autoscale-api-doc 2017-12-16 05:46:37 -08:00
test Merge pull request #56661 from xiangpengzhao/move-kubelet-constants 2017-12-16 05:46:35 -08:00
third_party Update generated files 2017-11-09 12:14:08 +01:00
translations Merge pull request #47584 from zjj2wry/translate 2017-11-15 23:57:28 -08:00
vendor Merge pull request #56161 from ericchiang/go-jose-import 2017-12-15 04:33:38 -08:00
.bazelrc
.generated_files
.gitattributes Hide openapi-spec in diffs 2017-11-04 23:16:04 -07:00
.gitignore make clean will remove all gitignored files 2017-09-04 11:04:09 -07:00
.kazelcfg.json
BUILD.bazel
CHANGELOG-1.2.md Update TOC of CHANGELOG 2017-09-09 13:38:29 +08:00
CHANGELOG-1.3.md Move 1.3.* release notes out of CHANGELOG.md 2017-09-15 11:21:25 +08:00
CHANGELOG-1.4.md Update invalid TOC anchor of 1.4 CHANGELOG 2017-10-26 17:25:23 +08:00
CHANGELOG-1.5.md Regenerate CHANGELOG TOCs 2017-10-11 17:04:47 -04:00
CHANGELOG-1.6.md Update CHANGELOG-1.6.md for v1.6.13. 2017-11-22 14:06:09 -08:00
CHANGELOG-1.7.md Update CHANGELOG-1.7.md for v1.7.11. 2017-11-25 16:37:13 -05:00
CHANGELOG-1.8.md Update CHANGELOG-1.8.md for v1.8.5. 2017-12-07 09:10:33 -08:00
CHANGELOG-1.9.md Update CHANGELOG-1.9.md for v1.9.0. 2017-12-15 14:15:58 -08:00
CHANGELOG.md Move 1.8.x release notes 2017-10-11 22:41:36 -04:00
code-of-conduct.md
CONTRIBUTING.md
labels.yaml Merge pull request #51848 from xiangpengzhao/milestone-label 2017-09-05 15:46:19 -07:00
LICENSE
Makefile
Makefile.generated_files
OWNERS
OWNERS_ALIASES Create sig-autoscaling-maintainers alias 2017-11-17 17:57:33 +01:00
README.md Add CII Best Practices Badge 2017-08-22 10:56:16 -05:00
SUPPORT.md
Vagrantfile fix download link for fedora libvirt vagrant box 2017-11-18 22:26:57 +05:30
WORKSPACE

Kubernetes

Submit Queue Widget GoDoc Widget CII Best Practices


Kubernetes is an open source system for managing containerized applications across multiple hosts, providing basic mechanisms for deployment, maintenance, and scaling of applications.

Kubernetes builds upon a decade and a half of experience at Google running production workloads at scale using a system called Borg, combined with best-of-breed ideas and practices from the community.

Kubernetes is hosted by the Cloud Native Computing Foundation (CNCF). If you are a company that wants to help shape the evolution of technologies that are container-packaged, dynamically-scheduled and microservices-oriented, consider joining the CNCF. For details about who's involved and how Kubernetes plays a role, read the CNCF announcement.


To start using Kubernetes

See our documentation on kubernetes.io.

Try our interactive tutorial.

Take a free course on Scalable Microservices with Kubernetes.

To start developing Kubernetes

The community repository hosts all information about building Kubernetes from source, how to contribute code and documentation, who to contact about what, etc.

If you want to build Kubernetes right away there are two options:

You have a working Go environment.
$ go get -d k8s.io/kubernetes
$ cd $GOPATH/src/k8s.io/kubernetes
$ make
You have a working Docker environment.
$ git clone https://github.com/kubernetes/kubernetes
$ cd kubernetes
$ make quick-release

If you are less impatient, head over to the developer's documentation.

Support

If you need support, start with the troubleshooting guide and work your way through the process that we've outlined.

That said, if you have questions, reach out to us one way or another.

Analytics