From 7506b1ad0b7558da6e5f576d191aacb30b99f04c Mon Sep 17 00:00:00 2001 From: Steve Perry Date: Wed, 13 Dec 2017 17:54:42 -0800 Subject: [PATCH] Update Federation API ref docs for 1.9. (#6636) * Update federation API ref docs. * Move and redirect. * Move generated Federation docs to the generated directory. * Fix titles. * Type * Fix titles --- _data/reference.yml | 10 +- _redirects | 5 +- .../extensions/v1beta1/definitions.html | 15 +-- .../extensions/v1beta1/operations.html | 101 ++++++++++++++++++ .../federation/v1beta1/definitions.html | 0 .../federation/v1beta1/operations.html | 0 .../{ => generated}/federation/index.md | 0 .../federation/v1/definitions.html | 5 +- .../federation/v1/operations.html | 91 ++++++++++++++++ skip_title_check.txt | 6 +- 10 files changed, 216 insertions(+), 17 deletions(-) rename docs/reference/{ => generated}/federation/extensions/v1beta1/definitions.html (99%) rename docs/reference/{ => generated}/federation/extensions/v1beta1/operations.html (98%) rename docs/reference/{ => generated}/federation/federation/v1beta1/definitions.html (100%) rename docs/reference/{ => generated}/federation/federation/v1beta1/operations.html (100%) rename docs/reference/{ => generated}/federation/index.md (100%) rename docs/reference/{ => generated}/federation/v1/definitions.html (99%) rename docs/reference/{ => generated}/federation/v1/operations.html (98%) diff --git a/_data/reference.yml b/_data/reference.yml index cbd029d1d8..2b4d9eddcb 100644 --- a/_data/reference.yml +++ b/_data/reference.yml @@ -40,12 +40,10 @@ toc: - title: Federation API section: - - docs/reference/federation/v1/operations.html - - docs/reference/federation/v1/definitions.html - - docs/reference/federation/v1beta1/operations.html - - docs/reference/federation/v1beta1/definitions.html - - docs/reference/federation/extensions/v1beta1/operations.html - - docs/reference/federation/extensions/v1beta1/definitions.html + - docs/reference/generated/federation/v1/operations.html + - docs/reference/generated/federation/v1/definitions.html + - docs/reference/generated/federation/extensions/v1beta1/operations.html + - docs/reference/generated/federation/extensions/v1beta1/definitions.html - title: kubectl CLI section: diff --git a/_redirects b/_redirects index 395f7bbb25..e1dd3f4f9b 100644 --- a/_redirects +++ b/_redirects @@ -183,7 +183,10 @@ /docs/hellonode/ /docs/tutorials/stateless-application/hello-minikube/ 301 /docs/home/coreos/ /docs/getting-started-guides/coreos/ 301 /docs/home/deprecation-policy/ /docs/reference/deprecation-policy/ 301 - +/docs/reference/federation/extensions/v1beta1/definitions/ /docs/reference/generated/federation/extensions/v1beta1/definitions/ 301 +/docs/reference/federation/extensions/v1beta1/operations/ /docs/reference/generated/federation/extensions/v1beta1/operations/ 301 +/docs/reference/federation/v1/definitions/ /docs/reference/generated/federation/v1/definitions/ 301 +/docs/reference/federation/v1/operations/ /docs/reference/generated/federation/v1/operations/ 301 /docs/reference/federation/v1beta1/definitions/ /docs/reference/federation/extensions/v1beta1/definitions/ 301 /docs/reference/federation/v1beta1/operations/ /docs/reference/federation/extensions/v1beta1/operations/ 301 /docs/reference/generated/kubectl/kubectl-options/ /docs/reference/generated/kubectl/kubectl/ 301 diff --git a/docs/reference/federation/extensions/v1beta1/definitions.html b/docs/reference/generated/federation/extensions/v1beta1/definitions.html similarity index 99% rename from docs/reference/federation/extensions/v1beta1/definitions.html rename to docs/reference/generated/federation/extensions/v1beta1/definitions.html index e91d3c54f6..8bf9ea6faa 100755 --- a/docs/reference/federation/extensions/v1beta1/definitions.html +++ b/docs/reference/generated/federation/extensions/v1beta1/definitions.html @@ -2,6 +2,7 @@ title: extensions/v1beta1 Model Definitions notitle: true --- + @@ -2520,7 +2521,7 @@ When an object is created, the system will populate this list with the current s

v1.PodAffinityTerm

-

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> tches that of any node on which a pod of the set of pods is running

+

Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key <topologyKey> matches that of any node on which a pod of the set of pods is running

@@ -3094,7 +3095,7 @@ When an object is created, the system will populate this list with the current s - + @@ -4854,21 +4855,21 @@ Examples:
- + - + - + @@ -5817,7 +5818,7 @@ Both these may change in the future. Incoming requests are matched against the h - + @@ -6190,7 +6191,7 @@ Both these may change in the future. Incoming requests are matched against the h

v1beta1.ReplicaSet

-

DEPRECATED - This group version of ReplicaSet is deprecated by apps/v1beta2/ReplicaSet. See the release notes for more information. ReplicaSet represents the configuration of a ReplicaSet.

+

DEPRECATED - This group version of ReplicaSet is deprecated by apps/v1beta2/ReplicaSet. See the release notes for more information. ReplicaSet ensures that a specified number of pod replicas are running at any given time.

kind

Expected values Shared: mulitple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared

Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared

false

v1.AzureDataDiskKind

protectionDomain

The name of the Protection Domain for the configured storage (defaults to "default").

The name of the ScaleIO Protection Domain for the configured storage.

false

string

storagePool

The Storage Pool associated with the protection domain (defaults to "default").

The ScaleIO Storage Pool associated with the protection domain.

false

string

storageMode

Indicates whether the storage for a volume should be thick or thin (defaults to "thin").

Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.

false

string

securityContext

Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://git.k8s.io/community/contributors/design-proposals/security_context.md

Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

false

v1.SecurityContext
diff --git a/docs/reference/federation/extensions/v1beta1/operations.html b/docs/reference/generated/federation/extensions/v1beta1/operations.html similarity index 98% rename from docs/reference/federation/extensions/v1beta1/operations.html rename to docs/reference/generated/federation/extensions/v1beta1/operations.html index 7a68f805ed..26449a64e5 100755 --- a/docs/reference/federation/extensions/v1beta1/operations.html +++ b/docs/reference/generated/federation/extensions/v1beta1/operations.html @@ -2,6 +2,7 @@ title: extensions/v1beta1 Operations notitle: true --- + @@ -1400,10 +1401,20 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; } + + + + + + + + + +

