Add new-style api and kubectl reference docs for 1.5 as "New Beta Docs" link under Reference
Phillip Wittrock
parent
3c77eff102
commit
39fe9ab8e8
|
|
@ -3,6 +3,16 @@ abstract: "Design docs, concept definitions, and references for APIs and CLIs."
|
|||
toc:
|
||||
- docs/reference.md
|
||||
|
||||
- title: Kubernetes API Reference (New Beta Docs)
|
||||
section:
|
||||
- title: Version 1.5
|
||||
path: /docs/api-reference/1_5/
|
||||
|
||||
- title: Kubectl Command Reference (New Beta Docs)
|
||||
section:
|
||||
- title: Version 1.5
|
||||
path: /docs/user-guide/kubectl/1_5
|
||||
|
||||
- title: Kubernetes API
|
||||
section:
|
||||
- docs/api.md
|
||||
|
|
@ -183,4 +193,3 @@ toc:
|
|||
path: https://github.com/kubernetes/kubernetes/blob/release-1.3/docs/design/security_context.md
|
||||
- title: Security in Kubernetes
|
||||
path: https://github.com/kubernetes/kubernetes/blob/release-1.3/docs/design/security.md
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,201 @@
|
|||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "{}"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright {yyyy} {name of copyright owner}
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
|
@ -0,0 +1,64 @@
|
|||
## Synopsis
|
||||
|
||||
Static compilation of html from markdown including processing for grouping code snippets into arbitrary tabs.
|
||||
|
||||
## Code Example
|
||||
|
||||
\> bdocs-tab:kubectl Deployment Config to run 3 nginx instances (max rollback set to 10 revisions).
|
||||
|
||||
bdocs-tab:tab will be stripped during rendering and utilized to with CSS to show or hide the prefered tab. kubectl indicates the desired tab, since blockquotes have no specific syntax highlighting.
|
||||
|
||||
\`\`\`bdocs-tab:kubectl_yaml
|
||||
apiVersion: extensions/v1beta1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: deployment-example
|
||||
spec:
|
||||
replicas: 3
|
||||
revisionHistoryLimit: 10
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
app: nginx
|
||||
spec:
|
||||
containers:
|
||||
- name: nginx
|
||||
image: nginx:1.10
|
||||
\`\`\`
|
||||
|
||||
bdocs-tab:tab_lang will be used to indicate which tab these code snippets belong to. The tab section of the string indicates the tab, while, the language is pushed beyond the underscore. During rendering, the language will be properly highlighted as if the bdoc token was omitted.
|
||||
|
||||
## Motivation
|
||||
|
||||
This is a project to extend markdown documents and render them in html with a table of contents and code snippet pane. Most projects of this variety lean heavily on front end parsing with JavaScript/jQuery. This project uses NodeJS, Marked, and highlight.js to output syntax highlighted code blocks.
|
||||
|
||||
With specific tokens on blockquotes and code blocks, the chunks can be placed according to their relevance. Ex: Multiple language code blocks that should be grouped under an arbitrary tab.
|
||||
|
||||
## Installation
|
||||
|
||||
Clone the repository, then add documents into documents directory. Modify the manifest.json to contain the document filenames in the order desired. The docs field is an array of objects with a filename key.
|
||||
|
||||
As a NodeJS program, a valid installation of node is required. Once node is installed, verify it can be run from command line.
|
||||
```
|
||||
node --version
|
||||
```
|
||||
Next, depedencies need to be installed via npm from the root of the project directory.
|
||||
```
|
||||
npm install
|
||||
```
|
||||
|
||||
Once dependencies are installed, run
|
||||
```
|
||||
node brodoc.js
|
||||
```
|
||||
|
||||
This will generate the index.html file, which can be opened in a browser or served.
|
||||
|
||||
The included node-static server can be run from the project root via
|
||||
```
|
||||
npm start
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
Apache License Version 2.0
|
||||
|
|
@ -0,0 +1,58 @@
|
|||
// https://jsfiddle.net/upqwhou2/
|
||||
|
||||
$(document).ready(function() {
|
||||
var navigationLinks = $('#sidebar-wrapper > ul li a');
|
||||
var navigationSections = $('#sidebar-wrapper > ul > ul');
|
||||
var sectionIdTonavigationLink = {};
|
||||
var sections = $('#page-content-wrapper').find('h1, h2').map(function(index, node) {
|
||||
if (node.id) {
|
||||
sectionIdTonavigationLink[node.id] = $('#sidebar-wrapper > ul li a[href="#' + node.id + '"]');
|
||||
return node;
|
||||
}
|
||||
});
|
||||
var sectionIdToNavContainerLink = {};
|
||||
var topLevelSections = $('#page-content-wrapper').find('h1').map(function(index, node) {
|
||||
if (node.id) {
|
||||
sectionIdToNavContainerLink[node.id] = $('#sidebar-wrapper > ul > ul[id="' + node.id + '-nav' +'"]');
|
||||
return node;
|
||||
}
|
||||
});
|
||||
|
||||
var firstLevelNavs = $('#sidebar-wrapper > li');
|
||||
var secondLevelNavs = $('#sidebar-wrapper > ul > ul');
|
||||
var secondLevelNavContents = $('#sidebar-wrapper > ul > ul > li');
|
||||
var thirdLevelNavs = null; // TODO: When compile provides 3 level nav, implement
|
||||
|
||||
var sectionsReversed = $(sections.get().reverse());
|
||||
|
||||
function checkScroll(event) {
|
||||
var scrollPosition = $(window).scrollTop();
|
||||
var offset = 50;
|
||||
scrollPosition += offset;
|
||||
sections.each(function() {
|
||||
var currentSection = $(this);
|
||||
var sectionTop = $(this).offset().top;
|
||||
var id = $(this).attr('id');
|
||||
if (scrollPosition >= sectionTop) {
|
||||
navigationLinks.removeClass('selected');
|
||||
sectionIdTonavigationLink[id].addClass('selected');
|
||||
var sectionNavContainer = sectionIdToNavContainerLink[id];
|
||||
var sectionNavContainerDisplay;
|
||||
if (sectionNavContainer) {
|
||||
sectionNavContainerDisplay = sectionNavContainer.css('display');
|
||||
}
|
||||
if (sectionNavContainer && sectionNavContainerDisplay === 'none') {
|
||||
navigationSections.toggle(false);
|
||||
sectionNavContainer.toggle(true);
|
||||
}
|
||||
}
|
||||
if (($(this).offset().top < window.pageYOffset + 50) && $(this).offset().top + $(this).height() > window.pageYOffset) {
|
||||
window.location.hash = id;
|
||||
}
|
||||
});
|
||||
}
|
||||
checkScroll();
|
||||
$(window).on('scroll', function(event) {
|
||||
checkScroll(event);
|
||||
});
|
||||
});
|
||||
|
|
@ -0,0 +1,210 @@
|
|||
const docFolder = './documents/';
|
||||
const fs = require('fs');
|
||||
const marked = require('marked');
|
||||
const highlight = require('highlight.js');
|
||||
const renderer = new marked.Renderer();
|
||||
const brodocDec = require('./markedDecorations.js');
|
||||
|
||||
|
||||
marked.setOptions({
|
||||
renderer: renderer,
|
||||
gfm: true,
|
||||
tables: true,
|
||||
breaks: false,
|
||||
pedantic: false,
|
||||
sanitize: false,
|
||||
smartLists: true,
|
||||
smartypants: false,
|
||||
highlight: function (code, lang) {
|
||||
return highlight.highlightAuto(code).value;
|
||||
}
|
||||
});
|
||||
brodocDec.decorateMarked(renderer);
|
||||
|
||||
var config = require('./manifest');
|
||||
var docs = config.docs;
|
||||
|
||||
var files = [];
|
||||
var fileArray = [];
|
||||
docs.forEach(file => {
|
||||
files.push(file.filename);
|
||||
fileArray.push(file);
|
||||
});
|
||||
|
||||
var bodyContent = '';
|
||||
var navIds = brodocDec.navIds;
|
||||
var codeTabs = brodocDec.codeTabs;
|
||||
|
||||
|
||||
// const lexer = new marked.Lexer();
|
||||
// lexer.rules.bdoc = /^(\/{4} )(\w+).*$/;
|
||||
|
||||
var path = docFolder;
|
||||
var fIndex = 0;
|
||||
var rIndex = 0;
|
||||
var fileObj = {toc: [], content: [], tabs: []};
|
||||
fileArray.forEach((file, index) => {
|
||||
fs.readFile(path + file.filename, 'utf8', (err, data) => {
|
||||
rIndex++;
|
||||
file.content = data;
|
||||
|
||||
if (rIndex >= files.length) {
|
||||
// do the things
|
||||
parseFileContent(fileArray);
|
||||
var navData = generateNavItems(navIds);
|
||||
var navContent = navData.content;
|
||||
var navDataArray = navData.navDataArray;
|
||||
var codeTabContent = generateCodeTabItems(codeTabs);
|
||||
var bodyContent = flattenContent(parsedContentArray);
|
||||
generateDoc(navContent, bodyContent, codeTabContent);
|
||||
generateNavJson(navDataArray);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
function flattenContent(content) {
|
||||
var flattenedContent = content.reduce(function(accum, val) {
|
||||
return accum + val;
|
||||
});
|
||||
return flattenedContent;
|
||||
}
|
||||
|
||||
var parsedContentArray = [];
|
||||
function parseFileContent(files) {
|
||||
files.forEach((file, index) => {
|
||||
parsedContentArray[index] = parseDoc(file.content);
|
||||
});
|
||||
}
|
||||
function parseDoc(doc) {
|
||||
return marked(doc, { renderer: renderer });
|
||||
}
|
||||
|
||||
function generateNavItems(navObjs) {
|
||||
var reversedNavs = navObjs.reverse();
|
||||
var currentNestArray = [];
|
||||
var currentStrongArray = [];
|
||||
var flattenedNest = '';
|
||||
var nestedNavArray = []; // Array containing generated html menu items - is flattened into a string.
|
||||
var navArrayInvert = []; // Deals with data layer of navigation;
|
||||
var navSectionArray = [];
|
||||
var navStrongSectionArray = [];
|
||||
var navSectionArrayClone;
|
||||
var flatNavArrayInvert = [];
|
||||
reversedNavs.forEach(obj => {
|
||||
flatNavArrayInvert.push(obj.id);
|
||||
var strong = (obj.id.indexOf('-strong-') !== -1);
|
||||
if (obj.level !== 1) {
|
||||
if (strong && currentNestArray.length !== 0) {
|
||||
flattenedNest = flattenContent(currentNestArray.reverse());
|
||||
currentStrongArray.push(generateNestedNav(obj, flattenedNest));
|
||||
currentNestArray.length = 0;
|
||||
|
||||
navSectionArrayClone = Object.assign([], navSectionArray);
|
||||
navStrongSectionArray.push({section: obj.id, subsections: navSectionArrayClone});
|
||||
navSectionArray.length = 0;
|
||||
} else {
|
||||
currentNestArray.push(generateNav(obj));
|
||||
navSectionArray.push({section: obj.id});
|
||||
}
|
||||
} else if (obj.level === 1) {
|
||||
if (currentStrongArray.length !== 0) {
|
||||
currentNestArray.forEach(obj => {
|
||||
currentStrongArray.push(obj);
|
||||
});
|
||||
flattenedNest = flattenContent(currentStrongArray.reverse());
|
||||
} else if (currentNestArray.length !== 0) {
|
||||
flattenedNest = flattenContent(currentNestArray.reverse());
|
||||
}
|
||||
nestedNavArray.push(generateNestedNav(obj, flattenedNest));
|
||||
currentNestArray.length = 0;
|
||||
currentStrongArray.length = 0;
|
||||
flattenedNest = '';
|
||||
|
||||
navSectionArray.forEach(obj => {
|
||||
navStrongSectionArray.push(obj);
|
||||
});
|
||||
navSectionArrayClone = Object.assign([], navStrongSectionArray);
|
||||
navStrongSectionArray.length = 0;
|
||||
navArrayInvert.push({section: obj.id, subsections: navSectionArrayClone});
|
||||
navSectionArray.length = 0;
|
||||
}
|
||||
});
|
||||
|
||||
var navContent = flattenContent(nestedNavArray.reverse());
|
||||
return {content: navContent, navDataArray: {toc: navArrayInvert, flatToc: flatNavArrayInvert}};
|
||||
}
|
||||
|
||||
function generateNav(obj) {
|
||||
var classString = 'nav-level-' + obj.level;
|
||||
var isStrong = obj.id.indexOf('-strong-') !== -1;
|
||||
if (isStrong) {
|
||||
classString += ' strong-nav';
|
||||
}
|
||||
return '<li class="' + classString + '">' + '<a href="#' + obj.id + '" class="nav-item">' + obj.text + '</a></li>';
|
||||
}
|
||||
|
||||
function generateNestedNav(parent, nest) {
|
||||
var nestContent = '';
|
||||
if (nest.length > 0) {
|
||||
nestContent = nest ? '<ul id="' + parent.id + '-nav" style="display: none;">' + nest + '</ul>' : '';
|
||||
}
|
||||
return '<ul>' + generateNav(parent) + nestContent + '</ul>';
|
||||
}
|
||||
|
||||
function generateNavJson(data) {
|
||||
var navJson = JSON.stringify(data);
|
||||
navScript = `(function(){navData = ${navJson}})();`;
|
||||
fs.writeFile('./navData.js', navScript, function(err) {
|
||||
if (err) {
|
||||
return console.log(err);
|
||||
}
|
||||
console.log("navData.js saved!");
|
||||
});
|
||||
}
|
||||
|
||||
function generateCodeTabItems(tabs) {
|
||||
var codeTabList = '';
|
||||
tabs.forEach(tab => {
|
||||
codeTabList += generateCodeTab(tab);
|
||||
});
|
||||
return codeTabList;
|
||||
}
|
||||
|
||||
function generateCodeTab(tab) {
|
||||
return '<li class="code-tab" id="' + tab + '">' + tab + '</li>';
|
||||
}
|
||||
|
||||
function generateDoc(navContent, bodyContent, codeTabContent) {
|
||||
var doc =
|
||||
`<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<title>${config.title}</title>
|
||||
<link rel="shortcut icon" href="favicon.ico" type="image/vnd.microsoft.icon">
|
||||
<!-- Latest compiled and minified CSS -->
|
||||
<link rel="stylesheet" href="node_modules/bootstrap/dist/css/bootstrap.min.css">
|
||||
<link rel="stylesheet" href="node_modules/font-awesome/css/font-awesome.min.css" type="text/css">
|
||||
<link rel="stylesheet" href="node_modules/highlight.js/styles/default.css" type="text/css">
|
||||
<link rel="stylesheet" href="stylesheet.css" type="text/css">
|
||||
</head>
|
||||
<body>
|
||||
<div id="sidebar-wrapper" class="side-nav side-bar-nav">${navContent}<br/><div class="copyright">${config.copyright}</div></div>
|
||||
<div id="wrapper">
|
||||
<div id="code-tabs-wrapper" class="code-tabs"><ul class="code-tab-list">${codeTabContent}</ul></div>
|
||||
<div id="page-content-wrapper" class="body-content container-fluid">${bodyContent}</div>
|
||||
</div>
|
||||
<script src="node_modules/jquery/dist/jquery.min.js"></script>
|
||||
<script src="navData.js"></script>
|
||||
<script src="scroll.js"></script>
|
||||
<!--<script src="actions.js"></script>-->
|
||||
<script src="tabvisibility.js"></script>
|
||||
</body>
|
||||
</html>`;
|
||||
fs.writeFile('./index.html', doc, function (err) {
|
||||
if (err) {
|
||||
return console.log(err);
|
||||
}
|
||||
console.log("index.html saved!");
|
||||
});
|
||||
}
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
# <strong>CLUSTER</strong>
|
||||
|
||||
These are responsible for defining configuration of the cluster itself, and are generally only used by cluster operators.
|
||||
|
||||
------------
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
# <strong>CONFIG & STORAGE</strong>
|
||||
|
||||
These are responsible for injecting data into your applications and persisting data externally to your container.
|
||||
|
||||
Common resource types:
|
||||
|
||||
- [ConfigMaps](#configmap-v1) for providing text key value pairs injected into the application through environment variables, command line arguments, or files
|
||||
- [Secrets](#secret-v1) for providing binary data injected into the application through files
|
||||
- [Volumes](#volume-v1) for providing a filesystem external to the Container. Maybe shared across Containers within the same Pod and have a lifetime persisting beyond a Container or Pod.
|
||||
|
||||
------------
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
# <strong>DEFINITIONS</strong>
|
||||
|
||||
These are Definitions for objects used by the above APIs
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
|
||||
|
||||
-----------
|
||||
# APIGroup unversioned
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | unversioned | APIGroup
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
APIGroup contains the name, the supported versions, and the preferred version of a group.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#apigrouplist-unversioned">APIGroupList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
name <br /> *string* | name is the name of the group.
|
||||
preferredVersion <br /> *[GroupVersionForDiscovery](#groupversionfordiscovery-unversioned)* | preferredVersion is the version preferred by the API server, which probably is the storage version.
|
||||
serverAddressByClientCIDRs <br /> *[ServerAddressByClientCIDR](#serveraddressbyclientcidr-unversioned) array* | a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
|
||||
versions <br /> *[GroupVersionForDiscovery](#groupversionfordiscovery-unversioned) array* | versions are the versions supported in this group.
|
||||
|
||||
|
||||
### APIGroupList unversioned
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
groups <br /> *[APIGroup](#apigroup-unversioned) array* | groups is a list of APIGroup.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
## APIGroup unversioned
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | unversioned | APIGroup
|
||||
|
||||
|
||||
|
||||
APIGroup contains the name, the supported versions, and the preferred version of a group.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#apigrouplist-unversioned">APIGroupList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
name <br /> *string* | name is the name of the group.
|
||||
preferredVersion <br /> *[GroupVersionForDiscovery](#groupversionfordiscovery-unversioned)* | preferredVersion is the version preferred by the API server, which probably is the storage version.
|
||||
serverAddressByClientCIDRs <br /> *[ServerAddressByClientCIDR](#serveraddressbyclientcidr-unversioned) array* | a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
|
||||
versions <br /> *[GroupVersionForDiscovery](#groupversionfordiscovery-unversioned) array* | versions are the versions supported in this group.
|
||||
|
||||
|
|
@ -0,0 +1,30 @@
|
|||
|
||||
|
||||
-----------
|
||||
# APIGroupList unversioned
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | unversioned | APIGroupList
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
APIGroupList is a list of APIGroup, to allow clients to discover the API at /apis.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
groups <br /> *[APIGroup](#apigroup-unversioned) array* | groups is a list of APIGroup.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
## APIGroupList unversioned
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | unversioned | APIGroupList
|
||||
|
||||
|
||||
|
||||
APIGroupList is a list of APIGroup, to allow clients to discover the API at /apis.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
groups <br /> *[APIGroup](#apigroup-unversioned) array* | groups is a list of APIGroup.
|
||||
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
|
||||
|
||||
-----------
|
||||
# APIResource unversioned
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | unversioned | APIResource
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
APIResource specifies the name of a resource and whether it is namespaced.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#apiresourcelist-unversioned">APIResourceList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
kind <br /> *string* | kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')
|
||||
name <br /> *string* | name is the name of the resource.
|
||||
namespaced <br /> *boolean* | namespaced indicates if a resource is namespaced or not.
|
||||
|
||||
|
||||
### APIResourceList unversioned
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
groupVersion <br /> *string* | groupVersion is the group and version this APIResourceList is for.
|
||||
resources <br /> *[APIResource](#apiresource-unversioned) array* | resources contains the name of the resources and if they are namespaced.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
## APIResource unversioned
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | unversioned | APIResource
|
||||
|
||||
|
||||
|
||||
APIResource specifies the name of a resource and whether it is namespaced.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#apiresourcelist-unversioned">APIResourceList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
kind <br /> *string* | kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')
|
||||
name <br /> *string* | name is the name of the resource.
|
||||
namespaced <br /> *boolean* | namespaced indicates if a resource is namespaced or not.
|
||||
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
|
||||
|
||||
-----------
|
||||
# APIResourceList unversioned
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | unversioned | APIResourceList
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
groupVersion <br /> *string* | groupVersion is the group and version this APIResourceList is for.
|
||||
resources <br /> *[APIResource](#apiresource-unversioned) array* | resources contains the name of the resources and if they are namespaced.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
## APIResourceList unversioned
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | unversioned | APIResourceList
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
groupVersion <br /> *string* | groupVersion is the group and version this APIResourceList is for.
|
||||
resources <br /> *[APIResource](#apiresource-unversioned) array* | resources contains the name of the resources and if they are namespaced.
|
||||
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
|
||||
|
||||
-----------
|
||||
# APIVersion v1beta1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1beta1 | APIVersion
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
An APIVersion represents a single concrete version of an object model.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#thirdpartyresource-v1beta1">ThirdPartyResource</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
name <br /> *string* | Name of this version (e.g. 'v1').
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
## APIVersion v1beta1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1beta1 | APIVersion
|
||||
|
||||
|
||||
|
||||
An APIVersion represents a single concrete version of an object model.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#thirdpartyresource-v1beta1">ThirdPartyResource</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
name <br /> *string* | Name of this version (e.g. 'v1').
|
||||
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
|
||||
|
||||
-----------
|
||||
# APIVersions unversioned
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | unversioned | APIVersions
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
APIVersions lists the versions that are available, to allow clients to discover the API at /api, which is the root path of the legacy v1 API.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
serverAddressByClientCIDRs <br /> *[ServerAddressByClientCIDR](#serveraddressbyclientcidr-unversioned) array* | a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
|
||||
versions <br /> *string array* | versions are the api versions that are available.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
## APIVersions unversioned
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | unversioned | APIVersions
|
||||
|
||||
|
||||
|
||||
APIVersions lists the versions that are available, to allow clients to discover the API at /api, which is the root path of the legacy v1 API.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
serverAddressByClientCIDRs <br /> *[ServerAddressByClientCIDR](#serveraddressbyclientcidr-unversioned) array* | a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
|
||||
versions <br /> *string array* | versions are the api versions that are available.
|
||||
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
|
||||
|
||||
-----------
|
||||
# AttachedVolume v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | AttachedVolume
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
AttachedVolume describes a volume attached to a node
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#nodestatus-v1">NodeStatus</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
devicePath <br /> *string* | DevicePath represents the device path where the volume should be available
|
||||
name <br /> *string* | Name of the attached volume
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
## AttachedVolume v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | AttachedVolume
|
||||
|
||||
|
||||
|
||||
AttachedVolume describes a volume attached to a node
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#nodestatus-v1">NodeStatus</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
devicePath <br /> *string* | DevicePath represents the device path where the volume should be available
|
||||
name <br /> *string* | Name of the attached volume
|
||||
|
||||
|
|
@ -0,0 +1,93 @@
|
|||
|
||||
|
||||
-----------
|
||||
# Binding v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | Binding
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Binding ties one object to another. For example, a pod is bound to a node by a scheduler.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
target <br /> *[ObjectReference](#objectreference-v1)* | The target object that you want to bind to the standard object.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## <strong>Write Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Create
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
create a Binding
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`POST /api/v1/namespaces/{namespace}/bindings`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Binding](#binding-v1)* |
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Binding](#binding-v1)* | OK
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
## Binding v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | Binding
|
||||
|
||||
|
||||
|
||||
Binding ties one object to another. For example, a pod is bound to a node by a scheduler.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
target <br /> *[ObjectReference](#objectreference-v1)* | The target object that you want to bind to the standard object.
|
||||
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
|
||||
|
||||
-----------
|
||||
# Capabilities v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | Capabilities
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Adds and removes POSIX capabilities from running containers.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#securitycontext-v1">SecurityContext</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
add <br /> *string array* | Added capabilities
|
||||
drop <br /> *string array* | Removed capabilities
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
## Capabilities v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | Capabilities
|
||||
|
||||
|
||||
|
||||
Adds and removes POSIX capabilities from running containers.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#securitycontext-v1">SecurityContext</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
add <br /> *string array* | Added capabilities
|
||||
drop <br /> *string array* | Removed capabilities
|
||||
|
||||
|
|
@ -0,0 +1,692 @@
|
|||
|
||||
|
||||
-----------
|
||||
# CertificateSigningRequest v1alpha1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Certificates | v1alpha1 | CertificateSigningRequest
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Describes a certificate signing request
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#certificatesigningrequestlist-v1alpha1">CertificateSigningRequestList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* |
|
||||
spec <br /> *[CertificateSigningRequestSpec](#certificatesigningrequestspec-v1alpha1)* | The certificate request itself and any additional information.
|
||||
status <br /> *[CertificateSigningRequestStatus](#certificatesigningrequeststatus-v1alpha1)* | Derived information about the request.
|
||||
|
||||
|
||||
### CertificateSigningRequestSpec v1alpha1
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#certificatesigningrequest-v1alpha1">CertificateSigningRequest</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
groups <br /> *string array* |
|
||||
request <br /> *string* | Base64-encoded PKCS#10 CSR data
|
||||
uid <br /> *string* |
|
||||
username <br /> *string* | Information about the requesting user (if relevant) See user.Info interface for details
|
||||
|
||||
### CertificateSigningRequestStatus v1alpha1
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#certificatesigningrequest-v1alpha1">CertificateSigningRequest</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
certificate <br /> *string* | If request was approved, the controller will place the issued certificate here.
|
||||
conditions <br /> *[CertificateSigningRequestCondition](#certificatesigningrequestcondition-v1alpha1) array* | Conditions applied to the request, such as approval or denial.
|
||||
|
||||
### CertificateSigningRequestList v1alpha1
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1) array* |
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* |
|
||||
|
||||
|
||||
|
||||
|
||||
## <strong>Write Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Create
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
create a CertificateSigningRequest
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`POST /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | OK
|
||||
|
||||
|
||||
## Replace
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
replace the specified CertificateSigningRequest
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PUT /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the CertificateSigningRequest
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | OK
|
||||
|
||||
|
||||
## Patch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
partially update the specified CertificateSigningRequest
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PATCH /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the CertificateSigningRequest
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | OK
|
||||
|
||||
|
||||
## Delete
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
delete a CertificateSigningRequest
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`DELETE /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the CertificateSigningRequest
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
gracePeriodSeconds | 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.
|
||||
orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Status](#status-unversioned)* | OK
|
||||
|
||||
|
||||
## Delete Collection
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
delete collection of CertificateSigningRequest
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`DELETE /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Status](#status-unversioned)* | OK
|
||||
|
||||
|
||||
|
||||
## <strong>Read Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Read
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
read the specified CertificateSigningRequest
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the CertificateSigningRequest
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'
|
||||
export | Should this value be exported. Export strips fields that a user can not specify.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | OK
|
||||
|
||||
|
||||
## List
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind CertificateSigningRequest
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[CertificateSigningRequestList](#certificatesigningrequestlist-v1alpha1)* | OK
|
||||
|
||||
|
||||
## Watch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch changes to an object of kind CertificateSigningRequest
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/certificates.k8s.io/v1alpha1/watch/certificatesigningrequests/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
name | name of the CertificateSigningRequest
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
## Watch List
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch individual changes to a list of CertificateSigningRequest
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/certificates.k8s.io/v1alpha1/watch/certificatesigningrequests`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
|
||||
## <strong>Status Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Replace Status
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
replace status of the specified CertificateSigningRequest
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PUT /apis/certificates.k8s.io/v1alpha1/certificatesigningrequests/{name}/status`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* |
|
||||
name | name of the CertificateSigningRequest
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1)* | OK
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
## CertificateSigningRequest v1alpha1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Certificates | v1alpha1 | CertificateSigningRequest
|
||||
|
||||
|
||||
|
||||
Describes a certificate signing request
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#certificatesigningrequestlist-v1alpha1">CertificateSigningRequestList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* |
|
||||
spec <br /> *[CertificateSigningRequestSpec](#certificatesigningrequestspec-v1alpha1)* | The certificate request itself and any additional information.
|
||||
status <br /> *[CertificateSigningRequestStatus](#certificatesigningrequeststatus-v1alpha1)* | Derived information about the request.
|
||||
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
|
||||
|
||||
-----------
|
||||
# CertificateSigningRequestCondition v1alpha1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1alpha1 | CertificateSigningRequestCondition
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#certificatesigningrequeststatus-v1alpha1">CertificateSigningRequestStatus</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
lastUpdateTime <br /> *[Time](#time-unversioned)* | timestamp for the last update to this condition
|
||||
message <br /> *string* | human readable message with details about the request state
|
||||
reason <br /> *string* | brief reason for the request state
|
||||
type <br /> *string* | request approval state, currently Approved or Denied.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
## CertificateSigningRequestCondition v1alpha1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1alpha1 | CertificateSigningRequestCondition
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#certificatesigningrequeststatus-v1alpha1">CertificateSigningRequestStatus</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
lastUpdateTime <br /> *[Time](#time-unversioned)* | timestamp for the last update to this condition
|
||||
message <br /> *string* | human readable message with details about the request state
|
||||
reason <br /> *string* | brief reason for the request state
|
||||
type <br /> *string* | request approval state, currently Approved or Denied.
|
||||
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
|
||||
|
||||
-----------
|
||||
# CertificateSigningRequestList v1alpha1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1alpha1 | CertificateSigningRequestList
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1) array* |
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
## CertificateSigningRequestList v1alpha1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1alpha1 | CertificateSigningRequestList
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[CertificateSigningRequest](#certificatesigningrequest-v1alpha1) array* |
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* |
|
||||
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
|
||||
|
||||
-----------
|
||||
# CertificateSigningRequestSpec v1alpha1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1alpha1 | CertificateSigningRequestSpec
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
This information is immutable after the request is created. Only the Request and ExtraInfo fields can be set on creation, other fields are derived by Kubernetes and cannot be modified by users.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#certificatesigningrequest-v1alpha1">CertificateSigningRequest</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
groups <br /> *string array* |
|
||||
request <br /> *string* | Base64-encoded PKCS#10 CSR data
|
||||
uid <br /> *string* |
|
||||
username <br /> *string* | Information about the requesting user (if relevant) See user.Info interface for details
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
## CertificateSigningRequestSpec v1alpha1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1alpha1 | CertificateSigningRequestSpec
|
||||
|
||||
|
||||
|
||||
This information is immutable after the request is created. Only the Request and ExtraInfo fields can be set on creation, other fields are derived by Kubernetes and cannot be modified by users.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#certificatesigningrequest-v1alpha1">CertificateSigningRequest</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
groups <br /> *string array* |
|
||||
request <br /> *string* | Base64-encoded PKCS#10 CSR data
|
||||
uid <br /> *string* |
|
||||
username <br /> *string* | Information about the requesting user (if relevant) See user.Info interface for details
|
||||
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
|
||||
|
||||
-----------
|
||||
# CertificateSigningRequestStatus v1alpha1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1alpha1 | CertificateSigningRequestStatus
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#certificatesigningrequest-v1alpha1">CertificateSigningRequest</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
certificate <br /> *string* | If request was approved, the controller will place the issued certificate here.
|
||||
conditions <br /> *[CertificateSigningRequestCondition](#certificatesigningrequestcondition-v1alpha1) array* | Conditions applied to the request, such as approval or denial.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
## CertificateSigningRequestStatus v1alpha1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1alpha1 | CertificateSigningRequestStatus
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#certificatesigningrequest-v1alpha1">CertificateSigningRequest</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
certificate <br /> *string* | If request was approved, the controller will place the issued certificate here.
|
||||
conditions <br /> *[CertificateSigningRequestCondition](#certificatesigningrequestcondition-v1alpha1) array* | Conditions applied to the request, such as approval or denial.
|
||||
|
||||
|
|
@ -0,0 +1,541 @@
|
|||
|
||||
|
||||
-----------
|
||||
# ClusterRole v1alpha1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
RbacAuthorization | v1alpha1 | ClusterRole
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#clusterrolelist-v1alpha1">ClusterRoleList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata.
|
||||
rules <br /> *[PolicyRule](#policyrule-v1alpha1) array* | Rules holds all the PolicyRules for this ClusterRole
|
||||
|
||||
|
||||
### ClusterRoleList v1alpha1
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[ClusterRole](#clusterrole-v1alpha1) array* | Items is a list of ClusterRoles
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard object's metadata.
|
||||
|
||||
|
||||
|
||||
|
||||
## <strong>Write Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Create
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
create a ClusterRole
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`POST /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[ClusterRole](#clusterrole-v1alpha1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ClusterRole](#clusterrole-v1alpha1)* | OK
|
||||
|
||||
|
||||
## Replace
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
replace the specified ClusterRole
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PUT /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ClusterRole
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[ClusterRole](#clusterrole-v1alpha1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ClusterRole](#clusterrole-v1alpha1)* | OK
|
||||
|
||||
|
||||
## Patch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
partially update the specified ClusterRole
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PATCH /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ClusterRole
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ClusterRole](#clusterrole-v1alpha1)* | OK
|
||||
|
||||
|
||||
## Delete
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
delete a ClusterRole
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ClusterRole
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
gracePeriodSeconds | 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.
|
||||
orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Status](#status-unversioned)* | OK
|
||||
|
||||
|
||||
## Delete Collection
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
delete collection of ClusterRole
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Status](#status-unversioned)* | OK
|
||||
|
||||
|
||||
|
||||
## <strong>Read Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Read
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
read the specified ClusterRole
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ClusterRole
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ClusterRole](#clusterrole-v1alpha1)* | OK
|
||||
|
||||
|
||||
## List
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind ClusterRole
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterroles`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ClusterRoleList](#clusterrolelist-v1alpha1)* | OK
|
||||
|
||||
|
||||
## Watch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch changes to an object of kind ClusterRole
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
name | name of the ClusterRole
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
## ClusterRole v1alpha1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
RbacAuthorization | v1alpha1 | ClusterRole
|
||||
|
||||
|
||||
|
||||
ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#clusterrolelist-v1alpha1">ClusterRoleList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata.
|
||||
rules <br /> *[PolicyRule](#policyrule-v1alpha1) array* | Rules holds all the PolicyRules for this ClusterRole
|
||||
|
||||
|
|
@ -0,0 +1,602 @@
|
|||
|
||||
|
||||
-----------
|
||||
# ClusterRoleBinding v1alpha1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
RbacAuthorization | v1alpha1 | ClusterRoleBinding
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#clusterrolebindinglist-v1alpha1">ClusterRoleBindingList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata.
|
||||
roleRef <br /> *[RoleRef](#roleref-v1alpha1)* | RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
|
||||
subjects <br /> *[Subject](#subject-v1alpha1) array* | Subjects holds references to the objects the role applies to.
|
||||
|
||||
|
||||
### ClusterRoleBindingList v1alpha1
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[ClusterRoleBinding](#clusterrolebinding-v1alpha1) array* | Items is a list of ClusterRoleBindings
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard object's metadata.
|
||||
|
||||
|
||||
|
||||
|
||||
## <strong>Write Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Create
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
create a ClusterRoleBinding
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`POST /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[ClusterRoleBinding](#clusterrolebinding-v1alpha1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ClusterRoleBinding](#clusterrolebinding-v1alpha1)* | OK
|
||||
|
||||
|
||||
## Replace
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
replace the specified ClusterRoleBinding
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PUT /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ClusterRoleBinding
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[ClusterRoleBinding](#clusterrolebinding-v1alpha1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ClusterRoleBinding](#clusterrolebinding-v1alpha1)* | OK
|
||||
|
||||
|
||||
## Patch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
partially update the specified ClusterRoleBinding
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PATCH /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ClusterRoleBinding
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ClusterRoleBinding](#clusterrolebinding-v1alpha1)* | OK
|
||||
|
||||
|
||||
## Delete
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
delete a ClusterRoleBinding
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ClusterRoleBinding
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
gracePeriodSeconds | 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.
|
||||
orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Status](#status-unversioned)* | OK
|
||||
|
||||
|
||||
## Delete Collection
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
delete collection of ClusterRoleBinding
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`DELETE /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Status](#status-unversioned)* | OK
|
||||
|
||||
|
||||
|
||||
## <strong>Read Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Read
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
read the specified ClusterRoleBinding
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ClusterRoleBinding
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ClusterRoleBinding](#clusterrolebinding-v1alpha1)* | OK
|
||||
|
||||
|
||||
## List
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind ClusterRoleBinding
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/rbac.authorization.k8s.io/v1alpha1/clusterrolebindings`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ClusterRoleBindingList](#clusterrolebindinglist-v1alpha1)* | OK
|
||||
|
||||
|
||||
## Watch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch changes to an object of kind ClusterRoleBinding
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
name | name of the ClusterRoleBinding
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
## Watch List
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch individual changes to a list of ClusterRoleBinding
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterrolebindings`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
## ClusterRoleBinding v1alpha1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
RbacAuthorization | v1alpha1 | ClusterRoleBinding
|
||||
|
||||
|
||||
|
||||
ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#clusterrolebindinglist-v1alpha1">ClusterRoleBindingList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata.
|
||||
roleRef <br /> *[RoleRef](#roleref-v1alpha1)* | RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
|
||||
subjects <br /> *[Subject](#subject-v1alpha1) array* | Subjects holds references to the objects the role applies to.
|
||||
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
|
||||
|
||||
-----------
|
||||
# ClusterRoleBindingList v1alpha1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1alpha1 | ClusterRoleBindingList
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ClusterRoleBindingList is a collection of ClusterRoleBindings
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[ClusterRoleBinding](#clusterrolebinding-v1alpha1) array* | Items is a list of ClusterRoleBindings
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard object's metadata.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
## ClusterRoleBindingList v1alpha1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1alpha1 | ClusterRoleBindingList
|
||||
|
||||
|
||||
|
||||
ClusterRoleBindingList is a collection of ClusterRoleBindings
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[ClusterRoleBinding](#clusterrolebinding-v1alpha1) array* | Items is a list of ClusterRoleBindings
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard object's metadata.
|
||||
|
||||
|
|
@ -0,0 +1,96 @@
|
|||
|
||||
|
||||
-----------
|
||||
# ClusterRoleList v1alpha1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
RbacAuthorization | v1alpha1 | ClusterRoleList
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ClusterRoleList is a collection of ClusterRoles
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[ClusterRole](#clusterrole-v1alpha1) array* | Items is a list of ClusterRoles
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard object's metadata.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## <strong>Read Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Watch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch individual changes to a list of ClusterRole
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/rbac.authorization.k8s.io/v1alpha1/watch/clusterroles`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
## ClusterRoleList v1alpha1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
RbacAuthorization | v1alpha1 | ClusterRoleList
|
||||
|
||||
|
||||
|
||||
ClusterRoleList is a collection of ClusterRoles
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[ClusterRole](#clusterrole-v1alpha1) array* | Items is a list of ClusterRoles
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard object's metadata.
|
||||
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
|
||||
|
||||
-----------
|
||||
# ComponentCondition v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ComponentCondition
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Information about the condition of a component.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#componentstatus-v1">ComponentStatus</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
error <br /> *string* | Condition error code for a component. For example, a health check error code.
|
||||
message <br /> *string* | Message about the condition for a component. For example, information about a health check.
|
||||
status <br /> *string* | Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown".
|
||||
type <br /> *string* | Type of condition for a component. Valid value: "Healthy"
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
## ComponentCondition v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ComponentCondition
|
||||
|
||||
|
||||
|
||||
Information about the condition of a component.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#componentstatus-v1">ComponentStatus</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
error <br /> *string* | Condition error code for a component. For example, a health check error code.
|
||||
message <br /> *string* | Message about the condition for a component. For example, information about a health check.
|
||||
status <br /> *string* | Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown".
|
||||
type <br /> *string* | Type of condition for a component. Valid value: "Healthy"
|
||||
|
||||
|
|
@ -0,0 +1,162 @@
|
|||
|
||||
|
||||
-----------
|
||||
# ComponentStatus v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ComponentStatus
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ComponentStatus (and ComponentStatusList) holds the cluster validation info.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#componentstatuslist-v1">ComponentStatusList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
conditions <br /> *[ComponentCondition](#componentcondition-v1) array* | List of component conditions observed
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
||||
### ComponentStatusList v1
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[ComponentStatus](#componentstatus-v1) array* | List of ComponentStatus objects.
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
|
||||
|
||||
|
||||
|
||||
## <strong>Read Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Read
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
read the specified ComponentStatus
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/v1/componentstatuses/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ComponentStatus
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ComponentStatus](#componentstatus-v1)* | OK
|
||||
|
||||
|
||||
## List
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
list objects of kind ComponentStatus
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/v1/componentstatuses`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ComponentStatusList](#componentstatuslist-v1)* | OK
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
## ComponentStatus v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ComponentStatus
|
||||
|
||||
|
||||
|
||||
ComponentStatus (and ComponentStatusList) holds the cluster validation info.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#componentstatuslist-v1">ComponentStatusList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
conditions <br /> *[ComponentCondition](#componentcondition-v1) array* | List of component conditions observed
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
|
||||
|
||||
-----------
|
||||
# ComponentStatusList v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ComponentStatusList
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Status of all the conditions for the component as a list of ComponentStatus objects.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[ComponentStatus](#componentstatus-v1) array* | List of ComponentStatus objects.
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
## ComponentStatusList v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ComponentStatusList
|
||||
|
||||
|
||||
|
||||
Status of all the conditions for the component as a list of ComponentStatus objects.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[ComponentStatus](#componentstatus-v1) array* | List of ComponentStatus objects.
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
|
||||
|
||||
|
|
@ -0,0 +1,736 @@
|
|||
|
||||
|
||||
-----------
|
||||
# ConfigMap v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ConfigMap
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ConfigMap holds configuration data for pods to consume.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#configmaplist-v1">ConfigMapList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
data <br /> *object* | Data contains the configuration data. Each key must be a valid DNS_SUBDOMAIN with an optional leading dot.
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
||||
### ConfigMapList v1
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[ConfigMap](#configmap-v1) array* | Items is the list of ConfigMaps.
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
||||
|
||||
|
||||
## <strong>Write Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Create
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
create a ConfigMap
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`POST /api/v1/namespaces/{namespace}/configmaps`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[ConfigMap](#configmap-v1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ConfigMap](#configmap-v1)* | OK
|
||||
|
||||
|
||||
## Replace
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
replace the specified ConfigMap
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PUT /api/v1/namespaces/{namespace}/configmaps/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ConfigMap
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[ConfigMap](#configmap-v1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ConfigMap](#configmap-v1)* | OK
|
||||
|
||||
|
||||
## Patch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
partially update the specified ConfigMap
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PATCH /api/v1/namespaces/{namespace}/configmaps/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ConfigMap
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ConfigMap](#configmap-v1)* | OK
|
||||
|
||||
|
||||
## Delete
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
delete a ConfigMap
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`DELETE /api/v1/namespaces/{namespace}/configmaps/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ConfigMap
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
gracePeriodSeconds | 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.
|
||||
orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Status](#status-unversioned)* | OK
|
||||
|
||||
|
||||
## Delete Collection
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
delete collection of ConfigMap
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`DELETE /api/v1/namespaces/{namespace}/configmaps`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Status](#status-unversioned)* | OK
|
||||
|
||||
|
||||
|
||||
## <strong>Read Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Read
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
read the specified ConfigMap
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/v1/namespaces/{namespace}/configmaps/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the ConfigMap
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'
|
||||
export | Should this value be exported. Export strips fields that a user can not specify.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ConfigMap](#configmap-v1)* | OK
|
||||
|
||||
|
||||
## List
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind ConfigMap
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/v1/namespaces/{namespace}/configmaps`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ConfigMapList](#configmaplist-v1)* | OK
|
||||
|
||||
|
||||
## List All Namespaces
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind ConfigMap
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/v1/configmaps`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[ConfigMapList](#configmaplist-v1)* | OK
|
||||
|
||||
|
||||
## Watch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch changes to an object of kind ConfigMap
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/v1/watch/namespaces/{namespace}/configmaps/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
name | name of the ConfigMap
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
## Watch List
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch individual changes to a list of ConfigMap
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/v1/watch/namespaces/{namespace}/configmaps`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
## Watch List All Namespaces
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch individual changes to a list of ConfigMap
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /api/v1/watch/configmaps`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
## ConfigMap v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ConfigMap
|
||||
|
||||
|
||||
|
||||
ConfigMap holds configuration data for pods to consume.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#configmaplist-v1">ConfigMapList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
data <br /> *object* | Data contains the configuration data. Each key must be a valid DNS_SUBDOMAIN with an optional leading dot.
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
|
||||
|
||||
-----------
|
||||
# ConfigMapKeySelector v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ConfigMapKeySelector
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Selects a key from a ConfigMap.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#envvarsource-v1">EnvVarSource</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
key <br /> *string* | The key to select.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
## ConfigMapKeySelector v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ConfigMapKeySelector
|
||||
|
||||
|
||||
|
||||
Selects a key from a ConfigMap.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#envvarsource-v1">EnvVarSource</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
key <br /> *string* | The key to select.
|
||||
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
|
||||
|
||||
-----------
|
||||
# ConfigMapList v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ConfigMapList
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ConfigMapList is a resource containing a list of ConfigMap objects.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[ConfigMap](#configmap-v1) array* | Items is the list of ConfigMaps.
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
## ConfigMapList v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ConfigMapList
|
||||
|
||||
|
||||
|
||||
ConfigMapList is a resource containing a list of ConfigMap objects.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[ConfigMap](#configmap-v1) array* | Items is the list of ConfigMaps.
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
|
@ -0,0 +1,84 @@
|
|||
|
||||
|
||||
-----------
|
||||
# Container v1
|
||||
|
||||
>bdocs-tab:kubectl Container Config to run nginx (must be embedded in a PodSpec to run).
|
||||
|
||||
```bdocs-tab:kubectl_yaml
|
||||
|
||||
name: nginx
|
||||
# Run the nginx:1.10 image
|
||||
image: nginx:1.10
|
||||
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Container Config to run nginx (must be embedded in a PodSpec to run).
|
||||
|
||||
```bdocs-tab:curl_yaml
|
||||
|
||||
name: nginx
|
||||
# Run the nginx:1.10 image
|
||||
image: nginx:1.10
|
||||
|
||||
|
||||
```
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | Container
|
||||
|
||||
<aside class="warning">Containers are only ever created within the context of a <a href="#pod-v1">Pod</a>. This is usually done using a Controller. See Controllers: <a href="#deployment-v1beta1">Deployment</a>, <a href="#job-v1">Job</a>, or <a href="#statefulset-v1beta1">StatefulSet</a></aside>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
A single application container that you want to run within a pod.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#podspec-v1">PodSpec</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
args <br /> *string array* | Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands
|
||||
command <br /> *string array* | Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands
|
||||
env <br /> *[EnvVar](#envvar-v1) array* | List of environment variables to set in the container. Cannot be updated.
|
||||
image <br /> *string* | Docker image name. More info: http://kubernetes.io/docs/user-guide/images
|
||||
imagePullPolicy <br /> *string* | Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/images#updating-images
|
||||
lifecycle <br /> *[Lifecycle](#lifecycle-v1)* | Actions that the management system should take in response to container lifecycle events. Cannot be updated.
|
||||
livenessProbe <br /> *[Probe](#probe-v1)* | Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes
|
||||
name <br /> *string* | Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
|
||||
ports <br /> *[ContainerPort](#containerport-v1) array* | List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.
|
||||
readinessProbe <br /> *[Probe](#probe-v1)* | Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes
|
||||
resources <br /> *[ResourceRequirements](#resourcerequirements-v1)* | Compute Resources required by this container. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#resources
|
||||
securityContext <br /> *[SecurityContext](#securitycontext-v1)* | Security options the pod should run with. More info: http://releases.k8s.io/HEAD/docs/design/security_context.md
|
||||
stdin <br /> *boolean* | Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
|
||||
stdinOnce <br /> *boolean* | Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
|
||||
terminationMessagePath <br /> *string* | Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Defaults to /dev/termination-log. Cannot be updated.
|
||||
tty <br /> *boolean* | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
|
||||
volumeMounts <br /> *[VolumeMount](#volumemount-v1) array* | Pod volumes to mount into the container's filesystem. Cannot be updated.
|
||||
workingDir <br /> *string* | Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.
|
||||
|
||||
|
||||
### ContainerStatus v1
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#podstatus-v1">PodStatus</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
containerID <br /> *string* | Container's ID in the format 'docker://<container_id>'. More info: http://kubernetes.io/docs/user-guide/container-environment#container-information
|
||||
image <br /> *string* | The image the container is running. More info: http://kubernetes.io/docs/user-guide/images
|
||||
imageID <br /> *string* | ImageID of the container's image.
|
||||
lastState <br /> *[ContainerState](#containerstate-v1)* | Details about the container's last termination condition.
|
||||
name <br /> *string* | This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.
|
||||
ready <br /> *boolean* | Specifies whether the container has passed its readiness probe.
|
||||
restartCount <br /> *integer* | The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC.
|
||||
state <br /> *[ContainerState](#containerstate-v1)* | Details about the container's current condition.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
## Container v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | Container
|
||||
|
||||
|
||||
|
||||
A single application container that you want to run within a pod.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#podspec-v1">PodSpec</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
args <br /> *string array* | Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands
|
||||
command <br /> *string array* | Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/containers#containers-and-commands
|
||||
env <br /> *[EnvVar](#envvar-v1) array* | List of environment variables to set in the container. Cannot be updated.
|
||||
image <br /> *string* | Docker image name. More info: http://kubernetes.io/docs/user-guide/images
|
||||
imagePullPolicy <br /> *string* | Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/images#updating-images
|
||||
lifecycle <br /> *[Lifecycle](#lifecycle-v1)* | Actions that the management system should take in response to container lifecycle events. Cannot be updated.
|
||||
livenessProbe <br /> *[Probe](#probe-v1)* | Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes
|
||||
name <br /> *string* | Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
|
||||
ports <br /> *[ContainerPort](#containerport-v1) array* | List of ports to expose from the container. Exposing a port here gives the system additional information about the network connections a container uses, but is primarily informational. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Cannot be updated.
|
||||
readinessProbe <br /> *[Probe](#probe-v1)* | Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/pod-states#container-probes
|
||||
resources <br /> *[ResourceRequirements](#resourcerequirements-v1)* | Compute Resources required by this container. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#resources
|
||||
securityContext <br /> *[SecurityContext](#securitycontext-v1)* | Security options the pod should run with. More info: http://releases.k8s.io/HEAD/docs/design/security_context.md
|
||||
stdin <br /> *boolean* | Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
|
||||
stdinOnce <br /> *boolean* | Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
|
||||
terminationMessagePath <br /> *string* | Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such as an assertion failure message. Defaults to /dev/termination-log. Cannot be updated.
|
||||
tty <br /> *boolean* | Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
|
||||
volumeMounts <br /> *[VolumeMount](#volumemount-v1) array* | Pod volumes to mount into the container's filesystem. Cannot be updated.
|
||||
workingDir <br /> *string* | Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.
|
||||
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
|
||||
|
||||
-----------
|
||||
# ContainerImage v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ContainerImage
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Describe a container image
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#nodestatus-v1">NodeStatus</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
names <br /> *string array* | Names by which this image is known. e.g. ["gcr.io/google_containers/hyperkube:v1.0.7", "dockerhub.io/google_containers/hyperkube:v1.0.7"]
|
||||
sizeBytes <br /> *integer* | The size of the image in bytes.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
## ContainerImage v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ContainerImage
|
||||
|
||||
|
||||
|
||||
Describe a container image
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#nodestatus-v1">NodeStatus</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
names <br /> *string array* | Names by which this image is known. e.g. ["gcr.io/google_containers/hyperkube:v1.0.7", "dockerhub.io/google_containers/hyperkube:v1.0.7"]
|
||||
sizeBytes <br /> *integer* | The size of the image in bytes.
|
||||
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
|
||||
|
||||
-----------
|
||||
# ContainerPort v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ContainerPort
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ContainerPort represents a network port in a single container.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#container-v1">Container</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
containerPort <br /> *integer* | Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
|
||||
hostIP <br /> *string* | What host IP to bind the external port to.
|
||||
hostPort <br /> *integer* | Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
|
||||
name <br /> *string* | If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
|
||||
protocol <br /> *string* | Protocol for port. Must be UDP or TCP. Defaults to "TCP".
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
## ContainerPort v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ContainerPort
|
||||
|
||||
|
||||
|
||||
ContainerPort represents a network port in a single container.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#container-v1">Container</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
containerPort <br /> *integer* | Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
|
||||
hostIP <br /> *string* | What host IP to bind the external port to.
|
||||
hostPort <br /> *integer* | Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
|
||||
name <br /> *string* | If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
|
||||
protocol <br /> *string* | Protocol for port. Must be UDP or TCP. Defaults to "TCP".
|
||||
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
|
||||
|
||||
-----------
|
||||
# ContainerState v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ContainerState
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#containerstatus-v1">ContainerStatus</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
running <br /> *[ContainerStateRunning](#containerstaterunning-v1)* | Details about a running container
|
||||
terminated <br /> *[ContainerStateTerminated](#containerstateterminated-v1)* | Details about a terminated container
|
||||
waiting <br /> *[ContainerStateWaiting](#containerstatewaiting-v1)* | Details about a waiting container
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
## ContainerState v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ContainerState
|
||||
|
||||
|
||||
|
||||
ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#containerstatus-v1">ContainerStatus</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
running <br /> *[ContainerStateRunning](#containerstaterunning-v1)* | Details about a running container
|
||||
terminated <br /> *[ContainerStateTerminated](#containerstateterminated-v1)* | Details about a terminated container
|
||||
waiting <br /> *[ContainerStateWaiting](#containerstatewaiting-v1)* | Details about a waiting container
|
||||
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
|
||||
|
||||
-----------
|
||||
# ContainerStateRunning v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ContainerStateRunning
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ContainerStateRunning is a running state of a container.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#containerstate-v1">ContainerState</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
startedAt <br /> *[Time](#time-unversioned)* | Time at which the container was last (re-)started
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
## ContainerStateRunning v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ContainerStateRunning
|
||||
|
||||
|
||||
|
||||
ContainerStateRunning is a running state of a container.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#containerstate-v1">ContainerState</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
startedAt <br /> *[Time](#time-unversioned)* | Time at which the container was last (re-)started
|
||||
|
||||
|
|
@ -0,0 +1,37 @@
|
|||
|
||||
|
||||
-----------
|
||||
# ContainerStateTerminated v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ContainerStateTerminated
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ContainerStateTerminated is a terminated state of a container.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#containerstate-v1">ContainerState</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
containerID <br /> *string* | Container's ID in the format 'docker://<container_id>'
|
||||
exitCode <br /> *integer* | Exit status from the last termination of the container
|
||||
finishedAt <br /> *[Time](#time-unversioned)* | Time at which the container last terminated
|
||||
message <br /> *string* | Message regarding the last termination of the container
|
||||
reason <br /> *string* | (brief) reason from the last termination of the container
|
||||
signal <br /> *integer* | Signal from the last termination of the container
|
||||
startedAt <br /> *[Time](#time-unversioned)* | Time at which previous execution of the container started
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
## ContainerStateTerminated v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ContainerStateTerminated
|
||||
|
||||
|
||||
|
||||
ContainerStateTerminated is a terminated state of a container.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#containerstate-v1">ContainerState</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
containerID <br /> *string* | Container's ID in the format 'docker://<container_id>'
|
||||
exitCode <br /> *integer* | Exit status from the last termination of the container
|
||||
finishedAt <br /> *[Time](#time-unversioned)* | Time at which the container last terminated
|
||||
message <br /> *string* | Message regarding the last termination of the container
|
||||
reason <br /> *string* | (brief) reason from the last termination of the container
|
||||
signal <br /> *integer* | Signal from the last termination of the container
|
||||
startedAt <br /> *[Time](#time-unversioned)* | Time at which previous execution of the container started
|
||||
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
|
||||
|
||||
-----------
|
||||
# ContainerStateWaiting v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ContainerStateWaiting
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ContainerStateWaiting is a waiting state of a container.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#containerstate-v1">ContainerState</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
message <br /> *string* | Message regarding why the container is not yet running.
|
||||
reason <br /> *string* | (brief) reason the container is not yet running.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
## ContainerStateWaiting v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ContainerStateWaiting
|
||||
|
||||
|
||||
|
||||
ContainerStateWaiting is a waiting state of a container.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#containerstate-v1">ContainerState</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
message <br /> *string* | Message regarding why the container is not yet running.
|
||||
reason <br /> *string* | (brief) reason the container is not yet running.
|
||||
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
|
||||
|
||||
-----------
|
||||
# ContainerStatus v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ContainerStatus
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
ContainerStatus contains details for the current status of this container.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#podstatus-v1">PodStatus</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
containerID <br /> *string* | Container's ID in the format 'docker://<container_id>'. More info: http://kubernetes.io/docs/user-guide/container-environment#container-information
|
||||
image <br /> *string* | The image the container is running. More info: http://kubernetes.io/docs/user-guide/images
|
||||
imageID <br /> *string* | ImageID of the container's image.
|
||||
lastState <br /> *[ContainerState](#containerstate-v1)* | Details about the container's last termination condition.
|
||||
name <br /> *string* | This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.
|
||||
ready <br /> *boolean* | Specifies whether the container has passed its readiness probe.
|
||||
restartCount <br /> *integer* | The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC.
|
||||
state <br /> *[ContainerState](#containerstate-v1)* | Details about the container's current condition.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
## ContainerStatus v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | ContainerStatus
|
||||
|
||||
|
||||
|
||||
ContainerStatus contains details for the current status of this container.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#podstatus-v1">PodStatus</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
containerID <br /> *string* | Container's ID in the format 'docker://<container_id>'. More info: http://kubernetes.io/docs/user-guide/container-environment#container-information
|
||||
image <br /> *string* | The image the container is running. More info: http://kubernetes.io/docs/user-guide/images
|
||||
imageID <br /> *string* | ImageID of the container's image.
|
||||
lastState <br /> *[ContainerState](#containerstate-v1)* | Details about the container's last termination condition.
|
||||
name <br /> *string* | This must be a DNS_LABEL. Each container in a pod must have a unique name. Cannot be updated.
|
||||
ready <br /> *boolean* | Specifies whether the container has passed its readiness probe.
|
||||
restartCount <br /> *integer* | The number of times the container has been restarted, currently based on the number of dead containers that have not yet been removed. Note that this is calculated from dead containers. But those containers are subject to garbage collection. This value will get capped at 5 by GC.
|
||||
state <br /> *[ContainerState](#containerstate-v1)* | Details about the container's current condition.
|
||||
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
|
||||
|
||||
-----------
|
||||
# CPUTargetUtilization v1beta1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1beta1 | CPUTargetUtilization
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#horizontalpodautoscalerspec-v1beta1">HorizontalPodAutoscalerSpec</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
targetPercentage <br /> *integer* | fraction of the requested CPU that should be utilized/used, e.g. 70 means that 70% of the requested CPU should be in use.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
## CPUTargetUtilization v1beta1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1beta1 | CPUTargetUtilization
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#horizontalpodautoscalerspec-v1beta1">HorizontalPodAutoscalerSpec</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
targetPercentage <br /> *integer* | fraction of the requested CPU that should be utilized/used, e.g. 70 means that 70% of the requested CPU should be in use.
|
||||
|
||||
|
|
@ -0,0 +1,760 @@
|
|||
|
||||
|
||||
-----------
|
||||
# CronJob v2alpha1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Batch | v2alpha1 | CronJob
|
||||
|
||||
<aside class="warning">Alpha objects should not be used in production and may not be compatible with future versions of the resource type.</aside>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
CronJob represents the configuration of a single cron job.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#cronjoblist-v2alpha1">CronJobList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
spec <br /> *[CronJobSpec](#cronjobspec-v2alpha1)* | Spec is a structure defining the expected behavior of a job, including the schedule. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
|
||||
status <br /> *[CronJobStatus](#cronjobstatus-v2alpha1)* | Status is a structure describing current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
|
||||
|
||||
|
||||
### CronJobSpec v2alpha1
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#cronjob-v2alpha1">CronJob</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
concurrencyPolicy <br /> *string* | ConcurrencyPolicy specifies how to treat concurrent executions of a Job.
|
||||
jobTemplate <br /> *[JobTemplateSpec](#jobtemplatespec-v2alpha1)* | JobTemplate is the object that describes the job that will be created when executing a CronJob.
|
||||
schedule <br /> *string* | Schedule contains the schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
|
||||
startingDeadlineSeconds <br /> *integer* | Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.
|
||||
suspend <br /> *boolean* | Suspend flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.
|
||||
|
||||
### CronJobStatus v2alpha1
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#cronjob-v2alpha1">CronJob</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
active <br /> *[ObjectReference](#objectreference-v1) array* | Active holds pointers to currently running jobs.
|
||||
lastScheduleTime <br /> *[Time](#time-unversioned)* | LastScheduleTime keeps information of when was the last time the job was successfully scheduled.
|
||||
|
||||
### CronJobList v2alpha1
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[CronJob](#cronjob-v2alpha1) array* | Items is the list of CronJob.
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
||||
|
||||
|
||||
## <strong>Write Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Create
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
create a CronJob
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`POST /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[CronJob](#cronjob-v2alpha1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[CronJob](#cronjob-v2alpha1)* | OK
|
||||
|
||||
|
||||
## Replace
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
replace the specified CronJob
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PUT /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the CronJob
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[CronJob](#cronjob-v2alpha1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[CronJob](#cronjob-v2alpha1)* | OK
|
||||
|
||||
|
||||
## Patch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
partially update the specified CronJob
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PATCH /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the CronJob
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[CronJob](#cronjob-v2alpha1)* | OK
|
||||
|
||||
|
||||
## Delete
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
delete a CronJob
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`DELETE /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the CronJob
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
gracePeriodSeconds | 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.
|
||||
orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Status](#status-unversioned)* | OK
|
||||
|
||||
|
||||
## Delete Collection
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
delete collection of CronJob
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`DELETE /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Status](#status-unversioned)* | OK
|
||||
|
||||
|
||||
|
||||
## <strong>Read Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Read
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
read the specified CronJob
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the CronJob
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'
|
||||
export | Should this value be exported. Export strips fields that a user can not specify.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[CronJob](#cronjob-v2alpha1)* | OK
|
||||
|
||||
|
||||
## List
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind CronJob
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[CronJobList](#cronjoblist-v2alpha1)* | OK
|
||||
|
||||
|
||||
## List All Namespaces
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind CronJob
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/batch/v2alpha1/cronjobs`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[CronJobList](#cronjoblist-v2alpha1)* | OK
|
||||
|
||||
|
||||
## Watch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch changes to an object of kind CronJob
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/batch/v2alpha1/watch/namespaces/{namespace}/cronjobs/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
name | name of the CronJob
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
## Watch List
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch individual changes to a list of CronJob
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/batch/v2alpha1/watch/namespaces/{namespace}/cronjobs`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
## Watch List All Namespaces
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch individual changes to a list of CronJob
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/batch/v2alpha1/watch/cronjobs`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
## CronJob v2alpha1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Batch | v2alpha1 | CronJob
|
||||
|
||||
|
||||
|
||||
CronJob represents the configuration of a single cron job.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#cronjoblist-v2alpha1">CronJobList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
spec <br /> *[CronJobSpec](#cronjobspec-v2alpha1)* | Spec is a structure defining the expected behavior of a job, including the schedule. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
|
||||
status <br /> *[CronJobStatus](#cronjobstatus-v2alpha1)* | Status is a structure describing current status of a job. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
|
||||
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
|
||||
|
||||
-----------
|
||||
# CronJobList v2alpha1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v2alpha1 | CronJobList
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
CronJobList is a collection of cron jobs.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[CronJob](#cronjob-v2alpha1) array* | Items is the list of CronJob.
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
## CronJobList v2alpha1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v2alpha1 | CronJobList
|
||||
|
||||
|
||||
|
||||
CronJobList is a collection of cron jobs.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[CronJob](#cronjob-v2alpha1) array* | Items is the list of CronJob.
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
|
||||
|
||||
-----------
|
||||
# CronJobSpec v2alpha1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v2alpha1 | CronJobSpec
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
CronJobSpec describes how the job execution will look like and when it will actually run.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#cronjob-v2alpha1">CronJob</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
concurrencyPolicy <br /> *string* | ConcurrencyPolicy specifies how to treat concurrent executions of a Job.
|
||||
jobTemplate <br /> *[JobTemplateSpec](#jobtemplatespec-v2alpha1)* | JobTemplate is the object that describes the job that will be created when executing a CronJob.
|
||||
schedule <br /> *string* | Schedule contains the schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
|
||||
startingDeadlineSeconds <br /> *integer* | Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.
|
||||
suspend <br /> *boolean* | Suspend flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,21 @@
|
|||
## CronJobSpec v2alpha1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v2alpha1 | CronJobSpec
|
||||
|
||||
|
||||
|
||||
CronJobSpec describes how the job execution will look like and when it will actually run.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#cronjob-v2alpha1">CronJob</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
concurrencyPolicy <br /> *string* | ConcurrencyPolicy specifies how to treat concurrent executions of a Job.
|
||||
jobTemplate <br /> *[JobTemplateSpec](#jobtemplatespec-v2alpha1)* | JobTemplate is the object that describes the job that will be created when executing a CronJob.
|
||||
schedule <br /> *string* | Schedule contains the schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
|
||||
startingDeadlineSeconds <br /> *integer* | Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.
|
||||
suspend <br /> *boolean* | Suspend flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.
|
||||
|
||||
|
|
@ -0,0 +1,223 @@
|
|||
|
||||
|
||||
-----------
|
||||
# CronJobStatus v2alpha1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Batch | v2alpha1 | CronJobStatus
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
CronJobStatus represents the current state of a cron job.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#cronjob-v2alpha1">CronJob</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
active <br /> *[ObjectReference](#objectreference-v1) array* | Active holds pointers to currently running jobs.
|
||||
lastScheduleTime <br /> *[Time](#time-unversioned)* | LastScheduleTime keeps information of when was the last time the job was successfully scheduled.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## <strong>Write Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Replace
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
replace status of the specified CronJob
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PUT /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the CronJob
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[CronJob](#cronjob-v2alpha1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[CronJob](#cronjob-v2alpha1)* | OK
|
||||
|
||||
|
||||
## Patch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
partially update status of the specified CronJob
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PATCH /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the CronJob
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[CronJob](#cronjob-v2alpha1)* | OK
|
||||
|
||||
|
||||
|
||||
## <strong>Read Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Read
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
read status of the specified CronJob
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/batch/v2alpha1/namespaces/{namespace}/cronjobs/{name}/status`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the CronJob
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[CronJob](#cronjob-v2alpha1)* | OK
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
## CronJobStatus v2alpha1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Batch | v2alpha1 | CronJobStatus
|
||||
|
||||
|
||||
|
||||
CronJobStatus represents the current state of a cron job.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#cronjob-v2alpha1">CronJob</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
active <br /> *[ObjectReference](#objectreference-v1) array* | Active holds pointers to currently running jobs.
|
||||
lastScheduleTime <br /> *[Time](#time-unversioned)* | LastScheduleTime keeps information of when was the last time the job was successfully scheduled.
|
||||
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
|
||||
|
||||
-----------
|
||||
# CrossVersionObjectReference v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | CrossVersionObjectReference
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
CrossVersionObjectReference contains enough information to let you identify the referred resource.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#horizontalpodautoscalerspec-v1">HorizontalPodAutoscalerSpec</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | API version of the referent
|
||||
kind <br /> *string* | Kind of the referent; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds"
|
||||
name <br /> *string* | Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
## CrossVersionObjectReference v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | CrossVersionObjectReference
|
||||
|
||||
|
||||
|
||||
CrossVersionObjectReference contains enough information to let you identify the referred resource.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#horizontalpodautoscalerspec-v1">HorizontalPodAutoscalerSpec</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
apiVersion <br /> *string* | API version of the referent
|
||||
kind <br /> *string* | Kind of the referent; More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds"
|
||||
name <br /> *string* | Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names
|
||||
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
|
||||
|
||||
-----------
|
||||
# DaemonEndpoint v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | DaemonEndpoint
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
DaemonEndpoint contains information about a single Daemon endpoint.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#nodedaemonendpoints-v1">NodeDaemonEndpoints</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
Port <br /> *integer* | Port number of the given endpoint.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
## DaemonEndpoint v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | DaemonEndpoint
|
||||
|
||||
|
||||
|
||||
DaemonEndpoint contains information about a single Daemon endpoint.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#nodedaemonendpoints-v1">NodeDaemonEndpoints</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
Port <br /> *integer* | Port number of the given endpoint.
|
||||
|
||||
|
|
@ -0,0 +1,936 @@
|
|||
|
||||
|
||||
-----------
|
||||
# DaemonSet v1beta1
|
||||
|
||||
>bdocs-tab:kubectl DaemonSet Config to print the `hostname` on each Node in the cluster every 10 seconds.
|
||||
|
||||
```bdocs-tab:kubectl_yaml
|
||||
|
||||
apiVersion: extensions/v1beta1
|
||||
kind: DaemonSet
|
||||
metadata:
|
||||
# Unique key of the DaemonSet instance
|
||||
name: daemonset-example
|
||||
spec:
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
app: daemonset-example
|
||||
spec:
|
||||
containers:
|
||||
# This container is run once on each Node in the cluster
|
||||
- name: daemonset-example
|
||||
image: ubuntu:trusty
|
||||
command:
|
||||
- /bin/sh
|
||||
args:
|
||||
- -c
|
||||
# This script is run through `sh -c <script>`
|
||||
- >-
|
||||
while [ true ]; do
|
||||
echo "DaemonSet running on $(hostname)" ;
|
||||
sleep 10 ;
|
||||
done
|
||||
|
||||
```
|
||||
>bdocs-tab:curl DaemonSet Config to print the `hostname` on each Node in the cluster every 10 seconds.
|
||||
|
||||
```bdocs-tab:curl_yaml
|
||||
|
||||
apiVersion: extensions/v1beta1
|
||||
kind: DaemonSet
|
||||
metadata:
|
||||
# Unique key of the DaemonSet instance
|
||||
name: daemonset-example
|
||||
spec:
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
app: daemonset-example
|
||||
spec:
|
||||
containers:
|
||||
# This container is run once on each Node in the cluster
|
||||
- name: daemonset-example
|
||||
image: ubuntu:trusty
|
||||
command:
|
||||
- /bin/sh
|
||||
args:
|
||||
- -c
|
||||
# This script is run through `sh -c <script>`
|
||||
- >-
|
||||
while [ true ]; do
|
||||
echo "DaemonSet running on $(hostname)" ;
|
||||
sleep 10 ;
|
||||
done
|
||||
|
||||
```
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Extensions | v1beta1 | DaemonSet
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
DaemonSet represents the configuration of a daemon set.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#daemonsetlist-v1beta1">DaemonSetList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
spec <br /> *[DaemonSetSpec](#daemonsetspec-v1beta1)* | Spec defines the desired behavior of this daemon set. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
|
||||
status <br /> *[DaemonSetStatus](#daemonsetstatus-v1beta1)* | Status is the current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
|
||||
|
||||
|
||||
### DaemonSetSpec v1beta1
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#daemonset-v1beta1">DaemonSet</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
selector <br /> *[LabelSelector](#labelselector-unversioned)* | Selector is a label query over pods that are managed by the daemon set. Must match in order to be controlled. If empty, defaulted to labels on Pod template. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
|
||||
template <br /> *[PodTemplateSpec](#podtemplatespec-v1)* | Template is the object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template's node selector (or on every node if no node selector is specified). More info: http://kubernetes.io/docs/user-guide/replication-controller#pod-template
|
||||
|
||||
### DaemonSetStatus v1beta1
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#daemonset-v1beta1">DaemonSet</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
currentNumberScheduled <br /> *integer* | CurrentNumberScheduled is the number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md
|
||||
desiredNumberScheduled <br /> *integer* | DesiredNumberScheduled is the total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md
|
||||
numberMisscheduled <br /> *integer* | NumberMisscheduled is the number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md
|
||||
numberReady <br /> *integer* | NumberReady is the number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.
|
||||
|
||||
### DaemonSetList v1beta1
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[DaemonSet](#daemonset-v1beta1) array* | Items is a list of daemon sets.
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
||||
|
||||
|
||||
## <strong>Write Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Create
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
$ echo 'apiVersion: extensions/v1beta1
|
||||
kind: DaemonSet
|
||||
metadata:
|
||||
name: daemonset-example
|
||||
spec:
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
app: daemonset-example
|
||||
spec:
|
||||
containers:
|
||||
- name: daemonset-example
|
||||
image: ubuntu:trusty
|
||||
command:
|
||||
- /bin/sh
|
||||
args:
|
||||
- -c
|
||||
- >-
|
||||
while [ true ]; do
|
||||
echo "DaemonSet running on $(hostname)" ;
|
||||
sleep 10 ;
|
||||
done
|
||||
' | kubectl create -f -
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
$ kubectl proxy
|
||||
$ curl -X POST -H 'Content-Type: application/yaml' --data '
|
||||
apiVersion: extensions/v1beta1
|
||||
kind: DaemonSet
|
||||
metadata:
|
||||
name: daemonset-example
|
||||
spec:
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
app: daemonset-example
|
||||
spec:
|
||||
containers:
|
||||
- name: daemonset-example
|
||||
image: ubuntu:trusty
|
||||
command:
|
||||
- /bin/sh
|
||||
args:
|
||||
- -c
|
||||
- >-
|
||||
while [ true ]; do
|
||||
echo "DaemonSet running on $(hostname)" ;
|
||||
sleep 10 ;
|
||||
done
|
||||
' http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/daemonsets
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
daemonset "daemonset-example" created
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
{
|
||||
"kind": "DaemonSet",
|
||||
"apiVersion": "extensions/v1beta1",
|
||||
"metadata": {
|
||||
"name": "daemonset-example",
|
||||
"namespace": "default",
|
||||
"selfLink": "/apis/extensions/v1beta1/namespaces/default/daemonsets/daemonset-example",
|
||||
"uid": "65552ced-b0e2-11e6-aef0-42010af00229",
|
||||
"resourceVersion": "3558",
|
||||
"generation": 1,
|
||||
"creationTimestamp": "2016-11-22T18:35:09Z",
|
||||
"labels": {
|
||||
"app": "daemonset-example"
|
||||
}
|
||||
},
|
||||
"spec": {
|
||||
"selector": {
|
||||
"matchLabels": {
|
||||
"app": "daemonset-example"
|
||||
}
|
||||
},
|
||||
"template": {
|
||||
"metadata": {
|
||||
"creationTimestamp": null,
|
||||
"labels": {
|
||||
"app": "daemonset-example"
|
||||
}
|
||||
},
|
||||
"spec": {
|
||||
"containers": [
|
||||
{
|
||||
"name": "daemonset-example",
|
||||
"image": "ubuntu:trusty",
|
||||
"command": [
|
||||
"/bin/sh"
|
||||
],
|
||||
"args": [
|
||||
"-c",
|
||||
"while [ true ]; do echo \"DaemonSet running on $(hostname)\" ; sleep 10 ; done"
|
||||
],
|
||||
"resources": {},
|
||||
"terminationMessagePath": "/dev/termination-log",
|
||||
"imagePullPolicy": "IfNotPresent"
|
||||
}
|
||||
],
|
||||
"restartPolicy": "Always",
|
||||
"terminationGracePeriodSeconds": 30,
|
||||
"dnsPolicy": "ClusterFirst",
|
||||
"securityContext": {}
|
||||
}
|
||||
}
|
||||
},
|
||||
"status": {
|
||||
"currentNumberScheduled": 0,
|
||||
"numberMisscheduled": 0,
|
||||
"desiredNumberScheduled": 0
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
create a DaemonSet
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`POST /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DaemonSet](#daemonset-v1beta1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[DaemonSet](#daemonset-v1beta1)* | OK
|
||||
|
||||
|
||||
## Replace
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
replace the specified DaemonSet
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PUT /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the DaemonSet
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DaemonSet](#daemonset-v1beta1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[DaemonSet](#daemonset-v1beta1)* | OK
|
||||
|
||||
|
||||
## Patch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
partially update the specified DaemonSet
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PATCH /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the DaemonSet
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[DaemonSet](#daemonset-v1beta1)* | OK
|
||||
|
||||
|
||||
## Delete
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
$ kubectl delete daemonset daemonset-example
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
$ kubectl proxy
|
||||
$ curl -X DELETE -H 'Content-Type: application/yaml' --data '
|
||||
gracePeriodSeconds: 0
|
||||
orphanDependents: false
|
||||
' 'http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/daemonsets/daemonset-example'
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
daemonset "daemonset-example" deleted
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
{
|
||||
"kind": "Status",
|
||||
"apiVersion": "v1",
|
||||
"metadata": {},
|
||||
"status": "Success",
|
||||
"code": 200
|
||||
}
|
||||
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
delete a DaemonSet
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`DELETE /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the DaemonSet
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DeleteOptions](#deleteoptions-v1)* |
|
||||
gracePeriodSeconds | 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.
|
||||
orphanDependents | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Status](#status-unversioned)* | OK
|
||||
|
||||
|
||||
## Delete Collection
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
delete collection of DaemonSet
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`DELETE /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Status](#status-unversioned)* | OK
|
||||
|
||||
|
||||
|
||||
## <strong>Read Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Read
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
$ kubectl get daemonset daemonset-example -o json
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
$ kubectl proxy
|
||||
$ curl -X GET http://127.0.0.1:8001/apis/extensions/v1beta1/namespaces/default/daemonsets/daemonset-example
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
read the specified DaemonSet
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the DaemonSet
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
exact | Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'
|
||||
export | Should this value be exported. Export strips fields that a user can not specify.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[DaemonSet](#daemonset-v1beta1)* | OK
|
||||
|
||||
|
||||
## List
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind DaemonSet
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[DaemonSetList](#daemonsetlist-v1beta1)* | OK
|
||||
|
||||
|
||||
## List All Namespaces
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
list or watch objects of kind DaemonSet
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/extensions/v1beta1/daemonsets`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[DaemonSetList](#daemonsetlist-v1beta1)* | OK
|
||||
|
||||
|
||||
## Watch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch changes to an object of kind DaemonSet
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/daemonsets/{name}`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
name | name of the DaemonSet
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
## Watch List
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch individual changes to a list of DaemonSet
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/extensions/v1beta1/watch/namespaces/{namespace}/daemonsets`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
## Watch List All Namespaces
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
watch individual changes to a list of DaemonSet
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/extensions/v1beta1/watch/daemonsets`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
fieldSelector | A selector to restrict the list of returned objects by their fields. Defaults to everything.
|
||||
labelSelector | A selector to restrict the list of returned objects by their labels. Defaults to everything.
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
resourceVersion | When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history.
|
||||
timeoutSeconds | Timeout for the list/watch call.
|
||||
watch | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[Event](#event-versioned)* | OK
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
## DaemonSet v1beta1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Extensions | v1beta1 | DaemonSet
|
||||
|
||||
|
||||
|
||||
DaemonSet represents the configuration of a daemon set.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#daemonsetlist-v1beta1">DaemonSetList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object's metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
spec <br /> *[DaemonSetSpec](#daemonsetspec-v1beta1)* | Spec defines the desired behavior of this daemon set. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
|
||||
status <br /> *[DaemonSetStatus](#daemonsetstatus-v1beta1)* | Status is the current status of this daemon set. This data may be out of date by some window of time. Populated by the system. Read-only. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#spec-and-status
|
||||
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
|
||||
|
||||
-----------
|
||||
# DaemonSetList v1beta1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1beta1 | DaemonSetList
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
DaemonSetList is a collection of daemon sets.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[DaemonSet](#daemonset-v1beta1) array* | Items is a list of daemon sets.
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
## DaemonSetList v1beta1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1beta1 | DaemonSetList
|
||||
|
||||
|
||||
|
||||
DaemonSetList is a collection of daemon sets.
|
||||
|
||||
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
items <br /> *[DaemonSet](#daemonset-v1beta1) array* | Items is a list of daemon sets.
|
||||
metadata <br /> *[ListMeta](#listmeta-unversioned)* | Standard list metadata. More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#metadata
|
||||
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
|
||||
|
||||
-----------
|
||||
# DaemonSetSpec v1beta1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1beta1 | DaemonSetSpec
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
DaemonSetSpec is the specification of a daemon set.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#daemonset-v1beta1">DaemonSet</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
selector <br /> *[LabelSelector](#labelselector-unversioned)* | Selector is a label query over pods that are managed by the daemon set. Must match in order to be controlled. If empty, defaulted to labels on Pod template. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
|
||||
template <br /> *[PodTemplateSpec](#podtemplatespec-v1)* | Template is the object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template's node selector (or on every node if no node selector is specified). More info: http://kubernetes.io/docs/user-guide/replication-controller#pod-template
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
## DaemonSetSpec v1beta1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1beta1 | DaemonSetSpec
|
||||
|
||||
|
||||
|
||||
DaemonSetSpec is the specification of a daemon set.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#daemonset-v1beta1">DaemonSet</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
selector <br /> *[LabelSelector](#labelselector-unversioned)* | Selector is a label query over pods that are managed by the daemon set. Must match in order to be controlled. If empty, defaulted to labels on Pod template. More info: http://kubernetes.io/docs/user-guide/labels#label-selectors
|
||||
template <br /> *[PodTemplateSpec](#podtemplatespec-v1)* | Template is the object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template's node selector (or on every node if no node selector is specified). More info: http://kubernetes.io/docs/user-guide/replication-controller#pod-template
|
||||
|
||||
|
|
@ -0,0 +1,225 @@
|
|||
|
||||
|
||||
-----------
|
||||
# DaemonSetStatus v1beta1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Extensions | v1beta1 | DaemonSetStatus
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
DaemonSetStatus represents the current status of a daemon set.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#daemonset-v1beta1">DaemonSet</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
currentNumberScheduled <br /> *integer* | CurrentNumberScheduled is the number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md
|
||||
desiredNumberScheduled <br /> *integer* | DesiredNumberScheduled is the total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md
|
||||
numberMisscheduled <br /> *integer* | NumberMisscheduled is the number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md
|
||||
numberReady <br /> *integer* | NumberReady is the number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## <strong>Write Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Replace
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
replace status of the specified DaemonSet
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PUT /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the DaemonSet
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[DaemonSet](#daemonset-v1beta1)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[DaemonSet](#daemonset-v1beta1)* | OK
|
||||
|
||||
|
||||
## Patch
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
partially update status of the specified DaemonSet
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`PATCH /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the DaemonSet
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
### Query Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
body <br /> *[Patch](#patch-unversioned)* |
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[DaemonSet](#daemonset-v1beta1)* | OK
|
||||
|
||||
|
||||
|
||||
## <strong>Read Operations</strong>
|
||||
|
||||
See supported operations below...
|
||||
|
||||
## Read
|
||||
|
||||
>bdocs-tab:kubectl `kubectl` Command
|
||||
|
||||
```bdocs-tab:kubectl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:curl `curl` Command (*requires `kubectl proxy` to be running*)
|
||||
|
||||
```bdocs-tab:curl_shell
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
>bdocs-tab:kubectl Output
|
||||
|
||||
```bdocs-tab:kubectl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
>bdocs-tab:curl Response Body
|
||||
|
||||
```bdocs-tab:curl_json
|
||||
|
||||
Coming Soon
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
read status of the specified DaemonSet
|
||||
|
||||
### HTTP Request
|
||||
|
||||
`GET /apis/extensions/v1beta1/namespaces/{namespace}/daemonsets/{name}/status`
|
||||
|
||||
### Path Parameters
|
||||
|
||||
Parameter | Description
|
||||
------------ | -----------
|
||||
name | name of the DaemonSet
|
||||
namespace | object name and auth scope, such as for teams and projects
|
||||
pretty | If 'true', then the output is pretty printed.
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
Code | Description
|
||||
------------ | -----------
|
||||
200 <br /> *[DaemonSet](#daemonset-v1beta1)* | OK
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
## DaemonSetStatus v1beta1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Extensions | v1beta1 | DaemonSetStatus
|
||||
|
||||
|
||||
|
||||
DaemonSetStatus represents the current status of a daemon set.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#daemonset-v1beta1">DaemonSet</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
currentNumberScheduled <br /> *integer* | CurrentNumberScheduled is the number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md
|
||||
desiredNumberScheduled <br /> *integer* | DesiredNumberScheduled is the total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md
|
||||
numberMisscheduled <br /> *integer* | NumberMisscheduled is the number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: http://releases.k8s.io/HEAD/docs/admin/daemons.md
|
||||
numberReady <br /> *integer* | NumberReady is the number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.
|
||||
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
|
||||
|
||||
-----------
|
||||
# DeleteOptions v1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | DeleteOptions
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
DeleteOptions may be provided when deleting an API object
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#eviction-v1beta1">Eviction</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
gracePeriodSeconds <br /> *integer* | 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.
|
||||
orphanDependents <br /> *boolean* | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.
|
||||
preconditions <br /> *[Preconditions](#preconditions-v1)* | Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
## DeleteOptions v1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1 | DeleteOptions
|
||||
|
||||
|
||||
|
||||
DeleteOptions may be provided when deleting an API object
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#eviction-v1beta1">Eviction</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
gracePeriodSeconds <br /> *integer* | 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.
|
||||
orphanDependents <br /> *boolean* | Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list.
|
||||
preconditions <br /> *[Preconditions](#preconditions-v1)* | Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,19 @@
|
|||
## Deployment v1beta1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Extensions | v1beta1 | Deployment
|
||||
|
||||
|
||||
|
||||
Deployment enables declarative updates for Pods and ReplicaSets.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#deploymentlist-v1beta1">DeploymentList</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
metadata <br /> *[ObjectMeta](#objectmeta-v1)* | Standard object metadata.
|
||||
spec <br /> *[DeploymentSpec](#deploymentspec-v1beta1)* | Specification of the desired behavior of the Deployment.
|
||||
status <br /> *[DeploymentStatus](#deploymentstatus-v1beta1)* | Most recently observed status of the Deployment.
|
||||
|
||||
|
|
@ -0,0 +1,36 @@
|
|||
|
||||
|
||||
-----------
|
||||
# DeploymentCondition v1beta1
|
||||
|
||||
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1beta1 | DeploymentCondition
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
DeploymentCondition describes the state of a deployment at a certain point.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#deploymentstatus-v1beta1">DeploymentStatus</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
lastTransitionTime <br /> *[Time](#time-unversioned)* | Last time the condition transitioned from one status to another.
|
||||
lastUpdateTime <br /> *[Time](#time-unversioned)* | The last time this condition was updated.
|
||||
message <br /> *string* | A human readable message indicating details about the transition.
|
||||
reason <br /> *string* | The reason for the condition's last transition.
|
||||
status <br /> *string* | Status of the condition, one of True, False, Unknown.
|
||||
type <br /> *string* | Type of deployment condition.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
## DeploymentCondition v1beta1
|
||||
|
||||
Group | Version | Kind
|
||||
------------ | ---------- | -----------
|
||||
Core | v1beta1 | DeploymentCondition
|
||||
|
||||
|
||||
|
||||
DeploymentCondition describes the state of a deployment at a certain point.
|
||||
|
||||
<aside class="notice">
|
||||
Appears In <a href="#deploymentstatus-v1beta1">DeploymentStatus</a> </aside>
|
||||
|
||||
Field | Description
|
||||
------------ | -----------
|
||||
lastTransitionTime <br /> *[Time](#time-unversioned)* | Last time the condition transitioned from one status to another.
|
||||
lastUpdateTime <br /> *[Time](#time-unversioned)* | The last time this condition was updated.
|
||||
message <br /> *string* | A human readable message indicating details about the transition.
|
||||
reason <br /> *string* | The reason for the condition's last transition.
|
||||
status <br /> *string* | Status of the condition, one of True, False, Unknown.
|
||||
type <br /> *string* | Type of deployment condition.
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue