regenerate ref docs, prepare hugo upgrade

This commit is contained in:
Karen Bradshaw
2020-04-13 17:44:29 -04:00
committed by bryan
parent 040dd04e7b
commit 05b55bfaa4
121 changed files with 9556 additions and 9771 deletions
@@ -21,7 +21,6 @@ light grey - rgb(161, 160, 158)
.body-content table {
margin-bottom: 1em;
width: 100%;
overflow: auto;
}
@@ -76,7 +75,6 @@ body > #wrapper {
#sidebar-wrapper {
display: block;
height: 100%;
width: 20%;
position: fixed;
z-index: 1;
top: 0;
@@ -124,7 +122,6 @@ body > #wrapper {
}
#page-content-wrapper {
margin-left: 20%;
padding-top: 60px;
}
@@ -9,8 +9,9 @@
<LINK rel="stylesheet" href="css/stylesheet.css" type="text/css">
</HEAD>
<BODY>
<DIV id="wrapper">
<DIV id="sidebar-wrapper" class="side-nav side-bar-nav">
<DIV id="wrapper" class="container-fluid">
<DIV class="row">
<DIV id="sidebar-wrapper" class="col-xs-4 col-sm-3 col-md-2 side-nav side-bar-nav">
<UL>
<LI class="nav-level-1 strong-nav"><A href="#-strong-api-overview-strong-" class="nav-item"><STRONG>Overview</STRONG></A></LI>
</UL>
@@ -3366,13 +3367,13 @@
<LI class="nav-level-1"><A href="#webhookclientconfig-v1alpha1-auditregistration-k8s-io" class="nav-item">WebhookClientConfig v1alpha1 auditregistration.k8s.io</A></LI>
</UL>
</DIV>
<DIV id="page-content-wrapper" class="body-content container">
<DIV id="page-content-wrapper" class="col-xs-8 offset-xs-4 col-sm-9 offset-sm-3 col-md-10 offset-md-2 body-content">
<DIV class="row">
<DIV class="col-md-6 copyright">
<a href="https://github.com/kubernetes/kubernetes">Copyright 2016-2020 The Kubernetes Authors.</a>
</DIV>
<DIV class="col-md-6 text-right">
<DIV>Generated at: 2020-03-25 16:27:15 (EDT)</DIV>
<DIV>Generated at: 2020-04-13 17:38:34 (EDT)</DIV>
<DIV>API Version: <a href="https://github.com/kubernetes/kubernetes/blob/release-1.18/api/openapi-spec/swagger.json">v1.18.0</a></DIV>
</DIV>
</DIV><H1 id="-strong-api-overview-strong-"><STRONG>API OVERVIEW</STRONG></H1>
@@ -3480,29 +3481,16 @@ data injected into the container.</P>
<HR />
<H1 id="container-v1-core">Container v1 core</H1>
<BUTTON class="btn btn-info" type="button" data-toggle="collapse"
data-target="#kubectl-container-v1-core" aria-controls="kubectl-container-v1-core"
aria-expanded="false">kubectl example</BUTTON>
<BUTTON class="btn btn-info" type="button" data-toggle="collapse"
data-target="#curl-container-v1-core" aria-controls="curl-container-v1-core"
aria-expanded="false">curl example</BUTTON>
<DIV class="collapse" id="kubectl-container-v1-core">
data-target="#example-container-v1-core" aria-controls="example-container-v1-core"
aria-expanded="false">example</BUTTON>
<DIV class="collapse" id="example-container-v1-core">
<DIV class="panel panel-default">
<DIV class="panel-heading">Container Config to run nginx (must be embedded in a PodSpec to run).</DIV>
<DIV class="panel-body">
<PRE class="kubectl"><CODE class="lang-yaml">
<PRE class="example"><CODE class="lang-yaml">
name: nginx
# Run the nginx:1.10 image
image: nginx:1.10
</CODE></PRE></DIV></DIV></DIV>
<DIV class="collapse" id="curl-container-v1-core">
<DIV class="panel panel-default">
<DIV class="panel-heading">Container Config to run nginx (must be embedded in a PodSpec to run).</DIV>
<DIV class="panel-body">
<PRE class="curl"><CODE class="lang-yaml">
name: nginx
# Run the nginx:1.10 image
image: nginx:1.10
# Run the nginx:1.14 image
image: nginx:1.14
</CODE></PRE></DIV></DIV></DIV>
<TABLE class="col-md-8">
@@ -4103,50 +4091,13 @@ image: nginx:1.10
</TABLE>
<H1 id="daemonset-v1-apps">DaemonSet v1 apps</H1>
<BUTTON class="btn btn-info" type="button" data-toggle="collapse"
data-target="#kubectl-daemonset-v1-apps" aria-controls="kubectl-daemonset-v1-apps"
aria-expanded="false">kubectl example</BUTTON>
<BUTTON class="btn btn-info" type="button" data-toggle="collapse"
data-target="#curl-daemonset-v1-apps" aria-controls="curl-daemonset-v1-apps"
aria-expanded="false">curl example</BUTTON>
<DIV class="collapse" id="kubectl-daemonset-v1-apps">
data-target="#example-daemonset-v1-apps" aria-controls="example-daemonset-v1-apps"
aria-expanded="false">example</BUTTON>
<DIV class="collapse" id="example-daemonset-v1-apps">
<DIV class="panel panel-default">
<DIV class="panel-heading">DaemonSet Config to print the `hostname` on each Node in the cluster every 10 seconds.</DIV>
<DIV class="panel-body">
<PRE class="kubectl"><CODE class="lang-yaml">
apiVersion: apps/v1
kind: DaemonSet
metadata:
# Unique key of the DaemonSet instance
name: daemonset-example
spec:
selector:
matchLabels:
app: daemonset-example
template:
metadata:
labels:
app: daemonset-example
spec:
containers:
# This container is run once on each Node in the cluster
- name: daemonset-example
image: ubuntu:trusty
command:
- /bin/sh
args:
- -c
# This script is run through `sh -c &lt;script&gt;`
- &gt;-
while [ true ]; do
echo &#34;DaemonSet running on $(hostname)&#34; ;
sleep 10 ;
done
</CODE></PRE></DIV></DIV></DIV>
<DIV class="collapse" id="curl-daemonset-v1-apps">
<DIV class="panel panel-default">
<DIV class="panel-heading">DaemonSet Config to print the `hostname` on each Node in the cluster every 10 seconds.</DIV>
<DIV class="panel-body">
<PRE class="curl"><CODE class="lang-yaml">
<PRE class="example"><CODE class="lang-yaml">
apiVersion: apps/v1
kind: DaemonSet
metadata:
@@ -4950,16 +4901,13 @@ $ curl -X GET http://127.0.0.1:8001/apis/apps/v1/namespaces/default/daemonsets/d
</TABLE>
<H1 id="deployment-v1-apps">Deployment v1 apps</H1>
<BUTTON class="btn btn-info" type="button" data-toggle="collapse"
data-target="#kubectl-deployment-v1-apps" aria-controls="kubectl-deployment-v1-apps"
aria-expanded="false">kubectl example</BUTTON>
<BUTTON class="btn btn-info" type="button" data-toggle="collapse"
data-target="#curl-deployment-v1-apps" aria-controls="curl-deployment-v1-apps"
aria-expanded="false">curl example</BUTTON>
<DIV class="collapse" id="kubectl-deployment-v1-apps">
data-target="#example-deployment-v1-apps" aria-controls="example-deployment-v1-apps"
aria-expanded="false">example</BUTTON>
<DIV class="collapse" id="example-deployment-v1-apps">
<DIV class="panel panel-default">
<DIV class="panel-heading">Deployment Config to run 3 nginx instances (max rollback set to 10 revisions).</DIV>
<DIV class="panel-body">
<PRE class="kubectl"><CODE class="lang-yaml">
<PRE class="example"><CODE class="lang-yaml">
apiVersion: apps/v1
kind: Deployment
metadata:
@@ -4981,36 +4929,7 @@ spec:
containers:
- name: nginx
# Run this image
image: nginx:1.10
</CODE></PRE></DIV></DIV></DIV>
<DIV class="collapse" id="curl-deployment-v1-apps">
<DIV class="panel panel-default">
<DIV class="panel-heading">Deployment Config to run 3 nginx instances (max rollback set to 10 revisions).</DIV>
<DIV class="panel-body">
<PRE class="curl"><CODE class="lang-yaml">
apiVersion: apps/v1
kind: Deployment
metadata:
# Unique key of the Deployment instance
name: deployment-example
spec:
# 3 Pods should exist at all times.
replicas: 3
selector:
matchLabels:
app: nginx
template:
metadata:
labels:
# Apply this label to pods and default
# the Deployment label selector to this value
app: nginx
spec:
containers:
- name: nginx
# Run this image
image: nginx:1.10
image: nginx:1.14
</CODE></PRE></DIV></DIV></DIV>
<TABLE class="col-md-8">
@@ -5138,7 +5057,7 @@ spec:
spec:
containers:
- name: nginx
image: nginx:1.10
image: nginx:1.14
ports:
- containerPort: 80
' | kubectl create -f -
@@ -5167,7 +5086,7 @@ spec:
spec:
containers:
- name: nginx
image: nginx:1.10
image: nginx:1.14
ports:
- containerPort: 80
' http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments
@@ -5223,7 +5142,7 @@ deployment "deployment-example" created
"containers": [
{
"name": "nginx",
"image": "nginx:1.10",
"image": "nginx:1.14",
"ports": [
{
"containerPort": 80,
@@ -5302,7 +5221,7 @@ deployment "deployment-example" created
<DIV class="panel-body">
<PRE class="kubectl"><CODE class="lang-shell">
$ kubectl patch deployment deployment-example -p \
'{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.11"}]}}}}'
'{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.16"}]}}}}'
</CODE></PRE></DIV></DIV></DIV>
<DIV class="collapse" id="req-curl-patch-deployment-v1-apps">
<DIV class="panel panel-default">
@@ -5311,7 +5230,7 @@ $ kubectl patch deployment deployment-example -p \
<PRE class="curl"><CODE class="lang-shell">
$ kubectl proxy
$ curl -X PATCH -H 'Content-Type: application/strategic-merge-patch+json' --data '
{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.11"}]}}}}' \
{"spec":{"template":{"spec":{"containers":[{"name":"nginx","image":"nginx:1.16"}]}}}}' \
'http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments/deployment-example'
</CODE></PRE></DIV></DIV></DIV>
<BUTTON class="btn btn-info" type="button" data-toggle="collapse"
@@ -5368,7 +5287,7 @@ $ curl -X PATCH -H 'Content-Type: application/strategic-merge-patch+json' --data
"containers": [
{
"name": "nginx",
"image": "nginx:1.11",
"image": "nginx:1.16",
"ports": [
{
"containerPort": 80,
@@ -5468,7 +5387,7 @@ spec:
spec:
containers:
- name: nginx
image: nginx:1.11
image: nginx:1.16
ports:
- containerPort: 80
' | kubectl replace -f -
@@ -5497,7 +5416,7 @@ spec:
spec:
containers:
- name: nginx
image: nginx:1.11
image: nginx:1.16
ports:
- containerPort: 80
' http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments/deployment-example
@@ -5553,7 +5472,7 @@ deployment "deployment-example" replaced
"containers": [
{
"name": "nginx",
"image": "nginx:1.11",
"image": "nginx:1.16",
"ports": [
{
"containerPort": 80,
@@ -5827,7 +5746,7 @@ $ curl -X GET http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments/
"containers": [
{
"name": "nginx",
"image": "nginx:1.10",
"image": "nginx:1.14",
"ports": [
{
"containerPort": 80,
@@ -5903,7 +5822,7 @@ $ curl -X GET http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments/
"containers": [
{
"name": "nginx",
"image": "nginx:1.10",
"image": "nginx:1.14",
"ports": [
{
"containerPort": 80,
@@ -6104,7 +6023,7 @@ $ curl -X GET 'http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments
"containers": [
{
"name": "nginx",
"image": "nginx:1.10",
"image": "nginx:1.14",
"ports": [
{
"containerPort": 80,
@@ -6252,7 +6171,7 @@ $ curl -X GET 'http://127.0.0.1:8001/apis/apps/v1/namespaces/default/deployments
"containers": [
{
"name": "nginx",
"image": "nginx:1.10",
"image": "nginx:1.14",
"ports": [
{
"containerPort": 80,
@@ -6418,7 +6337,7 @@ $ curl -X GET 'http://127.0.0.1:8001/apis/apps/v1/watch/namespaces/default/deplo
"containers": [
{
"name": "nginx",
"image": "nginx:1.10",
"image": "nginx:1.14",
"ports": [
{
"containerPort": 80,
@@ -6499,7 +6418,7 @@ $ curl -X GET 'http://127.0.0.1:8001/apis/apps/v1/watch/namespaces/default/deplo
"containers": [
{
"name": "nginx",
"image": "nginx:1.10",
"image": "nginx:1.14",
"ports": [
{
"containerPort": 80,
@@ -6829,40 +6748,13 @@ $ curl -X GET 'http://127.0.0.1:8001/apis/apps/v1/watch/namespaces/default/deplo
</TABLE>
<H1 id="job-v1-batch">Job v1 batch</H1>
<BUTTON class="btn btn-info" type="button" data-toggle="collapse"
data-target="#kubectl-job-v1-batch" aria-controls="kubectl-job-v1-batch"
aria-expanded="false">kubectl example</BUTTON>
<BUTTON class="btn btn-info" type="button" data-toggle="collapse"
data-target="#curl-job-v1-batch" aria-controls="curl-job-v1-batch"
aria-expanded="false">curl example</BUTTON>
<DIV class="collapse" id="kubectl-job-v1-batch">
data-target="#example-job-v1-batch" aria-controls="example-job-v1-batch"
aria-expanded="false">example</BUTTON>
<DIV class="collapse" id="example-job-v1-batch">
<DIV class="panel panel-default">
<DIV class="panel-heading">Job Config to print pi up to 2000 digits (then exit).</DIV>
<DIV class="panel-body">
<PRE class="kubectl"><CODE class="lang-yaml">
apiVersion: batch/v1
kind: Job
metadata:
# Unique key of the Job instance
name: example-job
spec:
template:
metadata:
name: example-job
spec:
containers:
- name: pi
image: perl
command: [&#34;perl&#34;]
args: [&#34;-Mbignum=bpi&#34;, &#34;-wle&#34;, &#34;print bpi(2000)&#34;]
# Do not restart containers after they exit
restartPolicy: Never
</CODE></PRE></DIV></DIV></DIV>
<DIV class="collapse" id="curl-job-v1-batch">
<DIV class="panel panel-default">
<DIV class="panel-heading">Job Config to print pi up to 2000 digits (then exit).</DIV>
<DIV class="panel-body">
<PRE class="curl"><CODE class="lang-yaml">
<PRE class="example"><CODE class="lang-yaml">
apiVersion: batch/v1
kind: Job
metadata:
@@ -8076,33 +7968,13 @@ $ curl -X GET 'http://127.0.0.1:8001/apis/batch/v1/watch/namespaces/default/jobs
</TABLE>
<H1 id="pod-v1-core">Pod v1 core</H1>
<BUTTON class="btn btn-info" type="button" data-toggle="collapse"
data-target="#kubectl-pod-v1-core" aria-controls="kubectl-pod-v1-core"
aria-expanded="false">kubectl example</BUTTON>
<BUTTON class="btn btn-info" type="button" data-toggle="collapse"
data-target="#curl-pod-v1-core" aria-controls="curl-pod-v1-core"
aria-expanded="false">curl example</BUTTON>
<DIV class="collapse" id="kubectl-pod-v1-core">
data-target="#example-pod-v1-core" aria-controls="example-pod-v1-core"
aria-expanded="false">example</BUTTON>
<DIV class="collapse" id="example-pod-v1-core">
<DIV class="panel panel-default">
<DIV class="panel-heading">Pod Config to print "Hello World".</DIV>
<DIV class="panel-body">
<PRE class="kubectl"><CODE class="lang-yaml">
apiVersion: v1
kind: Pod
metadata:
name: pod-example
spec:
containers:
- name: ubuntu
image: ubuntu:trusty
command: [&#34;echo&#34;]
args: [&#34;Hello World&#34;]
</CODE></PRE></DIV></DIV></DIV>
<DIV class="collapse" id="curl-pod-v1-core">
<DIV class="panel panel-default">
<DIV class="panel-heading">Pod Config to print "Hello World".</DIV>
<DIV class="panel-body">
<PRE class="curl"><CODE class="lang-yaml">
<PRE class="example"><CODE class="lang-yaml">
apiVersion: v1
kind: Pod
metadata:
@@ -9080,16 +8952,13 @@ spec:
</TABLE>
<H1 id="replicaset-v1-apps">ReplicaSet v1 apps</H1>
<BUTTON class="btn btn-info" type="button" data-toggle="collapse"
data-target="#kubectl-replicaset-v1-apps" aria-controls="kubectl-replicaset-v1-apps"
aria-expanded="false">kubectl example</BUTTON>
<BUTTON class="btn btn-info" type="button" data-toggle="collapse"
data-target="#curl-replicaset-v1-apps" aria-controls="curl-replicaset-v1-apps"
aria-expanded="false">curl example</BUTTON>
<DIV class="collapse" id="kubectl-replicaset-v1-apps">
data-target="#example-replicaset-v1-apps" aria-controls="example-replicaset-v1-apps"
aria-expanded="false">example</BUTTON>
<DIV class="collapse" id="example-replicaset-v1-apps">
<DIV class="panel panel-default">
<DIV class="panel-heading">ReplicaSet Config to run 3 nginx instances.</DIV>
<DIV class="panel-body">
<PRE class="kubectl"><CODE class="lang-yaml">
<PRE class="example"><CODE class="lang-yaml">
apiVersion: apps/v1
kind: ReplicaSet
metadata:
@@ -9109,34 +8978,7 @@ spec:
containers:
# Run the nginx image
- name: nginx
image: nginx:1.10
</CODE></PRE></DIV></DIV></DIV>
<DIV class="collapse" id="curl-replicaset-v1-apps">
<DIV class="panel panel-default">
<DIV class="panel-heading">ReplicaSet Config to run 3 nginx instances.</DIV>
<DIV class="panel-body">
<PRE class="curl"><CODE class="lang-yaml">
apiVersion: apps/v1
kind: ReplicaSet
metadata:
# Unique key of the ReplicaSet instance
name: replicaset-example
spec:
# 3 Pods should exist at all times.
replicas: 3
selector:
matchLabels:
app: nginx
template:
metadata:
labels:
app: nginx
spec:
containers:
# Run the nginx image
- name: nginx
image: nginx:1.10
image: nginx:1.14
</CODE></PRE></DIV></DIV></DIV>
<TABLE class="col-md-8">
@@ -9775,16 +9617,13 @@ spec:
</TABLE>
<H1 id="replicationcontroller-v1-core">ReplicationController v1 core</H1>
<BUTTON class="btn btn-info" type="button" data-toggle="collapse"
data-target="#kubectl-replicationcontroller-v1-core" aria-controls="kubectl-replicationcontroller-v1-core"
aria-expanded="false">kubectl example</BUTTON>
<BUTTON class="btn btn-info" type="button" data-toggle="collapse"
data-target="#curl-replicationcontroller-v1-core" aria-controls="curl-replicationcontroller-v1-core"
aria-expanded="false">curl example</BUTTON>
<DIV class="collapse" id="kubectl-replicationcontroller-v1-core">
data-target="#example-replicationcontroller-v1-core" aria-controls="example-replicationcontroller-v1-core"
aria-expanded="false">example</BUTTON>
<DIV class="collapse" id="example-replicationcontroller-v1-core">
<DIV class="panel panel-default">
<DIV class="panel-heading">ReplicationController Config to run 3 nginx instances.</DIV>
<DIV class="panel-body">
<PRE class="kubectl"><CODE class="lang-yaml">
<PRE class="example"><CODE class="lang-yaml">
apiVersion: v1
kind: ReplicationController
metadata:
@@ -9801,31 +9640,7 @@ spec:
containers:
# Run the nginx image
- name: nginx
image: nginx:1.10
</CODE></PRE></DIV></DIV></DIV>
<DIV class="collapse" id="curl-replicationcontroller-v1-core">
<DIV class="panel panel-default">
<DIV class="panel-heading">ReplicationController Config to run 3 nginx instances.</DIV>
<DIV class="panel-body">
<PRE class="curl"><CODE class="lang-yaml">
apiVersion: v1
kind: ReplicationController
metadata:
# Unique key of the ReplicationController instance
name: replicationcontroller-example
spec:
# 3 Pods should exist at all times.
replicas: 3
template:
metadata:
labels:
app: nginx
spec:
containers:
# Run the nginx image
- name: nginx
image: nginx:1.10
image: nginx:1.14
</CODE></PRE></DIV></DIV></DIV>
<TABLE class="col-md-8">
@@ -12788,42 +12603,13 @@ Workloads can be accessed via proxy through the api master using the <code>kubec
</TABLE>
<H1 id="service-v1-core">Service v1 core</H1>
<BUTTON class="btn btn-info" type="button" data-toggle="collapse"
data-target="#kubectl-service-v1-core" aria-controls="kubectl-service-v1-core"
aria-expanded="false">kubectl example</BUTTON>
<BUTTON class="btn btn-info" type="button" data-toggle="collapse"
data-target="#curl-service-v1-core" aria-controls="curl-service-v1-core"
aria-expanded="false">curl example</BUTTON>
<DIV class="collapse" id="kubectl-service-v1-core">
data-target="#example-service-v1-core" aria-controls="example-service-v1-core"
aria-expanded="false">example</BUTTON>
<DIV class="collapse" id="example-service-v1-core">
<DIV class="panel panel-default">
<DIV class="panel-heading">Service Config to load balance traffic across all Pods with the app=nginx label. Receives on and sends to port 80. Exposes an externally accessible endpoint.</DIV>
<DIV class="panel-body">
<PRE class="kubectl"><CODE class="lang-yaml">
kind: Service
apiVersion: v1
metadata:
# Unique key of the Service instance
name: service-example
spec:
ports:
# Accept traffic sent to port 80
- name: http
port: 80
targetPort: 80
selector:
# Loadbalance traffic across Pods matching
# this label selector
app: nginx
# Create an HA proxy in the cloud provider
# with an External IP address - *Only supported
# by some cloud providers*
type: LoadBalancer
</CODE></PRE></DIV></DIV></DIV>
<DIV class="collapse" id="curl-service-v1-core">
<DIV class="panel panel-default">
<DIV class="panel-heading">Service Config to load balance traffic across all Pods with the app=nginx label. Receives on and sends to port 80. Exposes an externally accessible endpoint.</DIV>
<DIV class="panel-body">
<PRE class="curl"><CODE class="lang-yaml">
<PRE class="example"><CODE class="lang-yaml">
kind: Service
apiVersion: v1
metadata:
@@ -48154,6 +47940,8 @@ The contents of the target Secret&#39;s Data field will be presented in a volume
<TR><TD><CODE>url</CODE><BR /><I>string</I></TD><TD>`url` gives the location of the webhook, in standard URL form (`scheme://host:port/path`). Exactly one of `url` or `service` must be specified. The `host` should not refer to a service running in the cluster; use the `service` field instead. The host might be resolved via external DNS in some apiservers (e.g., `kube-apiserver` cannot resolve in-cluster DNS as that would be a layering violation). `host` may also be an IP address. Please note that using `localhost` or `127.0.0.1` as a `host` is risky unless you take great care to run this webhook on all hosts which run an apiserver which might need to make calls to this webhook. Such installs are likely to be non-portable, i.e., not easy to turn up in a new cluster. The scheme must be &#34;https&#34;; the URL must begin with &#34;https://&#34;. A path is optional, and if present may be any string permissible in a URL. You may use the path to pass an arbitrary string to the webhook, for example, a cluster identifier. Attempting to use a user or basic auth e.g. &#34;user:password@&#34; is not allowed. Fragments (&#34;#...&#34;) and query parameters (&#34;?...&#34;) are not allowed, either.</TD></TR>
</TBODY>
</TABLE>
</DIV>
</DIV>
</DIV>
<SCRIPT src="/js/jquery-3.2.1.min.js"></SCRIPT>