202

Accepted

v1beta1.DaemonSet

200

success

v1beta1.DaemonSet

201

Created

v1beta1.DaemonSet
@@ -1666,6 +1677,11 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }

success

v1beta1.DaemonSet

+ +

201

+

Created

+

v1beta1.DaemonSet

+ @@ -2196,6 +2212,11 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }

success

v1beta1.DaemonSet

+ +

201

+

Created

+

v1beta1.DaemonSet

+ @@ -2802,10 +2823,20 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; } +

202

+

Accepted

+

v1beta1.Deployment

+ +

200

success

v1beta1.Deployment

+ +

201

+

Created

+

v1beta1.Deployment

+ @@ -3068,6 +3099,11 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }

success

v1beta1.Deployment

+ +

201

+

Created

+

v1beta1.Deployment

+ @@ -3475,10 +3511,20 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; } +

202

+

Accepted

+

v1beta1.DeploymentRollback

+ +

200

success

v1beta1.DeploymentRollback

+ +

201

+

Created

+

v1beta1.DeploymentRollback

+ @@ -3725,6 +3771,11 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }

success

v1beta1.Scale

+ +

201

+

Created

+

v1beta1.Scale

+ @@ -4104,6 +4155,11 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }

success

v1beta1.Deployment

+ +

201

+

Created

+

v1beta1.Deployment

+ @@ -4710,10 +4766,20 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; } +

202

+

Accepted

+

v1beta1.Ingress

+ +

200

success

v1beta1.Ingress

+ +

201

+

Created

+

v1beta1.Ingress

+ @@ -4976,6 +5042,11 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }

success

v1beta1.Ingress

+ +

201

+

Created

+

v1beta1.Ingress

+ @@ -5506,6 +5577,11 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }

success

v1beta1.Ingress

+ +

201

+

Created

+

v1beta1.Ingress

+ @@ -6112,10 +6188,20 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; } +

202

+

Accepted

+

v1beta1.ReplicaSet

+ +

200

success

v1beta1.ReplicaSet

+ +

201

+

Created

+

v1beta1.ReplicaSet

+ @@ -6378,6 +6464,11 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }

success

v1beta1.ReplicaSet

+ +

201

+

Created

+

v1beta1.ReplicaSet

+ @@ -6908,6 +6999,11 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }

success

v1beta1.Scale

+ +

201

+

Created

+

v1beta1.Scale

+ @@ -7287,6 +7383,11 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }

success

v1beta1.ReplicaSet

+ +

201

+

Created

+

v1beta1.ReplicaSet

