2211 lines
138 KiB
HTML
2211 lines
138 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html lang="en">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
|
|
<meta name="generator" content="Asciidoctor 0.1.4">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
|
<title>Top Level API Objects</title>
|
||
|
|
<style>
|
||
|
|
/* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
|
||
|
|
article, aside, details, figcaption, figure, footer, header, hgroup, main, nav, section, summary { display: block; }
|
||
|
|
audio, canvas, video { display: inline-block; }
|
||
|
|
audio:not([controls]) { display: none; height: 0; }
|
||
|
|
[hidden] { display: none; }
|
||
|
|
html { background: #fff; color: #000; font-family: sans-serif; -ms-text-size-adjust: 100%; -webkit-text-size-adjust: 100%; }
|
||
|
|
body { margin: 0; }
|
||
|
|
a:focus { outline: thin dotted; }
|
||
|
|
a:active, a:hover { outline: 0; }
|
||
|
|
h1 { font-size: 2em; margin: 0.67em 0; }
|
||
|
|
abbr[title] { border-bottom: 1px dotted; }
|
||
|
|
b, strong { font-weight: bold; }
|
||
|
|
dfn { font-style: italic; }
|
||
|
|
hr { -moz-box-sizing: content-box; box-sizing: content-box; height: 0; }
|
||
|
|
mark { background: #ff0; color: #000; }
|
||
|
|
code, kbd, pre, samp { font-family: monospace, serif; font-size: 1em; }
|
||
|
|
pre { white-space: pre-wrap; }
|
||
|
|
q { quotes: "\201C" "\201D" "\2018" "\2019"; }
|
||
|
|
small { font-size: 80%; }
|
||
|
|
sub, sup { font-size: 75%; line-height: 0; position: relative; vertical-align: baseline; }
|
||
|
|
sup { top: -0.5em; }
|
||
|
|
sub { bottom: -0.25em; }
|
||
|
|
img { border: 0; }
|
||
|
|
svg:not(:root) { overflow: hidden; }
|
||
|
|
figure { margin: 0; }
|
||
|
|
fieldset { border: 1px solid #c0c0c0; margin: 0 2px; padding: 0.35em 0.625em 0.75em; }
|
||
|
|
legend { border: 0; padding: 0; }
|
||
|
|
button, input, select, textarea { font-family: inherit; font-size: 100%; margin: 0; }
|
||
|
|
button, input { line-height: normal; }
|
||
|
|
button, select { text-transform: none; }
|
||
|
|
button, html input[type="button"], input[type="reset"], input[type="submit"] { -webkit-appearance: button; cursor: pointer; }
|
||
|
|
button[disabled], html input[disabled] { cursor: default; }
|
||
|
|
input[type="checkbox"], input[type="radio"] { box-sizing: border-box; padding: 0; }
|
||
|
|
input[type="search"] { -webkit-appearance: textfield; -moz-box-sizing: content-box; -webkit-box-sizing: content-box; box-sizing: content-box; }
|
||
|
|
input[type="search"]::-webkit-search-cancel-button, input[type="search"]::-webkit-search-decoration { -webkit-appearance: none; }
|
||
|
|
button::-moz-focus-inner, input::-moz-focus-inner { border: 0; padding: 0; }
|
||
|
|
textarea { overflow: auto; vertical-align: top; }
|
||
|
|
table { border-collapse: collapse; border-spacing: 0; }
|
||
|
|
*, *:before, *:after { -moz-box-sizing: border-box; -webkit-box-sizing: border-box; box-sizing: border-box; }
|
||
|
|
html, body { font-size: 100%; }
|
||
|
|
body { background: white; color: #222222; padding: 0; margin: 0; font-family: "Helvetica Neue", "Helvetica", Helvetica, Arial, sans-serif; font-weight: normal; font-style: normal; line-height: 1; position: relative; cursor: auto; }
|
||
|
|
a:hover { cursor: pointer; }
|
||
|
|
a:focus { outline: none; }
|
||
|
|
img, object, embed { max-width: 100%; height: auto; }
|
||
|
|
object, embed { height: 100%; }
|
||
|
|
img { -ms-interpolation-mode: bicubic; }
|
||
|
|
#map_canvas img, #map_canvas embed, #map_canvas object, .map_canvas img, .map_canvas embed, .map_canvas object { max-width: none !important; }
|
||
|
|
.left { float: left !important; }
|
||
|
|
.right { float: right !important; }
|
||
|
|
.text-left { text-align: left !important; }
|
||
|
|
.text-right { text-align: right !important; }
|
||
|
|
.text-center { text-align: center !important; }
|
||
|
|
.text-justify { text-align: justify !important; }
|
||
|
|
.hide { display: none; }
|
||
|
|
.antialiased, body { -webkit-font-smoothing: antialiased; }
|
||
|
|
img { display: inline-block; vertical-align: middle; }
|
||
|
|
textarea { height: auto; min-height: 50px; }
|
||
|
|
select { width: 100%; }
|
||
|
|
p.lead, .paragraph.lead > p, #preamble > .sectionbody > .paragraph:first-of-type p { font-size: 1.21875em; line-height: 1.6; }
|
||
|
|
.subheader, #content #toctitle, .admonitionblock td.content > .title, .exampleblock > .title, .imageblock > .title, .videoblock > .title, .listingblock > .title, .literalblock > .title, .openblock > .title, .paragraph > .title, .quoteblock > .title, .sidebarblock > .title, .tableblock > .title, .verseblock > .title, .dlist > .title, .olist > .title, .ulist > .title, .qlist > .title, .hdlist > .title, .tableblock > caption { line-height: 1.4; color: #7a2518; font-weight: 300; margin-top: 0.2em; margin-bottom: 0.5em; }
|
||
|
|
div, dl, dt, dd, ul, ol, li, h1, h2, h3, #toctitle, .sidebarblock > .content > .title, h4, h5, h6, pre, form, p, blockquote, th, td { margin: 0; padding: 0; direction: ltr; }
|
||
|
|
a { color: #005498; text-decoration: underline; line-height: inherit; }
|
||
|
|
a:hover, a:focus { color: #00467f; }
|
||
|
|
a img { border: none; }
|
||
|
|
p { font-family: inherit; font-weight: normal; font-size: 1em; line-height: 1.6; margin-bottom: 1.25em; text-rendering: optimizeLegibility; }
|
||
|
|
p aside { font-size: 0.875em; line-height: 1.35; font-style: italic; }
|
||
|
|
h1, h2, h3, #toctitle, .sidebarblock > .content > .title, h4, h5, h6 { font-family: Georgia, "URW Bookman L", Helvetica, Arial, sans-serif; font-weight: normal; font-style: normal; color: #ba3925; text-rendering: optimizeLegibility; margin-top: 1em; margin-bottom: 0.5em; line-height: 1.2125em; }
|
||
|
|
h1 small, h2 small, h3 small, #toctitle small, .sidebarblock > .content > .title small, h4 small, h5 small, h6 small { font-size: 60%; color: #e99b8f; line-height: 0; }
|
||
|
|
h1 { font-size: 2.125em; }
|
||
|
|
h2 { font-size: 1.6875em; }
|
||
|
|
h3, #toctitle, .sidebarblock > .content > .title { font-size: 1.375em; }
|
||
|
|
h4 { font-size: 1.125em; }
|
||
|
|
h5 { font-size: 1.125em; }
|
||
|
|
h6 { font-size: 1em; }
|
||
|
|
hr { border: solid #dddddd; border-width: 1px 0 0; clear: both; margin: 1.25em 0 1.1875em; height: 0; }
|
||
|
|
em, i { font-style: italic; line-height: inherit; }
|
||
|
|
strong, b { font-weight: bold; line-height: inherit; }
|
||
|
|
small { font-size: 60%; line-height: inherit; }
|
||
|
|
code { font-family: Consolas, "Liberation Mono", Courier, monospace; font-weight: normal; color: #6d180b; }
|
||
|
|
ul, ol, dl { font-size: 1em; line-height: 1.6; margin-bottom: 1.25em; list-style-position: outside; font-family: inherit; }
|
||
|
|
ul, ol { margin-left: 1.5em; }
|
||
|
|
ul li ul, ul li ol { margin-left: 1.25em; margin-bottom: 0; font-size: 1em; }
|
||
|
|
ul.square li ul, ul.circle li ul, ul.disc li ul { list-style: inherit; }
|
||
|
|
ul.square { list-style-type: square; }
|
||
|
|
ul.circle { list-style-type: circle; }
|
||
|
|
ul.disc { list-style-type: disc; }
|
||
|
|
ul.no-bullet { list-style: none; }
|
||
|
|
ol li ul, ol li ol { margin-left: 1.25em; margin-bottom: 0; }
|
||
|
|
dl dt { margin-bottom: 0.3125em; font-weight: bold; }
|
||
|
|
dl dd { margin-bottom: 1.25em; }
|
||
|
|
abbr, acronym { text-transform: uppercase; font-size: 90%; color: #222222; border-bottom: 1px dotted #dddddd; cursor: help; }
|
||
|
|
abbr { text-transform: none; }
|
||
|
|
blockquote { margin: 0 0 1.25em; padding: 0.5625em 1.25em 0 1.1875em; border-left: 1px solid #dddddd; }
|
||
|
|
blockquote cite { display: block; font-size: inherit; color: #555555; }
|
||
|
|
blockquote cite:before { content: "\2014 \0020"; }
|
||
|
|
blockquote cite a, blockquote cite a:visited { color: #555555; }
|
||
|
|
blockquote, blockquote p { line-height: 1.6; color: #6f6f6f; }
|
||
|
|
.vcard { display: inline-block; margin: 0 0 1.25em 0; border: 1px solid #dddddd; padding: 0.625em 0.75em; }
|
||
|
|
.vcard li { margin: 0; display: block; }
|
||
|
|
.vcard .fn { font-weight: bold; font-size: 0.9375em; }
|
||
|
|
.vevent .summary { font-weight: bold; }
|
||
|
|
.vevent abbr { cursor: auto; text-decoration: none; font-weight: bold; border: none; padding: 0 0.0625em; }
|
||
|
|
@media only screen and (min-width: 768px) { h1, h2, h3, #toctitle, .sidebarblock > .content > .title, h4, h5, h6 { line-height: 1.4; }
|
||
|
|
h1 { font-size: 2.75em; }
|
||
|
|
h2 { font-size: 2.3125em; }
|
||
|
|
h3, #toctitle, .sidebarblock > .content > .title { font-size: 1.6875em; }
|
||
|
|
h4 { font-size: 1.4375em; } }
|
||
|
|
.print-only { display: none !important; }
|
||
|
|
@media print { * { background: transparent !important; color: #000 !important; box-shadow: none !important; text-shadow: none !important; }
|
||
|
|
a, a:visited { text-decoration: underline; }
|
||
|
|
a[href]:after { content: " (" attr(href) ")"; }
|
||
|
|
abbr[title]:after { content: " (" attr(title) ")"; }
|
||
|
|
.ir a:after, a[href^="javascript:"]:after, a[href^="#"]:after { content: ""; }
|
||
|
|
pre, blockquote { border: 1px solid #999; page-break-inside: avoid; }
|
||
|
|
thead { display: table-header-group; }
|
||
|
|
tr, img { page-break-inside: avoid; }
|
||
|
|
img { max-width: 100% !important; }
|
||
|
|
@page { margin: 0.5cm; }
|
||
|
|
p, h2, h3, #toctitle, .sidebarblock > .content > .title { orphans: 3; widows: 3; }
|
||
|
|
h2, h3, #toctitle, .sidebarblock > .content > .title { page-break-after: avoid; }
|
||
|
|
.hide-on-print { display: none !important; }
|
||
|
|
.print-only { display: block !important; }
|
||
|
|
.hide-for-print { display: none !important; }
|
||
|
|
.show-for-print { display: inherit !important; } }
|
||
|
|
table { background: white; margin-bottom: 1.25em; border: solid 1px #dddddd; }
|
||
|
|
table thead, table tfoot { background: whitesmoke; font-weight: bold; }
|
||
|
|
table thead tr th, table thead tr td, table tfoot tr th, table tfoot tr td { padding: 0.5em 0.625em 0.625em; font-size: inherit; color: #222222; text-align: left; }
|
||
|
|
table tr th, table tr td { padding: 0.5625em 0.625em; font-size: inherit; color: #222222; }
|
||
|
|
table tr.even, table tr.alt, table tr:nth-of-type(even) { background: #f9f9f9; }
|
||
|
|
table thead tr th, table tfoot tr th, table tbody tr td, table tr td, table tfoot tr td { display: table-cell; line-height: 1.6; }
|
||
|
|
.clearfix:before, .clearfix:after, .float-group:before, .float-group:after { content: " "; display: table; }
|
||
|
|
.clearfix:after, .float-group:after { clear: both; }
|
||
|
|
*:not(pre) > code { font-size: 0.9375em; padding: 1px 3px 0; white-space: nowrap; background-color: #f2f2f2; border: 1px solid #cccccc; -webkit-border-radius: 4px; border-radius: 4px; text-shadow: none; }
|
||
|
|
pre, pre > code { line-height: 1.4; color: inherit; font-family: Consolas, "Liberation Mono", Courier, monospace; font-weight: normal; }
|
||
|
|
kbd.keyseq { color: #555555; }
|
||
|
|
kbd:not(.keyseq) { display: inline-block; color: #222222; font-size: 0.75em; line-height: 1.4; background-color: #F7F7F7; border: 1px solid #ccc; -webkit-border-radius: 3px; border-radius: 3px; -webkit-box-shadow: 0 1px 0 rgba(0, 0, 0, 0.2), 0 0 0 2px white inset; box-shadow: 0 1px 0 rgba(0, 0, 0, 0.2), 0 0 0 2px white inset; margin: -0.15em 0.15em 0 0.15em; padding: 0.2em 0.6em 0.2em 0.5em; vertical-align: middle; white-space: nowrap; }
|
||
|
|
kbd kbd:first-child { margin-left: 0; }
|
||
|
|
kbd kbd:last-child { margin-right: 0; }
|
||
|
|
.menuseq, .menu { color: #090909; }
|
||
|
|
p a > code:hover { color: #561309; }
|
||
|
|
#header, #content, #footnotes, #footer { width: 100%; margin-left: auto; margin-right: auto; margin-top: 0; margin-bottom: 0; max-width: 62.5em; *zoom: 1; position: relative; padding-left: 0.9375em; padding-right: 0.9375em; }
|
||
|
|
#header:before, #header:after, #content:before, #content:after, #footnotes:before, #footnotes:after, #footer:before, #footer:after { content: " "; display: table; }
|
||
|
|
#header:after, #content:after, #footnotes:after, #footer:after { clear: both; }
|
||
|
|
#header { margin-bottom: 2.5em; }
|
||
|
|
#header > h1 { color: black; font-weight: normal; border-bottom: 1px solid #dddddd; margin-bottom: -28px; padding-bottom: 32px; }
|
||
|
|
#header span { color: #6f6f6f; }
|
||
|
|
#header #revnumber { text-transform: capitalize; }
|
||
|
|
#header br { display: none; }
|
||
|
|
#header br + span { padding-left: 3px; }
|
||
|
|
#header br + span:before { content: "\2013 \0020"; }
|
||
|
|
#header br + span.author { padding-left: 0; }
|
||
|
|
#header br + span.author:before { content: ", "; }
|
||
|
|
#toc { border-bottom: 3px double #ebebeb; padding-bottom: 1.25em; }
|
||
|
|
#toc > ul { margin-left: 0.25em; }
|
||
|
|
#toc ul.sectlevel0 > li > a { font-style: italic; }
|
||
|
|
#toc ul.sectlevel0 ul.sectlevel1 { margin-left: 0; margin-top: 0.5em; margin-bottom: 0.5em; }
|
||
|
|
#toc ul { list-style-type: none; }
|
||
|
|
#toctitle { color: #7a2518; }
|
||
|
|
@media only screen and (min-width: 1280px) { body.toc2 { padding-left: 20em; }
|
||
|
|
#toc.toc2 { position: fixed; width: 20em; left: 0; top: 0; border-right: 1px solid #ebebeb; border-bottom: 0; z-index: 1000; padding: 1em; height: 100%; overflow: auto; }
|
||
|
|
#toc.toc2 #toctitle { margin-top: 0; }
|
||
|
|
#toc.toc2 > ul { font-size: .95em; }
|
||
|
|
#toc.toc2 ul ul { margin-left: 0; padding-left: 1.25em; }
|
||
|
|
#toc.toc2 ul.sectlevel0 ul.sectlevel1 { padding-left: 0; margin-top: 0.5em; margin-bottom: 0.5em; }
|
||
|
|
body.toc2.toc-right { padding-left: 0; padding-right: 20em; }
|
||
|
|
body.toc2.toc-right #toc.toc2 { border-right: 0; border-left: 1px solid #ebebeb; left: auto; right: 0; } }
|
||
|
|
#content #toc { border-style: solid; border-width: 1px; border-color: #d9d9d9; margin-bottom: 1.25em; padding: 1.25em; background: #f2f2f2; border-width: 0; -webkit-border-radius: 4px; border-radius: 4px; }
|
||
|
|
#content #toc > :first-child { margin-top: 0; }
|
||
|
|
#content #toc > :last-child { margin-bottom: 0; }
|
||
|
|
#content #toc a { text-decoration: none; }
|
||
|
|
#content #toctitle { font-weight: bold; font-family: "Helvetica Neue", "Helvetica", Helvetica, Arial, sans-serif; font-size: 1em; padding-left: 0.125em; }
|
||
|
|
#footer { max-width: 100%; background-color: #222222; padding: 1.25em; }
|
||
|
|
#footer-text { color: #dddddd; line-height: 1.44; }
|
||
|
|
.sect1 { padding-bottom: 1.25em; }
|
||
|
|
.sect1 + .sect1 { border-top: 3px double #ebebeb; }
|
||
|
|
#content h1 > a.anchor, h2 > a.anchor, h3 > a.anchor, #toctitle > a.anchor, .sidebarblock > .content > .title > a.anchor, h4 > a.anchor, h5 > a.anchor, h6 > a.anchor { position: absolute; width: 1em; margin-left: -1em; display: block; text-decoration: none; visibility: hidden; text-align: center; font-weight: normal; }
|
||
|
|
#content h1 > a.anchor:before, h2 > a.anchor:before, h3 > a.anchor:before, #toctitle > a.anchor:before, .sidebarblock > .content > .title > a.anchor:before, h4 > a.anchor:before, h5 > a.anchor:before, h6 > a.anchor:before { content: '\00A7'; font-size: .85em; vertical-align: text-top; display: block; margin-top: 0.05em; }
|
||
|
|
#content h1:hover > a.anchor, #content h1 > a.anchor:hover, h2:hover > a.anchor, h2 > a.anchor:hover, h3:hover > a.anchor, #toctitle:hover > a.anchor, .sidebarblock > .content > .title:hover > a.anchor, h3 > a.anchor:hover, #toctitle > a.anchor:hover, .sidebarblock > .content > .title > a.anchor:hover, h4:hover > a.anchor, h4 > a.anchor:hover, h5:hover > a.anchor, h5 > a.anchor:hover, h6:hover > a.anchor, h6 > a.anchor:hover { visibility: visible; }
|
||
|
|
#content h1 > a.link, h2 > a.link, h3 > a.link, #toctitle > a.link, .sidebarblock > .content > .title > a.link, h4 > a.link, h5 > a.link, h6 > a.link { color: #ba3925; text-decoration: none; }
|
||
|
|
#content h1 > a.link:hover, h2 > a.link:hover, h3 > a.link:hover, #toctitle > a.link:hover, .sidebarblock > .content > .title > a.link:hover, h4 > a.link:hover, h5 > a.link:hover, h6 > a.link:hover { color: #a53221; }
|
||
|
|
.imageblock, .literalblock, .listingblock, .verseblock, .videoblock { margin-bottom: 1.25em; }
|
||
|
|
.admonitionblock td.content > .title, .exampleblock > .title, .imageblock > .title, .videoblock > .title, .listingblock > .title, .literalblock > .title, .openblock > .title, .paragraph > .title, .quoteblock > .title, .sidebarblock > .title, .tableblock > .title, .verseblock > .title, .dlist > .title, .olist > .title, .ulist > .title, .qlist > .title, .hdlist > .title { text-align: left; font-weight: bold; }
|
||
|
|
.tableblock > caption { text-align: left; font-weight: bold; white-space: nowrap; overflow: visible; max-width: 0; }
|
||
|
|
table.tableblock #preamble > .sectionbody > .paragraph:first-of-type p { font-size: inherit; }
|
||
|
|
.admonitionblock > table { border: 0; background: none; width: 100%; }
|
||
|
|
.admonitionblock > table td.icon { text-align: center; width: 80px; }
|
||
|
|
.admonitionblock > table td.icon img { max-width: none; }
|
||
|
|
.admonitionblock > table td.icon .title { font-weight: bold; text-transform: uppercase; }
|
||
|
|
.admonitionblock > table td.content { padding-left: 1.125em; padding-right: 1.25em; border-left: 1px solid #dddddd; color: #6f6f6f; }
|
||
|
|
.admonitionblock > table td.content > :last-child > :last-child { margin-bottom: 0; }
|
||
|
|
.exampleblock > .content { border-style: solid; border-width: 1px; border-color: #e6e6e6; margin-bottom: 1.25em; padding: 1.25em; background: white; -webkit-border-radius: 4px; border-radius: 4px; }
|
||
|
|
.exampleblock > .content > :first-child { margin-top: 0; }
|
||
|
|
.exampleblock > .content > :last-child { margin-bottom: 0; }
|
||
|
|
.exampleblock > .content h1, .exampleblock > .content h2, .exampleblock > .content h3, .exampleblock > .content #toctitle, .sidebarblock.exampleblock > .content > .title, .exampleblock > .content h4, .exampleblock > .content h5, .exampleblock > .content h6, .exampleblock > .content p { color: #333333; }
|
||
|
|
.exampleblock > .content h1, .exampleblock > .content h2, .exampleblock > .content h3, .exampleblock > .content #toctitle, .sidebarblock.exampleblock > .content > .title, .exampleblock > .content h4, .exampleblock > .content h5, .exampleblock > .content h6 { line-height: 1; margin-bottom: 0.625em; }
|
||
|
|
.exampleblock > .content h1.subheader, .exampleblock > .content h2.subheader, .exampleblock > .content h3.subheader, .exampleblock > .content .subheader#toctitle, .sidebarblock.exampleblock > .content > .subheader.title, .exampleblock > .content h4.subheader, .exampleblock > .content h5.subheader, .exampleblock > .content h6.subheader { line-height: 1.4; }
|
||
|
|
.exampleblock.result > .content { -webkit-box-shadow: 0 1px 8px #d9d9d9; box-shadow: 0 1px 8px #d9d9d9; }
|
||
|
|
.sidebarblock { border-style: solid; border-width: 1px; border-color: #d9d9d9; margin-bottom: 1.25em; padding: 1.25em; background: #f2f2f2; -webkit-border-radius: 4px; border-radius: 4px; }
|
||
|
|
.sidebarblock > :first-child { margin-top: 0; }
|
||
|
|
.sidebarblock > :last-child { margin-bottom: 0; }
|
||
|
|
.sidebarblock h1, .sidebarblock h2, .sidebarblock h3, .sidebarblock #toctitle, .sidebarblock > .content > .title, .sidebarblock h4, .sidebarblock h5, .sidebarblock h6, .sidebarblock p { color: #333333; }
|
||
|
|
.sidebarblock h1, .sidebarblock h2, .sidebarblock h3, .sidebarblock #toctitle, .sidebarblock > .content > .title, .sidebarblock h4, .sidebarblock h5, .sidebarblock h6 { line-height: 1; margin-bottom: 0.625em; }
|
||
|
|
.sidebarblock h1.subheader, .sidebarblock h2.subheader, .sidebarblock h3.subheader, .sidebarblock .subheader#toctitle, .sidebarblock > .content > .subheader.title, .sidebarblock h4.subheader, .sidebarblock h5.subheader, .sidebarblock h6.subheader { line-height: 1.4; }
|
||
|
|
.sidebarblock > .content > .title { color: #7a2518; margin-top: 0; line-height: 1.6; }
|
||
|
|
.exampleblock > .content > :last-child > :last-child, .exampleblock > .content .olist > ol > li:last-child > :last-child, .exampleblock > .content .ulist > ul > li:last-child > :last-child, .exampleblock > .content .qlist > ol > li:last-child > :last-child, .sidebarblock > .content > :last-child > :last-child, .sidebarblock > .content .olist > ol > li:last-child > :last-child, .sidebarblock > .content .ulist > ul > li:last-child > :last-child, .sidebarblock > .content .qlist > ol > li:last-child > :last-child { margin-bottom: 0; }
|
||
|
|
.literalblock > .content pre, .listingblock > .content pre { background: none; border-width: 1px 0; border-style: dotted; border-color: #bfbfbf; -webkit-border-radius: 4px; border-radius: 4px; padding: 0.75em 0.75em 0.5em 0.75em; word-wrap: break-word; }
|
||
|
|
.literalblock > .content pre.nowrap, .listingblock > .content pre.nowrap { overflow-x: auto; white-space: pre; word-wrap: normal; }
|
||
|
|
.literalblock > .content pre > code, .listingblock > .content pre > code { display: block; }
|
||
|
|
@media only screen { .literalblock > .content pre, .listingblock > .content pre { font-size: 0.8em; } }
|
||
|
|
@media only screen and (min-width: 768px) { .literalblock > .content pre, .listingblock > .content pre { font-size: 0.9em; } }
|
||
|
|
@media only screen and (min-width: 1280px) { .literalblock > .content pre, .listingblock > .content pre { font-size: 1em; } }
|
||
|
|
.listingblock > .content { position: relative; }
|
||
|
|
.listingblock:hover code[class*=" language-"]:before { text-transform: uppercase; font-size: 0.9em; color: #999; position: absolute; top: 0.375em; right: 0.375em; }
|
||
|
|
.listingblock:hover code.asciidoc:before { content: "asciidoc"; }
|
||
|
|
.listingblock:hover code.clojure:before { content: "clojure"; }
|
||
|
|
.listingblock:hover code.css:before { content: "css"; }
|
||
|
|
.listingblock:hover code.groovy:before { content: "groovy"; }
|
||
|
|
.listingblock:hover code.html:before { content: "html"; }
|
||
|
|
.listingblock:hover code.java:before { content: "java"; }
|
||
|
|
.listingblock:hover code.javascript:before { content: "javascript"; }
|
||
|
|
.listingblock:hover code.python:before { content: "python"; }
|
||
|
|
.listingblock:hover code.ruby:before { content: "ruby"; }
|
||
|
|
.listingblock:hover code.scss:before { content: "scss"; }
|
||
|
|
.listingblock:hover code.xml:before { content: "xml"; }
|
||
|
|
.listingblock:hover code.yaml:before { content: "yaml"; }
|
||
|
|
.listingblock.terminal pre .command:before { content: attr(data-prompt); padding-right: 0.5em; color: #999; }
|
||
|
|
.listingblock.terminal pre .command:not([data-prompt]):before { content: '$'; }
|
||
|
|
table.pyhltable { border: 0; margin-bottom: 0; }
|
||
|
|
table.pyhltable td { vertical-align: top; padding-top: 0; padding-bottom: 0; }
|
||
|
|
table.pyhltable td.code { padding-left: .75em; padding-right: 0; }
|
||
|
|
.highlight.pygments .lineno, table.pyhltable td:not(.code) { color: #999; padding-left: 0; padding-right: .5em; border-right: 1px solid #dddddd; }
|
||
|
|
.highlight.pygments .lineno { display: inline-block; margin-right: .25em; }
|
||
|
|
table.pyhltable .linenodiv { background-color: transparent !important; padding-right: 0 !important; }
|
||
|
|
.quoteblock { margin: 0 0 1.25em; padding: 0.5625em 1.25em 0 1.1875em; border-left: 1px solid #dddddd; }
|
||
|
|
.quoteblock blockquote { margin: 0 0 1.25em 0; padding: 0 0 0.5625em 0; border: 0; }
|
||
|
|
.quoteblock blockquote > .paragraph:last-child p { margin-bottom: 0; }
|
||
|
|
.quoteblock .attribution { margin-top: -.25em; padding-bottom: 0.5625em; font-size: inherit; color: #555555; }
|
||
|
|
.quoteblock .attribution br { display: none; }
|
||
|
|
.quoteblock .attribution cite { display: block; margin-bottom: 0.625em; }
|
||
|
|
table thead th, table tfoot th { font-weight: bold; }
|
||
|
|
table.tableblock.grid-all { border-collapse: separate; border-spacing: 1px; -webkit-border-radius: 4px; border-radius: 4px; border-top: 1px solid #dddddd; border-bottom: 1px solid #dddddd; }
|
||
|
|
table.tableblock.frame-topbot, table.tableblock.frame-none { border-left: 0; border-right: 0; }
|
||
|
|
table.tableblock.frame-sides, table.tableblock.frame-none { border-top: 0; border-bottom: 0; }
|
||
|
|
table.tableblock td .paragraph:last-child p, table.tableblock td > p:last-child { margin-bottom: 0; }
|
||
|
|
th.tableblock.halign-left, td.tableblock.halign-left { text-align: left; }
|
||
|
|
th.tableblock.halign-right, td.tableblock.halign-right { text-align: right; }
|
||
|
|
th.tableblock.halign-center, td.tableblock.halign-center { text-align: center; }
|
||
|
|
th.tableblock.valign-top, td.tableblock.valign-top { vertical-align: top; }
|
||
|
|
th.tableblock.valign-bottom, td.tableblock.valign-bottom { vertical-align: bottom; }
|
||
|
|
th.tableblock.valign-middle, td.tableblock.valign-middle { vertical-align: middle; }
|
||
|
|
p.tableblock.header { color: #222222; font-weight: bold; }
|
||
|
|
td > div.verse { white-space: pre; }
|
||
|
|
ol { margin-left: 1.75em; }
|
||
|
|
ul li ol { margin-left: 1.5em; }
|
||
|
|
dl dd { margin-left: 1.125em; }
|
||
|
|
dl dd:last-child, dl dd:last-child > :last-child { margin-bottom: 0; }
|
||
|
|
ol > li p, ul > li p, ul dd, ol dd, .olist .olist, .ulist .ulist, .ulist .olist, .olist .ulist { margin-bottom: 0.625em; }
|
||
|
|
ul.unstyled, ol.unnumbered, ul.checklist, ul.none { list-style-type: none; }
|
||
|
|
ul.unstyled, ol.unnumbered, ul.checklist { margin-left: 0.625em; }
|
||
|
|
ul.checklist li > p:first-child > i[class^="icon-check"]:first-child, ul.checklist li > p:first-child > input[type="checkbox"]:first-child { margin-right: 0.25em; }
|
||
|
|
ul.checklist li > p:first-child > input[type="checkbox"]:first-child { position: relative; top: 1px; }
|
||
|
|
ul.inline { margin: 0 auto 0.625em auto; margin-left: -1.375em; margin-right: 0; padding: 0; list-style: none; overflow: hidden; }
|
||
|
|
ul.inline > li { list-style: none; float: left; margin-left: 1.375em; display: block; }
|
||
|
|
ul.inline > li > * { display: block; }
|
||
|
|
.unstyled dl dt { font-weight: normal; font-style: normal; }
|
||
|
|
ol.arabic { list-style-type: decimal; }
|
||
|
|
ol.decimal { list-style-type: decimal-leading-zero; }
|
||
|
|
ol.loweralpha { list-style-type: lower-alpha; }
|
||
|
|
ol.upperalpha { list-style-type: upper-alpha; }
|
||
|
|
ol.lowerroman { list-style-type: lower-roman; }
|
||
|
|
ol.upperroman { list-style-type: upper-roman; }
|
||
|
|
ol.lowergreek { list-style-type: lower-greek; }
|
||
|
|
.hdlist > table, .colist > table { border: 0; background: none; }
|
||
|
|
.hdlist > table > tbody > tr, .colist > table > tbody > tr { background: none; }
|
||
|
|
td.hdlist1 { padding-right: .8em; font-weight: bold; }
|
||
|
|
td.hdlist1, td.hdlist2 { vertical-align: top; }
|
||
|
|
.literalblock + .colist, .listingblock + .colist { margin-top: -0.5em; }
|
||
|
|
.colist > table tr > td:first-of-type { padding: 0 .8em; line-height: 1; }
|
||
|
|
.colist > table tr > td:last-of-type { padding: 0.25em 0; }
|
||
|
|
.qanda > ol > li > p > em:only-child { color: #00467f; }
|
||
|
|
.thumb, .th { line-height: 0; display: inline-block; border: solid 4px white; -webkit-box-shadow: 0 0 0 1px #dddddd; box-shadow: 0 0 0 1px #dddddd; }
|
||
|
|
.imageblock.left, .imageblock[style*="float: left"] { margin: 0.25em 0.625em 1.25em 0; }
|
||
|
|
.imageblock.right, .imageblock[style*="float: right"] { margin: 0.25em 0 1.25em 0.625em; }
|
||
|
|
.imageblock > .title { margin-bottom: 0; }
|
||
|
|
.imageblock.thumb, .imageblock.th { border-width: 6px; }
|
||
|
|
.imageblock.thumb > .title, .imageblock.th > .title { padding: 0 0.125em; }
|
||
|
|
.image.left, .image.right { margin-top: 0.25em; margin-bottom: 0.25em; display: inline-block; line-height: 0; }
|
||
|
|
.image.left { margin-right: 0.625em; }
|
||
|
|
.image.right { margin-left: 0.625em; }
|
||
|
|
a.image { text-decoration: none; }
|
||
|
|
span.footnote, span.footnoteref { vertical-align: super; font-size: 0.875em; }
|
||
|
|
span.footnote a, span.footnoteref a { text-decoration: none; }
|
||
|
|
#footnotes { padding-top: 0.75em; padding-bottom: 0.75em; margin-bottom: 0.625em; }
|
||
|
|
#footnotes hr { width: 20%; min-width: 6.25em; margin: -.25em 0 .75em 0; border-width: 1px 0 0 0; }
|
||
|
|
#footnotes .footnote { padding: 0 0.375em; line-height: 1.3; font-size: 0.875em; margin-left: 1.2em; text-indent: -1.2em; margin-bottom: .2em; }
|
||
|
|
#footnotes .footnote a:first-of-type { font-weight: bold; text-decoration: none; }
|
||
|
|
#footnotes .footnote:last-of-type { margin-bottom: 0; }
|
||
|
|
#content #footnotes { margin-top: -0.625em; margin-bottom: 0; padding: 0.75em 0; }
|
||
|
|
.gist .file-data > table { border: none; background: #fff; width: 100%; margin-bottom: 0; }
|
||
|
|
.gist .file-data > table td.line-data { width: 99%; }
|
||
|
|
div.unbreakable { page-break-inside: avoid; }
|
||
|
|
.big { font-size: larger; }
|
||
|
|
.small { font-size: smaller; }
|
||
|
|
.underline { text-decoration: underline; }
|
||
|
|
.overline { text-decoration: overline; }
|
||
|
|
.line-through { text-decoration: line-through; }
|
||
|
|
.aqua { color: #00bfbf; }
|
||
|
|
.aqua-background { background-color: #00fafa; }
|
||
|
|
.black { color: black; }
|
||
|
|
.black-background { background-color: black; }
|
||
|
|
.blue { color: #0000bf; }
|
||
|
|
.blue-background { background-color: #0000fa; }
|
||
|
|
.fuchsia { color: #bf00bf; }
|
||
|
|
.fuchsia-background { background-color: #fa00fa; }
|
||
|
|
.gray { color: #606060; }
|
||
|
|
.gray-background { background-color: #7d7d7d; }
|
||
|
|
.green { color: #006000; }
|
||
|
|
.green-background { background-color: #007d00; }
|
||
|
|
.lime { color: #00bf00; }
|
||
|
|
.lime-background { background-color: #00fa00; }
|
||
|
|
.maroon { color: #600000; }
|
||
|
|
.maroon-background { background-color: #7d0000; }
|
||
|
|
.navy { color: #000060; }
|
||
|
|
.navy-background { background-color: #00007d; }
|
||
|
|
.olive { color: #606000; }
|
||
|
|
.olive-background { background-color: #7d7d00; }
|
||
|
|
.purple { color: #600060; }
|
||
|
|
.purple-background { background-color: #7d007d; }
|
||
|
|
.red { color: #bf0000; }
|
||
|
|
.red-background { background-color: #fa0000; }
|
||
|
|
.silver { color: #909090; }
|
||
|
|
.silver-background { background-color: #bcbcbc; }
|
||
|
|
.teal { color: #006060; }
|
||
|
|
.teal-background { background-color: #007d7d; }
|
||
|
|
.white { color: #bfbfbf; }
|
||
|
|
.white-background { background-color: #fafafa; }
|
||
|
|
.yellow { color: #bfbf00; }
|
||
|
|
.yellow-background { background-color: #fafa00; }
|
||
|
|
span.icon > [class^="icon-"], span.icon > [class*=" icon-"] { cursor: default; }
|
||
|
|
.admonitionblock td.icon [class^="icon-"]:before { font-size: 2.5em; text-shadow: 1px 1px 2px rgba(0, 0, 0, 0.5); cursor: default; }
|
||
|
|
.admonitionblock td.icon .icon-note:before { content: "\f05a"; color: #005498; color: #003f72; }
|
||
|
|
.admonitionblock td.icon .icon-tip:before { content: "\f0eb"; text-shadow: 1px 1px 2px rgba(155, 155, 0, 0.8); color: #111; }
|
||
|
|
.admonitionblock td.icon .icon-warning:before { content: "\f071"; color: #bf6900; }
|
||
|
|
.admonitionblock td.icon .icon-caution:before { content: "\f06d"; color: #bf3400; }
|
||
|
|
.admonitionblock td.icon .icon-important:before { content: "\f06a"; color: #bf0000; }
|
||
|
|
.conum { display: inline-block; color: white !important; background-color: #222222; -webkit-border-radius: 100px; border-radius: 100px; text-align: center; width: 20px; height: 20px; font-size: 12px; font-weight: bold; line-height: 20px; font-family: Arial, sans-serif; font-style: normal; position: relative; top: -2px; letter-spacing: -1px; }
|
||
|
|
.conum * { color: white !important; }
|
||
|
|
.conum + b { display: none; }
|
||
|
|
.conum:after { content: attr(data-value); }
|
||
|
|
.conum:not([data-value]):empty { display: none; }
|
||
|
|
.literalblock > .content > pre, .listingblock > .content > pre { -webkit-border-radius: 0; border-radius: 0; }
|
||
|
|
|
||
|
|
</style>
|
||
|
|
</head>
|
||
|
|
<body class="article">
|
||
|
|
<div id="header">
|
||
|
|
</div>
|
||
|
|
<div id="content">
|
||
|
|
<div class="sect1">
|
||
|
|
<h2 id="_top_level_api_objects">Top Level API Objects</h2>
|
||
|
|
<div class="sectionbody">
|
||
|
|
<div class="ulist">
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
<p><a href="#_v1_service">v1.Service</a></p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p><a href="#_v1_servicelist">v1.ServiceList</a></p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p><a href="#_v1_event">v1.Event</a></p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p><a href="#_v1_eventlist">v1.EventList</a></p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p><a href="#_v1_namespace">v1.Namespace</a></p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p><a href="#_v1_namespacelist">v1.NamespaceList</a></p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p><a href="#_v1_secret">v1.Secret</a></p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p><a href="#_v1_secretlist">v1.SecretList</a></p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p><a href="#_v1_deleteoptions">v1.DeleteOptions</a></p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p><a href="#_v1_configmap">v1.ConfigMap</a></p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p><a href="#_v1_configmaplist">v1.ConfigMapList</a></p>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="sect1">
|
||
|
|
<h2 id="_definitions">Definitions</h2>
|
||
|
|
<div class="sectionbody">
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_apiresourcelist">v1.APIResourceList</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.</p>
|
||
|
|
</div>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">kind</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">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: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">apiVersion</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">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: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">groupVersion</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">groupVersion is the group and version this APIResourceList is for.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">resources</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">resources contains the name of the resources and if they are namespaced.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_apiresource">v1.APIResource</a> array</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_namespacelist">v1.NamespaceList</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>NamespaceList is a list of Namespaces.</p>
|
||
|
|
</div>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">kind</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">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: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">apiVersion</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">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: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">metadata</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Standard list metadata. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_listmeta">v1.ListMeta</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">items</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Items is the list of Namespace objects in the list. More info: <a href="http://kubernetes.io/docs/user-guide/namespaces">http://kubernetes.io/docs/user-guide/namespaces</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_namespace">v1.Namespace</a> array</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_listmeta">v1.ListMeta</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.</p>
|
||
|
|
</div>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">selfLink</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">SelfLink is a URL representing this object. Populated by the system. Read-only.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">resourceVersion</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">String that identifies the server’s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_namespace">v1.Namespace</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>Namespace provides a scope for Names. Use of multiple namespaces is optional.</p>
|
||
|
|
</div>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">kind</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">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: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">apiVersion</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">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: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">metadata</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Standard object’s metadata. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_objectmeta">v1.ObjectMeta</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spec</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Spec defines the behavior of the Namespace. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_namespacespec">v1.NamespaceSpec</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">status</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Status describes the current status of a Namespace. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_namespacestatus">v1.NamespaceStatus</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_preconditions">v1.Preconditions</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.</p>
|
||
|
|
</div>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">uid</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Specifies the target UID.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_types_uid">types.UID</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_status">v1.Status</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>Status is a return value for calls that don’t return other objects.</p>
|
||
|
|
</div>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">kind</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">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: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">apiVersion</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">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: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">metadata</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Standard list metadata. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_listmeta">v1.ListMeta</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">status</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Status of the operation. One of: "Success" or "Failure". More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">message</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">A human-readable description of the status of this operation.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">reason</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">details</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_statusdetails">v1.StatusDetails</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">code</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Suggested HTTP return code for this status, 0 if not set.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">integer (int32)</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_servicestatus">v1.ServiceStatus</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>ServiceStatus represents the current status of a service.</p>
|
||
|
|
</div>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">loadBalancer</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">LoadBalancer contains the current status of the load-balancer, if one is present.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_loadbalancerstatus">v1.LoadBalancerStatus</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_watchevent">v1.WatchEvent</h3>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_secret">v1.Secret</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes.</p>
|
||
|
|
</div>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">kind</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">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: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">apiVersion</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">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: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">metadata</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Standard object’s metadata. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_objectmeta">v1.ObjectMeta</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">data</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Data contains the secret data. Each key must be a valid DNS_SUBDOMAIN or leading dot followed by valid DNS_SUBDOMAIN. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in <a href="https://tools.ietf.org/html/rfc4648#section-4">https://tools.ietf.org/html/rfc4648#section-4</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">stringData</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Used to facilitate programmatic handling of secret data.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_event">v1.Event</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>Event is a report of an event somewhere in the cluster.</p>
|
||
|
|
</div>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">kind</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">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: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">apiVersion</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">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: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">metadata</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Standard object’s metadata. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_objectmeta">v1.ObjectMeta</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">involvedObject</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The object that this event is about.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_objectreference">v1.ObjectReference</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">reason</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">This should be a short, machine understandable string that gives the reason for the transition into the object’s current status.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">message</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">A human-readable description of the status of this operation.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">source</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The component reporting this event. Should be a short machine understandable string.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_eventsource">v1.EventSource</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">firstTimestamp</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The time at which the event was first recorded. (Time of server receipt is in TypeMeta.)</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">lastTimestamp</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The time at which the most recent occurrence of this event was recorded.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">count</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The number of times this event has occurred.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">integer (int32)</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Type of this event (Normal, Warning), new types could be added in the future</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_loadbalanceringress">v1.LoadBalancerIngress</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point.</p>
|
||
|
|
</div>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">ip</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">hostname</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_namespacestatus">v1.NamespaceStatus</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>NamespaceStatus is information about the current status of a Namespace.</p>
|
||
|
|
</div>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">phase</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Phase is the current lifecycle phase of the namespace. More info: <a href="http://releases.k8s.io/HEAD/docs/design/namespaces.md#phases">http://releases.k8s.io/HEAD/docs/design/namespaces.md#phases</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_servicelist">v1.ServiceList</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>ServiceList holds a list of services.</p>
|
||
|
|
</div>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">kind</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">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: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">apiVersion</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">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: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">metadata</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Standard list metadata. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_listmeta">v1.ListMeta</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">items</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">List of services</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_service">v1.Service</a> array</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_namespacespec">v1.NamespaceSpec</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>NamespaceSpec describes the attributes on a Namespace.</p>
|
||
|
|
</div>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">finalizers</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: <a href="http://releases.k8s.io/HEAD/docs/design/namespaces.md#finalizers">http://releases.k8s.io/HEAD/docs/design/namespaces.md#finalizers</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_finalizername">v1.FinalizerName</a> array</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_service">v1.Service</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.</p>
|
||
|
|
</div>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">kind</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">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: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">apiVersion</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">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: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">metadata</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Standard object’s metadata. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_objectmeta">v1.ObjectMeta</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">spec</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Spec defines the behavior of a service. <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_servicespec">v1.ServiceSpec</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">status</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Most recently observed status of the service. Populated by the system. Read-only. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_servicestatus">v1.ServiceStatus</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_patch">v1.Patch</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_configmaplist">v1.ConfigMapList</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>ConfigMapList is a resource containing a list of ConfigMap objects.</p>
|
||
|
|
</div>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">kind</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">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: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">apiVersion</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">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: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">metadata</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_listmeta">v1.ListMeta</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">items</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Items is the list of ConfigMaps.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_configmap">v1.ConfigMap</a> array</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_deleteoptions">v1.DeleteOptions</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>DeleteOptions may be provided when deleting an API object</p>
|
||
|
|
</div>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">kind</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">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: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">apiVersion</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">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: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">gracePeriodSeconds</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">integer (int64)</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">preconditions</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_preconditions">v1.Preconditions</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">orphanDependents</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object’s finalizers list.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">boolean</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_statusdetails">v1.StatusDetails</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.</p>
|
||
|
|
</div>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">group</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The group attribute of the resource associated with the status StatusReason.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">kind</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">causes</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_statuscause">v1.StatusCause</a> array</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">retryAfterSeconds</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If specified, the time in seconds before the operation should be retried.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">integer (int32)</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_configmap">v1.ConfigMap</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>ConfigMap holds configuration data for pods to consume.</p>
|
||
|
|
</div>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">kind</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">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: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">apiVersion</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">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: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">metadata</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Standard object’s metadata. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_objectmeta">v1.ObjectMeta</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">data</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Data contains the configuration data. Each key must be a valid DNS_SUBDOMAIN with an optional leading dot.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_objectreference">v1.ObjectReference</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>ObjectReference contains enough information to let you inspect or modify the referred object.</p>
|
||
|
|
</div>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">kind</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Kind of the referent. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">namespace</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Namespace of the referent. More info: <a href="http://kubernetes.io/docs/user-guide/namespaces">http://kubernetes.io/docs/user-guide/namespaces</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Name of the referent. More info: <a href="http://kubernetes.io/docs/user-guide/identifiers#names">http://kubernetes.io/docs/user-guide/identifiers#names</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">uid</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">UID of the referent. More info: <a href="http://kubernetes.io/docs/user-guide/identifiers#uids">http://kubernetes.io/docs/user-guide/identifiers#uids</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">apiVersion</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">API version of the referent.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">resourceVersion</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Specific resourceVersion to which this reference is made, if any. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">fieldPath</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_loadbalancerstatus">v1.LoadBalancerStatus</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>LoadBalancerStatus represents the status of a load-balancer.</p>
|
||
|
|
</div>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">ingress</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_loadbalanceringress">v1.LoadBalancerIngress</a> array</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_secretlist">v1.SecretList</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>SecretList is a list of Secret.</p>
|
||
|
|
</div>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">kind</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">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: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">apiVersion</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">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: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">metadata</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Standard list metadata. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_listmeta">v1.ListMeta</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">items</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Items is a list of secret objects. More info: <a href="http://kubernetes.io/docs/user-guide/secrets">http://kubernetes.io/docs/user-guide/secrets</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_secret">v1.Secret</a> array</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_finalizername">v1.FinalizerName</h3>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_serviceport">v1.ServicePort</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>ServicePort contains information on service’s port.</p>
|
||
|
|
</div>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. This maps to the <em>Name</em> field in EndpointPort objects. Optional if only one ServicePort is defined on this service.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">protocol</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The IP protocol for this port. Supports "TCP" and "UDP". Default is TCP.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">port</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The port that will be exposed by this service.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">integer (int32)</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">targetPort</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod’s container ports. If this is not specified, the value of the <em>port</em> field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the <em>port</em> field. More info: <a href="http://kubernetes.io/docs/user-guide/services#defining-a-service">http://kubernetes.io/docs/user-guide/services#defining-a-service</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">nodePort</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The port on each node on which this service is exposed when type=NodePort or LoadBalancer. Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one. More info: <a href="http://kubernetes.io/docs/user-guide/services#type—nodeport">http://kubernetes.io/docs/user-guide/services#type—nodeport</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">integer (int32)</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_ownerreference">v1.OwnerReference</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.</p>
|
||
|
|
</div>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">apiVersion</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">API version of the referent.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">kind</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Kind of the referent. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Name of the referent. More info: <a href="http://kubernetes.io/docs/user-guide/identifiers#names">http://kubernetes.io/docs/user-guide/identifiers#names</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">uid</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">UID of the referent. More info: <a href="http://kubernetes.io/docs/user-guide/identifiers#uids">http://kubernetes.io/docs/user-guide/identifiers#uids</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">controller</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If true, this reference points to the managing controller.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">boolean</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_objectmeta">v1.ObjectMeta</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.</p>
|
||
|
|
</div>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: <a href="http://kubernetes.io/docs/user-guide/identifiers#names">http://kubernetes.io/docs/user-guide/identifiers#names</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">generateName</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.<br>
|
||
|
|
<br>
|
||
|
|
If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).<br>
|
||
|
|
<br>
|
||
|
|
Applied only if Name is not specified. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#idempotency">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#idempotency</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">namespace</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.<br>
|
||
|
|
<br>
|
||
|
|
Must be a DNS_LABEL. Cannot be updated. More info: <a href="http://kubernetes.io/docs/user-guide/namespaces">http://kubernetes.io/docs/user-guide/namespaces</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">selfLink</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">SelfLink is a URL representing this object. Populated by the system. Read-only.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">uid</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.<br>
|
||
|
|
<br>
|
||
|
|
Populated by the system. Read-only. More info: <a href="http://kubernetes.io/docs/user-guide/identifiers#uids">http://kubernetes.io/docs/user-guide/identifiers#uids</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">resourceVersion</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.<br>
|
||
|
|
<br>
|
||
|
|
Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#concurrency-control-and-consistency</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">generation</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">integer (int64)</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">creationTimestamp</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.<br>
|
||
|
|
<br>
|
||
|
|
Populated by the system. Read-only. Null for lists. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">deletionTimestamp</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field. Once set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.<br>
|
||
|
|
<br>
|
||
|
|
Populated by the system when a graceful deletion is requested. Read-only. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">deletionGracePeriodSeconds</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">integer (int64)</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">labels</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: <a href="http://kubernetes.io/docs/user-guide/labels">http://kubernetes.io/docs/user-guide/labels</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">annotations</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: <a href="http://kubernetes.io/docs/user-guide/annotations">http://kubernetes.io/docs/user-guide/annotations</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">ownerReferences</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_ownerreference">v1.OwnerReference</a> array</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">finalizers</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string array</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">clusterName</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_eventlist">v1.EventList</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>EventList is a list of events.</p>
|
||
|
|
</div>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">kind</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">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: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">apiVersion</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">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: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#resources</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">metadata</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Standard list metadata. More info: <a href="http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds">http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_listmeta">v1.ListMeta</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">items</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">List of events</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_event">v1.Event</a> array</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_apiresource">v1.APIResource</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>APIResource specifies the name of a resource and whether it is namespaced.</p>
|
||
|
|
</div>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">name</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">name is the name of the resource.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">namespaced</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">namespaced indicates if a resource is namespaced or not.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">boolean</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">kind</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">kind is the kind for the resource (e.g. <em>Foo</em> is the kind for a resource <em>foo</em>)</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">verbs</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">true</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string array</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_servicespec">v1.ServiceSpec</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>ServiceSpec describes the attributes that a user creates on a service.</p>
|
||
|
|
</div>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">ports</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The list of ports that are exposed by this service. More info: <a href="http://kubernetes.io/docs/user-guide/services#virtual-ips-and-service-proxies">http://kubernetes.io/docs/user-guide/services#virtual-ips-and-service-proxies</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#_v1_serviceport">v1.ServicePort</a> array</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">selector</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: <a href="http://kubernetes.io/docs/user-guide/services#overview">http://kubernetes.io/docs/user-guide/services#overview</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">object</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">clusterIP</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">clusterIP is the IP address of the service and is usually assigned randomly by the master. If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are "None", empty string (""), or a valid IP address. "None" can be specified for headless services when proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName. More info: <a href="http://kubernetes.io/docs/user-guide/services#virtual-ips-and-service-proxies">http://kubernetes.io/docs/user-guide/services#virtual-ips-and-service-proxies</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">type</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ExternalName" maps to the specified externalName. "ClusterIP" allocates a cluster-internal IP address for load-balancing to endpoints. Endpoints are determined by the selector or if that is not specified, by manual construction of an Endpoints object. If clusterIP is "None", no virtual IP is allocated and the endpoints are published as a set of endpoints rather than a stable IP. "NodePort" builds on ClusterIP and allocates a port on every node which routes to the clusterIP. "LoadBalancer" builds on NodePort and creates an external load-balancer (if supported in the current cloud) which routes to the clusterIP. More info: <a href="http://kubernetes.io/docs/user-guide/services#overview">http://kubernetes.io/docs/user-guide/services#overview</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">externalIPs</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system. A previous form of this functionality exists as the deprecatedPublicIPs field. When using this field, callers should also clear the deprecatedPublicIPs field.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string array</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">deprecatedPublicIPs</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">deprecatedPublicIPs is deprecated and replaced by the externalIPs field with almost the exact same semantics. This field is retained in the v1 API for compatibility until at least 8/20/2016. It will be removed from any new API revisions. If both deprecatedPublicIPs <strong>and</strong> externalIPs are set, deprecatedPublicIPs is used.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string array</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">sessionAffinity</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info: <a href="http://kubernetes.io/docs/user-guide/services#virtual-ips-and-service-proxies">http://kubernetes.io/docs/user-guide/services#virtual-ips-and-service-proxies</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">loadBalancerIP</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Only applies to Service Type: LoadBalancer LoadBalancer will get created with the IP specified in this field. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be ignored if the cloud-provider does not support the feature.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">loadBalancerSourceRanges</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature." More info: <a href="http://kubernetes.io/docs/user-guide/services-firewalls">http://kubernetes.io/docs/user-guide/services-firewalls</a></p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string array</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">externalName</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">externalName is the external reference that kubedns or equivalent will return as a CNAME record for this service. No proxying will be involved. Must be a valid DNS name and requires Type to be ExternalName.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_eventsource">v1.EventSource</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>EventSource contains information for an event.</p>
|
||
|
|
</div>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">component</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Component from which the event is generated.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">host</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">Node name on which the event is generated.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_types_uid">types.UID</h3>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_v1_statuscause">v1.StatusCause</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.</p>
|
||
|
|
</div>
|
||
|
|
<table class="tableblock frame-all grid-all" style="width:100%; ">
|
||
|
|
<colgroup>
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
<col style="width:20%;">
|
||
|
|
</colgroup>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th class="tableblock halign-left valign-top">Name</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Description</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Required</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Schema</th>
|
||
|
|
<th class="tableblock halign-left valign-top">Default</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">reason</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">A machine-readable description of the cause of the error. If this value is empty there is no information available.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">message</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">A human-readable description of the cause of the error. This field may be presented as-is to a reader.</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">field</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.<br>
|
||
|
|
<br>
|
||
|
|
Examples:<br>
|
||
|
|
"name" - the field "name" on the current resource<br>
|
||
|
|
"items[0].name" - the field "name" on the first array entry in "items"</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
|
||
|
|
<td class="tableblock halign-left valign-top"></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<div class="sect2">
|
||
|
|
<h3 id="_any">any</h3>
|
||
|
|
<div class="paragraph">
|
||
|
|
<p>Represents an untyped JSON map - see the description of the field for more info about the structure of this object.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div id="footer">
|
||
|
|
<div id="footer-text">
|
||
|
|
Last updated 2017-01-06 18:15:17 UTC
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|