mirror of https://github.com/k3s-io/k3s
2018 lines
108 KiB
HTML
2018 lines
108 KiB
HTML
<!DOCTYPE HTML>
|
|
<html>
|
|
<head>
|
|
<title>Kubernetes API documentation</title>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
|
|
<script type="text/javascript">
|
|
var protocol = ((document.location.protocol === 'https:') ? 'https:': 'http:');
|
|
document.write('<link rel="stylesheet" href="' + protocol + '//netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css">');
|
|
document.write('<link rel="stylesheet" href="' + protocol + '//yandex.st/highlightjs/8.0/styles/github.min.css">');
|
|
document.write('<script type="text/javascript" src="' + protocol + '//code.jquery.com/jquery-1.11.0.min.js"><\/sc' + 'ript>');
|
|
document.write('<script type="text/javascript" src="' + protocol + '//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"><\/sc' + 'ript>');
|
|
</script>
|
|
|
|
<style>
|
|
.parent {
|
|
color: #999;
|
|
}
|
|
.list-group-item > .badge {
|
|
float: none;
|
|
margin-right: 6px;
|
|
}
|
|
.panel-title > .block > .badge {
|
|
float: right;
|
|
margin-left: 5px;
|
|
}
|
|
.badge {
|
|
border-radius: 0;
|
|
text-transform: uppercase;
|
|
width: 70px;
|
|
font-weight: normal;
|
|
color: #f3f3f6;
|
|
line-height: normal;
|
|
}
|
|
.block .badge {
|
|
visibility: hidden;
|
|
}
|
|
.block.collapsed .badge {
|
|
visibility: visible;
|
|
}
|
|
.badge_get {
|
|
background-color: #63a8e2;
|
|
}
|
|
.badge_post {
|
|
background-color: #6cbd7d;
|
|
}
|
|
.badge_put {
|
|
background-color: #22bac4;
|
|
}
|
|
.badge_delete {
|
|
background-color: #d26460;
|
|
}
|
|
.block {
|
|
display: block;
|
|
}
|
|
.list-group, .panel-group {
|
|
margin-bottom: 0;
|
|
}
|
|
.panel-group .panel+.panel-white {
|
|
margin-top: 0;
|
|
}
|
|
.panel-group .panel-white {
|
|
border-bottom: 1px solid #F5F5F5;
|
|
border-radius: 0;
|
|
}
|
|
.panel-white:last-child {
|
|
border-bottom-color: white;
|
|
-webkit-box-shadow: none;
|
|
box-shadow: none;
|
|
}
|
|
.panel-white .panel-heading {
|
|
background: white;
|
|
}
|
|
.tab-pane ul {
|
|
padding-left: 2em;
|
|
}
|
|
.tab-pane h2 {
|
|
font-size: 1.2em;
|
|
padding-bottom: 4px;
|
|
border-bottom: 1px solid #ddd;
|
|
}
|
|
.tab-pane h3 {
|
|
font-size: 1.1em;
|
|
}
|
|
.tab-content {
|
|
border-left: 1px solid #ddd;
|
|
border-right: 1px solid #ddd;
|
|
border-bottom: 1px solid #ddd;
|
|
padding: 10px;
|
|
}
|
|
#sidebar {
|
|
margin-top: 30px;
|
|
}
|
|
.resource-description {
|
|
border-bottom: 1px solid #ddd;
|
|
background: #fcfcfc;
|
|
padding: 15px 15px 0 15px;
|
|
margin: -15px -15px 10px -15px;
|
|
}
|
|
</style>
|
|
</head>
|
|
|
|
<body data-spy="scroll" data-target="#sidebar">
|
|
<div class="container">
|
|
<div class="row">
|
|
<div class="col-md-9" role="main">
|
|
<div class="page-header">
|
|
<h1>Kubernetes API documentation <small>version v1beta1</small></h1>
|
|
<p>http://server/api/v1beta1</p>
|
|
|
|
|
|
<h3 id="Overview"><a href="#Overview">Overview</a></h3>
|
|
<p>The Kubernetes API currently manages 3 main resources: <code>pods</code>,
|
|
<code>replicationControllers</code>, and <code>services</code>. Pods correspond to
|
|
colocated groups of <a href="http://docker.io">Docker containers</a> with
|
|
shared volumes, as supported by <a href="https://developers.google.com/compute/docs/containers">Google Cloud Platform's
|
|
container-vm
|
|
images</a>.
|
|
Singleton pods can be created directly via the <code>/pods</code>
|
|
endpoint. Sets of pods may created, maintained, and scaled using
|
|
replicationControllers. Services create load-balanced targets
|
|
for sets of pods.</p>
|
|
|
|
|
|
<h3 id="Resource-identifiers"><a href="#Resource-identifiers">Resource identifiers</a></h3>
|
|
<p>Each resource has a string <code>id</code> and list of key-value
|
|
<code>labels</code>. The <code>id</code> is generated by the system and is guaranteed
|
|
to be unique in space and time across all resources. <code>labels</code>
|
|
is a map of string (key) to string (value). Each resource may
|
|
have at most one label with a particular key. Individual labels
|
|
are used to specify identifying metadata that can be used to
|
|
define sets of resources by specifying required labels. Examples
|
|
of typical pod label keys include <code>stage</code>, <code>service</code>, <code>name</code>,
|
|
<code>tier</code>, <code>partition</code>, and <code>track</code>, but you are free to develop
|
|
your own conventions.</p>
|
|
|
|
|
|
<h3 id="Creation-semantics"><a href="#Creation-semantics">Creation semantics</a></h3>
|
|
<p>Creation is currently not idempotent. We plan to add a
|
|
modification token to each resource. A unique value for the token
|
|
should be provided by the user during creation. If the user
|
|
specifies a duplicate token at creation time, the system should
|
|
return an error with a pointer to the exiting resource with that
|
|
token. In this way a user can deterministically recover from a
|
|
dropped connection during a resource creation request.</p>
|
|
|
|
|
|
<h3 id="Update-semantics"><a href="#Update-semantics">Update semantics</a></h3>
|
|
<p>Custom verbs are minimized and are used only for 'edge triggered'
|
|
actions such as a reboot. Resource descriptions are generally set
|
|
up with <code>desiredState</code> for the user provided parameters and
|
|
<code>currentState</code> for the actual system state. While consistent
|
|
terminology is used across these two stanzas they do not match
|
|
member for member.</p>
|
|
<p>When a new version of a resource is PUT the <code>desiredState</code> is
|
|
updated and available immediately. Over time the system will work
|
|
to bring the <code>currentState</code> into line with the <code>desiredState</code>. The
|
|
system will drive toward the most recent <code>desiredState</code> regardless
|
|
of previous versions of that stanza. In other words, if a value
|
|
is changed from 2 to 5 in one PUT and then back down to 3 in
|
|
another PUT the system isn't required to 'touch base' at 5 before
|
|
making 3 the <code>currentState</code>.</p>
|
|
<p>When doing an update, we assume that the entire <code>desiredState</code>
|
|
stanza is specified. If a field is omitted it is assumed that the
|
|
user is looking to delete that field. It is viable for a user to
|
|
GET the resource, modify what they like in the <code>desiredState</code> or
|
|
labels stanzas and then PUT it back. If the <code>currentState</code> is
|
|
included in the PUT it will be silently ignored.</p>
|
|
<p>While currently unspecified, it is intended that concurrent
|
|
modification should be accomplished with optimistic locking of
|
|
resources. We plan to add a modification token to each resource. If
|
|
this is included with the PUT operation the system will verify
|
|
that there haven't been other successful mutations to the
|
|
resource during a read/modify/write cycle. The correct client
|
|
action at this point is to GET the resource again, apply the
|
|
changes afresh and try submitting again.</p>
|
|
<p>Note that updates currently only work for replicationControllers
|
|
and services, but not for pods. Label updates have not yet been
|
|
implemented, either.</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class="panel panel-default">
|
|
<div class="panel-heading">
|
|
<h3 id="_pods" class="panel-title">/pods</h3>
|
|
</div>
|
|
|
|
<div class="panel-body">
|
|
|
|
|
|
<div class="panel-group">
|
|
<div class="panel panel-white">
|
|
<div class="panel-heading">
|
|
<h4 class="panel-title">
|
|
<a class="block collapsed" data-toggle="collapse" href="#panel__pods">
|
|
|
|
<span class="badge badge_get">get</span>
|
|
|
|
<span class="badge badge_post">post</span>
|
|
|
|
<span class="parent"></span>/pods
|
|
</a>
|
|
</h4>
|
|
</div>
|
|
<div id="panel__pods" class="panel-collapse collapse">
|
|
<div class="panel-body">
|
|
<div class="list-group">
|
|
|
|
<a href="#" data-toggle="modal" data-target="#_pods_get" class="list-group-item">
|
|
<span class="badge badge_get">get</span>
|
|
List all pods on this cluster
|
|
</a>
|
|
|
|
<a href="#" data-toggle="modal" data-target="#_pods_post" class="list-group-item">
|
|
<span class="badge badge_post">post</span>
|
|
Create a new pod. currentState is ignored if present.
|
|
</a>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="modal fade" id="_pods_get">
|
|
<div class="modal-dialog">
|
|
<div class="modal-content">
|
|
<div class="modal-header">
|
|
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
|
|
<h4 class="modal-title" id="myModalLabel">
|
|
<span class="badge badge_get">get</span>
|
|
<span class="parent"></span>/pods
|
|
</h4>
|
|
</div>
|
|
<div class="modal-body">
|
|
<div class="alert alert-info"><p>List all pods on this cluster</p>
|
|
</div>
|
|
|
|
<!-- Nav tabs -->
|
|
<ul class="nav nav-tabs">
|
|
<li class="active">
|
|
<a href="#_pods_get_request" data-toggle="tab">Request</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#_pods_get_response" data-toggle="tab">Response</a>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- Tab panes -->
|
|
<div class="tab-content">
|
|
<div class="tab-pane active" id="_pods_get_request">
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class="tab-pane" id="_pods_get_response">
|
|
|
|
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2>
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Body</h3>
|
|
|
|
<p><strong>Type: application/json</strong></p>
|
|
|
|
|
|
<strong>Example:</strong>
|
|
<pre>{
|
|
"<span class="hljs-attribute">items</span>": <span class="hljs-value">[
|
|
{
|
|
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"my-pod-1"</span></span>,
|
|
"<span class="hljs-attribute">labels</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"testRun"</span></span>,
|
|
"<span class="hljs-attribute">replicationController</span>": <span class="hljs-value"><span class="hljs-string">"testRun"</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">manifest</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">containers</span>": <span class="hljs-value">[{
|
|
"<span class="hljs-attribute">image</span>": <span class="hljs-value"><span class="hljs-string">"dockerfile/nginx"</span></span>,
|
|
"<span class="hljs-attribute">ports</span>": <span class="hljs-value">[{
|
|
"<span class="hljs-attribute">hostPort</span>": <span class="hljs-value"><span class="hljs-number">8080</span></span>,
|
|
"<span class="hljs-attribute">containerPort</span>": <span class="hljs-value"><span class="hljs-number">80</span>
|
|
</span>}]
|
|
</span>}
|
|
}
|
|
},
|
|
<span class="hljs-string">"currentState"</span>: {
|
|
"<span class="hljs-attribute">host</span>": <span class="hljs-value"><span class="hljs-string">"host-1"</span>
|
|
</span>}
|
|
},
|
|
{
|
|
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"my-pod-2"</span></span>,
|
|
"<span class="hljs-attribute">labels</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"testRun"</span></span>,
|
|
"<span class="hljs-attribute">replicationController</span>": <span class="hljs-value"><span class="hljs-string">"testRun"</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">manifest</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">containers</span>": <span class="hljs-value">[{
|
|
"<span class="hljs-attribute">image</span>": <span class="hljs-value"><span class="hljs-string">"dockerfile/nginx"</span></span>,
|
|
"<span class="hljs-attribute">ports</span>": <span class="hljs-value">[{
|
|
"<span class="hljs-attribute">hostPort</span>": <span class="hljs-value"><span class="hljs-number">8080</span></span>,
|
|
"<span class="hljs-attribute">containerPort</span>": <span class="hljs-value"><span class="hljs-number">80</span>
|
|
</span>}]
|
|
</span>}
|
|
}
|
|
},
|
|
<span class="hljs-string">"currentState"</span>: {
|
|
"<span class="hljs-attribute">host</span>": <span class="hljs-value"><span class="hljs-string">"host-2"</span>
|
|
</span>}
|
|
}
|
|
]
|
|
</span>}</span></span></span></span></span></span></pre>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="modal fade" id="_pods_post">
|
|
<div class="modal-dialog">
|
|
<div class="modal-content">
|
|
<div class="modal-header">
|
|
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
|
|
<h4 class="modal-title" id="myModalLabel">
|
|
<span class="badge badge_post">post</span>
|
|
<span class="parent"></span>/pods
|
|
</h4>
|
|
</div>
|
|
<div class="modal-body">
|
|
<div class="alert alert-info"><p>Create a new pod. currentState is ignored if present.</p>
|
|
</div>
|
|
|
|
<!-- Nav tabs -->
|
|
<ul class="nav nav-tabs">
|
|
<li class="active">
|
|
<a href="#_pods_post_request" data-toggle="tab">Request</a>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- Tab panes -->
|
|
<div class="tab-content">
|
|
<div class="tab-pane active" id="_pods_post_request">
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Body</h3>
|
|
|
|
<p><strong>Type: json/application</strong></p>
|
|
|
|
|
|
<strong>Schema:</strong>
|
|
<pre>{
|
|
"<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-03/schema"</span></span>,
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
|
|
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Pod resource. A pod corresponds to a colocated group of [Docker containers](http://docker.io)."</span></span>,
|
|
"<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">kind</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">id</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">creationTimestamp</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">selfLink</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
|
|
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"The desired configuration of the pod"</span></span>,
|
|
"<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">manifest</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
|
|
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Manifest describing group of [Docker containers](http://docker.io); compatible with format used by [Google Cloud Platform's container-vm images](https://developers.google.com/compute/docs/containers)"</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">status</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
|
|
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">""</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">host</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
|
|
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">""</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">hostIP</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
|
|
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">""</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">info</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
|
|
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">""</span>
|
|
</span>}
|
|
</span>}
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">currentState</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
|
|
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"The current configuration and status of the pod. Fields in common with desiredState have the same meaning."</span></span>,
|
|
"<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">manifest</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">status</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">host</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">hostIP</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">info</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}
|
|
</span>}
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">labels</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}
|
|
</span>}
|
|
</span>}
|
|
</pre>
|
|
|
|
|
|
<strong>Example:</strong>
|
|
<pre>{
|
|
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"php"</span></span>,
|
|
"<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">manifest</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">containers</span>": <span class="hljs-value">[{
|
|
"<span class="hljs-attribute">image</span>": <span class="hljs-value"><span class="hljs-string">"dockerfile/nginx"</span></span>,
|
|
"<span class="hljs-attribute">ports</span>": <span class="hljs-value">[{
|
|
"<span class="hljs-attribute">containerPort</span>": <span class="hljs-value"><span class="hljs-number">80</span></span>,
|
|
"<span class="hljs-attribute">hostPort</span>": <span class="hljs-value"><span class="hljs-number">8080</span>
|
|
</span>}]
|
|
</span>}]
|
|
</span>}
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">labels</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"foo"</span>
|
|
</span>}
|
|
</span>}
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="panel panel-white">
|
|
<div class="panel-heading">
|
|
<h4 class="panel-title">
|
|
<a class="block collapsed" data-toggle="collapse" href="#panel__pods__podId_">
|
|
|
|
<span class="badge badge_get">get</span>
|
|
|
|
<span class="badge badge_put">put</span>
|
|
|
|
<span class="badge badge_delete">delete</span>
|
|
|
|
<span class="parent">/pods</span>/{podId}
|
|
</a>
|
|
</h4>
|
|
</div>
|
|
<div id="panel__pods__podId_" class="panel-collapse collapse">
|
|
<div class="panel-body">
|
|
<div class="list-group">
|
|
|
|
<a href="#" data-toggle="modal" data-target="#_pods__podId__get" class="list-group-item">
|
|
<span class="badge badge_get">get</span>
|
|
Get a specific pod
|
|
</a>
|
|
|
|
<a href="#" data-toggle="modal" data-target="#_pods__podId__put" class="list-group-item">
|
|
<span class="badge badge_put">put</span>
|
|
Update a pod
|
|
</a>
|
|
|
|
<a href="#" data-toggle="modal" data-target="#_pods__podId__delete" class="list-group-item">
|
|
<span class="badge badge_delete">delete</span>
|
|
Delete a specific pod
|
|
</a>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="modal fade" id="_pods__podId__get">
|
|
<div class="modal-dialog">
|
|
<div class="modal-content">
|
|
<div class="modal-header">
|
|
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
|
|
<h4 class="modal-title" id="myModalLabel">
|
|
<span class="badge badge_get">get</span>
|
|
<span class="parent">/pods</span>/{podId}
|
|
</h4>
|
|
</div>
|
|
<div class="modal-body">
|
|
<div class="alert alert-info"><p>Get a specific pod</p>
|
|
</div>
|
|
|
|
<!-- Nav tabs -->
|
|
<ul class="nav nav-tabs">
|
|
<li class="active">
|
|
<a href="#_pods__podId__get_request" data-toggle="tab">Request</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#_pods__podId__get_response" data-toggle="tab">Response</a>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- Tab panes -->
|
|
<div class="tab-content">
|
|
<div class="tab-pane active" id="_pods__podId__get_request">
|
|
|
|
<h3>URI Parameters</h3>
|
|
<ul>
|
|
|
|
<li><strong>podId</strong>: string</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class="tab-pane" id="_pods__podId__get_response">
|
|
|
|
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2>
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Body</h3>
|
|
|
|
<p><strong>Type: application/json</strong></p>
|
|
|
|
|
|
<strong>Example:</strong>
|
|
<pre>{
|
|
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"php"</span></span>,
|
|
"<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">manifest</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">containers</span>": <span class="hljs-value">[{
|
|
"<span class="hljs-attribute">image</span>": <span class="hljs-value"><span class="hljs-string">"dockerfile/nginx"</span></span>,
|
|
"<span class="hljs-attribute">ports</span>": <span class="hljs-value">[{
|
|
"<span class="hljs-attribute">containerPort</span>": <span class="hljs-value"><span class="hljs-number">80</span></span>,
|
|
"<span class="hljs-attribute">hostPort</span>": <span class="hljs-value"><span class="hljs-number">8080</span>
|
|
</span>}]
|
|
</span>}]
|
|
</span>}
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">labels</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"foo"</span>
|
|
</span>}
|
|
</span>}
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="modal fade" id="_pods__podId__put">
|
|
<div class="modal-dialog">
|
|
<div class="modal-content">
|
|
<div class="modal-header">
|
|
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
|
|
<h4 class="modal-title" id="myModalLabel">
|
|
<span class="badge badge_put">put</span>
|
|
<span class="parent">/pods</span>/{podId}
|
|
</h4>
|
|
</div>
|
|
<div class="modal-body">
|
|
<div class="alert alert-info"><p>Update a pod</p>
|
|
</div>
|
|
|
|
<!-- Nav tabs -->
|
|
<ul class="nav nav-tabs">
|
|
<li class="active">
|
|
<a href="#_pods__podId__put_request" data-toggle="tab">Request</a>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- Tab panes -->
|
|
<div class="tab-content">
|
|
<div class="tab-pane active" id="_pods__podId__put_request">
|
|
|
|
<h3>URI Parameters</h3>
|
|
<ul>
|
|
|
|
<li><strong>podId</strong>: string</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Body</h3>
|
|
|
|
<p><strong>Type: json/application</strong></p>
|
|
|
|
|
|
<strong>Schema:</strong>
|
|
<pre>{
|
|
"<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-03/schema"</span></span>,
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
|
|
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Pod resource. A pod corresponds to a colocated group of [Docker containers](http://docker.io)."</span></span>,
|
|
"<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">kind</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">id</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">creationTimestamp</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">selfLink</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
|
|
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"The desired configuration of the pod"</span></span>,
|
|
"<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">manifest</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
|
|
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Manifest describing group of [Docker containers](http://docker.io); compatible with format used by [Google Cloud Platform's container-vm images](https://developers.google.com/compute/docs/containers)"</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">status</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
|
|
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">""</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">host</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
|
|
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">""</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">hostIP</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
|
|
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">""</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">info</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
|
|
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">""</span>
|
|
</span>}
|
|
</span>}
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">currentState</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
|
|
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"The current configuration and status of the pod. Fields in common with desiredState have the same meaning."</span></span>,
|
|
"<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">manifest</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">status</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">host</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">hostIP</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">info</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}
|
|
</span>}
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">labels</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}
|
|
</span>}
|
|
</span>}
|
|
</pre>
|
|
|
|
|
|
<strong>Example:</strong>
|
|
<pre>{
|
|
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"php"</span></span>,
|
|
"<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">manifest</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">containers</span>": <span class="hljs-value">[{
|
|
"<span class="hljs-attribute">image</span>": <span class="hljs-value"><span class="hljs-string">"dockerfile/nginx"</span></span>,
|
|
"<span class="hljs-attribute">ports</span>": <span class="hljs-value">[{
|
|
"<span class="hljs-attribute">containerPort</span>": <span class="hljs-value"><span class="hljs-number">80</span></span>,
|
|
"<span class="hljs-attribute">hostPort</span>": <span class="hljs-value"><span class="hljs-number">8080</span>
|
|
</span>}]
|
|
</span>}]
|
|
</span>}
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">labels</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"foo"</span>
|
|
</span>}
|
|
</span>}
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="modal fade" id="_pods__podId__delete">
|
|
<div class="modal-dialog">
|
|
<div class="modal-content">
|
|
<div class="modal-header">
|
|
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
|
|
<h4 class="modal-title" id="myModalLabel">
|
|
<span class="badge badge_delete">delete</span>
|
|
<span class="parent">/pods</span>/{podId}
|
|
</h4>
|
|
</div>
|
|
<div class="modal-body">
|
|
<div class="alert alert-info"><p>Delete a specific pod</p>
|
|
</div>
|
|
|
|
<!-- Nav tabs -->
|
|
<ul class="nav nav-tabs">
|
|
<li class="active">
|
|
<a href="#_pods__podId__delete_request" data-toggle="tab">Request</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#_pods__podId__delete_response" data-toggle="tab">Response</a>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- Tab panes -->
|
|
<div class="tab-content">
|
|
<div class="tab-pane active" id="_pods__podId__delete_request">
|
|
|
|
<h3>URI Parameters</h3>
|
|
<ul>
|
|
|
|
<li><strong>podId</strong>: string</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class="tab-pane" id="_pods__podId__delete_response">
|
|
|
|
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2>
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Body</h3>
|
|
|
|
<p><strong>Type: application/json</strong></p>
|
|
|
|
|
|
<strong>Example:</strong>
|
|
<pre>{
|
|
"<span class="hljs-attribute">success</span>": <span class="hljs-value"><span class="hljs-literal">true</span>
|
|
</span>}
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="panel panel-default">
|
|
<div class="panel-heading">
|
|
<h3 id="_replicationControllers" class="panel-title">/replicationControllers</h3>
|
|
</div>
|
|
|
|
<div class="panel-body">
|
|
|
|
|
|
<div class="panel-group">
|
|
<div class="panel panel-white">
|
|
<div class="panel-heading">
|
|
<h4 class="panel-title">
|
|
<a class="block collapsed" data-toggle="collapse" href="#panel__replicationControllers">
|
|
|
|
<span class="badge badge_get">get</span>
|
|
|
|
<span class="badge badge_post">post</span>
|
|
|
|
<span class="parent"></span>/replicationControllers
|
|
</a>
|
|
</h4>
|
|
</div>
|
|
<div id="panel__replicationControllers" class="panel-collapse collapse">
|
|
<div class="panel-body">
|
|
<div class="list-group">
|
|
|
|
<a href="#" data-toggle="modal" data-target="#_replicationControllers_get" class="list-group-item">
|
|
<span class="badge badge_get">get</span>
|
|
List all replicationControllers on this cluster
|
|
</a>
|
|
|
|
<a href="#" data-toggle="modal" data-target="#_replicationControllers_post" class="list-group-item">
|
|
<span class="badge badge_post">post</span>
|
|
Create a new controller. currentState is ignored if present.
|
|
</a>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="modal fade" id="_replicationControllers_get">
|
|
<div class="modal-dialog">
|
|
<div class="modal-content">
|
|
<div class="modal-header">
|
|
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
|
|
<h4 class="modal-title" id="myModalLabel">
|
|
<span class="badge badge_get">get</span>
|
|
<span class="parent"></span>/replicationControllers
|
|
</h4>
|
|
</div>
|
|
<div class="modal-body">
|
|
<div class="alert alert-info"><p>List all replicationControllers on this cluster</p>
|
|
</div>
|
|
|
|
<!-- Nav tabs -->
|
|
<ul class="nav nav-tabs">
|
|
<li class="active">
|
|
<a href="#_replicationControllers_get_request" data-toggle="tab">Request</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#_replicationControllers_get_response" data-toggle="tab">Response</a>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- Tab panes -->
|
|
<div class="tab-content">
|
|
<div class="tab-pane active" id="_replicationControllers_get_request">
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class="tab-pane" id="_replicationControllers_get_response">
|
|
|
|
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2>
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Body</h3>
|
|
|
|
<p><strong>Type: application/json</strong></p>
|
|
|
|
|
|
<strong>Example:</strong>
|
|
<pre>{
|
|
"<span class="hljs-attribute">items</span>": <span class="hljs-value">[
|
|
{
|
|
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"testRun"</span></span>,
|
|
"<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">replicas</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
|
|
"<span class="hljs-attribute">replicasInSet</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"testRun"</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">podTemplate</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">image</span>": <span class="hljs-value"><span class="hljs-string">"dockerfile/nginx"</span></span>,
|
|
"<span class="hljs-attribute">networkPorts</span>": <span class="hljs-value">[
|
|
{
|
|
"<span class="hljs-attribute">hostPort</span>": <span class="hljs-value"><span class="hljs-number">8080</span></span>,
|
|
"<span class="hljs-attribute">containerPort</span>": <span class="hljs-value"><span class="hljs-number">80</span>
|
|
</span>}
|
|
]
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">labels</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"testRun"</span>
|
|
</span>}
|
|
</span>}
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">labels</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"testRun"</span>
|
|
</span>}
|
|
</span>}
|
|
]
|
|
</span>}</pre>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="modal fade" id="_replicationControllers_post">
|
|
<div class="modal-dialog">
|
|
<div class="modal-content">
|
|
<div class="modal-header">
|
|
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
|
|
<h4 class="modal-title" id="myModalLabel">
|
|
<span class="badge badge_post">post</span>
|
|
<span class="parent"></span>/replicationControllers
|
|
</h4>
|
|
</div>
|
|
<div class="modal-body">
|
|
<div class="alert alert-info"><p>Create a new controller. currentState is ignored if present.</p>
|
|
</div>
|
|
|
|
<!-- Nav tabs -->
|
|
<ul class="nav nav-tabs">
|
|
<li class="active">
|
|
<a href="#_replicationControllers_post_request" data-toggle="tab">Request</a>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- Tab panes -->
|
|
<div class="tab-content">
|
|
<div class="tab-pane active" id="_replicationControllers_post_request">
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Body</h3>
|
|
|
|
<p><strong>Type: json/application</strong></p>
|
|
|
|
|
|
<strong>Schema:</strong>
|
|
<pre>{
|
|
"<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-03/schema"</span></span>,
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
|
|
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"A replicationController resource. A replicationController helps to create and manage a set of pods. It acts as a factory to create new pods based on a template. It ensures that there are a specific number of pods running. If fewer pods are running than `replicas` then the needed pods are generated using `podTemplate`. If more pods are running than `replicas`, then excess pods are deleted."</span></span>,
|
|
"<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">kind</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">id</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">creationTimestamp</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">selfLink</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
|
|
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"The desired configuration of the replicationController"</span></span>,
|
|
"<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">replicas</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
|
|
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Number of pods desired in the set"</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">replicasInSet</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
|
|
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Required labels used to identify pods in the set"</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">podTemplate</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
|
|
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Template from which to create new pods, as necessary. Identical to pod schema."</span>
|
|
</span>}
|
|
</span>}
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">labels</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}
|
|
</span>}
|
|
</span>}
|
|
</pre>
|
|
|
|
|
|
<strong>Example:</strong>
|
|
<pre> {
|
|
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"nginxController"</span></span>,
|
|
"<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">replicas</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
|
|
"<span class="hljs-attribute">replicasInSet</span>": <span class="hljs-value">{"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"nginx"</span></span>}</span>,
|
|
"<span class="hljs-attribute">podTemplate</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">manifest</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">containers</span>": <span class="hljs-value">[{
|
|
"<span class="hljs-attribute">image</span>": <span class="hljs-value"><span class="hljs-string">"dockerfile/nginx"</span></span>,
|
|
"<span class="hljs-attribute">ports</span>": <span class="hljs-value">[{"<span class="hljs-attribute">containerPort</span>": <span class="hljs-value"><span class="hljs-number">80</span></span>, "<span class="hljs-attribute">hostPort</span>": <span class="hljs-value"><span class="hljs-number">8080</span></span>}]
|
|
</span>}]
|
|
</span>}
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">labels</span>": <span class="hljs-value">{"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"nginx"</span></span>}
|
|
</span>}</span>}</span>,
|
|
"<span class="hljs-attribute">labels</span>": <span class="hljs-value">{"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"nginx"</span></span>}
|
|
</span>}
|
|
</pre>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="panel panel-white">
|
|
<div class="panel-heading">
|
|
<h4 class="panel-title">
|
|
<a class="block collapsed" data-toggle="collapse" href="#panel__replicationControllers__controllerId_">
|
|
|
|
<span class="badge badge_get">get</span>
|
|
|
|
<span class="badge badge_put">put</span>
|
|
|
|
<span class="badge badge_delete">delete</span>
|
|
|
|
<span class="parent">/replicationControllers</span>/{controllerId}
|
|
</a>
|
|
</h4>
|
|
</div>
|
|
<div id="panel__replicationControllers__controllerId_" class="panel-collapse collapse">
|
|
<div class="panel-body">
|
|
<div class="list-group">
|
|
|
|
<a href="#" data-toggle="modal" data-target="#_replicationControllers__controllerId__get" class="list-group-item">
|
|
<span class="badge badge_get">get</span>
|
|
Get a specific controller
|
|
</a>
|
|
|
|
<a href="#" data-toggle="modal" data-target="#_replicationControllers__controllerId__put" class="list-group-item">
|
|
<span class="badge badge_put">put</span>
|
|
Update a controller
|
|
</a>
|
|
|
|
<a href="#" data-toggle="modal" data-target="#_replicationControllers__controllerId__delete" class="list-group-item">
|
|
<span class="badge badge_delete">delete</span>
|
|
Delete a specific controller
|
|
</a>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="modal fade" id="_replicationControllers__controllerId__get">
|
|
<div class="modal-dialog">
|
|
<div class="modal-content">
|
|
<div class="modal-header">
|
|
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
|
|
<h4 class="modal-title" id="myModalLabel">
|
|
<span class="badge badge_get">get</span>
|
|
<span class="parent">/replicationControllers</span>/{controllerId}
|
|
</h4>
|
|
</div>
|
|
<div class="modal-body">
|
|
<div class="alert alert-info"><p>Get a specific controller</p>
|
|
</div>
|
|
|
|
<!-- Nav tabs -->
|
|
<ul class="nav nav-tabs">
|
|
<li class="active">
|
|
<a href="#_replicationControllers__controllerId__get_request" data-toggle="tab">Request</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#_replicationControllers__controllerId__get_response" data-toggle="tab">Response</a>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- Tab panes -->
|
|
<div class="tab-content">
|
|
<div class="tab-pane active" id="_replicationControllers__controllerId__get_request">
|
|
|
|
<h3>URI Parameters</h3>
|
|
<ul>
|
|
|
|
<li><strong>controllerId</strong>: string</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class="tab-pane" id="_replicationControllers__controllerId__get_response">
|
|
|
|
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2>
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Body</h3>
|
|
|
|
<p><strong>Type: application/json</strong></p>
|
|
|
|
|
|
<strong>Example:</strong>
|
|
<pre> {
|
|
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"nginxController"</span></span>,
|
|
"<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">replicas</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
|
|
"<span class="hljs-attribute">replicasInSet</span>": <span class="hljs-value">{"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"nginx"</span></span>}</span>,
|
|
"<span class="hljs-attribute">podTemplate</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">manifest</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">containers</span>": <span class="hljs-value">[{
|
|
"<span class="hljs-attribute">image</span>": <span class="hljs-value"><span class="hljs-string">"dockerfile/nginx"</span></span>,
|
|
"<span class="hljs-attribute">ports</span>": <span class="hljs-value">[{"<span class="hljs-attribute">containerPort</span>": <span class="hljs-value"><span class="hljs-number">80</span></span>, "<span class="hljs-attribute">hostPort</span>": <span class="hljs-value"><span class="hljs-number">8080</span></span>}]
|
|
</span>}]
|
|
</span>}
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">labels</span>": <span class="hljs-value">{"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"nginx"</span></span>}
|
|
</span>}</span>}</span>,
|
|
"<span class="hljs-attribute">labels</span>": <span class="hljs-value">{"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"nginx"</span></span>}
|
|
</span>}
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="modal fade" id="_replicationControllers__controllerId__put">
|
|
<div class="modal-dialog">
|
|
<div class="modal-content">
|
|
<div class="modal-header">
|
|
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
|
|
<h4 class="modal-title" id="myModalLabel">
|
|
<span class="badge badge_put">put</span>
|
|
<span class="parent">/replicationControllers</span>/{controllerId}
|
|
</h4>
|
|
</div>
|
|
<div class="modal-body">
|
|
<div class="alert alert-info"><p>Update a controller</p>
|
|
</div>
|
|
|
|
<!-- Nav tabs -->
|
|
<ul class="nav nav-tabs">
|
|
<li class="active">
|
|
<a href="#_replicationControllers__controllerId__put_request" data-toggle="tab">Request</a>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- Tab panes -->
|
|
<div class="tab-content">
|
|
<div class="tab-pane active" id="_replicationControllers__controllerId__put_request">
|
|
|
|
<h3>URI Parameters</h3>
|
|
<ul>
|
|
|
|
<li><strong>controllerId</strong>: string</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Body</h3>
|
|
|
|
<p><strong>Type: json/application</strong></p>
|
|
|
|
|
|
<strong>Schema:</strong>
|
|
<pre>{
|
|
"<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-03/schema"</span></span>,
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
|
|
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"A replicationController resource. A replicationController helps to create and manage a set of pods. It acts as a factory to create new pods based on a template. It ensures that there are a specific number of pods running. If fewer pods are running than `replicas` then the needed pods are generated using `podTemplate`. If more pods are running than `replicas`, then excess pods are deleted."</span></span>,
|
|
"<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">kind</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">id</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">creationTimestamp</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">selfLink</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
|
|
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"The desired configuration of the replicationController"</span></span>,
|
|
"<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">replicas</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
|
|
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Number of pods desired in the set"</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">replicasInSet</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
|
|
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Required labels used to identify pods in the set"</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">podTemplate</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
|
|
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Template from which to create new pods, as necessary. Identical to pod schema."</span>
|
|
</span>}
|
|
</span>}
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">labels</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}
|
|
</span>}
|
|
</span>}
|
|
</pre>
|
|
|
|
|
|
<strong>Example:</strong>
|
|
<pre> {
|
|
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"nginxController"</span></span>,
|
|
"<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">replicas</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
|
|
"<span class="hljs-attribute">replicasInSet</span>": <span class="hljs-value">{"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"nginx"</span></span>}</span>,
|
|
"<span class="hljs-attribute">podTemplate</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">manifest</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">containers</span>": <span class="hljs-value">[{
|
|
"<span class="hljs-attribute">image</span>": <span class="hljs-value"><span class="hljs-string">"dockerfile/nginx"</span></span>,
|
|
"<span class="hljs-attribute">ports</span>": <span class="hljs-value">[{"<span class="hljs-attribute">containerPort</span>": <span class="hljs-value"><span class="hljs-number">80</span></span>, "<span class="hljs-attribute">hostPort</span>": <span class="hljs-value"><span class="hljs-number">8080</span></span>}]
|
|
</span>}]
|
|
</span>}
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">labels</span>": <span class="hljs-value">{"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"nginx"</span></span>}
|
|
</span>}</span>}</span>,
|
|
"<span class="hljs-attribute">labels</span>": <span class="hljs-value">{"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"nginx"</span></span>}
|
|
</span>}
|
|
</pre>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="modal fade" id="_replicationControllers__controllerId__delete">
|
|
<div class="modal-dialog">
|
|
<div class="modal-content">
|
|
<div class="modal-header">
|
|
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
|
|
<h4 class="modal-title" id="myModalLabel">
|
|
<span class="badge badge_delete">delete</span>
|
|
<span class="parent">/replicationControllers</span>/{controllerId}
|
|
</h4>
|
|
</div>
|
|
<div class="modal-body">
|
|
<div class="alert alert-info"><p>Delete a specific controller</p>
|
|
</div>
|
|
|
|
<!-- Nav tabs -->
|
|
<ul class="nav nav-tabs">
|
|
<li class="active">
|
|
<a href="#_replicationControllers__controllerId__delete_request" data-toggle="tab">Request</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#_replicationControllers__controllerId__delete_response" data-toggle="tab">Response</a>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- Tab panes -->
|
|
<div class="tab-content">
|
|
<div class="tab-pane active" id="_replicationControllers__controllerId__delete_request">
|
|
|
|
<h3>URI Parameters</h3>
|
|
<ul>
|
|
|
|
<li><strong>controllerId</strong>: string</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class="tab-pane" id="_replicationControllers__controllerId__delete_response">
|
|
|
|
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2>
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Body</h3>
|
|
|
|
<p><strong>Type: application/json</strong></p>
|
|
|
|
|
|
<strong>Example:</strong>
|
|
<pre>{
|
|
"<span class="hljs-attribute">success</span>": <span class="hljs-value"><span class="hljs-literal">true</span>
|
|
</span>}
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="panel panel-default">
|
|
<div class="panel-heading">
|
|
<h3 id="_services" class="panel-title">/services</h3>
|
|
</div>
|
|
|
|
<div class="panel-body">
|
|
|
|
|
|
<div class="panel-group">
|
|
<div class="panel panel-white">
|
|
<div class="panel-heading">
|
|
<h4 class="panel-title">
|
|
<a class="block collapsed" data-toggle="collapse" href="#panel__services">
|
|
|
|
<span class="badge badge_get">get</span>
|
|
|
|
<span class="badge badge_post">post</span>
|
|
|
|
<span class="parent"></span>/services
|
|
</a>
|
|
</h4>
|
|
</div>
|
|
<div id="panel__services" class="panel-collapse collapse">
|
|
<div class="panel-body">
|
|
<div class="list-group">
|
|
|
|
<a href="#" data-toggle="modal" data-target="#_services_get" class="list-group-item">
|
|
<span class="badge badge_get">get</span>
|
|
List all services on this cluster
|
|
</a>
|
|
|
|
<a href="#" data-toggle="modal" data-target="#_services_post" class="list-group-item">
|
|
<span class="badge badge_post">post</span>
|
|
Create a new service
|
|
</a>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="modal fade" id="_services_get">
|
|
<div class="modal-dialog">
|
|
<div class="modal-content">
|
|
<div class="modal-header">
|
|
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
|
|
<h4 class="modal-title" id="myModalLabel">
|
|
<span class="badge badge_get">get</span>
|
|
<span class="parent"></span>/services
|
|
</h4>
|
|
</div>
|
|
<div class="modal-body">
|
|
<div class="alert alert-info"><p>List all services on this cluster</p>
|
|
</div>
|
|
|
|
<!-- Nav tabs -->
|
|
<ul class="nav nav-tabs">
|
|
<li class="active">
|
|
<a href="#_services_get_request" data-toggle="tab">Request</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#_services_get_response" data-toggle="tab">Response</a>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- Tab panes -->
|
|
<div class="tab-content">
|
|
<div class="tab-pane active" id="_services_get_request">
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class="tab-pane" id="_services_get_response">
|
|
|
|
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2>
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Body</h3>
|
|
|
|
<p><strong>Type: application/json</strong></p>
|
|
|
|
|
|
<strong>Example:</strong>
|
|
<pre>{
|
|
"<span class="hljs-attribute">items</span>": <span class="hljs-value">[
|
|
{
|
|
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"example1"</span></span>,
|
|
"<span class="hljs-attribute">port</span>": <span class="hljs-value"><span class="hljs-number">8000</span></span>,
|
|
"<span class="hljs-attribute">labels</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"nginx"</span>
|
|
</span>}
|
|
</span>},
|
|
{
|
|
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"example2"</span></span>,
|
|
"<span class="hljs-attribute">port</span>": <span class="hljs-value"><span class="hljs-number">8080</span></span>,
|
|
"<span class="hljs-attribute">labels</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">env</span>": <span class="hljs-value"><span class="hljs-string">"prod"</span></span>,
|
|
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"jetty"</span>
|
|
</span>}
|
|
</span>}
|
|
]
|
|
</span>}
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="modal fade" id="_services_post">
|
|
<div class="modal-dialog">
|
|
<div class="modal-content">
|
|
<div class="modal-header">
|
|
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
|
|
<h4 class="modal-title" id="myModalLabel">
|
|
<span class="badge badge_post">post</span>
|
|
<span class="parent"></span>/services
|
|
</h4>
|
|
</div>
|
|
<div class="modal-body">
|
|
<div class="alert alert-info"><p>Create a new service</p>
|
|
</div>
|
|
|
|
<!-- Nav tabs -->
|
|
<ul class="nav nav-tabs">
|
|
<li class="active">
|
|
<a href="#_services_post_request" data-toggle="tab">Request</a>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- Tab panes -->
|
|
<div class="tab-content">
|
|
<div class="tab-pane active" id="_services_post_request">
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Body</h3>
|
|
|
|
<p><strong>Type: json/application</strong></p>
|
|
|
|
|
|
<strong>Schema:</strong>
|
|
<pre>{
|
|
"<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-03/schema"</span></span>,
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
|
|
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"A service resource."</span></span>,
|
|
"<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">kind</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">id</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">creationTimestamp</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">selfLink</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">name</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">port</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">labels</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}
|
|
</span>}
|
|
</span>}
|
|
</pre>
|
|
|
|
|
|
<strong>Example:</strong>
|
|
<pre>{
|
|
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"example2"</span></span>,
|
|
"<span class="hljs-attribute">port</span>": <span class="hljs-value"><span class="hljs-number">8000</span></span>,
|
|
"<span class="hljs-attribute">labels</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"nginx"</span>
|
|
</span>}
|
|
</span>}
|
|
</pre>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="panel panel-white">
|
|
<div class="panel-heading">
|
|
<h4 class="panel-title">
|
|
<a class="block collapsed" data-toggle="collapse" href="#panel__services__serviceId_">
|
|
|
|
<span class="badge badge_get">get</span>
|
|
|
|
<span class="badge badge_put">put</span>
|
|
|
|
<span class="badge badge_delete">delete</span>
|
|
|
|
<span class="parent">/services</span>/{serviceId}
|
|
</a>
|
|
</h4>
|
|
</div>
|
|
<div id="panel__services__serviceId_" class="panel-collapse collapse">
|
|
<div class="panel-body">
|
|
<div class="list-group">
|
|
|
|
<a href="#" data-toggle="modal" data-target="#_services__serviceId__get" class="list-group-item">
|
|
<span class="badge badge_get">get</span>
|
|
Get a specific service
|
|
</a>
|
|
|
|
<a href="#" data-toggle="modal" data-target="#_services__serviceId__put" class="list-group-item">
|
|
<span class="badge badge_put">put</span>
|
|
Update a service
|
|
</a>
|
|
|
|
<a href="#" data-toggle="modal" data-target="#_services__serviceId__delete" class="list-group-item">
|
|
<span class="badge badge_delete">delete</span>
|
|
Delete a specific service
|
|
</a>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="modal fade" id="_services__serviceId__get">
|
|
<div class="modal-dialog">
|
|
<div class="modal-content">
|
|
<div class="modal-header">
|
|
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
|
|
<h4 class="modal-title" id="myModalLabel">
|
|
<span class="badge badge_get">get</span>
|
|
<span class="parent">/services</span>/{serviceId}
|
|
</h4>
|
|
</div>
|
|
<div class="modal-body">
|
|
<div class="alert alert-info"><p>Get a specific service</p>
|
|
</div>
|
|
|
|
<!-- Nav tabs -->
|
|
<ul class="nav nav-tabs">
|
|
<li class="active">
|
|
<a href="#_services__serviceId__get_request" data-toggle="tab">Request</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#_services__serviceId__get_response" data-toggle="tab">Response</a>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- Tab panes -->
|
|
<div class="tab-content">
|
|
<div class="tab-pane active" id="_services__serviceId__get_request">
|
|
|
|
<h3>URI Parameters</h3>
|
|
<ul>
|
|
|
|
<li><strong>serviceId</strong>: string</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class="tab-pane" id="_services__serviceId__get_response">
|
|
|
|
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2>
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Body</h3>
|
|
|
|
<p><strong>Type: application/json</strong></p>
|
|
|
|
|
|
<strong>Example:</strong>
|
|
<pre>{
|
|
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"example2"</span></span>,
|
|
"<span class="hljs-attribute">port</span>": <span class="hljs-value"><span class="hljs-number">8000</span></span>,
|
|
"<span class="hljs-attribute">labels</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"nginx"</span>
|
|
</span>}
|
|
</span>}
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="modal fade" id="_services__serviceId__put">
|
|
<div class="modal-dialog">
|
|
<div class="modal-content">
|
|
<div class="modal-header">
|
|
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
|
|
<h4 class="modal-title" id="myModalLabel">
|
|
<span class="badge badge_put">put</span>
|
|
<span class="parent">/services</span>/{serviceId}
|
|
</h4>
|
|
</div>
|
|
<div class="modal-body">
|
|
<div class="alert alert-info"><p>Update a service</p>
|
|
</div>
|
|
|
|
<!-- Nav tabs -->
|
|
<ul class="nav nav-tabs">
|
|
<li class="active">
|
|
<a href="#_services__serviceId__put_request" data-toggle="tab">Request</a>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- Tab panes -->
|
|
<div class="tab-content">
|
|
<div class="tab-pane active" id="_services__serviceId__put_request">
|
|
|
|
<h3>URI Parameters</h3>
|
|
<ul>
|
|
|
|
<li><strong>serviceId</strong>: string</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Body</h3>
|
|
|
|
<p><strong>Type: json/application</strong></p>
|
|
|
|
|
|
<strong>Schema:</strong>
|
|
<pre>{
|
|
"<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-03/schema"</span></span>,
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>,
|
|
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"A service resource."</span></span>,
|
|
"<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">kind</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">id</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">creationTimestamp</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">selfLink</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">name</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">port</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}</span>,
|
|
"<span class="hljs-attribute">labels</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
|
|
"<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
|
|
</span>}
|
|
</span>}
|
|
</span>}
|
|
</pre>
|
|
|
|
|
|
<strong>Example:</strong>
|
|
<pre>{
|
|
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"example2"</span></span>,
|
|
"<span class="hljs-attribute">port</span>": <span class="hljs-value"><span class="hljs-number">8000</span></span>,
|
|
"<span class="hljs-attribute">labels</span>": <span class="hljs-value">{
|
|
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"nginx"</span>
|
|
</span>}
|
|
</span>}
|
|
</pre>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="modal fade" id="_services__serviceId__delete">
|
|
<div class="modal-dialog">
|
|
<div class="modal-content">
|
|
<div class="modal-header">
|
|
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
|
|
<h4 class="modal-title" id="myModalLabel">
|
|
<span class="badge badge_delete">delete</span>
|
|
<span class="parent">/services</span>/{serviceId}
|
|
</h4>
|
|
</div>
|
|
<div class="modal-body">
|
|
<div class="alert alert-info"><p>Delete a specific service</p>
|
|
</div>
|
|
|
|
<!-- Nav tabs -->
|
|
<ul class="nav nav-tabs">
|
|
<li class="active">
|
|
<a href="#_services__serviceId__delete_request" data-toggle="tab">Request</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="#_services__serviceId__delete_response" data-toggle="tab">Response</a>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<!-- Tab panes -->
|
|
<div class="tab-content">
|
|
<div class="tab-pane active" id="_services__serviceId__delete_request">
|
|
|
|
<h3>URI Parameters</h3>
|
|
<ul>
|
|
|
|
<li><strong>serviceId</strong>: string</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class="tab-pane" id="_services__serviceId__delete_response">
|
|
|
|
<h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2>
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Body</h3>
|
|
|
|
<p><strong>Type: application/json</strong></p>
|
|
|
|
|
|
<strong>Example:</strong>
|
|
<pre>{
|
|
"<span class="hljs-attribute">success</span>": <span class="hljs-value"><span class="hljs-literal">true</span>
|
|
</span>}
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="col-md-3">
|
|
<div id="sidebar" class="hidden-print affix" role="complementary">
|
|
<ul class="nav nav-pills nav-stacked">
|
|
|
|
<li><a href="#_pods">/pods</a></li>
|
|
|
|
<li><a href="#_replicationControllers">/replicationControllers</a></li>
|
|
|
|
<li><a href="#_services">/services</a></li>
|
|
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|