+ diff --git a/docs/reference/federation/federation/v1beta1/definitions.html b/docs/reference/generated/federation/federation/v1beta1/definitions.html similarity index 100% rename from docs/reference/federation/federation/v1beta1/definitions.html rename to docs/reference/generated/federation/federation/v1beta1/definitions.html diff --git a/docs/reference/federation/federation/v1beta1/operations.html b/docs/reference/generated/federation/federation/v1beta1/operations.html similarity index 100% rename from docs/reference/federation/federation/v1beta1/operations.html rename to docs/reference/generated/federation/federation/v1beta1/operations.html diff --git a/docs/reference/federation/index.md b/docs/reference/generated/federation/index.md similarity index 100% rename from docs/reference/federation/index.md rename to docs/reference/generated/federation/index.md diff --git a/docs/reference/federation/v1/definitions.html b/docs/reference/generated/federation/v1/definitions.html similarity index 99% rename from docs/reference/federation/v1/definitions.html rename to docs/reference/generated/federation/v1/definitions.html index a7329fae7f..ca4e573991 100755 --- a/docs/reference/federation/v1/definitions.html +++ b/docs/reference/generated/federation/v1/definitions.html @@ -2,6 +2,7 @@ title: v1 Model Definitions notitle: true --- + @@ -1103,7 +1104,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }

phase

-

Phase is the current lifecycle phase of the namespace. More info: https://git.k8s.io/community/contributors/design-proposals/architecture/namespaces.md#phases

+

Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/

false

string

@@ -1192,7 +1193,7 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }

finalizers

-

Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://git.k8s.io/community/contributors/design-proposals/architecture/namespaces.md#finalizers

+

Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/

false

v1.FinalizerName array

diff --git a/docs/reference/federation/v1/operations.html b/docs/reference/generated/federation/v1/operations.html similarity index 98% rename from docs/reference/federation/v1/operations.html rename to docs/reference/generated/federation/v1/operations.html index a24105e0b2..eef0937454 100755 --- a/docs/reference/federation/v1/operations.html +++ b/docs/reference/generated/federation/v1/operations.html @@ -2,6 +2,7 @@ title: v1 Operations notitle: true --- + @@ -1034,10 +1035,20 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; } +

202

+

Accepted

+

v1.Namespace

+ +

200

success

v1.Namespace

+ +

201

+

Created

+

v1.Namespace

+ @@ -1511,10 +1522,20 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; } +

202

+

Accepted

+

v1.ConfigMap

+ +

200

success

v1.ConfigMap

+ +

201

+

Created

+

v1.ConfigMap

+ @@ -1777,6 +1798,11 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }

success

v1.ConfigMap

+ +

201

+

Created

+

v1.ConfigMap

+ @@ -2534,10 +2560,20 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; } +

202

+

Accepted

+

v1.Event

+ +

200

success

v1.Event

+ +

201

+

Created

+

v1.Event

+ @@ -2800,6 +2836,11 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }

success

v1.Event

+ +

201

+

Created

+

v1.Event

+ @@ -3557,10 +3598,20 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; } +

202

+

Accepted

+

v1.Secret

+ +

200

success

v1.Secret

+ +

201

+

Created

+

v1.Secret

+ @@ -3823,6 +3874,11 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }

success

v1.Secret

+ +

201

+

Created

+

v1.Secret

+ @@ -4580,10 +4636,20 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; } +

202

+

Accepted

+

v1.Service

+ +

200

success

v1.Service

+ +

201

+

Created

+

v1.Service

+ @@ -4846,6 +4912,11 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }

success

v1.Service

+ +

201

+

Created

+

v1.Service

+ @@ -5376,6 +5447,11 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }

success

v1.Service

+ +

201

+

Created

+

v1.Service

+ @@ -5755,6 +5831,11 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }

success

v1.Namespace

+ +

201

+

Created

+

v1.Namespace

+ @@ -6142,6 +6223,11 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }

success

v1.Namespace

+ +

201

+

Created

+

v1.Namespace

+ @@ -6372,6 +6458,11 @@ span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }

success

v1.Namespace

+ +

201

+

Created

+

v1.Namespace

+ diff --git a/skip_title_check.txt b/skip_title_check.txt index d7b56acdda..f1fa02234b 100644 --- a/skip_title_check.txt +++ b/skip_title_check.txt @@ -1,5 +1,9 @@ # Put files you want to skip "title:" check here: docs/reference/generated/README.md +docs/reference/generated/federation/v1/operations.html +docs/reference/generated/federation/v1/definitions.html +docs/reference/generated/federation/extensions/v1beta1/operations.html +docs/reference/generated/federation/extensions/v1beta1/definitions.html docs/sitemap.md docs/user-guide/configmap/README.md docs/user-guide/downward-api/README.md @@ -68,4 +72,4 @@ docs/reference/setup-tools/kubeadm/generated/kubeadm_token_list.md docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade.md docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_apply.md docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_plan.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_version.md \ No newline at end of file +docs/reference/setup-tools/kubeadm/generated/kubeadm_version.md