github.com/deemoprobe/k8s-first-commit@v0.0.0-20230430165612-a541f1982be3/api/kubernetes.html (about) 1 <!DOCTYPE HTML> 2 <html> 3 <head> 4 <title>Kubernetes API documentation</title> 5 <meta http-equiv="X-UA-Compatible" content="IE=edge"> 6 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> 7 8 <script type="text/javascript"> 9 var protocol = ((document.location.protocol === 'https:') ? 'https:': 'http:'); 10 document.write('<link rel="stylesheet" href="' + protocol + '//netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css">'); 11 document.write('<link rel="stylesheet" href="' + protocol + '//yandex.st/highlightjs/8.0/styles/github.min.css">'); 12 document.write('<script type="text/javascript" src="' + protocol + '//code.jquery.com/jquery-1.11.0.min.js"><\/sc' + 'ript>'); 13 document.write('<script type="text/javascript" src="' + protocol + '//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"><\/sc' + 'ript>'); 14 </script> 15 16 <style> 17 .parent { 18 color: #999; 19 } 20 .list-group-item > .badge { 21 float: none; 22 margin-right: 6px; 23 } 24 .panel-title > .block > .badge { 25 float: right; 26 margin-left: 5px; 27 } 28 .badge { 29 border-radius: 0; 30 text-transform: uppercase; 31 width: 70px; 32 font-weight: normal; 33 color: #f3f3f6; 34 line-height: normal; 35 } 36 .block .badge { 37 visibility: hidden; 38 } 39 .block.collapsed .badge { 40 visibility: visible; 41 } 42 .badge_get { 43 background-color: #63a8e2; 44 } 45 .badge_post { 46 background-color: #6cbd7d; 47 } 48 .badge_put { 49 background-color: #22bac4; 50 } 51 .badge_delete { 52 background-color: #d26460; 53 } 54 .block { 55 display: block; 56 } 57 .list-group, .panel-group { 58 margin-bottom: 0; 59 } 60 .panel-group .panel+.panel-white { 61 margin-top: 0; 62 } 63 .panel-group .panel-white { 64 border-bottom: 1px solid #F5F5F5; 65 border-radius: 0; 66 } 67 .panel-white:last-child { 68 border-bottom-color: white; 69 -webkit-box-shadow: none; 70 box-shadow: none; 71 } 72 .panel-white .panel-heading { 73 background: white; 74 } 75 .tab-pane ul { 76 padding-left: 2em; 77 } 78 .tab-pane h2 { 79 font-size: 1.2em; 80 padding-bottom: 4px; 81 border-bottom: 1px solid #ddd; 82 } 83 .tab-pane h3 { 84 font-size: 1.1em; 85 } 86 .tab-content { 87 border-left: 1px solid #ddd; 88 border-right: 1px solid #ddd; 89 border-bottom: 1px solid #ddd; 90 padding: 10px; 91 } 92 #sidebar { 93 margin-top: 30px; 94 } 95 .resource-description { 96 border-bottom: 1px solid #ddd; 97 background: #fcfcfc; 98 padding: 15px 15px 0 15px; 99 margin: -15px -15px 10px -15px; 100 } 101 </style> 102 </head> 103 104 <body data-spy="scroll" data-target="#sidebar"> 105 <div class="container"> 106 <div class="row"> 107 <div class="col-md-9" role="main"> 108 <div class="page-header"> 109 <h1>Kubernetes API documentation <small>version v1beta1</small></h1> 110 <p>http://server/api/v1beta1</p> 111 112 113 <h3 id="Overview"><a href="#Overview">Overview</a></h3> 114 <p>The Kubernetes API currently manages 3 main resources: <code>tasks</code>, 115 <code>replicationControllers</code>, and <code>services</code>. Tasks correspond to 116 colocated groups of <a href="http://docker.io">Docker containers</a> with 117 shared volumes, as supported by <a href="https://developers.google.com/compute/docs/containers">Google Cloud Platform's 118 container-vm 119 images</a>. 120 Singleton tasks can be created directly via the <code>/tasks</code> 121 endpoint. Sets of tasks may created, maintained, and scaled using 122 replicationControllers. Services create load-balanced targets 123 for sets of tasks.</p> 124 125 126 <h3 id="Resource-identifiers"><a href="#Resource-identifiers">Resource identifiers</a></h3> 127 <p>Each resource has a string <code>id</code> and list of key-value 128 <code>labels</code>. The <code>id</code> is generated by the system and is guaranteed 129 to be unique in space and time across all resources. <code>labels</code> 130 is a map of string (key) to string (value). Each resource may 131 have at most one label with a particular key. Individual labels 132 are used to specify identifying metadata that can be used to 133 define sets of resources by specifying required labels. Examples 134 of typical task label keys include <code>stage</code>, <code>service</code>, <code>name</code>, 135 <code>tier</code>, <code>partition</code>, and <code>track</code>, but you are free to develop 136 your own conventions.</p> 137 138 139 <h3 id="Creation-semantics"><a href="#Creation-semantics">Creation semantics</a></h3> 140 <p>Creation is currently not idempotent. We plan to add a 141 modification token to each resource. A unique value for the token 142 should be provided by the user during creation. If the user 143 specifies a duplicate token at creation time, the system should 144 return an error with a pointer to the exiting resource with that 145 token. In this way a user can deterministically recover from a 146 dropped connection during a resource creation request.</p> 147 148 149 <h3 id="Update-semantics"><a href="#Update-semantics">Update semantics</a></h3> 150 <p>Custom verbs are minimized and are used only for 'edge triggered' 151 actions such as a reboot. Resource descriptions are generally set 152 up with <code>desiredState</code> for the user provided parameters and 153 <code>currentState</code> for the actual system state. While consistent 154 terminology is used across these two stanzas they do not match 155 member for member.</p> 156 <p>When a new version of a resource is PUT the <code>desiredState</code> is 157 updated and available immediately. Over time the system will work 158 to bring the <code>currentState</code> into line with the <code>desiredState</code>. The 159 system will drive toward the most recent <code>desiredState</code> regardless 160 of previous versions of that stanza. In other words, if a value 161 is changed from 2 to 5 in one PUT and then back down to 3 in 162 another PUT the system isn't required to 'touch base' at 5 before 163 making 3 the <code>currentState</code>.</p> 164 <p>When doing an update, we assume that the entire <code>desiredState</code> 165 stanza is specified. If a field is omitted it is assumed that the 166 user is looking to delete that field. It is viable for a user to 167 GET the resource, modify what they like in the <code>desiredState</code> or 168 labels stanzas and then PUT it back. If the <code>currentState</code> is 169 included in the PUT it will be silently ignored.</p> 170 <p>While currently unspecified, it is intended that concurrent 171 modification should be accomplished with optimistic locking of 172 resources. We plan to add a modification token to each resource. If 173 this is included with the PUT operation the system will verify 174 that there haven't been other successful mutations to the 175 resource during a read/modify/write cycle. The correct client 176 action at this point is to GET the resource again, apply the 177 changes afresh and try submitting again.</p> 178 <p>Note that updates currently only work for replicationControllers 179 and services, but not for tasks. Label updates have not yet been 180 implemented, either.</p> 181 182 183 </div> 184 185 186 <div class="panel panel-default"> 187 <div class="panel-heading"> 188 <h3 id="_tasks" class="panel-title">/tasks</h3> 189 </div> 190 191 <div class="panel-body"> 192 193 194 <div class="panel-group"> 195 <div class="panel panel-white"> 196 <div class="panel-heading"> 197 <h4 class="panel-title"> 198 <a class="block collapsed" data-toggle="collapse" href="#panel__tasks"> 199 200 <span class="badge badge_get">get</span> 201 202 <span class="badge badge_post">post</span> 203 204 <span class="parent"></span>/tasks 205 </a> 206 </h4> 207 </div> 208 <div id="panel__tasks" class="panel-collapse collapse"> 209 <div class="panel-body"> 210 <div class="list-group"> 211 212 <a href="#" data-toggle="modal" data-target="#_tasks_get" class="list-group-item"> 213 <span class="badge badge_get">get</span> 214 List all tasks on this cluster 215 </a> 216 217 <a href="#" data-toggle="modal" data-target="#_tasks_post" class="list-group-item"> 218 <span class="badge badge_post">post</span> 219 Create a new task. currentState is ignored if present. 220 </a> 221 222 </div> 223 </div> 224 </div> 225 226 227 <div class="modal fade" id="_tasks_get"> 228 <div class="modal-dialog"> 229 <div class="modal-content"> 230 <div class="modal-header"> 231 <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button> 232 <h4 class="modal-title" id="myModalLabel"> 233 <span class="badge badge_get">get</span> 234 <span class="parent"></span>/tasks 235 </h4> 236 </div> 237 <div class="modal-body"> 238 <div class="alert alert-info"><p>List all tasks on this cluster</p> 239 </div> 240 241 <!-- Nav tabs --> 242 <ul class="nav nav-tabs"> 243 <li class="active"> 244 <a href="#_tasks_get_request" data-toggle="tab">Request</a> 245 </li> 246 247 <li> 248 <a href="#_tasks_get_response" data-toggle="tab">Response</a> 249 </li> 250 251 </ul> 252 253 <!-- Tab panes --> 254 <div class="tab-content"> 255 <div class="tab-pane active" id="_tasks_get_request"> 256 257 258 259 260 261 </div> 262 263 264 <div class="tab-pane" id="_tasks_get_response"> 265 266 <h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2> 267 268 269 270 271 272 <h3>Body</h3> 273 274 <p><strong>Type: application/json</strong></p> 275 276 277 <strong>Example:</strong> 278 <pre>{ 279 "<span class="hljs-attribute">items</span>": <span class="hljs-value">[ 280 { 281 "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"my-task-1"</span></span>, 282 "<span class="hljs-attribute">labels</span>": <span class="hljs-value">{ 283 "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"testRun"</span></span>, 284 "<span class="hljs-attribute">replicationController</span>": <span class="hljs-value"><span class="hljs-string">"testRun"</span> 285 </span>}</span>, 286 "<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{ 287 "<span class="hljs-attribute">manifest</span>": <span class="hljs-value">{ 288 "<span class="hljs-attribute">containers</span>": <span class="hljs-value">[{ 289 "<span class="hljs-attribute">image</span>": <span class="hljs-value"><span class="hljs-string">"dockerfile/nginx"</span></span>, 290 "<span class="hljs-attribute">ports</span>": <span class="hljs-value">[{ 291 "<span class="hljs-attribute">hostPort</span>": <span class="hljs-value"><span class="hljs-number">8080</span></span>, 292 "<span class="hljs-attribute">containerPort</span>": <span class="hljs-value"><span class="hljs-number">80</span> 293 </span>}] 294 </span>} 295 } 296 }, 297 <span class="hljs-string">"currentState"</span>: { 298 "<span class="hljs-attribute">host</span>": <span class="hljs-value"><span class="hljs-string">"host-1"</span> 299 </span>} 300 }, 301 { 302 "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"my-task-2"</span></span>, 303 "<span class="hljs-attribute">labels</span>": <span class="hljs-value">{ 304 "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"testRun"</span></span>, 305 "<span class="hljs-attribute">replicationController</span>": <span class="hljs-value"><span class="hljs-string">"testRun"</span> 306 </span>}</span>, 307 "<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{ 308 "<span class="hljs-attribute">manifest</span>": <span class="hljs-value">{ 309 "<span class="hljs-attribute">containers</span>": <span class="hljs-value">[{ 310 "<span class="hljs-attribute">image</span>": <span class="hljs-value"><span class="hljs-string">"dockerfile/nginx"</span></span>, 311 "<span class="hljs-attribute">ports</span>": <span class="hljs-value">[{ 312 "<span class="hljs-attribute">hostPort</span>": <span class="hljs-value"><span class="hljs-number">8080</span></span>, 313 "<span class="hljs-attribute">containerPort</span>": <span class="hljs-value"><span class="hljs-number">80</span> 314 </span>}] 315 </span>} 316 } 317 }, 318 <span class="hljs-string">"currentState"</span>: { 319 "<span class="hljs-attribute">host</span>": <span class="hljs-value"><span class="hljs-string">"host-2"</span> 320 </span>} 321 } 322 ] 323 </span>}</span></span></span></span></span></span></pre> 324 325 326 327 328 </div> 329 330 </div> 331 </div> 332 </div> 333 </div> 334 </div> 335 336 <div class="modal fade" id="_tasks_post"> 337 <div class="modal-dialog"> 338 <div class="modal-content"> 339 <div class="modal-header"> 340 <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button> 341 <h4 class="modal-title" id="myModalLabel"> 342 <span class="badge badge_post">post</span> 343 <span class="parent"></span>/tasks 344 </h4> 345 </div> 346 <div class="modal-body"> 347 <div class="alert alert-info"><p>Create a new task. currentState is ignored if present.</p> 348 </div> 349 350 <!-- Nav tabs --> 351 <ul class="nav nav-tabs"> 352 <li class="active"> 353 <a href="#_tasks_post_request" data-toggle="tab">Request</a> 354 </li> 355 356 </ul> 357 358 <!-- Tab panes --> 359 <div class="tab-content"> 360 <div class="tab-pane active" id="_tasks_post_request"> 361 362 363 364 365 366 <h3>Body</h3> 367 368 <p><strong>Type: json/application</strong></p> 369 370 371 <strong>Schema:</strong> 372 <pre>{ 373 "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-03/schema"</span></span>, 374 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 375 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, 376 "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Task resource. A task corresponds to a colocated group of [Docker containers](http://docker.io)."</span></span>, 377 "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ 378 "<span class="hljs-attribute">kind</span>": <span class="hljs-value">{ 379 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 380 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 381 </span>}</span>, 382 "<span class="hljs-attribute">id</span>": <span class="hljs-value">{ 383 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 384 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 385 </span>}</span>, 386 "<span class="hljs-attribute">creationTimestamp</span>": <span class="hljs-value">{ 387 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 388 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 389 </span>}</span>, 390 "<span class="hljs-attribute">selfLink</span>": <span class="hljs-value">{ 391 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 392 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 393 </span>}</span>, 394 "<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{ 395 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 396 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, 397 "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"The desired configuration of the task"</span></span>, 398 "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ 399 "<span class="hljs-attribute">manifest</span>": <span class="hljs-value">{ 400 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 401 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, 402 "<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> 403 </span>}</span>, 404 "<span class="hljs-attribute">status</span>": <span class="hljs-value">{ 405 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 406 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, 407 "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">""</span> 408 </span>}</span>, 409 "<span class="hljs-attribute">host</span>": <span class="hljs-value">{ 410 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 411 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, 412 "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">""</span> 413 </span>}</span>, 414 "<span class="hljs-attribute">hostIP</span>": <span class="hljs-value">{ 415 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 416 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, 417 "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">""</span> 418 </span>}</span>, 419 "<span class="hljs-attribute">info</span>": <span class="hljs-value">{ 420 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 421 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, 422 "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">""</span> 423 </span>} 424 </span>} 425 </span>}</span>, 426 "<span class="hljs-attribute">currentState</span>": <span class="hljs-value">{ 427 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 428 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, 429 "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"The current configuration and status of the task. Fields in common with desiredState have the same meaning."</span></span>, 430 "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ 431 "<span class="hljs-attribute">manifest</span>": <span class="hljs-value">{ 432 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 433 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 434 </span>}</span>, 435 "<span class="hljs-attribute">status</span>": <span class="hljs-value">{ 436 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 437 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 438 </span>}</span>, 439 "<span class="hljs-attribute">host</span>": <span class="hljs-value">{ 440 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 441 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 442 </span>}</span>, 443 "<span class="hljs-attribute">hostIP</span>": <span class="hljs-value">{ 444 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 445 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 446 </span>}</span>, 447 "<span class="hljs-attribute">info</span>": <span class="hljs-value">{ 448 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 449 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 450 </span>} 451 </span>} 452 </span>}</span>, 453 "<span class="hljs-attribute">labels</span>": <span class="hljs-value">{ 454 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 455 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 456 </span>} 457 </span>} 458 </span>} 459 </pre> 460 461 462 <strong>Example:</strong> 463 <pre>{ 464 "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"php"</span></span>, 465 "<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{ 466 "<span class="hljs-attribute">manifest</span>": <span class="hljs-value">{ 467 "<span class="hljs-attribute">containers</span>": <span class="hljs-value">[{ 468 "<span class="hljs-attribute">image</span>": <span class="hljs-value"><span class="hljs-string">"dockerfile/nginx"</span></span>, 469 "<span class="hljs-attribute">ports</span>": <span class="hljs-value">[{ 470 "<span class="hljs-attribute">containerPort</span>": <span class="hljs-value"><span class="hljs-number">80</span></span>, 471 "<span class="hljs-attribute">hostPort</span>": <span class="hljs-value"><span class="hljs-number">8080</span> 472 </span>}] 473 </span>}] 474 </span>} 475 </span>}</span>, 476 "<span class="hljs-attribute">labels</span>": <span class="hljs-value">{ 477 "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"foo"</span> 478 </span>} 479 </span>} 480 481 </pre> 482 483 484 485 </div> 486 487 488 </div> 489 </div> 490 </div> 491 </div> 492 </div> 493 494 </div> 495 496 497 <div class="panel panel-white"> 498 <div class="panel-heading"> 499 <h4 class="panel-title"> 500 <a class="block collapsed" data-toggle="collapse" href="#panel__tasks__taskId_"> 501 502 <span class="badge badge_get">get</span> 503 504 <span class="badge badge_put">put</span> 505 506 <span class="badge badge_delete">delete</span> 507 508 <span class="parent">/tasks</span>/{taskId} 509 </a> 510 </h4> 511 </div> 512 <div id="panel__tasks__taskId_" class="panel-collapse collapse"> 513 <div class="panel-body"> 514 <div class="list-group"> 515 516 <a href="#" data-toggle="modal" data-target="#_tasks__taskId__get" class="list-group-item"> 517 <span class="badge badge_get">get</span> 518 Get a specific task 519 </a> 520 521 <a href="#" data-toggle="modal" data-target="#_tasks__taskId__put" class="list-group-item"> 522 <span class="badge badge_put">put</span> 523 Update a task 524 </a> 525 526 <a href="#" data-toggle="modal" data-target="#_tasks__taskId__delete" class="list-group-item"> 527 <span class="badge badge_delete">delete</span> 528 Delete a specific task 529 </a> 530 531 </div> 532 </div> 533 </div> 534 535 536 <div class="modal fade" id="_tasks__taskId__get"> 537 <div class="modal-dialog"> 538 <div class="modal-content"> 539 <div class="modal-header"> 540 <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button> 541 <h4 class="modal-title" id="myModalLabel"> 542 <span class="badge badge_get">get</span> 543 <span class="parent">/tasks</span>/{taskId} 544 </h4> 545 </div> 546 <div class="modal-body"> 547 <div class="alert alert-info"><p>Get a specific task</p> 548 </div> 549 550 <!-- Nav tabs --> 551 <ul class="nav nav-tabs"> 552 <li class="active"> 553 <a href="#_tasks__taskId__get_request" data-toggle="tab">Request</a> 554 </li> 555 556 <li> 557 <a href="#_tasks__taskId__get_response" data-toggle="tab">Response</a> 558 </li> 559 560 </ul> 561 562 <!-- Tab panes --> 563 <div class="tab-content"> 564 <div class="tab-pane active" id="_tasks__taskId__get_request"> 565 566 <h3>URI Parameters</h3> 567 <ul> 568 569 <li><strong>taskId</strong>: string</li> 570 571 </ul> 572 573 574 575 576 577 </div> 578 579 580 <div class="tab-pane" id="_tasks__taskId__get_response"> 581 582 <h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2> 583 584 585 586 587 588 <h3>Body</h3> 589 590 <p><strong>Type: application/json</strong></p> 591 592 593 <strong>Example:</strong> 594 <pre>{ 595 "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"php"</span></span>, 596 "<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{ 597 "<span class="hljs-attribute">manifest</span>": <span class="hljs-value">{ 598 "<span class="hljs-attribute">containers</span>": <span class="hljs-value">[{ 599 "<span class="hljs-attribute">image</span>": <span class="hljs-value"><span class="hljs-string">"dockerfile/nginx"</span></span>, 600 "<span class="hljs-attribute">ports</span>": <span class="hljs-value">[{ 601 "<span class="hljs-attribute">containerPort</span>": <span class="hljs-value"><span class="hljs-number">80</span></span>, 602 "<span class="hljs-attribute">hostPort</span>": <span class="hljs-value"><span class="hljs-number">8080</span> 603 </span>}] 604 </span>}] 605 </span>} 606 </span>}</span>, 607 "<span class="hljs-attribute">labels</span>": <span class="hljs-value">{ 608 "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"foo"</span> 609 </span>} 610 </span>} 611 612 </pre> 613 614 615 616 617 </div> 618 619 </div> 620 </div> 621 </div> 622 </div> 623 </div> 624 625 <div class="modal fade" id="_tasks__taskId__put"> 626 <div class="modal-dialog"> 627 <div class="modal-content"> 628 <div class="modal-header"> 629 <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button> 630 <h4 class="modal-title" id="myModalLabel"> 631 <span class="badge badge_put">put</span> 632 <span class="parent">/tasks</span>/{taskId} 633 </h4> 634 </div> 635 <div class="modal-body"> 636 <div class="alert alert-info"><p>Update a task</p> 637 </div> 638 639 <!-- Nav tabs --> 640 <ul class="nav nav-tabs"> 641 <li class="active"> 642 <a href="#_tasks__taskId__put_request" data-toggle="tab">Request</a> 643 </li> 644 645 </ul> 646 647 <!-- Tab panes --> 648 <div class="tab-content"> 649 <div class="tab-pane active" id="_tasks__taskId__put_request"> 650 651 <h3>URI Parameters</h3> 652 <ul> 653 654 <li><strong>taskId</strong>: string</li> 655 656 </ul> 657 658 659 660 661 662 <h3>Body</h3> 663 664 <p><strong>Type: json/application</strong></p> 665 666 667 <strong>Schema:</strong> 668 <pre>{ 669 "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-03/schema"</span></span>, 670 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 671 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, 672 "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Task resource. A task corresponds to a colocated group of [Docker containers](http://docker.io)."</span></span>, 673 "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ 674 "<span class="hljs-attribute">kind</span>": <span class="hljs-value">{ 675 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 676 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 677 </span>}</span>, 678 "<span class="hljs-attribute">id</span>": <span class="hljs-value">{ 679 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 680 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 681 </span>}</span>, 682 "<span class="hljs-attribute">creationTimestamp</span>": <span class="hljs-value">{ 683 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 684 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 685 </span>}</span>, 686 "<span class="hljs-attribute">selfLink</span>": <span class="hljs-value">{ 687 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 688 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 689 </span>}</span>, 690 "<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{ 691 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 692 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, 693 "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"The desired configuration of the task"</span></span>, 694 "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ 695 "<span class="hljs-attribute">manifest</span>": <span class="hljs-value">{ 696 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 697 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, 698 "<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> 699 </span>}</span>, 700 "<span class="hljs-attribute">status</span>": <span class="hljs-value">{ 701 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 702 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, 703 "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">""</span> 704 </span>}</span>, 705 "<span class="hljs-attribute">host</span>": <span class="hljs-value">{ 706 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 707 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, 708 "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">""</span> 709 </span>}</span>, 710 "<span class="hljs-attribute">hostIP</span>": <span class="hljs-value">{ 711 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 712 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, 713 "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">""</span> 714 </span>}</span>, 715 "<span class="hljs-attribute">info</span>": <span class="hljs-value">{ 716 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 717 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, 718 "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">""</span> 719 </span>} 720 </span>} 721 </span>}</span>, 722 "<span class="hljs-attribute">currentState</span>": <span class="hljs-value">{ 723 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 724 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, 725 "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"The current configuration and status of the task. Fields in common with desiredState have the same meaning."</span></span>, 726 "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ 727 "<span class="hljs-attribute">manifest</span>": <span class="hljs-value">{ 728 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 729 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 730 </span>}</span>, 731 "<span class="hljs-attribute">status</span>": <span class="hljs-value">{ 732 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 733 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 734 </span>}</span>, 735 "<span class="hljs-attribute">host</span>": <span class="hljs-value">{ 736 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 737 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 738 </span>}</span>, 739 "<span class="hljs-attribute">hostIP</span>": <span class="hljs-value">{ 740 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 741 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 742 </span>}</span>, 743 "<span class="hljs-attribute">info</span>": <span class="hljs-value">{ 744 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 745 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 746 </span>} 747 </span>} 748 </span>}</span>, 749 "<span class="hljs-attribute">labels</span>": <span class="hljs-value">{ 750 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 751 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 752 </span>} 753 </span>} 754 </span>} 755 </pre> 756 757 758 <strong>Example:</strong> 759 <pre>{ 760 "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"php"</span></span>, 761 "<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{ 762 "<span class="hljs-attribute">manifest</span>": <span class="hljs-value">{ 763 "<span class="hljs-attribute">containers</span>": <span class="hljs-value">[{ 764 "<span class="hljs-attribute">image</span>": <span class="hljs-value"><span class="hljs-string">"dockerfile/nginx"</span></span>, 765 "<span class="hljs-attribute">ports</span>": <span class="hljs-value">[{ 766 "<span class="hljs-attribute">containerPort</span>": <span class="hljs-value"><span class="hljs-number">80</span></span>, 767 "<span class="hljs-attribute">hostPort</span>": <span class="hljs-value"><span class="hljs-number">8080</span> 768 </span>}] 769 </span>}] 770 </span>} 771 </span>}</span>, 772 "<span class="hljs-attribute">labels</span>": <span class="hljs-value">{ 773 "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"foo"</span> 774 </span>} 775 </span>} 776 777 </pre> 778 779 780 781 </div> 782 783 784 </div> 785 </div> 786 </div> 787 </div> 788 </div> 789 790 <div class="modal fade" id="_tasks__taskId__delete"> 791 <div class="modal-dialog"> 792 <div class="modal-content"> 793 <div class="modal-header"> 794 <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button> 795 <h4 class="modal-title" id="myModalLabel"> 796 <span class="badge badge_delete">delete</span> 797 <span class="parent">/tasks</span>/{taskId} 798 </h4> 799 </div> 800 <div class="modal-body"> 801 <div class="alert alert-info"><p>Delete a specific task</p> 802 </div> 803 804 <!-- Nav tabs --> 805 <ul class="nav nav-tabs"> 806 <li class="active"> 807 <a href="#_tasks__taskId__delete_request" data-toggle="tab">Request</a> 808 </li> 809 810 <li> 811 <a href="#_tasks__taskId__delete_response" data-toggle="tab">Response</a> 812 </li> 813 814 </ul> 815 816 <!-- Tab panes --> 817 <div class="tab-content"> 818 <div class="tab-pane active" id="_tasks__taskId__delete_request"> 819 820 <h3>URI Parameters</h3> 821 <ul> 822 823 <li><strong>taskId</strong>: string</li> 824 825 </ul> 826 827 828 829 830 831 </div> 832 833 834 <div class="tab-pane" id="_tasks__taskId__delete_response"> 835 836 <h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2> 837 838 839 840 841 842 <h3>Body</h3> 843 844 <p><strong>Type: application/json</strong></p> 845 846 847 <strong>Example:</strong> 848 <pre>{ 849 "<span class="hljs-attribute">success</span>": <span class="hljs-value"><span class="hljs-literal">true</span> 850 </span>} 851 </pre> 852 853 854 855 856 </div> 857 858 </div> 859 </div> 860 </div> 861 </div> 862 </div> 863 864 </div> 865 866 867 868 869 870 </div> 871 </div> 872 </div> 873 874 <div class="panel panel-default"> 875 <div class="panel-heading"> 876 <h3 id="_replicationControllers" class="panel-title">/replicationControllers</h3> 877 </div> 878 879 <div class="panel-body"> 880 881 882 <div class="panel-group"> 883 <div class="panel panel-white"> 884 <div class="panel-heading"> 885 <h4 class="panel-title"> 886 <a class="block collapsed" data-toggle="collapse" href="#panel__replicationControllers"> 887 888 <span class="badge badge_get">get</span> 889 890 <span class="badge badge_post">post</span> 891 892 <span class="parent"></span>/replicationControllers 893 </a> 894 </h4> 895 </div> 896 <div id="panel__replicationControllers" class="panel-collapse collapse"> 897 <div class="panel-body"> 898 <div class="list-group"> 899 900 <a href="#" data-toggle="modal" data-target="#_replicationControllers_get" class="list-group-item"> 901 <span class="badge badge_get">get</span> 902 List all replicationControllers on this cluster 903 </a> 904 905 <a href="#" data-toggle="modal" data-target="#_replicationControllers_post" class="list-group-item"> 906 <span class="badge badge_post">post</span> 907 Create a new controller. currentState is ignored if present. 908 </a> 909 910 </div> 911 </div> 912 </div> 913 914 915 <div class="modal fade" id="_replicationControllers_get"> 916 <div class="modal-dialog"> 917 <div class="modal-content"> 918 <div class="modal-header"> 919 <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button> 920 <h4 class="modal-title" id="myModalLabel"> 921 <span class="badge badge_get">get</span> 922 <span class="parent"></span>/replicationControllers 923 </h4> 924 </div> 925 <div class="modal-body"> 926 <div class="alert alert-info"><p>List all replicationControllers on this cluster</p> 927 </div> 928 929 <!-- Nav tabs --> 930 <ul class="nav nav-tabs"> 931 <li class="active"> 932 <a href="#_replicationControllers_get_request" data-toggle="tab">Request</a> 933 </li> 934 935 <li> 936 <a href="#_replicationControllers_get_response" data-toggle="tab">Response</a> 937 </li> 938 939 </ul> 940 941 <!-- Tab panes --> 942 <div class="tab-content"> 943 <div class="tab-pane active" id="_replicationControllers_get_request"> 944 945 946 947 948 949 </div> 950 951 952 <div class="tab-pane" id="_replicationControllers_get_response"> 953 954 <h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2> 955 956 957 958 959 960 <h3>Body</h3> 961 962 <p><strong>Type: application/json</strong></p> 963 964 965 <strong>Example:</strong> 966 <pre>{ 967 "<span class="hljs-attribute">items</span>": <span class="hljs-value">[ 968 { 969 "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"testRun"</span></span>, 970 "<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{ 971 "<span class="hljs-attribute">replicas</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>, 972 "<span class="hljs-attribute">replicasInSet</span>": <span class="hljs-value">{ 973 "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"testRun"</span> 974 </span>}</span>, 975 "<span class="hljs-attribute">taskTemplate</span>": <span class="hljs-value">{ 976 "<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{ 977 "<span class="hljs-attribute">image</span>": <span class="hljs-value"><span class="hljs-string">"dockerfile/nginx"</span></span>, 978 "<span class="hljs-attribute">networkPorts</span>": <span class="hljs-value">[ 979 { 980 "<span class="hljs-attribute">hostPort</span>": <span class="hljs-value"><span class="hljs-number">8080</span></span>, 981 "<span class="hljs-attribute">containerPort</span>": <span class="hljs-value"><span class="hljs-number">80</span> 982 </span>} 983 ] 984 </span>}</span>, 985 "<span class="hljs-attribute">labels</span>": <span class="hljs-value">{ 986 "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"testRun"</span> 987 </span>} 988 </span>} 989 </span>}</span>, 990 "<span class="hljs-attribute">labels</span>": <span class="hljs-value">{ 991 "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"testRun"</span> 992 </span>} 993 </span>} 994 ] 995 </span>}</pre> 996 997 998 999 1000 </div> 1001 1002 </div> 1003 </div> 1004 </div> 1005 </div> 1006 </div> 1007 1008 <div class="modal fade" id="_replicationControllers_post"> 1009 <div class="modal-dialog"> 1010 <div class="modal-content"> 1011 <div class="modal-header"> 1012 <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button> 1013 <h4 class="modal-title" id="myModalLabel"> 1014 <span class="badge badge_post">post</span> 1015 <span class="parent"></span>/replicationControllers 1016 </h4> 1017 </div> 1018 <div class="modal-body"> 1019 <div class="alert alert-info"><p>Create a new controller. currentState is ignored if present.</p> 1020 </div> 1021 1022 <!-- Nav tabs --> 1023 <ul class="nav nav-tabs"> 1024 <li class="active"> 1025 <a href="#_replicationControllers_post_request" data-toggle="tab">Request</a> 1026 </li> 1027 1028 </ul> 1029 1030 <!-- Tab panes --> 1031 <div class="tab-content"> 1032 <div class="tab-pane active" id="_replicationControllers_post_request"> 1033 1034 1035 1036 1037 1038 <h3>Body</h3> 1039 1040 <p><strong>Type: json/application</strong></p> 1041 1042 1043 <strong>Schema:</strong> 1044 <pre>{ 1045 "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-03/schema"</span></span>, 1046 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 1047 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, 1048 "<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 tasks. It acts as a factory to create new tasks based on a template. It ensures that there are a specific number of tasks running. If fewer tasks are running than `replicas` then the needed tasks are generated using `taskTemplate`. If more tasks are running than `replicas`, then excess tasks are deleted."</span></span>, 1049 "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ 1050 "<span class="hljs-attribute">kind</span>": <span class="hljs-value">{ 1051 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 1052 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 1053 </span>}</span>, 1054 "<span class="hljs-attribute">id</span>": <span class="hljs-value">{ 1055 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 1056 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 1057 </span>}</span>, 1058 "<span class="hljs-attribute">creationTimestamp</span>": <span class="hljs-value">{ 1059 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 1060 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 1061 </span>}</span>, 1062 "<span class="hljs-attribute">selfLink</span>": <span class="hljs-value">{ 1063 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 1064 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 1065 </span>}</span>, 1066 "<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{ 1067 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 1068 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, 1069 "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"The desired configuration of the replicationController"</span></span>, 1070 "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ 1071 "<span class="hljs-attribute">replicas</span>": <span class="hljs-value">{ 1072 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>, 1073 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, 1074 "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Number of tasks desired in the set"</span> 1075 </span>}</span>, 1076 "<span class="hljs-attribute">replicasInSet</span>": <span class="hljs-value">{ 1077 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 1078 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, 1079 "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Required labels used to identify tasks in the set"</span> 1080 </span>}</span>, 1081 "<span class="hljs-attribute">taskTemplate</span>": <span class="hljs-value">{ 1082 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 1083 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, 1084 "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Template from which to create new tasks, as necessary. Identical to task schema."</span> 1085 </span>} 1086 </span>} 1087 </span>}</span>, 1088 "<span class="hljs-attribute">labels</span>": <span class="hljs-value">{ 1089 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 1090 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 1091 </span>} 1092 </span>} 1093 </span>} 1094 </pre> 1095 1096 1097 <strong>Example:</strong> 1098 <pre> { 1099 "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"nginxController"</span></span>, 1100 "<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{ 1101 "<span class="hljs-attribute">replicas</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>, 1102 "<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>, 1103 "<span class="hljs-attribute">taskTemplate</span>": <span class="hljs-value">{ 1104 "<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{ 1105 "<span class="hljs-attribute">manifest</span>": <span class="hljs-value">{ 1106 "<span class="hljs-attribute">containers</span>": <span class="hljs-value">[{ 1107 "<span class="hljs-attribute">image</span>": <span class="hljs-value"><span class="hljs-string">"dockerfile/nginx"</span></span>, 1108 "<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>}] 1109 </span>}] 1110 </span>} 1111 </span>}</span>, 1112 "<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>} 1113 </span>}</span>}</span>, 1114 "<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>} 1115 </span>} 1116 </pre> 1117 1118 1119 1120 </div> 1121 1122 1123 </div> 1124 </div> 1125 </div> 1126 </div> 1127 </div> 1128 1129 </div> 1130 1131 1132 <div class="panel panel-white"> 1133 <div class="panel-heading"> 1134 <h4 class="panel-title"> 1135 <a class="block collapsed" data-toggle="collapse" href="#panel__replicationControllers__controllerId_"> 1136 1137 <span class="badge badge_get">get</span> 1138 1139 <span class="badge badge_put">put</span> 1140 1141 <span class="badge badge_delete">delete</span> 1142 1143 <span class="parent">/replicationControllers</span>/{controllerId} 1144 </a> 1145 </h4> 1146 </div> 1147 <div id="panel__replicationControllers__controllerId_" class="panel-collapse collapse"> 1148 <div class="panel-body"> 1149 <div class="list-group"> 1150 1151 <a href="#" data-toggle="modal" data-target="#_replicationControllers__controllerId__get" class="list-group-item"> 1152 <span class="badge badge_get">get</span> 1153 Get a specific controller 1154 </a> 1155 1156 <a href="#" data-toggle="modal" data-target="#_replicationControllers__controllerId__put" class="list-group-item"> 1157 <span class="badge badge_put">put</span> 1158 Update a controller 1159 </a> 1160 1161 <a href="#" data-toggle="modal" data-target="#_replicationControllers__controllerId__delete" class="list-group-item"> 1162 <span class="badge badge_delete">delete</span> 1163 Delete a specific controller 1164 </a> 1165 1166 </div> 1167 </div> 1168 </div> 1169 1170 1171 <div class="modal fade" id="_replicationControllers__controllerId__get"> 1172 <div class="modal-dialog"> 1173 <div class="modal-content"> 1174 <div class="modal-header"> 1175 <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button> 1176 <h4 class="modal-title" id="myModalLabel"> 1177 <span class="badge badge_get">get</span> 1178 <span class="parent">/replicationControllers</span>/{controllerId} 1179 </h4> 1180 </div> 1181 <div class="modal-body"> 1182 <div class="alert alert-info"><p>Get a specific controller</p> 1183 </div> 1184 1185 <!-- Nav tabs --> 1186 <ul class="nav nav-tabs"> 1187 <li class="active"> 1188 <a href="#_replicationControllers__controllerId__get_request" data-toggle="tab">Request</a> 1189 </li> 1190 1191 <li> 1192 <a href="#_replicationControllers__controllerId__get_response" data-toggle="tab">Response</a> 1193 </li> 1194 1195 </ul> 1196 1197 <!-- Tab panes --> 1198 <div class="tab-content"> 1199 <div class="tab-pane active" id="_replicationControllers__controllerId__get_request"> 1200 1201 <h3>URI Parameters</h3> 1202 <ul> 1203 1204 <li><strong>controllerId</strong>: string</li> 1205 1206 </ul> 1207 1208 1209 1210 1211 1212 </div> 1213 1214 1215 <div class="tab-pane" id="_replicationControllers__controllerId__get_response"> 1216 1217 <h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2> 1218 1219 1220 1221 1222 1223 <h3>Body</h3> 1224 1225 <p><strong>Type: application/json</strong></p> 1226 1227 1228 <strong>Example:</strong> 1229 <pre> { 1230 "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"nginxController"</span></span>, 1231 "<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{ 1232 "<span class="hljs-attribute">replicas</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>, 1233 "<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>, 1234 "<span class="hljs-attribute">taskTemplate</span>": <span class="hljs-value">{ 1235 "<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{ 1236 "<span class="hljs-attribute">manifest</span>": <span class="hljs-value">{ 1237 "<span class="hljs-attribute">containers</span>": <span class="hljs-value">[{ 1238 "<span class="hljs-attribute">image</span>": <span class="hljs-value"><span class="hljs-string">"dockerfile/nginx"</span></span>, 1239 "<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>}] 1240 </span>}] 1241 </span>} 1242 </span>}</span>, 1243 "<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>} 1244 </span>}</span>}</span>, 1245 "<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>} 1246 </span>} 1247 </pre> 1248 1249 1250 1251 1252 </div> 1253 1254 </div> 1255 </div> 1256 </div> 1257 </div> 1258 </div> 1259 1260 <div class="modal fade" id="_replicationControllers__controllerId__put"> 1261 <div class="modal-dialog"> 1262 <div class="modal-content"> 1263 <div class="modal-header"> 1264 <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button> 1265 <h4 class="modal-title" id="myModalLabel"> 1266 <span class="badge badge_put">put</span> 1267 <span class="parent">/replicationControllers</span>/{controllerId} 1268 </h4> 1269 </div> 1270 <div class="modal-body"> 1271 <div class="alert alert-info"><p>Update a controller</p> 1272 </div> 1273 1274 <!-- Nav tabs --> 1275 <ul class="nav nav-tabs"> 1276 <li class="active"> 1277 <a href="#_replicationControllers__controllerId__put_request" data-toggle="tab">Request</a> 1278 </li> 1279 1280 </ul> 1281 1282 <!-- Tab panes --> 1283 <div class="tab-content"> 1284 <div class="tab-pane active" id="_replicationControllers__controllerId__put_request"> 1285 1286 <h3>URI Parameters</h3> 1287 <ul> 1288 1289 <li><strong>controllerId</strong>: string</li> 1290 1291 </ul> 1292 1293 1294 1295 1296 1297 <h3>Body</h3> 1298 1299 <p><strong>Type: json/application</strong></p> 1300 1301 1302 <strong>Schema:</strong> 1303 <pre>{ 1304 "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-03/schema"</span></span>, 1305 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 1306 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, 1307 "<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 tasks. It acts as a factory to create new tasks based on a template. It ensures that there are a specific number of tasks running. If fewer tasks are running than `replicas` then the needed tasks are generated using `taskTemplate`. If more tasks are running than `replicas`, then excess tasks are deleted."</span></span>, 1308 "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ 1309 "<span class="hljs-attribute">kind</span>": <span class="hljs-value">{ 1310 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 1311 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 1312 </span>}</span>, 1313 "<span class="hljs-attribute">id</span>": <span class="hljs-value">{ 1314 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 1315 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 1316 </span>}</span>, 1317 "<span class="hljs-attribute">creationTimestamp</span>": <span class="hljs-value">{ 1318 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 1319 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 1320 </span>}</span>, 1321 "<span class="hljs-attribute">selfLink</span>": <span class="hljs-value">{ 1322 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 1323 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 1324 </span>}</span>, 1325 "<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{ 1326 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 1327 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, 1328 "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"The desired configuration of the replicationController"</span></span>, 1329 "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ 1330 "<span class="hljs-attribute">replicas</span>": <span class="hljs-value">{ 1331 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>, 1332 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, 1333 "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Number of tasks desired in the set"</span> 1334 </span>}</span>, 1335 "<span class="hljs-attribute">replicasInSet</span>": <span class="hljs-value">{ 1336 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 1337 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, 1338 "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Required labels used to identify tasks in the set"</span> 1339 </span>}</span>, 1340 "<span class="hljs-attribute">taskTemplate</span>": <span class="hljs-value">{ 1341 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 1342 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, 1343 "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Template from which to create new tasks, as necessary. Identical to task schema."</span> 1344 </span>} 1345 </span>} 1346 </span>}</span>, 1347 "<span class="hljs-attribute">labels</span>": <span class="hljs-value">{ 1348 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 1349 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 1350 </span>} 1351 </span>} 1352 </span>} 1353 </pre> 1354 1355 1356 <strong>Example:</strong> 1357 <pre> { 1358 "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"nginxController"</span></span>, 1359 "<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{ 1360 "<span class="hljs-attribute">replicas</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>, 1361 "<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>, 1362 "<span class="hljs-attribute">taskTemplate</span>": <span class="hljs-value">{ 1363 "<span class="hljs-attribute">desiredState</span>": <span class="hljs-value">{ 1364 "<span class="hljs-attribute">manifest</span>": <span class="hljs-value">{ 1365 "<span class="hljs-attribute">containers</span>": <span class="hljs-value">[{ 1366 "<span class="hljs-attribute">image</span>": <span class="hljs-value"><span class="hljs-string">"dockerfile/nginx"</span></span>, 1367 "<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>}] 1368 </span>}] 1369 </span>} 1370 </span>}</span>, 1371 "<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>} 1372 </span>}</span>}</span>, 1373 "<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>} 1374 </span>} 1375 </pre> 1376 1377 1378 1379 </div> 1380 1381 1382 </div> 1383 </div> 1384 </div> 1385 </div> 1386 </div> 1387 1388 <div class="modal fade" id="_replicationControllers__controllerId__delete"> 1389 <div class="modal-dialog"> 1390 <div class="modal-content"> 1391 <div class="modal-header"> 1392 <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button> 1393 <h4 class="modal-title" id="myModalLabel"> 1394 <span class="badge badge_delete">delete</span> 1395 <span class="parent">/replicationControllers</span>/{controllerId} 1396 </h4> 1397 </div> 1398 <div class="modal-body"> 1399 <div class="alert alert-info"><p>Delete a specific controller</p> 1400 </div> 1401 1402 <!-- Nav tabs --> 1403 <ul class="nav nav-tabs"> 1404 <li class="active"> 1405 <a href="#_replicationControllers__controllerId__delete_request" data-toggle="tab">Request</a> 1406 </li> 1407 1408 <li> 1409 <a href="#_replicationControllers__controllerId__delete_response" data-toggle="tab">Response</a> 1410 </li> 1411 1412 </ul> 1413 1414 <!-- Tab panes --> 1415 <div class="tab-content"> 1416 <div class="tab-pane active" id="_replicationControllers__controllerId__delete_request"> 1417 1418 <h3>URI Parameters</h3> 1419 <ul> 1420 1421 <li><strong>controllerId</strong>: string</li> 1422 1423 </ul> 1424 1425 1426 1427 1428 1429 </div> 1430 1431 1432 <div class="tab-pane" id="_replicationControllers__controllerId__delete_response"> 1433 1434 <h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2> 1435 1436 1437 1438 1439 1440 <h3>Body</h3> 1441 1442 <p><strong>Type: application/json</strong></p> 1443 1444 1445 <strong>Example:</strong> 1446 <pre>{ 1447 "<span class="hljs-attribute">success</span>": <span class="hljs-value"><span class="hljs-literal">true</span> 1448 </span>} 1449 </pre> 1450 1451 1452 1453 1454 </div> 1455 1456 </div> 1457 </div> 1458 </div> 1459 </div> 1460 </div> 1461 1462 </div> 1463 1464 1465 1466 1467 1468 </div> 1469 </div> 1470 </div> 1471 1472 <div class="panel panel-default"> 1473 <div class="panel-heading"> 1474 <h3 id="_services" class="panel-title">/services</h3> 1475 </div> 1476 1477 <div class="panel-body"> 1478 1479 1480 <div class="panel-group"> 1481 <div class="panel panel-white"> 1482 <div class="panel-heading"> 1483 <h4 class="panel-title"> 1484 <a class="block collapsed" data-toggle="collapse" href="#panel__services"> 1485 1486 <span class="badge badge_get">get</span> 1487 1488 <span class="badge badge_post">post</span> 1489 1490 <span class="parent"></span>/services 1491 </a> 1492 </h4> 1493 </div> 1494 <div id="panel__services" class="panel-collapse collapse"> 1495 <div class="panel-body"> 1496 <div class="list-group"> 1497 1498 <a href="#" data-toggle="modal" data-target="#_services_get" class="list-group-item"> 1499 <span class="badge badge_get">get</span> 1500 List all services on this cluster 1501 </a> 1502 1503 <a href="#" data-toggle="modal" data-target="#_services_post" class="list-group-item"> 1504 <span class="badge badge_post">post</span> 1505 Create a new service 1506 </a> 1507 1508 </div> 1509 </div> 1510 </div> 1511 1512 1513 <div class="modal fade" id="_services_get"> 1514 <div class="modal-dialog"> 1515 <div class="modal-content"> 1516 <div class="modal-header"> 1517 <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button> 1518 <h4 class="modal-title" id="myModalLabel"> 1519 <span class="badge badge_get">get</span> 1520 <span class="parent"></span>/services 1521 </h4> 1522 </div> 1523 <div class="modal-body"> 1524 <div class="alert alert-info"><p>List all services on this cluster</p> 1525 </div> 1526 1527 <!-- Nav tabs --> 1528 <ul class="nav nav-tabs"> 1529 <li class="active"> 1530 <a href="#_services_get_request" data-toggle="tab">Request</a> 1531 </li> 1532 1533 <li> 1534 <a href="#_services_get_response" data-toggle="tab">Response</a> 1535 </li> 1536 1537 </ul> 1538 1539 <!-- Tab panes --> 1540 <div class="tab-content"> 1541 <div class="tab-pane active" id="_services_get_request"> 1542 1543 1544 1545 1546 1547 </div> 1548 1549 1550 <div class="tab-pane" id="_services_get_response"> 1551 1552 <h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2> 1553 1554 1555 1556 1557 1558 <h3>Body</h3> 1559 1560 <p><strong>Type: application/json</strong></p> 1561 1562 1563 <strong>Example:</strong> 1564 <pre>{ 1565 "<span class="hljs-attribute">items</span>": <span class="hljs-value">[ 1566 { 1567 "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"example1"</span></span>, 1568 "<span class="hljs-attribute">port</span>": <span class="hljs-value"><span class="hljs-number">8000</span></span>, 1569 "<span class="hljs-attribute">labels</span>": <span class="hljs-value">{ 1570 "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"nginx"</span> 1571 </span>} 1572 </span>}, 1573 { 1574 "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"example2"</span></span>, 1575 "<span class="hljs-attribute">port</span>": <span class="hljs-value"><span class="hljs-number">8080</span></span>, 1576 "<span class="hljs-attribute">labels</span>": <span class="hljs-value">{ 1577 "<span class="hljs-attribute">env</span>": <span class="hljs-value"><span class="hljs-string">"prod"</span></span>, 1578 "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"jetty"</span> 1579 </span>} 1580 </span>} 1581 ] 1582 </span>} 1583 </pre> 1584 1585 1586 1587 1588 </div> 1589 1590 </div> 1591 </div> 1592 </div> 1593 </div> 1594 </div> 1595 1596 <div class="modal fade" id="_services_post"> 1597 <div class="modal-dialog"> 1598 <div class="modal-content"> 1599 <div class="modal-header"> 1600 <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button> 1601 <h4 class="modal-title" id="myModalLabel"> 1602 <span class="badge badge_post">post</span> 1603 <span class="parent"></span>/services 1604 </h4> 1605 </div> 1606 <div class="modal-body"> 1607 <div class="alert alert-info"><p>Create a new service</p> 1608 </div> 1609 1610 <!-- Nav tabs --> 1611 <ul class="nav nav-tabs"> 1612 <li class="active"> 1613 <a href="#_services_post_request" data-toggle="tab">Request</a> 1614 </li> 1615 1616 </ul> 1617 1618 <!-- Tab panes --> 1619 <div class="tab-content"> 1620 <div class="tab-pane active" id="_services_post_request"> 1621 1622 1623 1624 1625 1626 <h3>Body</h3> 1627 1628 <p><strong>Type: json/application</strong></p> 1629 1630 1631 <strong>Schema:</strong> 1632 <pre>{ 1633 "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-03/schema"</span></span>, 1634 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 1635 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, 1636 "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"A service resource."</span></span>, 1637 "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ 1638 "<span class="hljs-attribute">kind</span>": <span class="hljs-value">{ 1639 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 1640 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 1641 </span>}</span>, 1642 "<span class="hljs-attribute">id</span>": <span class="hljs-value">{ 1643 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 1644 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 1645 </span>}</span>, 1646 "<span class="hljs-attribute">creationTimestamp</span>": <span class="hljs-value">{ 1647 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 1648 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 1649 </span>}</span>, 1650 "<span class="hljs-attribute">selfLink</span>": <span class="hljs-value">{ 1651 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 1652 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 1653 </span>}</span>, 1654 "<span class="hljs-attribute">name</span>": <span class="hljs-value">{ 1655 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 1656 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 1657 </span>}</span>, 1658 "<span class="hljs-attribute">port</span>": <span class="hljs-value">{ 1659 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>, 1660 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 1661 </span>}</span>, 1662 "<span class="hljs-attribute">labels</span>": <span class="hljs-value">{ 1663 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 1664 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 1665 </span>} 1666 </span>} 1667 </span>} 1668 </pre> 1669 1670 1671 <strong>Example:</strong> 1672 <pre>{ 1673 "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"example2"</span></span>, 1674 "<span class="hljs-attribute">port</span>": <span class="hljs-value"><span class="hljs-number">8000</span></span>, 1675 "<span class="hljs-attribute">labels</span>": <span class="hljs-value">{ 1676 "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"nginx"</span> 1677 </span>} 1678 </span>} 1679 </pre> 1680 1681 1682 1683 </div> 1684 1685 1686 </div> 1687 </div> 1688 </div> 1689 </div> 1690 </div> 1691 1692 </div> 1693 1694 1695 <div class="panel panel-white"> 1696 <div class="panel-heading"> 1697 <h4 class="panel-title"> 1698 <a class="block collapsed" data-toggle="collapse" href="#panel__services__serviceId_"> 1699 1700 <span class="badge badge_get">get</span> 1701 1702 <span class="badge badge_put">put</span> 1703 1704 <span class="badge badge_delete">delete</span> 1705 1706 <span class="parent">/services</span>/{serviceId} 1707 </a> 1708 </h4> 1709 </div> 1710 <div id="panel__services__serviceId_" class="panel-collapse collapse"> 1711 <div class="panel-body"> 1712 <div class="list-group"> 1713 1714 <a href="#" data-toggle="modal" data-target="#_services__serviceId__get" class="list-group-item"> 1715 <span class="badge badge_get">get</span> 1716 Get a specific service 1717 </a> 1718 1719 <a href="#" data-toggle="modal" data-target="#_services__serviceId__put" class="list-group-item"> 1720 <span class="badge badge_put">put</span> 1721 Update a service 1722 </a> 1723 1724 <a href="#" data-toggle="modal" data-target="#_services__serviceId__delete" class="list-group-item"> 1725 <span class="badge badge_delete">delete</span> 1726 Delete a specific service 1727 </a> 1728 1729 </div> 1730 </div> 1731 </div> 1732 1733 1734 <div class="modal fade" id="_services__serviceId__get"> 1735 <div class="modal-dialog"> 1736 <div class="modal-content"> 1737 <div class="modal-header"> 1738 <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button> 1739 <h4 class="modal-title" id="myModalLabel"> 1740 <span class="badge badge_get">get</span> 1741 <span class="parent">/services</span>/{serviceId} 1742 </h4> 1743 </div> 1744 <div class="modal-body"> 1745 <div class="alert alert-info"><p>Get a specific service</p> 1746 </div> 1747 1748 <!-- Nav tabs --> 1749 <ul class="nav nav-tabs"> 1750 <li class="active"> 1751 <a href="#_services__serviceId__get_request" data-toggle="tab">Request</a> 1752 </li> 1753 1754 <li> 1755 <a href="#_services__serviceId__get_response" data-toggle="tab">Response</a> 1756 </li> 1757 1758 </ul> 1759 1760 <!-- Tab panes --> 1761 <div class="tab-content"> 1762 <div class="tab-pane active" id="_services__serviceId__get_request"> 1763 1764 <h3>URI Parameters</h3> 1765 <ul> 1766 1767 <li><strong>serviceId</strong>: string</li> 1768 1769 </ul> 1770 1771 1772 1773 1774 1775 </div> 1776 1777 1778 <div class="tab-pane" id="_services__serviceId__get_response"> 1779 1780 <h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2> 1781 1782 1783 1784 1785 1786 <h3>Body</h3> 1787 1788 <p><strong>Type: application/json</strong></p> 1789 1790 1791 <strong>Example:</strong> 1792 <pre>{ 1793 "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"example2"</span></span>, 1794 "<span class="hljs-attribute">port</span>": <span class="hljs-value"><span class="hljs-number">8000</span></span>, 1795 "<span class="hljs-attribute">labels</span>": <span class="hljs-value">{ 1796 "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"nginx"</span> 1797 </span>} 1798 </span>} 1799 </pre> 1800 1801 1802 1803 1804 </div> 1805 1806 </div> 1807 </div> 1808 </div> 1809 </div> 1810 </div> 1811 1812 <div class="modal fade" id="_services__serviceId__put"> 1813 <div class="modal-dialog"> 1814 <div class="modal-content"> 1815 <div class="modal-header"> 1816 <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button> 1817 <h4 class="modal-title" id="myModalLabel"> 1818 <span class="badge badge_put">put</span> 1819 <span class="parent">/services</span>/{serviceId} 1820 </h4> 1821 </div> 1822 <div class="modal-body"> 1823 <div class="alert alert-info"><p>Update a service</p> 1824 </div> 1825 1826 <!-- Nav tabs --> 1827 <ul class="nav nav-tabs"> 1828 <li class="active"> 1829 <a href="#_services__serviceId__put_request" data-toggle="tab">Request</a> 1830 </li> 1831 1832 </ul> 1833 1834 <!-- Tab panes --> 1835 <div class="tab-content"> 1836 <div class="tab-pane active" id="_services__serviceId__put_request"> 1837 1838 <h3>URI Parameters</h3> 1839 <ul> 1840 1841 <li><strong>serviceId</strong>: string</li> 1842 1843 </ul> 1844 1845 1846 1847 1848 1849 <h3>Body</h3> 1850 1851 <p><strong>Type: json/application</strong></p> 1852 1853 1854 <strong>Schema:</strong> 1855 <pre>{ 1856 "<span class="hljs-attribute">$schema</span>": <span class="hljs-value"><span class="hljs-string">"http://json-schema.org/draft-03/schema"</span></span>, 1857 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 1858 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span></span>, 1859 "<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"A service resource."</span></span>, 1860 "<span class="hljs-attribute">properties</span>": <span class="hljs-value">{ 1861 "<span class="hljs-attribute">kind</span>": <span class="hljs-value">{ 1862 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 1863 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 1864 </span>}</span>, 1865 "<span class="hljs-attribute">id</span>": <span class="hljs-value">{ 1866 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 1867 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 1868 </span>}</span>, 1869 "<span class="hljs-attribute">creationTimestamp</span>": <span class="hljs-value">{ 1870 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 1871 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 1872 </span>}</span>, 1873 "<span class="hljs-attribute">selfLink</span>": <span class="hljs-value">{ 1874 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 1875 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 1876 </span>}</span>, 1877 "<span class="hljs-attribute">name</span>": <span class="hljs-value">{ 1878 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>, 1879 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 1880 </span>}</span>, 1881 "<span class="hljs-attribute">port</span>": <span class="hljs-value">{ 1882 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"number"</span></span>, 1883 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 1884 </span>}</span>, 1885 "<span class="hljs-attribute">labels</span>": <span class="hljs-value">{ 1886 "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>, 1887 "<span class="hljs-attribute">required</span>": <span class="hljs-value"><span class="hljs-literal">false</span> 1888 </span>} 1889 </span>} 1890 </span>} 1891 </pre> 1892 1893 1894 <strong>Example:</strong> 1895 <pre>{ 1896 "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-string">"example2"</span></span>, 1897 "<span class="hljs-attribute">port</span>": <span class="hljs-value"><span class="hljs-number">8000</span></span>, 1898 "<span class="hljs-attribute">labels</span>": <span class="hljs-value">{ 1899 "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"nginx"</span> 1900 </span>} 1901 </span>} 1902 </pre> 1903 1904 1905 1906 </div> 1907 1908 1909 </div> 1910 </div> 1911 </div> 1912 </div> 1913 </div> 1914 1915 <div class="modal fade" id="_services__serviceId__delete"> 1916 <div class="modal-dialog"> 1917 <div class="modal-content"> 1918 <div class="modal-header"> 1919 <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button> 1920 <h4 class="modal-title" id="myModalLabel"> 1921 <span class="badge badge_delete">delete</span> 1922 <span class="parent">/services</span>/{serviceId} 1923 </h4> 1924 </div> 1925 <div class="modal-body"> 1926 <div class="alert alert-info"><p>Delete a specific service</p> 1927 </div> 1928 1929 <!-- Nav tabs --> 1930 <ul class="nav nav-tabs"> 1931 <li class="active"> 1932 <a href="#_services__serviceId__delete_request" data-toggle="tab">Request</a> 1933 </li> 1934 1935 <li> 1936 <a href="#_services__serviceId__delete_response" data-toggle="tab">Response</a> 1937 </li> 1938 1939 </ul> 1940 1941 <!-- Tab panes --> 1942 <div class="tab-content"> 1943 <div class="tab-pane active" id="_services__serviceId__delete_request"> 1944 1945 <h3>URI Parameters</h3> 1946 <ul> 1947 1948 <li><strong>serviceId</strong>: string</li> 1949 1950 </ul> 1951 1952 1953 1954 1955 1956 </div> 1957 1958 1959 <div class="tab-pane" id="_services__serviceId__delete_response"> 1960 1961 <h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2> 1962 1963 1964 1965 1966 1967 <h3>Body</h3> 1968 1969 <p><strong>Type: application/json</strong></p> 1970 1971 1972 <strong>Example:</strong> 1973 <pre>{ 1974 "<span class="hljs-attribute">success</span>": <span class="hljs-value"><span class="hljs-literal">true</span> 1975 </span>} 1976 </pre> 1977 1978 1979 1980 1981 </div> 1982 1983 </div> 1984 </div> 1985 </div> 1986 </div> 1987 </div> 1988 1989 </div> 1990 1991 1992 1993 1994 1995 </div> 1996 </div> 1997 </div> 1998 1999 </div> 2000 2001 <div class="col-md-3"> 2002 <div id="sidebar" class="hidden-print affix" role="complementary"> 2003 <ul class="nav nav-pills nav-stacked"> 2004 2005 <li><a href="#_tasks">/tasks</a></li> 2006 2007 <li><a href="#_replicationControllers">/replicationControllers</a></li> 2008 2009 <li><a href="#_services">/services</a></li> 2010 2011 </ul> 2012 </div> 2013 </div> 2014 </div> 2015 </div> 2016 </body> 2017 </html>