Browse code
Rename API docs, fix link to raw html
- Rename API docs file, title and version per upstream convention
- Fix link to the raw API docs, use http instead of https
Vojtech Vitek (V-Teq) authored on 2014/09/17 23:46:49Showing 8 changed files
- README.md
- api/Dockerfile
- api/README.md
- api/oov3.html
- api/oov3.raml
- api/openshift3.html
- api/openshift3.raml
- hack/build-api-docs-image.sh
| ... | ... |
@@ -74,7 +74,7 @@ Several experimental API objects are being prototyped, and should be available s |
| 74 | 74 |
* `http://localhost:8080/osapi/v1beta1/builds` |
| 75 | 75 |
* `http://localhost:8080/osapi/v1beta1/buildConfigs` |
| 76 | 76 |
|
| 77 |
-A draft of the proposed API is available at https://rawgit.com/openshift/origin/master/api/oov3.html and is developed under the [api](./api) directory. Expect significant changes. |
|
| 77 |
+A draft of the proposed API is available at http://rawgit.com/openshift/origin/master/api/openshift3.html and is developed under the [api](./api) directory. Expect significant changes. |
|
| 78 | 78 |
|
| 79 | 79 |
|
| 80 | 80 |
FAQ |
| ... | ... |
@@ -3,7 +3,7 @@ |
| 3 | 3 |
|
| 4 | 4 |
## Viewing the documentation ## |
| 5 | 5 |
Use htmlpreview for github with a URL like: |
| 6 |
-[https://rawgit.com/openshift/origin/master/api/oov3.html] (https://rawgit.com/openshift/origin/master/api/oov3.html) |
|
| 6 |
+[http://rawgit.com/openshift/origin/master/api/openshift3.html] (http://rawgit.com/openshift/origin/master/api/openshift3.html) |
|
| 7 | 7 |
|
| 8 | 8 |
## Generating the API document |
| 9 | 9 |
``` |
| 10 | 10 |
deleted file mode 100644 |
| ... | ... |
@@ -1,2000 +0,0 @@ |
| 1 |
-<!DOCTYPE HTML><html><head><title>OpenShiftV3 -- Draft API documentation</title><meta http-equiv=X-UA-Compatible content="IE=edge"><meta http-equiv=Content-Type content="text/html; charset=utf-8"><meta name=generator content="https://github.com/kevinrenskers/raml2html 1.0.3"><link rel=stylesheet href=http://netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css><link rel=stylesheet href=http://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.1/styles/default.min.css><script type=text/javascript src=http://code.jquery.com/jquery-1.11.0.min.js></script><script type=text/javascript src=http://netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js></script><script type=text/javascript src=http://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.1/highlight.min.js></script><script type=text/javascript> |
|
| 2 |
- $(document).ready(function() {
|
|
| 3 |
- $('.page-header pre code, .top-resource-description pre code').each(function(i, block) {
|
|
| 4 |
- hljs.highlightBlock(block); |
|
| 5 |
- }); |
|
| 6 |
- |
|
| 7 |
- $('[data-toggle]').click(function() {
|
|
| 8 |
- var selector = $(this).data('target') + ' pre code';
|
|
| 9 |
- $(selector).each(function(i, block) {
|
|
| 10 |
- hljs.highlightBlock(block); |
|
| 11 |
- }); |
|
| 12 |
- }); |
|
| 13 |
- }); |
|
| 14 |
- </script><style> |
|
| 15 |
- .hljs {
|
|
| 16 |
- background: transparent; |
|
| 17 |
- } |
|
| 18 |
- .parent {
|
|
| 19 |
- color: #999; |
|
| 20 |
- } |
|
| 21 |
- .list-group-item > .badge {
|
|
| 22 |
- float: none; |
|
| 23 |
- margin-right: 6px; |
|
| 24 |
- } |
|
| 25 |
- .panel-title > .methods {
|
|
| 26 |
- float: right; |
|
| 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 |
- .badge_get {
|
|
| 37 |
- background-color: #63a8e2; |
|
| 38 |
- } |
|
| 39 |
- .badge_post {
|
|
| 40 |
- background-color: #6cbd7d; |
|
| 41 |
- } |
|
| 42 |
- .badge_put {
|
|
| 43 |
- background-color: #22bac4; |
|
| 44 |
- } |
|
| 45 |
- .badge_delete {
|
|
| 46 |
- background-color: #d26460; |
|
| 47 |
- } |
|
| 48 |
- .list-group, .panel-group {
|
|
| 49 |
- margin-bottom: 0; |
|
| 50 |
- } |
|
| 51 |
- .panel-group .panel+.panel-white {
|
|
| 52 |
- margin-top: 0; |
|
| 53 |
- } |
|
| 54 |
- .panel-group .panel-white {
|
|
| 55 |
- border-bottom: 1px solid #F5F5F5; |
|
| 56 |
- border-radius: 0; |
|
| 57 |
- } |
|
| 58 |
- .panel-white:last-child {
|
|
| 59 |
- border-bottom-color: white; |
|
| 60 |
- -webkit-box-shadow: none; |
|
| 61 |
- box-shadow: none; |
|
| 62 |
- } |
|
| 63 |
- .panel-white .panel-heading {
|
|
| 64 |
- background: white; |
|
| 65 |
- } |
|
| 66 |
- .tab-pane ul {
|
|
| 67 |
- padding-left: 2em; |
|
| 68 |
- } |
|
| 69 |
- .tab-pane h2 {
|
|
| 70 |
- font-size: 1.2em; |
|
| 71 |
- padding-bottom: 4px; |
|
| 72 |
- border-bottom: 1px solid #ddd; |
|
| 73 |
- } |
|
| 74 |
- .tab-pane h3 {
|
|
| 75 |
- font-size: 1.1em; |
|
| 76 |
- } |
|
| 77 |
- .tab-content {
|
|
| 78 |
- border-left: 1px solid #ddd; |
|
| 79 |
- border-right: 1px solid #ddd; |
|
| 80 |
- border-bottom: 1px solid #ddd; |
|
| 81 |
- padding: 10px; |
|
| 82 |
- } |
|
| 83 |
- #sidebar {
|
|
| 84 |
- margin-top: 30px; |
|
| 85 |
- } |
|
| 86 |
- .top-resource-description {
|
|
| 87 |
- border-bottom: 1px solid #ddd; |
|
| 88 |
- background: #fcfcfc; |
|
| 89 |
- padding: 15px 15px 0 15px; |
|
| 90 |
- margin: -15px -15px 10px -15px; |
|
| 91 |
- } |
|
| 92 |
- .resource-description {
|
|
| 93 |
- border-bottom: 1px solid #fcfcfc; |
|
| 94 |
- background: #fcfcfc; |
|
| 95 |
- padding: 15px 15px 0 15px; |
|
| 96 |
- margin: -15px -15px 10px -15px; |
|
| 97 |
- } |
|
| 98 |
- .list-group .badge {
|
|
| 99 |
- float: left; |
|
| 100 |
- } |
|
| 101 |
- .method_description {
|
|
| 102 |
- margin-left: 85px; |
|
| 103 |
- } |
|
| 104 |
- .method_description p:last-child {
|
|
| 105 |
- margin: 0; |
|
| 106 |
- } |
|
| 107 |
- .list-group-item {
|
|
| 108 |
- cursor: pointer; |
|
| 109 |
- } |
|
| 110 |
- .list-group-item:hover {
|
|
| 111 |
- background-color: #f5f5f5; |
|
| 112 |
- } |
|
| 113 |
- </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>OpenShiftV3 -- Draft API documentation <small>version alpha</small></h1><p>http://server/broker/rest</p><h3 id=Overview><a href=#Overview>Overview</a></h3><p>The 3.x model attempts to expose underlying Docker and Google models as accurately as possible, with a focus on easy composition of applications by a developer (install Ruby, push code, add MySQL). Unlike 2.x, more flexibility of configuration is exposed after creation in all aspects of the model. Terminology is still being weighed, but the concept of an application as a separate object is being removed in favor of more flexible composition of "services" - allowing two web containers to reuse a DB, or expose a DB directly to the edge of the network. The existing API will continue to be supported through 3.x, with concepts mapped as closely as possible to the new model.</p></div><div class="panel panel-default"><div class=panel-heading><h3 id=_projects class=panel-title>/projects</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=collapsed data-toggle=collapse href=#panel__projects><span class=parent></span>/projects</a> <span class=methods><a href=# data-toggle=modal data-target=#_projects_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_projects_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__projects class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_projects_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>List all projects for your account.</p><p>Projects are a similar concept to v2 domains. A project is a grouping of services with shared access control and resource limits. Applications can be assembled from services in a project by linking them together via service endpoints.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_projects_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new project</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_projects_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>/projects</h4></div><div class=modal-body><div class="alert alert-info"><p>List all projects for your account.</p><p>Projects are a similar concept to v2 domains. A project is a grouping of services with shared access control and resource limits. Applications can be assembled from services in a project by linking them together via service endpoints.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_projects_get_request data-toggle=tab>Request</a></li><li><a href=#_projects_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_projects_get_request></div><div class=tab-pane id=_projects_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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 114 |
- "data": |
|
| 115 |
- [ |
|
| 116 |
- {
|
|
| 117 |
- "id": "53c4249f076573c0f4000001", |
|
| 118 |
- "suffix": "dev.rhcloud.com", |
|
| 119 |
- "name": "mydomain", |
|
| 120 |
- "members": [ |
|
| 121 |
- {
|
|
| 122 |
- "login": "adminuser", |
|
| 123 |
- "role": "admin", |
|
| 124 |
- "type": "user", |
|
| 125 |
- "owner": true |
|
| 126 |
- } |
|
| 127 |
- ] |
|
| 128 |
- }, |
|
| 129 |
- {
|
|
| 130 |
- "id": "54c4259f076573c0f4000023", |
|
| 131 |
- "suffix": "dev.rhcloud.com", |
|
| 132 |
- "name": "appdomain", |
|
| 133 |
- "members": [ |
|
| 134 |
- {
|
|
| 135 |
- "login": "adminuser", |
|
| 136 |
- "role": "admin", |
|
| 137 |
- "type": "user", |
|
| 138 |
- "owner": true |
|
| 139 |
- } |
|
| 140 |
- ] |
|
| 141 |
- } |
|
| 142 |
- ] |
|
| 143 |
-} |
|
| 144 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_projects_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>/projects</h4></div><div class=modal-body><div class="alert alert-info"><p>Create a new project</p></div><ul class="nav nav-tabs"><li class=active><a href=#_projects_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_projects_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 145 |
- "data": |
|
| 146 |
- {
|
|
| 147 |
- "id": "53c4249f076573c0f4000001", |
|
| 148 |
- "suffix": "dev.rhcloud.com", |
|
| 149 |
- "name": "myproject", |
|
| 150 |
- "members": [ |
|
| 151 |
- {
|
|
| 152 |
- "login": "adminuser", |
|
| 153 |
- "role": "admin", |
|
| 154 |
- "type": "user", |
|
| 155 |
- "owner": true |
|
| 156 |
- } |
|
| 157 |
- ] |
|
| 158 |
- } |
|
| 159 |
-} |
|
| 160 |
-</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_project__projectID_ class=panel-title>/project/{projectID}</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=collapsed data-toggle=collapse href=#panel__project__projectID_><span class=parent></span>/project/{projectID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_project__projectID__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_project__projectID__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_project__projectID__delete><span class="badge badge_delete">delete</span></a> <a href=# data-toggle=modal data-target=#_project__projectID__post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__project__projectID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_project__projectID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get a specific project</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_project__projectID__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a project</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_project__projectID__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a project</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_project__projectID__post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Instantiate a template in the given project</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_project__projectID__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>/project/{projectID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get a specific project</p></div><ul class="nav nav-tabs"><li class=active><a href=#_project__projectID__get_request data-toggle=tab>Request</a></li><li><a href=#_project__projectID__get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_project__projectID__get_request><h3>URI Parameters</h3><ul><li><strong>projectID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_project__projectID__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 161 |
- "data": |
|
| 162 |
- {
|
|
| 163 |
- "id": "53c4249f076573c0f4000001", |
|
| 164 |
- "suffix": "dev.rhcloud.com", |
|
| 165 |
- "name": "myproject", |
|
| 166 |
- "members": [ |
|
| 167 |
- {
|
|
| 168 |
- "login": "adminuser", |
|
| 169 |
- "role": "admin", |
|
| 170 |
- "type": "user", |
|
| 171 |
- "owner": true |
|
| 172 |
- } |
|
| 173 |
- ] |
|
| 174 |
- } |
|
| 175 |
-} |
|
| 176 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_project__projectID__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></span>/project/{projectID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update a project</p></div><ul class="nav nav-tabs"><li class=active><a href=#_project__projectID__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_project__projectID__put_request><h3>URI Parameters</h3><ul><li><strong>projectID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 177 |
- "data": |
|
| 178 |
- {
|
|
| 179 |
- "id": "53c4249f076573c0f4000001", |
|
| 180 |
- "name": "newproject-name" |
|
| 181 |
- } |
|
| 182 |
-} |
|
| 183 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_project__projectID__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></span>/project/{projectID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete a project</p></div><ul class="nav nav-tabs"><li class=active><a href=#_project__projectID__delete_request data-toggle=tab>Request</a></li><li><a href=#_project__projectID__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_project__projectID__delete_request><h3>URI Parameters</h3><ul><li><strong>projectID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_project__projectID__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 184 |
- "apiVersion": "v1beta1", |
|
| 185 |
- "creationTimestamp": null, |
|
| 186 |
- "kind": "Status", |
|
| 187 |
- "status": "success" |
|
| 188 |
-} |
|
| 189 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_project__projectID__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>/project/{projectID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Instantiate a template in the given project</p></div><ul class="nav nav-tabs"><li class=active><a href=#_project__projectID__post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_project__projectID__post_request><h3>URI Parameters</h3><ul><li><strong>projectID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 190 |
- "templateId": "the-template-id" |
|
| 191 |
-} |
|
| 192 |
-</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_imageRepositories class=panel-title>/imageRepositories</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=collapsed data-toggle=collapse href=#panel__imageRepositories><span class=parent></span>/imageRepositories</a> <span class=methods><a href=# data-toggle=modal data-target=#_imageRepositories_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_imageRepositories_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__imageRepositories class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_imageRepositories_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Lists all image repositories.</p><p>An image repository is a collection of images that share the same metadata. It may reference a Docker image repository on a Docker registry, but this is optional. An image repository also contains a mapping of tags to images.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_imageRepositories_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new image repository</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_imageRepositories_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>/imageRepositories</h4></div><div class=modal-body><div class="alert alert-info"><p>Lists all image repositories.</p><p>An image repository is a collection of images that share the same metadata. It may reference a Docker image repository on a Docker registry, but this is optional. An image repository also contains a mapping of tags to images.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_imageRepositories_get_request data-toggle=tab>Request</a></li><li><a href=#_imageRepositories_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_imageRepositories_get_request></div><div class=tab-pane id=_imageRepositories_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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 193 |
- "apiVersion": "v1beta1", |
|
| 194 |
- "creationTimestamp": null, |
|
| 195 |
- "items": [ |
|
| 196 |
- {
|
|
| 197 |
- "creationTimestamp": "2014-09-10T12:23:01-04:00", |
|
| 198 |
- "dockerImageRepository": "localhost:5000/someproject/somerepo", |
|
| 199 |
- "id": "somerepo", |
|
| 200 |
- "resourceVersion": 17, |
|
| 201 |
- "tags": {
|
|
| 202 |
- "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b", |
|
| 203 |
- "latest": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b" |
|
| 204 |
- } |
|
| 205 |
- }, |
|
| 206 |
- {
|
|
| 207 |
- "creationTimestamp": "2014-09-10T09:33:42-04:00", |
|
| 208 |
- "dockerImageRepository": "openshift/ruby-19-centos", |
|
| 209 |
- "id": "test", |
|
| 210 |
- "labels": {
|
|
| 211 |
- "color": "blue" |
|
| 212 |
- }, |
|
| 213 |
- "resourceVersion": 14, |
|
| 214 |
- "tags": {
|
|
| 215 |
- "latest": "120e218dd395ec314e7b6249f39d2853911b3d6def6ea164ae05722649f34b16" |
|
| 216 |
- } |
|
| 217 |
- } |
|
| 218 |
- ], |
|
| 219 |
- "kind": "ImageRepositoryList", |
|
| 220 |
- "resourceVersion": 22 |
|
| 221 |
-} |
|
| 222 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_imageRepositories_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>/imageRepositories</h4></div><div class=modal-body><div class="alert alert-info"><p>Create a new image repository</p></div><ul class="nav nav-tabs"><li class=active><a href=#_imageRepositories_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_imageRepositories_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 223 |
- "apiVersion": "v1beta1", |
|
| 224 |
- "dockerImageRepository": "openshift/ruby-19-centos", |
|
| 225 |
- "id": "test", |
|
| 226 |
- "kind": "ImageRepository", |
|
| 227 |
- "labels": {
|
|
| 228 |
- "color": "blue" |
|
| 229 |
- }, |
|
| 230 |
- "tags": {
|
|
| 231 |
- "latest": "120e218dd395ec314e7b6249f39d2853911b3d6def6ea164ae05722649f34b16" |
|
| 232 |
- } |
|
| 233 |
-} |
|
| 234 |
-</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_imageRepositories__repositoryID_ class=panel-title>/imageRepositories/{repositoryID}</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=collapsed data-toggle=collapse href=#panel__imageRepositories__repositoryID_><span class=parent></span>/imageRepositories/{repositoryID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_imageRepositories__repositoryID__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_imageRepositories__repositoryID__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_imageRepositories__repositoryID__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__imageRepositories__repositoryID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_imageRepositories__repositoryID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get information about an image repository</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_imageRepositories__repositoryID__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update an image repository</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_imageRepositories__repositoryID__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete an image repository</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_imageRepositories__repositoryID__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>/imageRepositories/{repositoryID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get information about an image repository</p></div><ul class="nav nav-tabs"><li class=active><a href=#_imageRepositories__repositoryID__get_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_imageRepositories__repositoryID__get_request><h3>URI Parameters</h3><ul><li><strong>repositoryID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 235 |
- "apiVersion": "v1beta1", |
|
| 236 |
- "creationTimestamp": "2014-09-10T09:33:42-04:00", |
|
| 237 |
- "dockerImageRepository": "openshift/ruby-19-centos", |
|
| 238 |
- "id": "test", |
|
| 239 |
- "kind": "ImageRepository", |
|
| 240 |
- "labels": {
|
|
| 241 |
- "color": "blue" |
|
| 242 |
- }, |
|
| 243 |
- "resourceVersion": 14, |
|
| 244 |
- "tags": {
|
|
| 245 |
- "latest": "120e218dd395ec314e7b6249f39d2853911b3d6def6ea164ae05722649f34b16" |
|
| 246 |
- } |
|
| 247 |
-} |
|
| 248 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_imageRepositories__repositoryID__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></span>/imageRepositories/{repositoryID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update an image repository</p></div><ul class="nav nav-tabs"><li class=active><a href=#_imageRepositories__repositoryID__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_imageRepositories__repositoryID__put_request><h3>URI Parameters</h3><ul><li><strong>repositoryID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 249 |
- "apiVersion": "v1beta1", |
|
| 250 |
- "creationTimestamp": "2014-09-10T09:33:42-04:00", |
|
| 251 |
- "dockerImageRepository": "openshift/ruby-19-centos", |
|
| 252 |
- "id": "test", |
|
| 253 |
- "kind": "ImageRepository", |
|
| 254 |
- "labels": {
|
|
| 255 |
- "color": "blue" |
|
| 256 |
- }, |
|
| 257 |
- "resourceVersion": 14, |
|
| 258 |
- "tags": {
|
|
| 259 |
- "latest": "120e218dd395ec314e7b6249f39d2853911b3d6def6ea164ae05722649f34b16" |
|
| 260 |
- } |
|
| 261 |
-} |
|
| 262 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_imageRepositories__repositoryID__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></span>/imageRepositories/{repositoryID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete an image repository</p></div><ul class="nav nav-tabs"><li class=active><a href=#_imageRepositories__repositoryID__delete_request data-toggle=tab>Request</a></li><li><a href=#_imageRepositories__repositoryID__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_imageRepositories__repositoryID__delete_request><h3>URI Parameters</h3><ul><li><strong>repositoryID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_imageRepositories__repositoryID__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 263 |
- "apiVersion": "v1beta1", |
|
| 264 |
- "creationTimestamp": null, |
|
| 265 |
- "kind": "Status", |
|
| 266 |
- "status": "success" |
|
| 267 |
-} |
|
| 268 |
-</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_images class=panel-title>/images</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=collapsed data-toggle=collapse href=#panel__images><span class=parent></span>/images</a> <span class=methods><a href=# data-toggle=modal data-target=#_images_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_images_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__images class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_images_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Lists all images.</p><p>An image is a reference to an image in a Docker image repository on a Docker registry, plus a set of metadata. The metadata that Openshift stores for an image will augment the metadata that has already been specified in the image through its Dockerfile.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_images_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new image definition</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_images_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>/images</h4></div><div class=modal-body><div class="alert alert-info"><p>Lists all images.</p><p>An image is a reference to an image in a Docker image repository on a Docker registry, plus a set of metadata. The metadata that Openshift stores for an image will augment the metadata that has already been specified in the image through its Dockerfile.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_images_get_request data-toggle=tab>Request</a></li><li><a href=#_images_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_images_get_request></div><div class=tab-pane id=_images_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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 269 |
- "apiVersion": "v1beta1", |
|
| 270 |
- "creationTimestamp": null, |
|
| 271 |
- "items": [ |
|
| 272 |
- {
|
|
| 273 |
- "creationTimestamp": "2014-09-10T09:33:43-04:00", |
|
| 274 |
- "dockerImageReference": "openshift/ruby-19-centos:latest", |
|
| 275 |
- "id": "abcd1234", |
|
| 276 |
- "metadata": {
|
|
| 277 |
- "Size": 0, |
|
| 278 |
- "containerconfig": {
|
|
| 279 |
- "AttachStderr": false, |
|
| 280 |
- "AttachStdin": false, |
|
| 281 |
- "AttachStdout": false, |
|
| 282 |
- "Cmd": null, |
|
| 283 |
- "CpuShares": 0, |
|
| 284 |
- "Dns": null, |
|
| 285 |
- "Domainname": "", |
|
| 286 |
- "Entrypoint": null, |
|
| 287 |
- "Env": null, |
|
| 288 |
- "ExposedPorts": null, |
|
| 289 |
- "Hostname": "", |
|
| 290 |
- "Image": "", |
|
| 291 |
- "Memory": 0, |
|
| 292 |
- "MemorySwap": 0, |
|
| 293 |
- "NetworkDisabled": false, |
|
| 294 |
- "OpenStdin": false, |
|
| 295 |
- "PortSpecs": null, |
|
| 296 |
- "StdinOnce": false, |
|
| 297 |
- "Tty": false, |
|
| 298 |
- "User": "", |
|
| 299 |
- "Volumes": null, |
|
| 300 |
- "VolumesFrom": "", |
|
| 301 |
- "WorkingDir": "" |
|
| 302 |
- }, |
|
| 303 |
- "created": "0001-01-01T00:00:00Z", |
|
| 304 |
- "id": "" |
|
| 305 |
- }, |
|
| 306 |
- "resourceVersion": 15 |
|
| 307 |
- }, |
|
| 308 |
- {
|
|
| 309 |
- "creationTimestamp": "2014-09-10T12:23:24-04:00", |
|
| 310 |
- "dockerImageReference": "localhost:5000/someproject/somerepo:c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b", |
|
| 311 |
- "id": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b", |
|
| 312 |
- "metadata": {
|
|
| 313 |
- "Size": 0, |
|
| 314 |
- "architecture": "amd64", |
|
| 315 |
- "config": {
|
|
| 316 |
- "AttachStderr": false, |
|
| 317 |
- "AttachStdin": false, |
|
| 318 |
- "AttachStdout": false, |
|
| 319 |
- "Cmd": null, |
|
| 320 |
- "CpuShares": 0, |
|
| 321 |
- "Dns": null, |
|
| 322 |
- "Domainname": "", |
|
| 323 |
- "Entrypoint": null, |
|
| 324 |
- "Env": null, |
|
| 325 |
- "ExposedPorts": null, |
|
| 326 |
- "Hostname": "", |
|
| 327 |
- "Image": "", |
|
| 328 |
- "Memory": 0, |
|
| 329 |
- "MemorySwap": 0, |
|
| 330 |
- "NetworkDisabled": false, |
|
| 331 |
- "OpenStdin": false, |
|
| 332 |
- "PortSpecs": null, |
|
| 333 |
- "StdinOnce": false, |
|
| 334 |
- "Tty": false, |
|
| 335 |
- "User": "", |
|
| 336 |
- "Volumes": null, |
|
| 337 |
- "VolumesFrom": "", |
|
| 338 |
- "WorkingDir": "" |
|
| 339 |
- }, |
|
| 340 |
- "container": "6b03c2dda0f8cbfa6186d96557e35e35c61915a70e4217a465f92f26c2d9290b", |
|
| 341 |
- "containerconfig": {
|
|
| 342 |
- "AttachStderr": false, |
|
| 343 |
- "AttachStdin": false, |
|
| 344 |
- "AttachStdout": false, |
|
| 345 |
- "Cmd": null, |
|
| 346 |
- "CpuShares": 0, |
|
| 347 |
- "Dns": null, |
|
| 348 |
- "Domainname": "", |
|
| 349 |
- "Entrypoint": null, |
|
| 350 |
- "Env": null, |
|
| 351 |
- "ExposedPorts": null, |
|
| 352 |
- "Hostname": "", |
|
| 353 |
- "Image": "", |
|
| 354 |
- "Memory": 0, |
|
| 355 |
- "MemorySwap": 0, |
|
| 356 |
- "NetworkDisabled": false, |
|
| 357 |
- "OpenStdin": false, |
|
| 358 |
- "PortSpecs": null, |
|
| 359 |
- "StdinOnce": false, |
|
| 360 |
- "Tty": false, |
|
| 361 |
- "User": "", |
|
| 362 |
- "Volumes": null, |
|
| 363 |
- "VolumesFrom": "", |
|
| 364 |
- "WorkingDir": "" |
|
| 365 |
- }, |
|
| 366 |
- "created": "0001-01-01T00:00:00Z", |
|
| 367 |
- "id": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b", |
|
| 368 |
- "parent": "32730be9f383719ce6308329c8ee5aac189ece9e41928dc10b8bc0fc35e9d1d5" |
|
| 369 |
- }, |
|
| 370 |
- "resourceVersion": 18 |
|
| 371 |
- } |
|
| 372 |
- ], |
|
| 373 |
- "kind": "ImageList", |
|
| 374 |
- "resourceVersion": 22 |
|
| 375 |
-} |
|
| 376 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_images_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>/images</h4></div><div class=modal-body><div class="alert alert-info"><p>Create a new image definition</p></div><ul class="nav nav-tabs"><li class=active><a href=#_images_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_images_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 377 |
- "apiVersion": "v1beta1", |
|
| 378 |
- "dockerImageReference": "localhost:5000/someproject/somerepo:c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b", |
|
| 379 |
- "id": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b", |
|
| 380 |
- "kind": "Image", |
|
| 381 |
- "metadata": {
|
|
| 382 |
- "Size": 0, |
|
| 383 |
- "architecture": "amd64", |
|
| 384 |
- "config": {
|
|
| 385 |
- "AttachStderr": false, |
|
| 386 |
- "AttachStdin": false, |
|
| 387 |
- "AttachStdout": false, |
|
| 388 |
- "Cmd": null, |
|
| 389 |
- "CpuShares": 0, |
|
| 390 |
- "Dns": null, |
|
| 391 |
- "Domainname": "", |
|
| 392 |
- "Entrypoint": null, |
|
| 393 |
- "Env": null, |
|
| 394 |
- "ExposedPorts": null, |
|
| 395 |
- "Hostname": "", |
|
| 396 |
- "Image": "", |
|
| 397 |
- "Memory": 0, |
|
| 398 |
- "MemorySwap": 0, |
|
| 399 |
- "NetworkDisabled": false, |
|
| 400 |
- "OpenStdin": false, |
|
| 401 |
- "PortSpecs": null, |
|
| 402 |
- "StdinOnce": false, |
|
| 403 |
- "Tty": false, |
|
| 404 |
- "User": "", |
|
| 405 |
- "Volumes": null, |
|
| 406 |
- "VolumesFrom": "", |
|
| 407 |
- "WorkingDir": "" |
|
| 408 |
- }, |
|
| 409 |
- "container": "6b03c2dda0f8cbfa6186d96557e35e35c61915a70e4217a465f92f26c2d9290b", |
|
| 410 |
- "containerconfig": {
|
|
| 411 |
- "AttachStderr": false, |
|
| 412 |
- "AttachStdin": false, |
|
| 413 |
- "AttachStdout": false, |
|
| 414 |
- "Cmd": null, |
|
| 415 |
- "CpuShares": 0, |
|
| 416 |
- "Dns": null, |
|
| 417 |
- "Domainname": "", |
|
| 418 |
- "Entrypoint": null, |
|
| 419 |
- "Env": null, |
|
| 420 |
- "ExposedPorts": null, |
|
| 421 |
- "Hostname": "", |
|
| 422 |
- "Image": "", |
|
| 423 |
- "Memory": 0, |
|
| 424 |
- "MemorySwap": 0, |
|
| 425 |
- "NetworkDisabled": false, |
|
| 426 |
- "OpenStdin": false, |
|
| 427 |
- "PortSpecs": null, |
|
| 428 |
- "StdinOnce": false, |
|
| 429 |
- "Tty": false, |
|
| 430 |
- "User": "", |
|
| 431 |
- "Volumes": null, |
|
| 432 |
- "VolumesFrom": "", |
|
| 433 |
- "WorkingDir": "" |
|
| 434 |
- }, |
|
| 435 |
- "created": "0001-01-01T00:00:00Z", |
|
| 436 |
- "id": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b", |
|
| 437 |
- "parent": "32730be9f383719ce6308329c8ee5aac189ece9e41928dc10b8bc0fc35e9d1d5" |
|
| 438 |
- }, |
|
| 439 |
-} |
|
| 440 |
-</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_images__imageID_ class=panel-title>/images/{imageID}</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=collapsed data-toggle=collapse href=#panel__images__imageID_><span class=parent></span>/images/{imageID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_images__imageID__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_images__imageID__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__images__imageID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_images__imageID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get image definition</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_images__imageID__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete an image</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_images__imageID__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>/images/{imageID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get image definition</p></div><ul class="nav nav-tabs"><li class=active><a href=#_images__imageID__get_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_images__imageID__get_request><h3>URI Parameters</h3><ul><li><strong>imageID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 441 |
- "apiVersion": "v1beta1", |
|
| 442 |
- "creationTimestamp": "2014-09-10T12:23:24-04:00", |
|
| 443 |
- "dockerImageReference": "localhost:5000/someproject/somerepo:c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b", |
|
| 444 |
- "id": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b", |
|
| 445 |
- "kind": "Image", |
|
| 446 |
- "metadata": {
|
|
| 447 |
- "Size": 0, |
|
| 448 |
- "architecture": "amd64", |
|
| 449 |
- "config": {
|
|
| 450 |
- "AttachStderr": false, |
|
| 451 |
- "AttachStdin": false, |
|
| 452 |
- "AttachStdout": false, |
|
| 453 |
- "Cmd": null, |
|
| 454 |
- "CpuShares": 0, |
|
| 455 |
- "Dns": null, |
|
| 456 |
- "Domainname": "", |
|
| 457 |
- "Entrypoint": null, |
|
| 458 |
- "Env": null, |
|
| 459 |
- "ExposedPorts": null, |
|
| 460 |
- "Hostname": "", |
|
| 461 |
- "Image": "", |
|
| 462 |
- "Memory": 0, |
|
| 463 |
- "MemorySwap": 0, |
|
| 464 |
- "NetworkDisabled": false, |
|
| 465 |
- "OpenStdin": false, |
|
| 466 |
- "PortSpecs": null, |
|
| 467 |
- "StdinOnce": false, |
|
| 468 |
- "Tty": false, |
|
| 469 |
- "User": "", |
|
| 470 |
- "Volumes": null, |
|
| 471 |
- "VolumesFrom": "", |
|
| 472 |
- "WorkingDir": "" |
|
| 473 |
- }, |
|
| 474 |
- "container": "6b03c2dda0f8cbfa6186d96557e35e35c61915a70e4217a465f92f26c2d9290b", |
|
| 475 |
- "containerconfig": {
|
|
| 476 |
- "AttachStderr": false, |
|
| 477 |
- "AttachStdin": false, |
|
| 478 |
- "AttachStdout": false, |
|
| 479 |
- "Cmd": null, |
|
| 480 |
- "CpuShares": 0, |
|
| 481 |
- "Dns": null, |
|
| 482 |
- "Domainname": "", |
|
| 483 |
- "Entrypoint": null, |
|
| 484 |
- "Env": null, |
|
| 485 |
- "ExposedPorts": null, |
|
| 486 |
- "Hostname": "", |
|
| 487 |
- "Image": "", |
|
| 488 |
- "Memory": 0, |
|
| 489 |
- "MemorySwap": 0, |
|
| 490 |
- "NetworkDisabled": false, |
|
| 491 |
- "OpenStdin": false, |
|
| 492 |
- "PortSpecs": null, |
|
| 493 |
- "StdinOnce": false, |
|
| 494 |
- "Tty": false, |
|
| 495 |
- "User": "", |
|
| 496 |
- "Volumes": null, |
|
| 497 |
- "VolumesFrom": "", |
|
| 498 |
- "WorkingDir": "" |
|
| 499 |
- }, |
|
| 500 |
- "created": "0001-01-01T00:00:00Z", |
|
| 501 |
- "id": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b", |
|
| 502 |
- "parent": "32730be9f383719ce6308329c8ee5aac189ece9e41928dc10b8bc0fc35e9d1d5" |
|
| 503 |
- }, |
|
| 504 |
- "resourceVersion": 18 |
|
| 505 |
-} |
|
| 506 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_images__imageID__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></span>/images/{imageID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete an image</p></div><ul class="nav nav-tabs"><li class=active><a href=#_images__imageID__delete_request data-toggle=tab>Request</a></li><li><a href=#_images__imageID__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_images__imageID__delete_request><h3>URI Parameters</h3><ul><li><strong>imageID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_images__imageID__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 507 |
- "apiVersion": "v1beta1", |
|
| 508 |
- "creationTimestamp": null, |
|
| 509 |
- "kind": "Status", |
|
| 510 |
- "status": "success" |
|
| 511 |
-} |
|
| 512 |
-</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_imageRepositoryMappings class=panel-title>/imageRepositoryMappings</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=collapsed data-toggle=collapse href=#panel__imageRepositoryMappings><span class=parent></span>/imageRepositoryMappings</a> <span class=methods><a href=# data-toggle=modal data-target=#_imageRepositoryMappings_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__imageRepositoryMappings class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_imageRepositoryMappings_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Creates an image and updates an image repository.</p><p>This is designed as a webhook that a Docker registry can invoke when a new tag is created. The image repository mapping contains a reference to the repository, the image's metadata, and the name of the new tag. Upon execution, a new image is created if it doesn't already exist, and the image repository is updated with the new tag.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_imageRepositoryMappings_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>/imageRepositoryMappings</h4></div><div class=modal-body><div class="alert alert-info"><p>Creates an image and updates an image repository.</p><p>This is designed as a webhook that a Docker registry can invoke when a new tag is created. The image repository mapping contains a reference to the repository, the image's metadata, and the name of the new tag. Upon execution, a new image is created if it doesn't already exist, and the image repository is updated with the new tag.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_imageRepositoryMappings_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_imageRepositoryMappings_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 513 |
- "dockerImageRepository": "localhost:5000/someproject/somerepo", |
|
| 514 |
- "image": {
|
|
| 515 |
- "dockerImageReference": "localhost:5000/someproject/somerepo:c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b", |
|
| 516 |
- "id": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b", |
|
| 517 |
- "metadata": {
|
|
| 518 |
- "Size": 0, |
|
| 519 |
- "architecture": "amd64", |
|
| 520 |
- "config": {
|
|
| 521 |
- "AttachStderr": false, |
|
| 522 |
- "AttachStdin": false, |
|
| 523 |
- "AttachStdout": false, |
|
| 524 |
- "Cmd": [ |
|
| 525 |
- "/bin/sh" |
|
| 526 |
- ], |
|
| 527 |
- "CpuShares": 0, |
|
| 528 |
- "Cpuset": "", |
|
| 529 |
- "Domainname": "", |
|
| 530 |
- "Entrypoint": null, |
|
| 531 |
- "Env": [ |
|
| 532 |
- "c=e", |
|
| 533 |
- "b=2", |
|
| 534 |
- "a=1", |
|
| 535 |
- "HOME=/", |
|
| 536 |
- "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin" |
|
| 537 |
- ], |
|
| 538 |
- "ExposedPorts": null, |
|
| 539 |
- "Hostname": "", |
|
| 540 |
- "Image": "", |
|
| 541 |
- "Memory": 0, |
|
| 542 |
- "MemorySwap": 0, |
|
| 543 |
- "NetworkDisabled": false, |
|
| 544 |
- "OnBuild": null, |
|
| 545 |
- "OpenStdin": false, |
|
| 546 |
- "PortSpecs": null, |
|
| 547 |
- "StdinOnce": false, |
|
| 548 |
- "Tty": false, |
|
| 549 |
- "User": "", |
|
| 550 |
- "Volumes": null, |
|
| 551 |
- "WorkingDir": "" |
|
| 552 |
- }, |
|
| 553 |
- "container": "6b03c2dda0f8cbfa6186d96557e35e35c61915a70e4217a465f92f26c2d9290b", |
|
| 554 |
- "container_config": {
|
|
| 555 |
- "AttachStderr": true, |
|
| 556 |
- "AttachStdin": false, |
|
| 557 |
- "AttachStdout": true, |
|
| 558 |
- "Cmd": [ |
|
| 559 |
- "/bin/sh" |
|
| 560 |
- ], |
|
| 561 |
- "CpuShares": 0, |
|
| 562 |
- "Cpuset": "", |
|
| 563 |
- "Domainname": "", |
|
| 564 |
- "Entrypoint": null, |
|
| 565 |
- "Env": [ |
|
| 566 |
- "c=e", |
|
| 567 |
- "b=2", |
|
| 568 |
- "a=1", |
|
| 569 |
- "HOME=/", |
|
| 570 |
- "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin" |
|
| 571 |
- ], |
|
| 572 |
- "ExposedPorts": null, |
|
| 573 |
- "Hostname": "6b03c2dda0f8", |
|
| 574 |
- "Image": "localhost:5000/someproject/somerepo", |
|
| 575 |
- "Memory": 0, |
|
| 576 |
- "MemorySwap": 0, |
|
| 577 |
- "NetworkDisabled": false, |
|
| 578 |
- "OnBuild": null, |
|
| 579 |
- "OpenStdin": false, |
|
| 580 |
- "PortSpecs": null, |
|
| 581 |
- "StdinOnce": false, |
|
| 582 |
- "Tty": false, |
|
| 583 |
- "User": "", |
|
| 584 |
- "Volumes": null, |
|
| 585 |
- "WorkingDir": "" |
|
| 586 |
- }, |
|
| 587 |
- "created": "2014-09-04T17:43:39.863545902Z", |
|
| 588 |
- "docker_version": "1.1.2", |
|
| 589 |
- "id": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b", |
|
| 590 |
- "os": "linux", |
|
| 591 |
- "parent": "32730be9f383719ce6308329c8ee5aac189ece9e41928dc10b8bc0fc35e9d1d5" |
|
| 592 |
- } |
|
| 593 |
- }, |
|
| 594 |
- "kind": "ImageRepositoryMapping", |
|
| 595 |
- "tag": "latest", |
|
| 596 |
- "version": "v1beta1" |
|
| 597 |
-} |
|
| 598 |
-</code></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=collapsed data-toggle=collapse href=#panel__services><span class=parent></span>/services</a> <span class=methods><a href=# data-toggle=modal data-target=#_services_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_services_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__services class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_services_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Lists all services that your account has access to</p><p>Services can be public or owned by a project. They contain a template of a pod and reference image repositories that supply the images for those templates. A service may be configured to react to an image being pushed to an image repository by initiating a deployment. Deployments are associated with a service and make use of Kubernetes replication controllers to manage pods in a cluster. For deployments, a service contains a policy that constrains how deployments can occur. For example, it may require that there exist at least 2 operational pods at all times. A deployment needs to operate under those constraints when making changes.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_services_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new service</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 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>Lists all services that your account has access to</p><p>Services can be public or owned by a project. They contain a template of a pod and reference image repositories that supply the images for those templates. A service may be configured to react to an image being pushed to an image repository by initiating a deployment. Deployments are associated with a service and make use of Kubernetes replication controllers to manage pods in a cluster. For deployments, a service contains a policy that constrains how deployments can occur. For example, it may require that there exist at least 2 operational pods at all times. A deployment needs to operate under those constraints when making changes.</p></div><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><div class=tab-content><div class="tab-pane active" id=_services_get_request><h3>Query Parameters</h3><ul><li><strong>projectId</strong>: <em>(string)</em><p>filter the services owned by a particular project</p></li></ul></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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 599 |
- "list": |
|
| 600 |
- [ |
|
| 601 |
- {
|
|
| 602 |
- "id": "53c4249f076573c0f4000001", |
|
| 603 |
- "name": "service-name", |
|
| 604 |
- "domain": "domain-id", |
|
| 605 |
- "desiredState": |
|
| 606 |
- {
|
|
| 607 |
- "replicas": 3, |
|
| 608 |
- "replicaSelector": { "name": "service-name" },
|
|
| 609 |
- "replicaPolicy": {
|
|
| 610 |
- "atLeast": 2 |
|
| 611 |
- }, |
|
| 612 |
- "activeDeployment": "a_deployment_id", |
|
| 613 |
- "podTemplate": |
|
| 614 |
- {
|
|
| 615 |
- "desiredState": |
|
| 616 |
- {
|
|
| 617 |
- "image": "server/domain/name", |
|
| 618 |
- "network-ports": [ |
|
| 619 |
- {
|
|
| 620 |
- "hostPort": 8080, |
|
| 621 |
- "containerPort": 80 |
|
| 622 |
- } |
|
| 623 |
- ], |
|
| 624 |
- "owner": true |
|
| 625 |
- }, |
|
| 626 |
- "labels": {
|
|
| 627 |
- "name": "service-name" |
|
| 628 |
- } |
|
| 629 |
- } |
|
| 630 |
- } |
|
| 631 |
- ] |
|
| 632 |
- } |
|
| 633 |
-} |
|
| 634 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 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><ul class="nav nav-tabs"><li class=active><a href=#_services_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_services_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 635 |
- "data": |
|
| 636 |
- {
|
|
| 637 |
- "name": "service-name", |
|
| 638 |
- "desiredState": |
|
| 639 |
- {
|
|
| 640 |
- "replicas": 3, |
|
| 641 |
- "replicaPolicy": {
|
|
| 642 |
- "atLeast": 2 |
|
| 643 |
- }, |
|
| 644 |
- "podTemplate": |
|
| 645 |
- {
|
|
| 646 |
- "desiredState": |
|
| 647 |
- {
|
|
| 648 |
- "image": "server/domain/name", |
|
| 649 |
- "network-ports": [ |
|
| 650 |
- {
|
|
| 651 |
- "hostPort": 8080, |
|
| 652 |
- "containerPort": 80 |
|
| 653 |
- } |
|
| 654 |
- ] |
|
| 655 |
- } |
|
| 656 |
- } |
|
| 657 |
- } |
|
| 658 |
- } |
|
| 659 |
-} |
|
| 660 |
-</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_service__serviceID_ class=panel-title>/service/{serviceID}</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=collapsed data-toggle=collapse href=#panel__service__serviceID_><span class=parent></span>/service/{serviceID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_service__serviceID__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_service__serviceID__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_service__serviceID__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__service__serviceID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_service__serviceID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get a specific service definition</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_service__serviceID__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a service</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_service__serviceID__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a service</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_service__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></span>/service/{serviceID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get a specific service definition</p></div><ul class="nav nav-tabs"><li class=active><a href=#_service__serviceID__get_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_service__serviceID__get_request><h3>URI Parameters</h3><ul><li><strong>serviceID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 661 |
- "data": |
|
| 662 |
- {
|
|
| 663 |
- "id": "53c4249f076573c0f4000001", |
|
| 664 |
- "name": "service-name", |
|
| 665 |
- "domain": "domain-id", |
|
| 666 |
- "desiredState": |
|
| 667 |
- {
|
|
| 668 |
- "replicas": 3, |
|
| 669 |
- "replicaSelector": { "name": "service-name" },
|
|
| 670 |
- "replicaPolicy": {
|
|
| 671 |
- "atLeast": 2 |
|
| 672 |
- }, |
|
| 673 |
- "activeDeployment": "a_deployment_id", |
|
| 674 |
- "podTemplate": |
|
| 675 |
- {
|
|
| 676 |
- "desiredState": |
|
| 677 |
- {
|
|
| 678 |
- "image": "server/domain/name", |
|
| 679 |
- "network-ports": [ |
|
| 680 |
- {
|
|
| 681 |
- "hostPort": 8080, |
|
| 682 |
- "containerPort": 80 |
|
| 683 |
- } |
|
| 684 |
- ], |
|
| 685 |
- "owner": true |
|
| 686 |
- }, |
|
| 687 |
- "labels": {
|
|
| 688 |
- "name": "service-name" |
|
| 689 |
- } |
|
| 690 |
- } |
|
| 691 |
- } |
|
| 692 |
- } |
|
| 693 |
-} |
|
| 694 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_service__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></span>/service/{serviceID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update a service</p></div><ul class="nav nav-tabs"><li class=active><a href=#_service__serviceID__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_service__serviceID__put_request><h3>URI Parameters</h3><ul><li><strong>serviceID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 695 |
- "data": |
|
| 696 |
- {
|
|
| 697 |
- "id": "53c4249f076573c0f4000001", |
|
| 698 |
- "name": "service-name", |
|
| 699 |
- "domain": "domain-id", |
|
| 700 |
- "desiredState": |
|
| 701 |
- {
|
|
| 702 |
- "replicas": 3, |
|
| 703 |
- "replicaSelector": { "name": "service-name" },
|
|
| 704 |
- "replicaPolicy": {
|
|
| 705 |
- "atLeast": 2 |
|
| 706 |
- }, |
|
| 707 |
- "activeDeployment": "a_deployment_id", |
|
| 708 |
- "podTemplate": |
|
| 709 |
- {
|
|
| 710 |
- "desiredState": |
|
| 711 |
- {
|
|
| 712 |
- "image": "server/domain/name", |
|
| 713 |
- "network-ports": [ |
|
| 714 |
- {
|
|
| 715 |
- "hostPort": 8080, |
|
| 716 |
- "containerPort": 80 |
|
| 717 |
- } |
|
| 718 |
- ], |
|
| 719 |
- "owner": true |
|
| 720 |
- }, |
|
| 721 |
- "labels": {
|
|
| 722 |
- "name": "service-name" |
|
| 723 |
- } |
|
| 724 |
- } |
|
| 725 |
- } |
|
| 726 |
- } |
|
| 727 |
-} |
|
| 728 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_service__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></span>/service/{serviceID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete a service</p></div><ul class="nav nav-tabs"><li class=active><a href=#_service__serviceID__delete_request data-toggle=tab>Request</a></li><li><a href=#_service__serviceID__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_service__serviceID__delete_request><h3>URI Parameters</h3><ul><li><strong>serviceID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_service__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 729 |
- "apiVersion": "v1beta1", |
|
| 730 |
- "creationTimestamp": null, |
|
| 731 |
- "kind": "Status", |
|
| 732 |
- "status": "success" |
|
| 733 |
-} |
|
| 734 |
-</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__service__serviceID__environment_variables><span class=parent>/service/{serviceID}</span>/environment-variables</a> <span class=methods><a href=# data-toggle=modal data-target=#_service__serviceID__environment_variables_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_service__serviceID__environment_variables_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__service__serviceID__environment_variables class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_service__serviceID__environment_variables_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Environment variables associated with this service</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_service__serviceID__environment_variables_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create/update environment variables</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_service__serviceID__environment_variables_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>/service/{serviceID}</span>/environment-variables</h4></div><div class=modal-body><div class="alert alert-info"><p>Environment variables associated with this service</p></div><ul class="nav nav-tabs"><li class=active><a href=#_service__serviceID__environment_variables_get_request data-toggle=tab>Request</a></li><li><a href=#_service__serviceID__environment_variables_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_service__serviceID__environment_variables_get_request><h3>URI Parameters</h3><ul><li><strong>serviceID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_service__serviceID__environment_variables_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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 735 |
- "data": |
|
| 736 |
- [ |
|
| 737 |
- { "name": "var1", "value": "value1" },
|
|
| 738 |
- { "name": "var2", "value": "value2" }
|
|
| 739 |
- ] |
|
| 740 |
-} |
|
| 741 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_service__serviceID__environment_variables_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>/service/{serviceID}</span>/environment-variables</h4></div><div class=modal-body><div class="alert alert-info"><p>Create/update environment variables</p></div><ul class="nav nav-tabs"><li class=active><a href=#_service__serviceID__environment_variables_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_service__serviceID__environment_variables_post_request><h3>URI Parameters</h3><ul><li><strong>serviceID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 742 |
- "data": |
|
| 743 |
- [ |
|
| 744 |
- { "name": "var1", "value": "value1" },
|
|
| 745 |
- { "name": "var2", "value": "value2" }
|
|
| 746 |
- ] |
|
| 747 |
-} |
|
| 748 |
-</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__service__serviceID__environment_variables__variableName_><span class=parent>/service/{serviceID}/environment-variables</span>/{variableName}</a> <span class=methods><a href=# data-toggle=modal data-target=#_service__serviceID__environment_variables__variableName__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_service__serviceID__environment_variables__variableName__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_service__serviceID__environment_variables__variableName__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__service__serviceID__environment_variables__variableName_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_service__serviceID__environment_variables__variableName__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get environment variable</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_service__serviceID__environment_variables__variableName__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update an environment variable's value</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_service__serviceID__environment_variables__variableName__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete an environment variable</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_service__serviceID__environment_variables__variableName__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>/service/{serviceID}/environment-variables</span>/{variableName}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get environment variable</p></div><ul class="nav nav-tabs"><li class=active><a href=#_service__serviceID__environment_variables__variableName__get_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_service__serviceID__environment_variables__variableName__get_request><h3>URI Parameters</h3><ul><li><strong>serviceID</strong>: <em>required (string)</em></li><li><strong>variableName</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 749 |
- "data": { "name": "var1", "value": "value1" }
|
|
| 750 |
-} |
|
| 751 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_service__serviceID__environment_variables__variableName__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>/service/{serviceID}/environment-variables</span>/{variableName}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update an environment variable's value</p></div><ul class="nav nav-tabs"><li class=active><a href=#_service__serviceID__environment_variables__variableName__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_service__serviceID__environment_variables__variableName__put_request><h3>URI Parameters</h3><ul><li><strong>serviceID</strong>: <em>required (string)</em></li><li><strong>variableName</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 752 |
- "data": { "name": "var1", "value": "value1" }
|
|
| 753 |
-} |
|
| 754 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_service__serviceID__environment_variables__variableName__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>/service/{serviceID}/environment-variables</span>/{variableName}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete an environment variable</p></div><ul class="nav nav-tabs"><li class=active><a href=#_service__serviceID__environment_variables__variableName__delete_request data-toggle=tab>Request</a></li><li><a href=#_service__serviceID__environment_variables__variableName__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_service__serviceID__environment_variables__variableName__delete_request><h3>URI Parameters</h3><ul><li><strong>serviceID</strong>: <em>required (string)</em></li><li><strong>variableName</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_service__serviceID__environment_variables__variableName__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 755 |
- "apiVersion": "v1beta1", |
|
| 756 |
- "creationTimestamp": null, |
|
| 757 |
- "kind": "Status", |
|
| 758 |
- "status": "success" |
|
| 759 |
-} |
|
| 760 |
-</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_deployments class=panel-title>/deployments</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=collapsed data-toggle=collapse href=#panel__deployments><span class=parent></span>/deployments</a> <span class=methods><a href=# data-toggle=modal data-target=#_deployments_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_deployments_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__deployments class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_deployments_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Lists active deployments in the current project</p><p>Deployments effect change in a service such as scaling up, down, updating the current image, etc. Deployments may use different policies for carrying out the change. For example, a rolling update with a single pod change at a time, or a batch update, etc. Deployments make use of Kubernetes replicationControllers to bring about the changes.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_deployments_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new deployment</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_deployments_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>/deployments</h4></div><div class=modal-body><div class="alert alert-info"><p>Lists active deployments in the current project</p><p>Deployments effect change in a service such as scaling up, down, updating the current image, etc. Deployments may use different policies for carrying out the change. For example, a rolling update with a single pod change at a time, or a batch update, etc. Deployments make use of Kubernetes replicationControllers to bring about the changes.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_deployments_get_request data-toggle=tab>Request</a></li><li><a href=#_deployments_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_deployments_get_request></div><div class=tab-pane id=_deployments_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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 761 |
- "list": [ |
|
| 762 |
- {
|
|
| 763 |
- "id": "1234235172374", |
|
| 764 |
- "serviceId": "the-service-id", |
|
| 765 |
- "replicationControllers": [ |
|
| 766 |
- "replication-controller-id1", |
|
| 767 |
- "replication-controller-id2", |
|
| 768 |
- "replication-controller-id3" |
|
| 769 |
- ], |
|
| 770 |
- "currentState": {
|
|
| 771 |
- "replicas": 1, |
|
| 772 |
- "replicaSelector": {
|
|
| 773 |
- "name": "nginx" |
|
| 774 |
- }, |
|
| 775 |
- "containers": [{
|
|
| 776 |
- "image": "dockerfile/nginx", |
|
| 777 |
- "ports": [{"containerPort": 80, "hostPort": 8080}]
|
|
| 778 |
- }], |
|
| 779 |
- }, |
|
| 780 |
- "desiredState": {
|
|
| 781 |
- "replicas": 2, |
|
| 782 |
- "replicaSelector": {
|
|
| 783 |
- "name": "nginx" |
|
| 784 |
- }, |
|
| 785 |
- "containers": [{
|
|
| 786 |
- "image": "dockerfile/nginx/v2tag", |
|
| 787 |
- "ports": [{"containerPort": 80, "hostPort": 8080}]
|
|
| 788 |
- }], |
|
| 789 |
- }, |
|
| 790 |
- "status": "active" |
|
| 791 |
- } |
|
| 792 |
- ] |
|
| 793 |
-} |
|
| 794 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_deployments_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>/deployments</h4></div><div class=modal-body><div class="alert alert-info"><p>Create a new deployment</p></div><ul class="nav nav-tabs"><li class=active><a href=#_deployments_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_deployments_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 795 |
- "object": {
|
|
| 796 |
- "id": "1234235172374", |
|
| 797 |
- "serviceId": "the-service-id", |
|
| 798 |
- "desiredState": {
|
|
| 799 |
- "replicas": 2, |
|
| 800 |
- "replicaSelector": {
|
|
| 801 |
- "name": "nginx" |
|
| 802 |
- }, |
|
| 803 |
- "containers": [{
|
|
| 804 |
- "image": "dockerfile/nginx/v2tag", |
|
| 805 |
- "ports": [{"containerPort": 80, "hostPort": 8080}]
|
|
| 806 |
- }] |
|
| 807 |
- } |
|
| 808 |
- } |
|
| 809 |
-} |
|
| 810 |
-</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_deployment__deploymentID_ class=panel-title>/deployment/{deploymentID}</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=collapsed data-toggle=collapse href=#panel__deployment__deploymentID_><span class=parent></span>/deployment/{deploymentID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_deployment__deploymentID__get><span class="badge badge_get">get</span></a></span></h4></div><div id=panel__deployment__deploymentID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_deployment__deploymentID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get deployment details</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_deployment__deploymentID__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>/deployment/{deploymentID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get deployment details</p></div><ul class="nav nav-tabs"><li class=active><a href=#_deployment__deploymentID__get_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_deployment__deploymentID__get_request><h3>URI Parameters</h3><ul><li><strong>deploymentID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 811 |
- "object": {
|
|
| 812 |
- "id": "1234235172374", |
|
| 813 |
- "serviceId": "the-service-id", |
|
| 814 |
- "replicationControllers": [ |
|
| 815 |
- "replication-controller-id1", |
|
| 816 |
- "replication-controller-id2", |
|
| 817 |
- "replication-controller-id3" |
|
| 818 |
- ], |
|
| 819 |
- "currentState": {
|
|
| 820 |
- "replicas": 1, |
|
| 821 |
- "replicaSelector": {
|
|
| 822 |
- "name": "nginx" |
|
| 823 |
- }, |
|
| 824 |
- "containers": [{
|
|
| 825 |
- "image": "dockerfile/nginx", |
|
| 826 |
- "ports": [{"containerPort": 80, "hostPort": 8080}]
|
|
| 827 |
- }], |
|
| 828 |
- }, |
|
| 829 |
- "desiredState": {
|
|
| 830 |
- "replicas": 2, |
|
| 831 |
- "replicaSelector": {
|
|
| 832 |
- "name": "nginx" |
|
| 833 |
- }, |
|
| 834 |
- "containers": [{
|
|
| 835 |
- "image": "dockerfile/nginx/v2tag", |
|
| 836 |
- "ports": [{"containerPort": 80, "hostPort": 8080}]
|
|
| 837 |
- }], |
|
| 838 |
- }, |
|
| 839 |
- "status": "active" |
|
| 840 |
- } |
|
| 841 |
-} |
|
| 842 |
-</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_links class=panel-title>/links</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=collapsed data-toggle=collapse href=#panel__links><span class=parent></span>/links</a> <span class=methods><a href=# data-toggle=modal data-target=#_links_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_links_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__links class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_links_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>List of links between services in your account</p><p>Unlike a Docker link, a Link in OpenShift defines a relationship between services which may be composed by multiple Docker images. A link may include additional metadata about the relationship such as the algorithm to use to distribute requests.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_links_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new link between this service and a different service</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_links_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>/links</h4></div><div class=modal-body><div class="alert alert-info"><p>List of links between services in your account</p><p>Unlike a Docker link, a Link in OpenShift defines a relationship between services which may be composed by multiple Docker images. A link may include additional metadata about the relationship such as the algorithm to use to distribute requests.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_links_get_request data-toggle=tab>Request</a></li><li><a href=#_links_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_links_get_request><h3>Query Parameters</h3><ul><li><strong>projectId</strong>: <em>(string)</em><p>filter the links owned by a particular project</p></li><li><strong>serviceId</strong>: <em>(string)</em><p>filter the links attached to a particular service</p></li></ul></div><div class=tab-pane id=_links_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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 843 |
- "list": |
|
| 844 |
- [ |
|
| 845 |
- {
|
|
| 846 |
- "id": "53c4249f076573c0f4000001", |
|
| 847 |
- "projectId": "myproject-1234123132", |
|
| 848 |
- "source": {
|
|
| 849 |
- "serviceId": "nginx-1893747912737" |
|
| 850 |
- }, |
|
| 851 |
- "destination": {
|
|
| 852 |
- "serviceId": "ruby1.9-1237471273", |
|
| 853 |
- "port": 8080 |
|
| 854 |
- } |
|
| 855 |
- "policy": "round-robin" |
|
| 856 |
- } |
|
| 857 |
- ] |
|
| 858 |
-} |
|
| 859 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_links_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>/links</h4></div><div class=modal-body><div class="alert alert-info"><p>Create a new link between this service and a different service</p></div><ul class="nav nav-tabs"><li class=active><a href=#_links_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_links_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 860 |
- "data": |
|
| 861 |
- {
|
|
| 862 |
- "id": "53c4249f076573c0f4000001", |
|
| 863 |
- "projectId": "myproject-1234123132", |
|
| 864 |
- "source": {
|
|
| 865 |
- "serviceId": "nginx-1893747912737" |
|
| 866 |
- }, |
|
| 867 |
- "destination": {
|
|
| 868 |
- "serviceId": "ruby1.9-1237471273", |
|
| 869 |
- "port": 8080 |
|
| 870 |
- } |
|
| 871 |
- "policy": "round-robin" |
|
| 872 |
- } |
|
| 873 |
-} |
|
| 874 |
-</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_link__linkID_ class=panel-title>/link/{linkID}</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=collapsed data-toggle=collapse href=#panel__link__linkID_><span class=parent></span>/link/{linkID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_link__linkID__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_link__linkID__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_link__linkID__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__link__linkID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_link__linkID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get link details</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_link__linkID__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a link</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_link__linkID__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a link</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_link__linkID__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>/link/{linkID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get link details</p></div><ul class="nav nav-tabs"><li class=active><a href=#_link__linkID__get_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_link__linkID__get_request><h3>URI Parameters</h3><ul><li><strong>linkID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 875 |
- "data": |
|
| 876 |
- {
|
|
| 877 |
- "id": "53c4249f076573c0f4000001", |
|
| 878 |
- "projectId": "myproject-1234123132", |
|
| 879 |
- "source": {
|
|
| 880 |
- "serviceId": "nginx-1893747912737" |
|
| 881 |
- }, |
|
| 882 |
- "destination": {
|
|
| 883 |
- "serviceId": "ruby1.9-1237471273", |
|
| 884 |
- "port": 8080 |
|
| 885 |
- } |
|
| 886 |
- "policy": "round-robin" |
|
| 887 |
- } |
|
| 888 |
-} |
|
| 889 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_link__linkID__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></span>/link/{linkID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update a link</p></div><ul class="nav nav-tabs"><li class=active><a href=#_link__linkID__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_link__linkID__put_request><h3>URI Parameters</h3><ul><li><strong>linkID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 890 |
- "data": |
|
| 891 |
- {
|
|
| 892 |
- "id": "53c4249f076573c0f4000001", |
|
| 893 |
- "projectId": "myproject-1234123132", |
|
| 894 |
- "source": {
|
|
| 895 |
- "serviceId": "nginx-1893747912737" |
|
| 896 |
- }, |
|
| 897 |
- "destination": {
|
|
| 898 |
- "serviceId": "ruby1.9-1237471273", |
|
| 899 |
- "port": 8080 |
|
| 900 |
- } |
|
| 901 |
- "policy": "round-robin" |
|
| 902 |
- } |
|
| 903 |
-} |
|
| 904 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_link__linkID__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></span>/link/{linkID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete a link</p></div><ul class="nav nav-tabs"><li class=active><a href=#_link__linkID__delete_request data-toggle=tab>Request</a></li><li><a href=#_link__linkID__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_link__linkID__delete_request><h3>URI Parameters</h3><ul><li><strong>linkID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_link__linkID__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 905 |
- "apiVersion": "v1beta1", |
|
| 906 |
- "creationTimestamp": null, |
|
| 907 |
- "kind": "Status", |
|
| 908 |
- "status": "success" |
|
| 909 |
-} |
|
| 910 |
-</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_aliases class=panel-title>/aliases</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=collapsed data-toggle=collapse href=#panel__aliases><span class=parent></span>/aliases</a> <span class=methods><a href=# data-toggle=modal data-target=#_aliases_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_aliases_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__aliases class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_aliases_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>List all aliases visible to you</p><p>Aliases in v3 perform the same function as aliases in v2. The main difference is that in v3 an alias is associated with a service, not an application.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_aliases_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create an alias for this service</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_aliases_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>/aliases</h4></div><div class=modal-body><div class="alert alert-info"><p>List all aliases visible to you</p><p>Aliases in v3 perform the same function as aliases in v2. The main difference is that in v3 an alias is associated with a service, not an application.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_aliases_get_request data-toggle=tab>Request</a></li><li><a href=#_aliases_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_aliases_get_request><h3>Query Parameters</h3><ul><li><strong>serviceId</strong>: <em>(string)</em><p>filter aliases by associated service</p></li></ul></div><div class=tab-pane id=_aliases_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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 911 |
- "list": |
|
| 912 |
- [ |
|
| 913 |
- {
|
|
| 914 |
- "id": "myalias", |
|
| 915 |
- "ssl_certificate": "-----BEGIN CERTIFICATE-----\nMIIDoDCCAogCCQDzF8AJCHnrbjANBgkqhkiG9w0BAQUFADCBkTELMAkGA1UEBhMC\nVVMxCzAJBgNVBAgMAkNBMRIwEAYDVQQHDAlTdW5ueXZhbGUxDzANBgNVBAoMBnJl\nZGhhdDESMBAGA1UECwwJb3BlbnNoaWZ0MRIwEAYDVQQDDAlvcGVuc2hpZnQxKDAm\nBgkqhkiG9w0BCQEWGWluZm9Ab3BlbnNoaWZ0LnJlZGhhdC5jb20wHhcNMTMwMjE5\nMjExMTQ4WhcNMTQwMjE5MjExMTQ4WjCBkTELMAkGA1UEBhMCVVMxCzAJBgNVBAgM\nAkNBMRIwEAYDVQQHDAlTdW5ueXZhbGUxDzANBgNVBAoMBnJlZGhhdDESMBAGA1UE\nCwwJb3BlbnNoaWZ0MRIwEAYDVQQDDAlvcGVuc2hpZnQxKDAmBgkqhkiG9w0BCQEW\nGWluZm9Ab3BlbnNoaWZ0LnJlZGhhdC5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IB\nDwAwggEKAoIBAQDAEbH4MCi3iIDP1HS+/Xwu8SjdSc5WJX6htV7hJpmFZ8HohV/8\nba0v6aM9IJIIt+sIe2J62t/9G3leOdIHBxeACN4fV2l/iA/fvxvlnFKeD7sHm9Oc\nYj1H6YYJ57sIOf/oLDpJl6l3Rw8VC3+3W0/lzlVpA8qt7fpkiW7XQJCPplUSrdVC\n3okQ2T5NAod5+wVIOqELgE5bLX1LRs5VPsjytHkJ7rKXs55FHR3kpsoImn5xD0Ky\n6lRn8cIMolQoyN5HIGr8f5P+07hrHibve8jje/DKTssb5yEUAEmh6iGHQsRAnsUW\nQoIEUOLqQCu9re2No4G52Kl2xQIjyJF7rCfxAgMBAAEwDQYJKoZIhvcNAQEFBQAD\nggEBAGHrya/ZkiAje2kHsOajXMlO2+y1iLfUDcRLuEWpUa8sI5EM4YtemQrsupFp\n8lVYG5C4Vh8476oF9t8Wex5eH3ocwbSvPIUqE07hdmrubiMq4wxFVRYq7g9lHAnx\nl+bABuN/orbAcPcGAGg7AkXVoAc3Fza/ZcgMcw7NOtDTEss70V9OdgCfQUJL0KdO\nhCO8bQ1EaEiq6zEh8RpZe8mu+f/GYATX1I+eJUc6F6cn83oJjE9bqAVzk7TzTHeK\nEBKN50C14wWtXeG7n2+ugaVO+0xnvHeUrQBLHSRyOHqxXrQQ5XmzcaBiyI0f2IQM\nHst1BVXyX0n/L/ZoYYsv5juJmDo=\n-----END CERTIFICATE-----", |
|
| 916 |
- "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEAwBGx+DAot4iAz9R0vv18LvEo3UnOViV+obVe4SaZhWfB6IVf\n/G2tL+mjPSCSCLfrCHtietrf/Rt5XjnSBwcXgAjeH1dpf4gP378b5ZxSng+7B5vT\nnGI9R+mGCee7CDn/6Cw6SZepd0cPFQt/t1tP5c5VaQPKre36ZIlu10CQj6ZVEq3V\nQt6JENk+TQKHefsFSDqhC4BOWy19S0bOVT7I8rR5Ce6yl7OeRR0d5KbKCJp+cQ9C\nsupUZ/HCDKJUKMjeRyBq/H+T/tO4ax4m73vI43vwyk7LG+chFABJoeohh0LEQJ7F\nFkKCBFDi6kArva3tjaOBudipdsUCI8iRe6wn8QIDAQABAoIBAG/on4JVRRQSw8LU\nLiWt+jI7ryyoOUH2XL8JtzuGSwLwvomlVJT2rmbxQXx3Qr8zsgziHzIn30RRQrkF\nBXu0xRuDjzBBtSVqeJ1Mc4uoNncEAVxgjb5bewswZDnXPCGB8bosMtX4OPRXgdEo\nPwTtfjMOsrMaU3hd5Xu4m81tQA2BvwOlx8aYDyH0jeTnervc5uRGbeTBQG4Bu40E\nrWNmXvgNq2EzTAwbbN6Ma97gw9KgXnM4Nlh29Fxb5TBeUU9lkzuTZAZIDXKIm7AG\nUwMbj/A038yAumYQtThTE/3e4W3rn7F2Vko900bC4aAC1KQOAzjIeQqzqkVxWTWq\n4SUFQAECgYEA/ODwifOTuI6hdZK6JRgc4wp6Rc0fkqHuxLzABXoIGuSVlWyimqIN\nZySAkpo5EW6DNraRJxNCOBmWeGPEhHGrea+JPiPEwCK0F7SxvSmg3jzNzw3Es31T\necET7eDwuSOY9v4XDzLyiXXkEUUReD7Ng2hEYL+HaQrl5jWj4lxgq/ECgYEAwnCb\nKrz7FwX8AqtFAEi6uUrc12k1xYKQfrwSxbfdK2vBBUpgB71Iq/fqP+1BittEljDG\n8f4jEtMBFfEPhLzGIHaI3UiHUHXS4GetA77TRgR8lnKKpj1FcMIY2iKU479707O5\nQ08pgWRUDQ8BVg2ePgbo5QjLMc/rv7UF3AHvPAECgYB/auAIwqDGN6gHU/1TP4ke\npWLi1O55tfpXSzv+BnUbB96PQgPUop7aP7xBIlBrBiI7aVZOOBf/qHT3CF421geu\n8tHWa7NxlIrl/vgn9lfGYyDYmXlpb1amXLEsBVGGF/e1TGZWFDe9J5fZU9HvosVu\n1xTNIvSZ6xHYI2MGZcGYIQKBgEYeebaV5C7PV6xWu1F46O19U9rS9DM//H/XryVi\nQv4vo7IWuj7QQe7SPsXC98ntfPR0rqoCLf/R3ChfgGsr8H8wf/bc+v9HHj8S5E/f\ndy1e3Nccg2ej3PDm7jNsGSlwmmUkAQGHAL7KwYzcBm1UB+bycvZ1j2FtS+UckPpg\nMDgBAoGALD8PkxHb4U4DtbNFSYRrUdvS9heav/yph3lTMfifNkOir36io6v8RPgb\nD2bHKKZgmYlTgJrxD45Er9agC5jclJO35QRU/OfGf3GcnABkBI7vlvUKADAo65Sq\nweZkdJnbrIadcvLOHOzkKC9m+rxFTC9VoN1dwK2zwYvUXfa1VJA=\n-----END RSA PRIVATE KEY-----", |
|
| 917 |
- "pass_phrase": "abcd" |
|
| 918 |
- } |
|
| 919 |
- ] |
|
| 920 |
-} |
|
| 921 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_aliases_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>/aliases</h4></div><div class=modal-body><div class="alert alert-info"><p>Create an alias for this service</p></div><ul class="nav nav-tabs"><li class=active><a href=#_aliases_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_aliases_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 922 |
- "data": |
|
| 923 |
- {
|
|
| 924 |
- "id": "53c4249f076573c0f4000001", |
|
| 925 |
- "suffix": "dev.rhcloud.com", |
|
| 926 |
- "name": "mydomain", |
|
| 927 |
- "members": [ |
|
| 928 |
- {
|
|
| 929 |
- "login": "adminuser", |
|
| 930 |
- "role": "admin", |
|
| 931 |
- "type": "user", |
|
| 932 |
- "owner": true |
|
| 933 |
- } |
|
| 934 |
- ] |
|
| 935 |
- } |
|
| 936 |
-} |
|
| 937 |
-</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_alias__aliasID_ class=panel-title>/alias/{aliasID}</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=collapsed data-toggle=collapse href=#panel__alias__aliasID_><span class=parent></span>/alias/{aliasID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_alias__aliasID__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_alias__aliasID__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_alias__aliasID__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__alias__aliasID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_alias__aliasID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get alias</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_alias__aliasID__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update an alias</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_alias__aliasID__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete an alias</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_alias__aliasID__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>/alias/{aliasID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get alias</p></div><ul class="nav nav-tabs"><li class=active><a href=#_alias__aliasID__get_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_alias__aliasID__get_request><h3>URI Parameters</h3><ul><li><strong>aliasID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 938 |
- "data": |
|
| 939 |
- {
|
|
| 940 |
- "id": "53c4249f076573c0f4000001", |
|
| 941 |
- "suffix": "dev.rhcloud.com", |
|
| 942 |
- "name": "mydomain", |
|
| 943 |
- "members": [ |
|
| 944 |
- {
|
|
| 945 |
- "login": "adminuser", |
|
| 946 |
- "role": "admin", |
|
| 947 |
- "type": "user", |
|
| 948 |
- "owner": true |
|
| 949 |
- } |
|
| 950 |
- ] |
|
| 951 |
- } |
|
| 952 |
-} |
|
| 953 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_alias__aliasID__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></span>/alias/{aliasID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update an alias</p></div><ul class="nav nav-tabs"><li class=active><a href=#_alias__aliasID__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_alias__aliasID__put_request><h3>URI Parameters</h3><ul><li><strong>aliasID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 954 |
- "data": |
|
| 955 |
- {
|
|
| 956 |
- "id": "53c4249f076573c0f4000001", |
|
| 957 |
- "suffix": "dev.rhcloud.com", |
|
| 958 |
- "name": "mydomain", |
|
| 959 |
- "members": [ |
|
| 960 |
- {
|
|
| 961 |
- "login": "adminuser", |
|
| 962 |
- "role": "admin", |
|
| 963 |
- "type": "user", |
|
| 964 |
- "owner": true |
|
| 965 |
- } |
|
| 966 |
- ] |
|
| 967 |
- } |
|
| 968 |
-} |
|
| 969 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_alias__aliasID__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></span>/alias/{aliasID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete an alias</p></div><ul class="nav nav-tabs"><li class=active><a href=#_alias__aliasID__delete_request data-toggle=tab>Request</a></li><li><a href=#_alias__aliasID__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_alias__aliasID__delete_request><h3>URI Parameters</h3><ul><li><strong>aliasID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_alias__aliasID__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 970 |
- "apiVersion": "v1beta1", |
|
| 971 |
- "creationTimestamp": null, |
|
| 972 |
- "kind": "Status", |
|
| 973 |
- "status": "success" |
|
| 974 |
-} |
|
| 975 |
-</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_builds class=panel-title>/builds</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=collapsed data-toggle=collapse href=#panel__builds><span class=parent></span>/builds</a> <span class=methods><a href=# data-toggle=modal data-target=#_builds_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_builds_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__builds class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_builds_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Retrieves a list of builds</p><p>Build encapsulates the inputs needed to produce a new deployable image, as well as the status of the operation and a reference to the Pod which runs the build.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_builds_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new build</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_builds_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>/builds</h4></div><div class=modal-body><div class="alert alert-info"><p>Retrieves a list of builds</p><p>Build encapsulates the inputs needed to produce a new deployable image, as well as the status of the operation and a reference to the Pod which runs the build.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_builds_get_request data-toggle=tab>Request</a></li><li><a href=#_builds_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_builds_get_request></div><div class=tab-pane id=_builds_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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 976 |
- "apiVersion": "v1beta1", |
|
| 977 |
- "creationTimestamp": null, |
|
| 978 |
- "items": [ |
|
| 979 |
- {
|
|
| 980 |
- "creationTimestamp": "2014-09-16T02:58:19Z", |
|
| 981 |
- "id": "5065bcf2-3d4d-11e4-a95b-0800279696e1", |
|
| 982 |
- "input": {
|
|
| 983 |
- "imageTag": "test/dockerbuild", |
|
| 984 |
- "sourceURI": "git://github.com/test/dockerbuild", |
|
| 985 |
- "type": "docker" |
|
| 986 |
- }, |
|
| 987 |
- "podID": "build-sti-5065bcf2-3d4d-11e4-a95b-0800279696e1", |
|
| 988 |
- "resourceVersion": 114, |
|
| 989 |
- "status": "new" |
|
| 990 |
- } |
|
| 991 |
- ], |
|
| 992 |
- "kind": "BuildList", |
|
| 993 |
- "resourceVersion": 116 |
|
| 994 |
-} |
|
| 995 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_builds_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>/builds</h4></div><div class=modal-body><div class="alert alert-info"><p>Create a new build</p></div><ul class="nav nav-tabs"><li class=active><a href=#_builds_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_builds_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 996 |
- "kind": "Build", |
|
| 997 |
- "apiVersion": "v1beta1", |
|
| 998 |
- "input": {
|
|
| 999 |
- "type": "docker", |
|
| 1000 |
- "sourceURI": "github.com/test/dockerBuild", |
|
| 1001 |
- "imageTag": "test/dockerBuild" |
|
| 1002 |
- } |
|
| 1003 |
-} |
|
| 1004 |
-</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_builds__buildId_ class=panel-title>/builds/{buildId}</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=collapsed data-toggle=collapse href=#panel__builds__buildId_><span class=parent></span>/builds/{buildId}</a> <span class=methods><a href=# data-toggle=modal data-target=#_builds__buildId__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_builds__buildId__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_builds__buildId__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__builds__buildId_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_builds__buildId__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Retrieve a single build definition</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_builds__buildId__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a build definition</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_builds__buildId__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a build definition</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_builds__buildId__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>/builds/{buildId}</h4></div><div class=modal-body><div class="alert alert-info"><p>Retrieve a single build definition</p></div><ul class="nav nav-tabs"><li class=active><a href=#_builds__buildId__get_request data-toggle=tab>Request</a></li><li><a href=#_builds__buildId__get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_builds__buildId__get_request><h3>URI Parameters</h3><ul><li><strong>buildId</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_builds__buildId__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1005 |
- "apiVersion": "v1beta1", |
|
| 1006 |
- "creationTimestamp": "2014-09-16T02:58:19Z", |
|
| 1007 |
- "id": "5065bcf2-3d4d-11e4-a95b-0800279696e1", |
|
| 1008 |
- "input": {
|
|
| 1009 |
- "imageTag": "test/dockerBuild", |
|
| 1010 |
- "sourceURI": "github.com/test/dockerBuild", |
|
| 1011 |
- "type": "docker" |
|
| 1012 |
- }, |
|
| 1013 |
- "kind": "Build", |
|
| 1014 |
- "podID": "build-sti-5065bcf2-3d4d-11e4-a95b-0800279696e1", |
|
| 1015 |
- "resourceVersion": 114, |
|
| 1016 |
- "status": "pending" |
|
| 1017 |
-} |
|
| 1018 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_builds__buildId__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></span>/builds/{buildId}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update a build definition</p></div><ul class="nav nav-tabs"><li class=active><a href=#_builds__buildId__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_builds__buildId__put_request><h3>URI Parameters</h3><ul><li><strong>buildId</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1019 |
- "apiVersion": "v1beta1", |
|
| 1020 |
- "creationTimestamp": "2014-09-16T02:58:19Z", |
|
| 1021 |
- "id": "5065bcf2-3d4d-11e4-a95b-0800279696e1", |
|
| 1022 |
- "input": {
|
|
| 1023 |
- "imageTag": "test/dockerBuild", |
|
| 1024 |
- "sourceURI": "github.com/test/dockerBuild", |
|
| 1025 |
- "type": "docker" |
|
| 1026 |
- }, |
|
| 1027 |
- "kind": "Build", |
|
| 1028 |
- "podID": "build-sti-5065bcf2-3d4d-11e4-a95b-0800279696e1", |
|
| 1029 |
- "resourceVersion": 114, |
|
| 1030 |
- "status": "pending" |
|
| 1031 |
-} |
|
| 1032 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_builds__buildId__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></span>/builds/{buildId}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete a build definition</p></div><ul class="nav nav-tabs"><li class=active><a href=#_builds__buildId__delete_request data-toggle=tab>Request</a></li><li><a href=#_builds__buildId__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_builds__buildId__delete_request><h3>URI Parameters</h3><ul><li><strong>buildId</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_builds__buildId__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1033 |
- "apiVersion": "v1beta1", |
|
| 1034 |
- "creationTimestamp": null, |
|
| 1035 |
- "kind": "Status", |
|
| 1036 |
- "status": "success" |
|
| 1037 |
-} |
|
| 1038 |
-</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_buildConfigs class=panel-title>/buildConfigs</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=collapsed data-toggle=collapse href=#panel__buildConfigs><span class=parent></span>/buildConfigs</a> <span class=methods><a href=# data-toggle=modal data-target=#_buildConfigs_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_buildConfigs_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__buildConfigs class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_buildConfigs_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Retrieves a list of BuildConfigs</p><p>BuildConfig contains the inputs needed to produce a new deployable image</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_buildConfigs_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new build</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_buildConfigs_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>/buildConfigs</h4></div><div class=modal-body><div class="alert alert-info"><p>Retrieves a list of BuildConfigs</p><p>BuildConfig contains the inputs needed to produce a new deployable image</p></div><ul class="nav nav-tabs"><li class=active><a href=#_buildConfigs_get_request data-toggle=tab>Request</a></li><li><a href=#_buildConfigs_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_buildConfigs_get_request></div><div class=tab-pane id=_buildConfigs_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></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_buildConfigs_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>/buildConfigs</h4></div><div class=modal-body><div class="alert alert-info"><p>Create a new build</p></div><ul class="nav nav-tabs"><li class=active><a href=#_buildConfigs_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_buildConfigs_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1039 |
- "kind": "BuildConfig", |
|
| 1040 |
- "apiVersion": "v1beta1", |
|
| 1041 |
- "desiredInput": {
|
|
| 1042 |
- "type": "sti", |
|
| 1043 |
- "sourceURI": "git://github.com/pmorie/simple-ruby", |
|
| 1044 |
- "builderImage": "openshift/ruby-19-centos", |
|
| 1045 |
- "imageTag": "test-ruby-app" |
|
| 1046 |
- } |
|
| 1047 |
-} |
|
| 1048 |
-</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_buildConfigs__configId_ class=panel-title>/buildConfigs/{configId}</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=collapsed data-toggle=collapse href=#panel__buildConfigs__configId_><span class=parent></span>/buildConfigs/{configId}</a> <span class=methods><a href=# data-toggle=modal data-target=#_buildConfigs__configId__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_buildConfigs__configId__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_buildConfigs__configId__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__buildConfigs__configId_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_buildConfigs__configId__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Retrieve a build configuration</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_buildConfigs__configId__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a build configuration</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_buildConfigs__configId__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a build configuration</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_buildConfigs__configId__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>/buildConfigs/{configId}</h4></div><div class=modal-body><div class="alert alert-info"><p>Retrieve a build configuration</p></div><ul class="nav nav-tabs"><li class=active><a href=#_buildConfigs__configId__get_request data-toggle=tab>Request</a></li><li><a href=#_buildConfigs__configId__get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_buildConfigs__configId__get_request><h3>URI Parameters</h3><ul><li><strong>configId</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_buildConfigs__configId__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1049 |
- "apiVersion": "v1beta1", |
|
| 1050 |
- "creationTimestamp": "2014-09-16T19:33:36Z", |
|
| 1051 |
- "desiredInput": {
|
|
| 1052 |
- "builderImage": "openshift/ruby-19-centos", |
|
| 1053 |
- "imageTag": "test-ruby-app", |
|
| 1054 |
- "sourceURI": "git://github.com/pmorie/simple-ruby", |
|
| 1055 |
- "type": "sti" |
|
| 1056 |
- }, |
|
| 1057 |
- "id": "5a6a5b9c-3dd8-11e4-9d75-0800279696e1", |
|
| 1058 |
- "kind": "BuildConfig", |
|
| 1059 |
- "resourceVersion": 117 |
|
| 1060 |
-} |
|
| 1061 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_buildConfigs__configId__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></span>/buildConfigs/{configId}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update a build configuration</p></div><ul class="nav nav-tabs"><li class=active><a href=#_buildConfigs__configId__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_buildConfigs__configId__put_request><h3>URI Parameters</h3><ul><li><strong>configId</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1062 |
- "apiVersion": "v1beta1", |
|
| 1063 |
- "creationTimestamp": "2014-09-16T19:33:36Z", |
|
| 1064 |
- "desiredInput": {
|
|
| 1065 |
- "builderImage": "openshift/ruby-19-centos", |
|
| 1066 |
- "imageTag": "test-ruby-app", |
|
| 1067 |
- "sourceURI": "git://github.com/pmorie/simple-ruby", |
|
| 1068 |
- "type": "sti" |
|
| 1069 |
- }, |
|
| 1070 |
- "id": "5a6a5b9c-3dd8-11e4-9d75-0800279696e1", |
|
| 1071 |
- "kind": "BuildConfig", |
|
| 1072 |
- "resourceVersion": 117 |
|
| 1073 |
-} |
|
| 1074 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_buildConfigs__configId__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></span>/buildConfigs/{configId}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete a build configuration</p></div><ul class="nav nav-tabs"><li class=active><a href=#_buildConfigs__configId__delete_request data-toggle=tab>Request</a></li><li><a href=#_buildConfigs__configId__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_buildConfigs__configId__delete_request><h3>URI Parameters</h3><ul><li><strong>configId</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_buildConfigs__configId__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1075 |
- "apiVersion": "v1beta1", |
|
| 1076 |
- "creationTimestamp": null, |
|
| 1077 |
- "kind": "Status", |
|
| 1078 |
- "status": "success" |
|
| 1079 |
-} |
|
| 1080 |
-</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_buildConfigHooks__buildId___secret___plugin_ class=panel-title>/buildConfigHooks/{buildId}/{secret}/{plugin}</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=collapsed data-toggle=collapse href=#panel__buildConfigHooks__buildId___secret___plugin_><span class=parent></span>/buildConfigHooks/{buildId}/{secret}/{plugin}</a> <span class=methods><a href=# data-toggle=modal data-target=#_buildConfigHooks__buildId___secret___plugin__post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__buildConfigHooks__buildId___secret___plugin_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_buildConfigHooks__buildId___secret___plugin__post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Webhook on push event from external repository</p><p>buildId specifies which build to trigger, whereas plugin defines source of the request, this might be github, bitbucket or others.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_buildConfigHooks__buildId___secret___plugin__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>/buildConfigHooks/{buildId}/{secret}/{plugin}</h4></div><div class=modal-body><div class="alert alert-info"><p>Webhook on push event from external repository</p><p>buildId specifies which build to trigger, whereas plugin defines source of the request, this might be github, bitbucket or others.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_buildConfigHooks__buildId___secret___plugin__post_request data-toggle=tab>Request</a></li><li><a href=#_buildConfigHooks__buildId___secret___plugin__post_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_buildConfigHooks__buildId___secret___plugin__post_request><h3>URI Parameters</h3><ul><li><strong>buildId</strong>: <em>required (string)</em></li><li><strong>secret</strong>: <em>required (string)</em></li><li><strong>plugin</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_buildConfigHooks__buildId___secret___plugin__post_response><h2>HTTP status code <a href=http://httpstatus.es/204 target=_blank>204</a></h2><p>No content</p></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_templates class=panel-title>/templates</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=collapsed data-toggle=collapse href=#panel__templates><span class=parent></span>/templates</a> <span class=methods><a href=# data-toggle=modal data-target=#_templates_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_templates_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__templates class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_templates_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Lists all templates that your account has access to</p><p>A template defines 0..n services and 0..m links. When it is applied to an existing project, those services and links are instantiated for that project.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_templates_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new template</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_templates_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>/templates</h4></div><div class=modal-body><div class="alert alert-info"><p>Lists all templates that your account has access to</p><p>A template defines 0..n services and 0..m links. When it is applied to an existing project, those services and links are instantiated for that project.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_templates_get_request data-toggle=tab>Request</a></li><li><a href=#_templates_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_templates_get_request></div><div class=tab-pane id=_templates_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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1081 |
- "list": |
|
| 1082 |
- [ |
|
| 1083 |
- {
|
|
| 1084 |
- "services": [ |
|
| 1085 |
- {
|
|
| 1086 |
- "name": "service-name", |
|
| 1087 |
- "domain": "domain-id", |
|
| 1088 |
- "desiredState": |
|
| 1089 |
- {
|
|
| 1090 |
- "replicas": 3, |
|
| 1091 |
- "replicaSelector": { "name": "service-name" },
|
|
| 1092 |
- "replicaPolicy": {
|
|
| 1093 |
- "atLeast": 2 |
|
| 1094 |
- }, |
|
| 1095 |
- "activeDeployment": "a_deployment_id", |
|
| 1096 |
- "podTemplate": |
|
| 1097 |
- {
|
|
| 1098 |
- "desiredState": |
|
| 1099 |
- {
|
|
| 1100 |
- "image": "server/domain/name", |
|
| 1101 |
- "network-ports": [ |
|
| 1102 |
- {
|
|
| 1103 |
- "hostPort": 8080, |
|
| 1104 |
- "containerPort": 80 |
|
| 1105 |
- } |
|
| 1106 |
- ], |
|
| 1107 |
- "owner": true |
|
| 1108 |
- }, |
|
| 1109 |
- "labels": {
|
|
| 1110 |
- "name": "service-name" |
|
| 1111 |
- } |
|
| 1112 |
- } |
|
| 1113 |
- } |
|
| 1114 |
- } |
|
| 1115 |
- ], |
|
| 1116 |
- "links": [ |
|
| 1117 |
- {
|
|
| 1118 |
- "id": "53c4249f076573c0f4000001", |
|
| 1119 |
- "projectId": "myproject-1234123132", |
|
| 1120 |
- "source": {
|
|
| 1121 |
- "serviceId": "nginx-1893747912737" |
|
| 1122 |
- }, |
|
| 1123 |
- "destination": {
|
|
| 1124 |
- "serviceId": "ruby1.9-1237471273", |
|
| 1125 |
- "port": 8080 |
|
| 1126 |
- } |
|
| 1127 |
- "policy": "round-robin" |
|
| 1128 |
- } |
|
| 1129 |
- ] |
|
| 1130 |
- } |
|
| 1131 |
- ] |
|
| 1132 |
-} |
|
| 1133 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_templates_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>/templates</h4></div><div class=modal-body><div class="alert alert-info"><p>Create a new template</p></div><ul class="nav nav-tabs"><li class=active><a href=#_templates_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_templates_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1134 |
- "data": |
|
| 1135 |
- {
|
|
| 1136 |
- "services": [ |
|
| 1137 |
- {
|
|
| 1138 |
- "name": "service-name", |
|
| 1139 |
- "domain": "domain-id", |
|
| 1140 |
- "desiredState": |
|
| 1141 |
- {
|
|
| 1142 |
- "replicas": 3, |
|
| 1143 |
- "replicaSelector": { "name": "service-name" },
|
|
| 1144 |
- "replicaPolicy": {
|
|
| 1145 |
- "atLeast": 2 |
|
| 1146 |
- }, |
|
| 1147 |
- "activeDeployment": "a_deployment_id", |
|
| 1148 |
- "podTemplate": |
|
| 1149 |
- {
|
|
| 1150 |
- "desiredState": |
|
| 1151 |
- {
|
|
| 1152 |
- "image": "server/domain/name", |
|
| 1153 |
- "network-ports": [ |
|
| 1154 |
- {
|
|
| 1155 |
- "hostPort": 8080, |
|
| 1156 |
- "containerPort": 80 |
|
| 1157 |
- } |
|
| 1158 |
- ], |
|
| 1159 |
- "owner": true |
|
| 1160 |
- }, |
|
| 1161 |
- "labels": {
|
|
| 1162 |
- "name": "service-name" |
|
| 1163 |
- } |
|
| 1164 |
- } |
|
| 1165 |
- } |
|
| 1166 |
- } |
|
| 1167 |
- ], |
|
| 1168 |
- "links": [ |
|
| 1169 |
- {
|
|
| 1170 |
- "id": "53c4249f076573c0f4000001", |
|
| 1171 |
- "projectId": "myproject-1234123132", |
|
| 1172 |
- "source": {
|
|
| 1173 |
- "serviceId": "nginx-1893747912737" |
|
| 1174 |
- }, |
|
| 1175 |
- "destination": {
|
|
| 1176 |
- "serviceId": "ruby1.9-1237471273", |
|
| 1177 |
- "port": 8080 |
|
| 1178 |
- } |
|
| 1179 |
- "policy": "round-robin" |
|
| 1180 |
- } |
|
| 1181 |
- ] |
|
| 1182 |
- } |
|
| 1183 |
-} |
|
| 1184 |
-</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_template__templateID_ class=panel-title>/template/{templateID}</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=collapsed data-toggle=collapse href=#panel__template__templateID_><span class=parent></span>/template/{templateID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_template__templateID__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_template__templateID__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_template__templateID__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__template__templateID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_template__templateID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get a specific template</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_template__templateID__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a template</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_template__templateID__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a template</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_template__templateID__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>/template/{templateID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get a specific template</p></div><ul class="nav nav-tabs"><li class=active><a href=#_template__templateID__get_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_template__templateID__get_request><h3>URI Parameters</h3><ul><li><strong>templateID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1185 |
- "data": |
|
| 1186 |
- {
|
|
| 1187 |
- "services": [ |
|
| 1188 |
- {
|
|
| 1189 |
- "name": "service-name", |
|
| 1190 |
- "domain": "domain-id", |
|
| 1191 |
- "desiredState": |
|
| 1192 |
- {
|
|
| 1193 |
- "replicas": 3, |
|
| 1194 |
- "replicaSelector": { "name": "service-name" },
|
|
| 1195 |
- "replicaPolicy": {
|
|
| 1196 |
- "atLeast": 2 |
|
| 1197 |
- }, |
|
| 1198 |
- "activeDeployment": "a_deployment_id", |
|
| 1199 |
- "podTemplate": |
|
| 1200 |
- {
|
|
| 1201 |
- "desiredState": |
|
| 1202 |
- {
|
|
| 1203 |
- "image": "server/domain/name", |
|
| 1204 |
- "network-ports": [ |
|
| 1205 |
- {
|
|
| 1206 |
- "hostPort": 8080, |
|
| 1207 |
- "containerPort": 80 |
|
| 1208 |
- } |
|
| 1209 |
- ], |
|
| 1210 |
- "owner": true |
|
| 1211 |
- }, |
|
| 1212 |
- "labels": {
|
|
| 1213 |
- "name": "service-name" |
|
| 1214 |
- } |
|
| 1215 |
- } |
|
| 1216 |
- } |
|
| 1217 |
- } |
|
| 1218 |
- ], |
|
| 1219 |
- "links": [ |
|
| 1220 |
- {
|
|
| 1221 |
- "id": "53c4249f076573c0f4000001", |
|
| 1222 |
- "projectId": "myproject-1234123132", |
|
| 1223 |
- "source": {
|
|
| 1224 |
- "serviceId": "nginx-1893747912737" |
|
| 1225 |
- }, |
|
| 1226 |
- "destination": {
|
|
| 1227 |
- "serviceId": "ruby1.9-1237471273", |
|
| 1228 |
- "port": 8080 |
|
| 1229 |
- } |
|
| 1230 |
- "policy": "round-robin" |
|
| 1231 |
- } |
|
| 1232 |
- ] |
|
| 1233 |
- } |
|
| 1234 |
-} |
|
| 1235 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_template__templateID__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></span>/template/{templateID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update a template</p></div><ul class="nav nav-tabs"><li class=active><a href=#_template__templateID__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_template__templateID__put_request><h3>URI Parameters</h3><ul><li><strong>templateID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1236 |
- "data": |
|
| 1237 |
- {
|
|
| 1238 |
- "services": [ |
|
| 1239 |
- {
|
|
| 1240 |
- "name": "service-name", |
|
| 1241 |
- "domain": "domain-id", |
|
| 1242 |
- "desiredState": |
|
| 1243 |
- {
|
|
| 1244 |
- "replicas": 3, |
|
| 1245 |
- "replicaSelector": { "name": "service-name" },
|
|
| 1246 |
- "replicaPolicy": {
|
|
| 1247 |
- "atLeast": 2 |
|
| 1248 |
- }, |
|
| 1249 |
- "activeDeployment": "a_deployment_id", |
|
| 1250 |
- "podTemplate": |
|
| 1251 |
- {
|
|
| 1252 |
- "desiredState": |
|
| 1253 |
- {
|
|
| 1254 |
- "image": "server/domain/name", |
|
| 1255 |
- "network-ports": [ |
|
| 1256 |
- {
|
|
| 1257 |
- "hostPort": 8080, |
|
| 1258 |
- "containerPort": 80 |
|
| 1259 |
- } |
|
| 1260 |
- ], |
|
| 1261 |
- "owner": true |
|
| 1262 |
- }, |
|
| 1263 |
- "labels": {
|
|
| 1264 |
- "name": "service-name" |
|
| 1265 |
- } |
|
| 1266 |
- } |
|
| 1267 |
- } |
|
| 1268 |
- } |
|
| 1269 |
- ], |
|
| 1270 |
- "links": [ |
|
| 1271 |
- {
|
|
| 1272 |
- "id": "53c4249f076573c0f4000001", |
|
| 1273 |
- "projectId": "myproject-1234123132", |
|
| 1274 |
- "source": {
|
|
| 1275 |
- "serviceId": "nginx-1893747912737" |
|
| 1276 |
- }, |
|
| 1277 |
- "destination": {
|
|
| 1278 |
- "serviceId": "ruby1.9-1237471273", |
|
| 1279 |
- "port": 8080 |
|
| 1280 |
- } |
|
| 1281 |
- "policy": "round-robin" |
|
| 1282 |
- } |
|
| 1283 |
- ] |
|
| 1284 |
- } |
|
| 1285 |
-} |
|
| 1286 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_template__templateID__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></span>/template/{templateID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete a template</p></div><ul class="nav nav-tabs"><li class=active><a href=#_template__templateID__delete_request data-toggle=tab>Request</a></li><li><a href=#_template__templateID__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_template__templateID__delete_request><h3>URI Parameters</h3><ul><li><strong>templateID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_template__templateID__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1287 |
- "apiVersion": "v1beta1", |
|
| 1288 |
- "creationTimestamp": null, |
|
| 1289 |
- "kind": "Status", |
|
| 1290 |
- "status": "success" |
|
| 1291 |
-} |
|
| 1292 |
-</code></pre></div></div></div></div></div></div></div></div></div></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=collapsed data-toggle=collapse href=#panel__pods><span class=parent></span>/pods</a> <span class=methods><a href=# data-toggle=modal data-target=#_pods_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_pods_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__pods class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_pods_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>List all pods on this cluster</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_pods_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new pod. currentState is ignored if present.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 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><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><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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1293 |
- "items": [ |
|
| 1294 |
- {
|
|
| 1295 |
- "id": "my-pod-1", |
|
| 1296 |
- "labels": {
|
|
| 1297 |
- "name": "testRun", |
|
| 1298 |
- "replicationController": "testRun" |
|
| 1299 |
- }, |
|
| 1300 |
- "desiredState": {
|
|
| 1301 |
- "manifest": {
|
|
| 1302 |
- "version": "v1beta1", |
|
| 1303 |
- "id": "my-pod-1", |
|
| 1304 |
- "containers": [{
|
|
| 1305 |
- "image": "dockerfile/nginx", |
|
| 1306 |
- "ports": [{
|
|
| 1307 |
- "hostPort": 8080, |
|
| 1308 |
- "containerPort": 80 |
|
| 1309 |
- }] |
|
| 1310 |
- } |
|
| 1311 |
- } |
|
| 1312 |
- }, |
|
| 1313 |
- "currentState": {
|
|
| 1314 |
- "host": "host-1" |
|
| 1315 |
- } |
|
| 1316 |
- }, |
|
| 1317 |
- {
|
|
| 1318 |
- "id": "my-pod-2", |
|
| 1319 |
- "labels": {
|
|
| 1320 |
- "name": "testRun", |
|
| 1321 |
- "replicationController": "testRun" |
|
| 1322 |
- }, |
|
| 1323 |
- "desiredState": {
|
|
| 1324 |
- "manifest": {
|
|
| 1325 |
- "version": "v1beta1", |
|
| 1326 |
- "id": "my-pod-2", |
|
| 1327 |
- "containers": [{
|
|
| 1328 |
- "image": "dockerfile/nginx", |
|
| 1329 |
- "ports": [{
|
|
| 1330 |
- "hostPort": 8080, |
|
| 1331 |
- "containerPort": 80 |
|
| 1332 |
- }] |
|
| 1333 |
- } |
|
| 1334 |
- } |
|
| 1335 |
- }, |
|
| 1336 |
- "currentState": {
|
|
| 1337 |
- "host": "host-2" |
|
| 1338 |
- } |
|
| 1339 |
- } |
|
| 1340 |
- ] |
|
| 1341 |
-} |
|
| 1342 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 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><ul class="nav nav-tabs"><li class=active><a href=#_pods_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_pods_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
|
|
| 1343 |
- "$schema": "http://json-schema.org/draft-03/schema", |
|
| 1344 |
- "type": "object", |
|
| 1345 |
- "required": false, |
|
| 1346 |
- "description": "Pod resource. A pod corresponds to a co-located group of [Docker containers](http://docker.io).", |
|
| 1347 |
- "properties": {
|
|
| 1348 |
- "kind": {
|
|
| 1349 |
- "type": "string", |
|
| 1350 |
- "required": false |
|
| 1351 |
- }, |
|
| 1352 |
- "id": {
|
|
| 1353 |
- "type": "string", |
|
| 1354 |
- "required": false |
|
| 1355 |
- }, |
|
| 1356 |
- "creationTimestamp": {
|
|
| 1357 |
- "type": "string", |
|
| 1358 |
- "required": false |
|
| 1359 |
- }, |
|
| 1360 |
- "selfLink": {
|
|
| 1361 |
- "type": "string", |
|
| 1362 |
- "required": false |
|
| 1363 |
- }, |
|
| 1364 |
- "desiredState": {
|
|
| 1365 |
- "type": "object", |
|
| 1366 |
- "required": false, |
|
| 1367 |
- "description": "The desired configuration of the pod", |
|
| 1368 |
- "properties": {
|
|
| 1369 |
- "manifest": {
|
|
| 1370 |
- "type": "object", |
|
| 1371 |
- "required": false, |
|
| 1372 |
- "description": "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)" |
|
| 1373 |
- }, |
|
| 1374 |
- "status": {
|
|
| 1375 |
- "type": "string", |
|
| 1376 |
- "required": false, |
|
| 1377 |
- "description": "" |
|
| 1378 |
- }, |
|
| 1379 |
- "host": {
|
|
| 1380 |
- "type": "string", |
|
| 1381 |
- "required": false, |
|
| 1382 |
- "description": "" |
|
| 1383 |
- }, |
|
| 1384 |
- "hostIP": {
|
|
| 1385 |
- "type": "string", |
|
| 1386 |
- "required": false, |
|
| 1387 |
- "description": "" |
|
| 1388 |
- }, |
|
| 1389 |
- "info": {
|
|
| 1390 |
- "type": "object", |
|
| 1391 |
- "required": false, |
|
| 1392 |
- "description": "" |
|
| 1393 |
- } |
|
| 1394 |
- } |
|
| 1395 |
- }, |
|
| 1396 |
- "currentState": {
|
|
| 1397 |
- "type": "object", |
|
| 1398 |
- "required": false, |
|
| 1399 |
- "description": "The current configuration and status of the pod. Fields in common with desiredState have the same meaning.", |
|
| 1400 |
- "properties": {
|
|
| 1401 |
- "manifest": {
|
|
| 1402 |
- "type": "object", |
|
| 1403 |
- "required": false |
|
| 1404 |
- }, |
|
| 1405 |
- "status": {
|
|
| 1406 |
- "type": "string", |
|
| 1407 |
- "required": false |
|
| 1408 |
- }, |
|
| 1409 |
- "host": {
|
|
| 1410 |
- "type": "string", |
|
| 1411 |
- "required": false |
|
| 1412 |
- }, |
|
| 1413 |
- "hostIP": {
|
|
| 1414 |
- "type": "string", |
|
| 1415 |
- "required": false |
|
| 1416 |
- }, |
|
| 1417 |
- "info": {
|
|
| 1418 |
- "type": "object", |
|
| 1419 |
- "required": false |
|
| 1420 |
- } |
|
| 1421 |
- } |
|
| 1422 |
- }, |
|
| 1423 |
- "labels": {
|
|
| 1424 |
- "type": "object", |
|
| 1425 |
- "required": false |
|
| 1426 |
- } |
|
| 1427 |
- } |
|
| 1428 |
-} |
|
| 1429 |
-</code></pre><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1430 |
- "id": "php", |
|
| 1431 |
- "desiredState": {
|
|
| 1432 |
- "manifest": {
|
|
| 1433 |
- "version": "v1beta1", |
|
| 1434 |
- "id": "php", |
|
| 1435 |
- "containers": [{
|
|
| 1436 |
- "name": "nginx", |
|
| 1437 |
- "image": "dockerfile/nginx", |
|
| 1438 |
- "ports": [{
|
|
| 1439 |
- "containerPort": 80, |
|
| 1440 |
- "hostPort": 8080 |
|
| 1441 |
- }], |
|
| 1442 |
- "livenessProbe": {
|
|
| 1443 |
- "enabled": true, |
|
| 1444 |
- "type": "http", |
|
| 1445 |
- "initialDelaySeconds": 30, |
|
| 1446 |
- "httpGet": {
|
|
| 1447 |
- "path": "/index.html", |
|
| 1448 |
- "port": "8080" |
|
| 1449 |
- } |
|
| 1450 |
- } |
|
| 1451 |
- }] |
|
| 1452 |
- } |
|
| 1453 |
- }, |
|
| 1454 |
- "labels": {
|
|
| 1455 |
- "name": "foo" |
|
| 1456 |
- } |
|
| 1457 |
-} |
|
| 1458 |
- |
|
| 1459 |
-</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__pods__podId_><span class=parent>/pods</span>/{podId}</a> <span class=methods><a href=# data-toggle=modal data-target=#_pods__podId__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_pods__podId__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_pods__podId__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__pods__podId_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_pods__podId__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get a specific pod</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_pods__podId__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a pod</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_pods__podId__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a specific pod</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 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><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><div class=tab-content><div class="tab-pane active" id=_pods__podId__get_request><h3>URI Parameters</h3><ul><li><strong>podId</strong>: <em>required (string)</em></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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1460 |
- "id": "php", |
|
| 1461 |
- "desiredState": {
|
|
| 1462 |
- "manifest": {
|
|
| 1463 |
- "version": "v1beta1", |
|
| 1464 |
- "id": "php", |
|
| 1465 |
- "containers": [{
|
|
| 1466 |
- "name": "nginx", |
|
| 1467 |
- "image": "dockerfile/nginx", |
|
| 1468 |
- "ports": [{
|
|
| 1469 |
- "containerPort": 80, |
|
| 1470 |
- "hostPort": 8080 |
|
| 1471 |
- }], |
|
| 1472 |
- "livenessProbe": {
|
|
| 1473 |
- "enabled": true, |
|
| 1474 |
- "type": "http", |
|
| 1475 |
- "initialDelaySeconds": 30, |
|
| 1476 |
- "httpGet": {
|
|
| 1477 |
- "path": "/index.html", |
|
| 1478 |
- "port": "8080" |
|
| 1479 |
- } |
|
| 1480 |
- } |
|
| 1481 |
- }] |
|
| 1482 |
- } |
|
| 1483 |
- }, |
|
| 1484 |
- "labels": {
|
|
| 1485 |
- "name": "foo" |
|
| 1486 |
- } |
|
| 1487 |
-} |
|
| 1488 |
- |
|
| 1489 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 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><ul class="nav nav-tabs"><li class=active><a href=#_pods__podId__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_pods__podId__put_request><h3>URI Parameters</h3><ul><li><strong>podId</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
|
|
| 1490 |
- "$schema": "http://json-schema.org/draft-03/schema", |
|
| 1491 |
- "type": "object", |
|
| 1492 |
- "required": false, |
|
| 1493 |
- "description": "Pod resource. A pod corresponds to a co-located group of [Docker containers](http://docker.io).", |
|
| 1494 |
- "properties": {
|
|
| 1495 |
- "kind": {
|
|
| 1496 |
- "type": "string", |
|
| 1497 |
- "required": false |
|
| 1498 |
- }, |
|
| 1499 |
- "id": {
|
|
| 1500 |
- "type": "string", |
|
| 1501 |
- "required": false |
|
| 1502 |
- }, |
|
| 1503 |
- "creationTimestamp": {
|
|
| 1504 |
- "type": "string", |
|
| 1505 |
- "required": false |
|
| 1506 |
- }, |
|
| 1507 |
- "selfLink": {
|
|
| 1508 |
- "type": "string", |
|
| 1509 |
- "required": false |
|
| 1510 |
- }, |
|
| 1511 |
- "desiredState": {
|
|
| 1512 |
- "type": "object", |
|
| 1513 |
- "required": false, |
|
| 1514 |
- "description": "The desired configuration of the pod", |
|
| 1515 |
- "properties": {
|
|
| 1516 |
- "manifest": {
|
|
| 1517 |
- "type": "object", |
|
| 1518 |
- "required": false, |
|
| 1519 |
- "description": "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)" |
|
| 1520 |
- }, |
|
| 1521 |
- "status": {
|
|
| 1522 |
- "type": "string", |
|
| 1523 |
- "required": false, |
|
| 1524 |
- "description": "" |
|
| 1525 |
- }, |
|
| 1526 |
- "host": {
|
|
| 1527 |
- "type": "string", |
|
| 1528 |
- "required": false, |
|
| 1529 |
- "description": "" |
|
| 1530 |
- }, |
|
| 1531 |
- "hostIP": {
|
|
| 1532 |
- "type": "string", |
|
| 1533 |
- "required": false, |
|
| 1534 |
- "description": "" |
|
| 1535 |
- }, |
|
| 1536 |
- "info": {
|
|
| 1537 |
- "type": "object", |
|
| 1538 |
- "required": false, |
|
| 1539 |
- "description": "" |
|
| 1540 |
- } |
|
| 1541 |
- } |
|
| 1542 |
- }, |
|
| 1543 |
- "currentState": {
|
|
| 1544 |
- "type": "object", |
|
| 1545 |
- "required": false, |
|
| 1546 |
- "description": "The current configuration and status of the pod. Fields in common with desiredState have the same meaning.", |
|
| 1547 |
- "properties": {
|
|
| 1548 |
- "manifest": {
|
|
| 1549 |
- "type": "object", |
|
| 1550 |
- "required": false |
|
| 1551 |
- }, |
|
| 1552 |
- "status": {
|
|
| 1553 |
- "type": "string", |
|
| 1554 |
- "required": false |
|
| 1555 |
- }, |
|
| 1556 |
- "host": {
|
|
| 1557 |
- "type": "string", |
|
| 1558 |
- "required": false |
|
| 1559 |
- }, |
|
| 1560 |
- "hostIP": {
|
|
| 1561 |
- "type": "string", |
|
| 1562 |
- "required": false |
|
| 1563 |
- }, |
|
| 1564 |
- "info": {
|
|
| 1565 |
- "type": "object", |
|
| 1566 |
- "required": false |
|
| 1567 |
- } |
|
| 1568 |
- } |
|
| 1569 |
- }, |
|
| 1570 |
- "labels": {
|
|
| 1571 |
- "type": "object", |
|
| 1572 |
- "required": false |
|
| 1573 |
- } |
|
| 1574 |
- } |
|
| 1575 |
-} |
|
| 1576 |
-</code></pre><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1577 |
- "id": "php", |
|
| 1578 |
- "desiredState": {
|
|
| 1579 |
- "manifest": {
|
|
| 1580 |
- "version": "v1beta1", |
|
| 1581 |
- "id": "php", |
|
| 1582 |
- "containers": [{
|
|
| 1583 |
- "name": "nginx", |
|
| 1584 |
- "image": "dockerfile/nginx", |
|
| 1585 |
- "ports": [{
|
|
| 1586 |
- "containerPort": 80, |
|
| 1587 |
- "hostPort": 8080 |
|
| 1588 |
- }], |
|
| 1589 |
- "livenessProbe": {
|
|
| 1590 |
- "enabled": true, |
|
| 1591 |
- "type": "http", |
|
| 1592 |
- "initialDelaySeconds": 30, |
|
| 1593 |
- "httpGet": {
|
|
| 1594 |
- "path": "/index.html", |
|
| 1595 |
- "port": "8080" |
|
| 1596 |
- } |
|
| 1597 |
- } |
|
| 1598 |
- }] |
|
| 1599 |
- } |
|
| 1600 |
- }, |
|
| 1601 |
- "labels": {
|
|
| 1602 |
- "name": "foo" |
|
| 1603 |
- } |
|
| 1604 |
-} |
|
| 1605 |
- |
|
| 1606 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 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><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><div class=tab-content><div class="tab-pane active" id=_pods__podId__delete_request><h3>URI Parameters</h3><ul><li><strong>podId</strong>: <em>required (string)</em></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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1607 |
- "apiVersion": "v1beta1", |
|
| 1608 |
- "creationTimestamp": null, |
|
| 1609 |
- "kind": "Status", |
|
| 1610 |
- "status": "success" |
|
| 1611 |
-} |
|
| 1612 |
-</code></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=collapsed data-toggle=collapse href=#panel__replicationControllers><span class=parent></span>/replicationControllers</a> <span class=methods><a href=# data-toggle=modal data-target=#_replicationControllers_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_replicationControllers_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__replicationControllers class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_replicationControllers_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>List all replicationControllers on this cluster</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_replicationControllers_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new controller. currentState is ignored if present.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 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><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><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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1613 |
- "items": [ |
|
| 1614 |
- {
|
|
| 1615 |
- "id": "testRun", |
|
| 1616 |
- "desiredState": {
|
|
| 1617 |
- "replicas": 2, |
|
| 1618 |
- "replicaSelector": {
|
|
| 1619 |
- "name": "testRun" |
|
| 1620 |
- }, |
|
| 1621 |
- "podTemplate": {
|
|
| 1622 |
- "desiredState": {
|
|
| 1623 |
- "image": "dockerfile/nginx", |
|
| 1624 |
- "networkPorts": [ |
|
| 1625 |
- {
|
|
| 1626 |
- "hostPort": 8080, |
|
| 1627 |
- "containerPort": 80 |
|
| 1628 |
- } |
|
| 1629 |
- ] |
|
| 1630 |
- }, |
|
| 1631 |
- "labels": {
|
|
| 1632 |
- "name": "testRun" |
|
| 1633 |
- } |
|
| 1634 |
- } |
|
| 1635 |
- }, |
|
| 1636 |
- "labels": {
|
|
| 1637 |
- "name": "testRun" |
|
| 1638 |
- } |
|
| 1639 |
- } |
|
| 1640 |
- ] |
|
| 1641 |
-}</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 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><ul class="nav nav-tabs"><li class=active><a href=#_replicationControllers_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_replicationControllers_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
|
|
| 1642 |
- "$schema": "http://json-schema.org/draft-03/schema", |
|
| 1643 |
- "type": "object", |
|
| 1644 |
- "required": false, |
|
| 1645 |
- "description": "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.", |
|
| 1646 |
- "properties": {
|
|
| 1647 |
- "kind": {
|
|
| 1648 |
- "type": "string", |
|
| 1649 |
- "required": false |
|
| 1650 |
- }, |
|
| 1651 |
- "id": {
|
|
| 1652 |
- "type": "string", |
|
| 1653 |
- "required": false |
|
| 1654 |
- }, |
|
| 1655 |
- "creationTimestamp": {
|
|
| 1656 |
- "type": "string", |
|
| 1657 |
- "required": false |
|
| 1658 |
- }, |
|
| 1659 |
- "selfLink": {
|
|
| 1660 |
- "type": "string", |
|
| 1661 |
- "required": false |
|
| 1662 |
- }, |
|
| 1663 |
- "desiredState": {
|
|
| 1664 |
- "type": "object", |
|
| 1665 |
- "required": false, |
|
| 1666 |
- "description": "The desired configuration of the replicationController", |
|
| 1667 |
- "properties": {
|
|
| 1668 |
- "replicas": {
|
|
| 1669 |
- "type": "number", |
|
| 1670 |
- "required": false, |
|
| 1671 |
- "description": "Number of pods desired in the set" |
|
| 1672 |
- }, |
|
| 1673 |
- "replicaSelector": {
|
|
| 1674 |
- "type": "object", |
|
| 1675 |
- "required": false, |
|
| 1676 |
- "description": "Required labels used to identify pods in the set" |
|
| 1677 |
- }, |
|
| 1678 |
- "podTemplate": {
|
|
| 1679 |
- "type": "object", |
|
| 1680 |
- "required": false, |
|
| 1681 |
- "description": "Template from which to create new pods, as necessary. Identical to pod schema." |
|
| 1682 |
- } |
|
| 1683 |
- } |
|
| 1684 |
- }, |
|
| 1685 |
- "labels": {
|
|
| 1686 |
- "type": "object", |
|
| 1687 |
- "required": false |
|
| 1688 |
- } |
|
| 1689 |
- } |
|
| 1690 |
-} |
|
| 1691 |
-</code></pre><p><strong>Example</strong>:</p><pre><code> {
|
|
| 1692 |
- "id": "nginxController", |
|
| 1693 |
- "desiredState": {
|
|
| 1694 |
- "replicas": 2, |
|
| 1695 |
- "replicaSelector": {"name": "nginx"},
|
|
| 1696 |
- "podTemplate": {
|
|
| 1697 |
- "desiredState": {
|
|
| 1698 |
- "manifest": {
|
|
| 1699 |
- "version": "v1beta1", |
|
| 1700 |
- "id": "nginxController", |
|
| 1701 |
- "containers": [{
|
|
| 1702 |
- "name": "nginx", |
|
| 1703 |
- "image": "dockerfile/nginx", |
|
| 1704 |
- "ports": [{"containerPort": 80, "hostPort": 8080}]
|
|
| 1705 |
- }] |
|
| 1706 |
- } |
|
| 1707 |
- }, |
|
| 1708 |
- "labels": {"name": "nginx"}
|
|
| 1709 |
- }}, |
|
| 1710 |
- "labels": {"name": "nginx"}
|
|
| 1711 |
- } |
|
| 1712 |
-</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__replicationControllers__controllerId_><span class=parent>/replicationControllers</span>/{controllerId}</a> <span class=methods><a href=# data-toggle=modal data-target=#_replicationControllers__controllerId__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_replicationControllers__controllerId__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_replicationControllers__controllerId__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__replicationControllers__controllerId_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_replicationControllers__controllerId__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get a specific controller</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_replicationControllers__controllerId__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a controller</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_replicationControllers__controllerId__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a specific controller</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 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><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><div class=tab-content><div class="tab-pane active" id=_replicationControllers__controllerId__get_request><h3>URI Parameters</h3><ul><li><strong>controllerId</strong>: <em>required (string)</em></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><p><strong>Example</strong>:</p><pre><code> {
|
|
| 1713 |
- "id": "nginxController", |
|
| 1714 |
- "desiredState": {
|
|
| 1715 |
- "replicas": 2, |
|
| 1716 |
- "replicaSelector": {"name": "nginx"},
|
|
| 1717 |
- "podTemplate": {
|
|
| 1718 |
- "desiredState": {
|
|
| 1719 |
- "manifest": {
|
|
| 1720 |
- "version": "v1beta1", |
|
| 1721 |
- "id": "nginxController", |
|
| 1722 |
- "containers": [{
|
|
| 1723 |
- "name": "nginx", |
|
| 1724 |
- "image": "dockerfile/nginx", |
|
| 1725 |
- "ports": [{"containerPort": 80, "hostPort": 8080}]
|
|
| 1726 |
- }] |
|
| 1727 |
- } |
|
| 1728 |
- }, |
|
| 1729 |
- "labels": {"name": "nginx"}
|
|
| 1730 |
- }}, |
|
| 1731 |
- "labels": {"name": "nginx"}
|
|
| 1732 |
- } |
|
| 1733 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 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><ul class="nav nav-tabs"><li class=active><a href=#_replicationControllers__controllerId__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_replicationControllers__controllerId__put_request><h3>URI Parameters</h3><ul><li><strong>controllerId</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
|
|
| 1734 |
- "$schema": "http://json-schema.org/draft-03/schema", |
|
| 1735 |
- "type": "object", |
|
| 1736 |
- "required": false, |
|
| 1737 |
- "description": "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.", |
|
| 1738 |
- "properties": {
|
|
| 1739 |
- "kind": {
|
|
| 1740 |
- "type": "string", |
|
| 1741 |
- "required": false |
|
| 1742 |
- }, |
|
| 1743 |
- "id": {
|
|
| 1744 |
- "type": "string", |
|
| 1745 |
- "required": false |
|
| 1746 |
- }, |
|
| 1747 |
- "creationTimestamp": {
|
|
| 1748 |
- "type": "string", |
|
| 1749 |
- "required": false |
|
| 1750 |
- }, |
|
| 1751 |
- "selfLink": {
|
|
| 1752 |
- "type": "string", |
|
| 1753 |
- "required": false |
|
| 1754 |
- }, |
|
| 1755 |
- "desiredState": {
|
|
| 1756 |
- "type": "object", |
|
| 1757 |
- "required": false, |
|
| 1758 |
- "description": "The desired configuration of the replicationController", |
|
| 1759 |
- "properties": {
|
|
| 1760 |
- "replicas": {
|
|
| 1761 |
- "type": "number", |
|
| 1762 |
- "required": false, |
|
| 1763 |
- "description": "Number of pods desired in the set" |
|
| 1764 |
- }, |
|
| 1765 |
- "replicaSelector": {
|
|
| 1766 |
- "type": "object", |
|
| 1767 |
- "required": false, |
|
| 1768 |
- "description": "Required labels used to identify pods in the set" |
|
| 1769 |
- }, |
|
| 1770 |
- "podTemplate": {
|
|
| 1771 |
- "type": "object", |
|
| 1772 |
- "required": false, |
|
| 1773 |
- "description": "Template from which to create new pods, as necessary. Identical to pod schema." |
|
| 1774 |
- } |
|
| 1775 |
- } |
|
| 1776 |
- }, |
|
| 1777 |
- "labels": {
|
|
| 1778 |
- "type": "object", |
|
| 1779 |
- "required": false |
|
| 1780 |
- } |
|
| 1781 |
- } |
|
| 1782 |
-} |
|
| 1783 |
-</code></pre><p><strong>Example</strong>:</p><pre><code> {
|
|
| 1784 |
- "id": "nginxController", |
|
| 1785 |
- "desiredState": {
|
|
| 1786 |
- "replicas": 2, |
|
| 1787 |
- "replicaSelector": {"name": "nginx"},
|
|
| 1788 |
- "podTemplate": {
|
|
| 1789 |
- "desiredState": {
|
|
| 1790 |
- "manifest": {
|
|
| 1791 |
- "version": "v1beta1", |
|
| 1792 |
- "id": "nginxController", |
|
| 1793 |
- "containers": [{
|
|
| 1794 |
- "name": "nginx", |
|
| 1795 |
- "image": "dockerfile/nginx", |
|
| 1796 |
- "ports": [{"containerPort": 80, "hostPort": 8080}]
|
|
| 1797 |
- }] |
|
| 1798 |
- } |
|
| 1799 |
- }, |
|
| 1800 |
- "labels": {"name": "nginx"}
|
|
| 1801 |
- }}, |
|
| 1802 |
- "labels": {"name": "nginx"}
|
|
| 1803 |
- } |
|
| 1804 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 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><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><div class=tab-content><div class="tab-pane active" id=_replicationControllers__controllerId__delete_request><h3>URI Parameters</h3><ul><li><strong>controllerId</strong>: <em>required (string)</em></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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1805 |
- "apiVersion": "v1beta1", |
|
| 1806 |
- "creationTimestamp": null, |
|
| 1807 |
- "kind": "Status", |
|
| 1808 |
- "status": "success" |
|
| 1809 |
-} |
|
| 1810 |
-</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_lbservices class=panel-title>/lbservices</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=collapsed data-toggle=collapse href=#panel__lbservices><span class=parent></span>/lbservices</a> <span class=methods><a href=# data-toggle=modal data-target=#_lbservices_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_lbservices_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__lbservices class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_lbservices_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>List all services on this cluster</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_lbservices_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new service</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_lbservices_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>/lbservices</h4></div><div class=modal-body><div class="alert alert-info"><p>List all services on this cluster</p></div><ul class="nav nav-tabs"><li class=active><a href=#_lbservices_get_request data-toggle=tab>Request</a></li><li><a href=#_lbservices_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_lbservices_get_request></div><div class=tab-pane id=_lbservices_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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1811 |
- "items": [ |
|
| 1812 |
- {
|
|
| 1813 |
- "id": "example1", |
|
| 1814 |
- "port": 8000, |
|
| 1815 |
- "labels": {
|
|
| 1816 |
- "name": "nginx" |
|
| 1817 |
- } |
|
| 1818 |
- "selector": {
|
|
| 1819 |
- "name": "nginx" |
|
| 1820 |
- } |
|
| 1821 |
- }, |
|
| 1822 |
- {
|
|
| 1823 |
- "id": "example2", |
|
| 1824 |
- "port": 8080, |
|
| 1825 |
- "labels": {
|
|
| 1826 |
- "env": "prod", |
|
| 1827 |
- "name": "jetty" |
|
| 1828 |
- } |
|
| 1829 |
- "selector": {
|
|
| 1830 |
- "env": "prod", |
|
| 1831 |
- "name": "jetty" |
|
| 1832 |
- } |
|
| 1833 |
- } |
|
| 1834 |
- ] |
|
| 1835 |
-} |
|
| 1836 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_lbservices_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>/lbservices</h4></div><div class=modal-body><div class="alert alert-info"><p>Create a new service</p></div><ul class="nav nav-tabs"><li class=active><a href=#_lbservices_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_lbservices_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
|
|
| 1837 |
- "$schema": "http://json-schema.org/draft-03/schema", |
|
| 1838 |
- "type": "object", |
|
| 1839 |
- "required": false, |
|
| 1840 |
- "description": "A service resource.", |
|
| 1841 |
- "properties": {
|
|
| 1842 |
- "kind": {
|
|
| 1843 |
- "type": "string", |
|
| 1844 |
- "required": false |
|
| 1845 |
- }, |
|
| 1846 |
- "id": {
|
|
| 1847 |
- "type": "string", |
|
| 1848 |
- "required": false |
|
| 1849 |
- }, |
|
| 1850 |
- "creationTimestamp": {
|
|
| 1851 |
- "type": "string", |
|
| 1852 |
- "required": false |
|
| 1853 |
- }, |
|
| 1854 |
- "selfLink": {
|
|
| 1855 |
- "type": "string", |
|
| 1856 |
- "required": false |
|
| 1857 |
- }, |
|
| 1858 |
- "name": {
|
|
| 1859 |
- "type": "string", |
|
| 1860 |
- "required": false |
|
| 1861 |
- }, |
|
| 1862 |
- "port": {
|
|
| 1863 |
- "type": "number", |
|
| 1864 |
- "required": false |
|
| 1865 |
- }, |
|
| 1866 |
- "labels": {
|
|
| 1867 |
- "type": "object", |
|
| 1868 |
- "required": false |
|
| 1869 |
- }, |
|
| 1870 |
- "selector": {
|
|
| 1871 |
- "type": "object", |
|
| 1872 |
- "required": false |
|
| 1873 |
- } |
|
| 1874 |
- } |
|
| 1875 |
-} |
|
| 1876 |
-</code></pre><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1877 |
- "id": "example", |
|
| 1878 |
- "port": 8000, |
|
| 1879 |
- "labels": {
|
|
| 1880 |
- "name": "nginx" |
|
| 1881 |
- }, |
|
| 1882 |
- "selector": {
|
|
| 1883 |
- "name": "nginx" |
|
| 1884 |
- } |
|
| 1885 |
-} |
|
| 1886 |
-</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__lbservices__serviceId_><span class=parent>/lbservices</span>/{serviceId}</a> <span class=methods><a href=# data-toggle=modal data-target=#_lbservices__serviceId__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_lbservices__serviceId__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_lbservices__serviceId__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__lbservices__serviceId_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_lbservices__serviceId__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get a specific service</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_lbservices__serviceId__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a service</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_lbservices__serviceId__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a specific service</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_lbservices__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>/lbservices</span>/{serviceId}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get a specific service</p></div><ul class="nav nav-tabs"><li class=active><a href=#_lbservices__serviceId__get_request data-toggle=tab>Request</a></li><li><a href=#_lbservices__serviceId__get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_lbservices__serviceId__get_request><h3>URI Parameters</h3><ul><li><strong>serviceId</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_lbservices__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1887 |
- "data": |
|
| 1888 |
- {
|
|
| 1889 |
- "id": "53c4249f076573c0f4000001", |
|
| 1890 |
- "name": "service-name", |
|
| 1891 |
- "domain": "domain-id", |
|
| 1892 |
- "desiredState": |
|
| 1893 |
- {
|
|
| 1894 |
- "replicas": 3, |
|
| 1895 |
- "replicaSelector": { "name": "service-name" },
|
|
| 1896 |
- "replicaPolicy": {
|
|
| 1897 |
- "atLeast": 2 |
|
| 1898 |
- }, |
|
| 1899 |
- "activeDeployment": "a_deployment_id", |
|
| 1900 |
- "podTemplate": |
|
| 1901 |
- {
|
|
| 1902 |
- "desiredState": |
|
| 1903 |
- {
|
|
| 1904 |
- "image": "server/domain/name", |
|
| 1905 |
- "network-ports": [ |
|
| 1906 |
- {
|
|
| 1907 |
- "hostPort": 8080, |
|
| 1908 |
- "containerPort": 80 |
|
| 1909 |
- } |
|
| 1910 |
- ], |
|
| 1911 |
- "owner": true |
|
| 1912 |
- }, |
|
| 1913 |
- "labels": {
|
|
| 1914 |
- "name": "service-name" |
|
| 1915 |
- } |
|
| 1916 |
- } |
|
| 1917 |
- } |
|
| 1918 |
- } |
|
| 1919 |
-} |
|
| 1920 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_lbservices__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>/lbservices</span>/{serviceId}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update a service</p></div><ul class="nav nav-tabs"><li class=active><a href=#_lbservices__serviceId__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_lbservices__serviceId__put_request><h3>URI Parameters</h3><ul><li><strong>serviceId</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
|
|
| 1921 |
- "$schema": "http://json-schema.org/draft-03/schema", |
|
| 1922 |
- "type": "object", |
|
| 1923 |
- "required": false, |
|
| 1924 |
- "description": "A service resource.", |
|
| 1925 |
- "properties": {
|
|
| 1926 |
- "kind": {
|
|
| 1927 |
- "type": "string", |
|
| 1928 |
- "required": false |
|
| 1929 |
- }, |
|
| 1930 |
- "id": {
|
|
| 1931 |
- "type": "string", |
|
| 1932 |
- "required": false |
|
| 1933 |
- }, |
|
| 1934 |
- "creationTimestamp": {
|
|
| 1935 |
- "type": "string", |
|
| 1936 |
- "required": false |
|
| 1937 |
- }, |
|
| 1938 |
- "selfLink": {
|
|
| 1939 |
- "type": "string", |
|
| 1940 |
- "required": false |
|
| 1941 |
- }, |
|
| 1942 |
- "name": {
|
|
| 1943 |
- "type": "string", |
|
| 1944 |
- "required": false |
|
| 1945 |
- }, |
|
| 1946 |
- "port": {
|
|
| 1947 |
- "type": "number", |
|
| 1948 |
- "required": false |
|
| 1949 |
- }, |
|
| 1950 |
- "labels": {
|
|
| 1951 |
- "type": "object", |
|
| 1952 |
- "required": false |
|
| 1953 |
- }, |
|
| 1954 |
- "selector": {
|
|
| 1955 |
- "type": "object", |
|
| 1956 |
- "required": false |
|
| 1957 |
- } |
|
| 1958 |
- } |
|
| 1959 |
-} |
|
| 1960 |
-</code></pre><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1961 |
- "data": |
|
| 1962 |
- {
|
|
| 1963 |
- "id": "53c4249f076573c0f4000001", |
|
| 1964 |
- "name": "service-name", |
|
| 1965 |
- "domain": "domain-id", |
|
| 1966 |
- "desiredState": |
|
| 1967 |
- {
|
|
| 1968 |
- "replicas": 3, |
|
| 1969 |
- "replicaSelector": { "name": "service-name" },
|
|
| 1970 |
- "replicaPolicy": {
|
|
| 1971 |
- "atLeast": 2 |
|
| 1972 |
- }, |
|
| 1973 |
- "activeDeployment": "a_deployment_id", |
|
| 1974 |
- "podTemplate": |
|
| 1975 |
- {
|
|
| 1976 |
- "desiredState": |
|
| 1977 |
- {
|
|
| 1978 |
- "image": "server/domain/name", |
|
| 1979 |
- "network-ports": [ |
|
| 1980 |
- {
|
|
| 1981 |
- "hostPort": 8080, |
|
| 1982 |
- "containerPort": 80 |
|
| 1983 |
- } |
|
| 1984 |
- ], |
|
| 1985 |
- "owner": true |
|
| 1986 |
- }, |
|
| 1987 |
- "labels": {
|
|
| 1988 |
- "name": "service-name" |
|
| 1989 |
- } |
|
| 1990 |
- } |
|
| 1991 |
- } |
|
| 1992 |
- } |
|
| 1993 |
-} |
|
| 1994 |
-</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_lbservices__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>/lbservices</span>/{serviceId}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete a specific service</p></div><ul class="nav nav-tabs"><li class=active><a href=#_lbservices__serviceId__delete_request data-toggle=tab>Request</a></li><li><a href=#_lbservices__serviceId__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_lbservices__serviceId__delete_request><h3>URI Parameters</h3><ul><li><strong>serviceId</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_lbservices__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1995 |
- "apiVersion": "v1beta1", |
|
| 1996 |
- "creationTimestamp": null, |
|
| 1997 |
- "kind": "Status", |
|
| 1998 |
- "status": "success" |
|
| 1999 |
-} |
|
| 2000 |
-</code></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=#_projects>/projects</a></li><li><a href=#_project__projectID_>/project/{projectID}</a></li><li><a href=#_imageRepositories>/imageRepositories</a></li><li><a href=#_imageRepositories__repositoryID_>/imageRepositories/{repositoryID}</a></li><li><a href=#_images>/images</a></li><li><a href=#_images__imageID_>/images/{imageID}</a></li><li><a href=#_imageRepositoryMappings>/imageRepositoryMappings</a></li><li><a href=#_services>/services</a></li><li><a href=#_service__serviceID_>/service/{serviceID}</a></li><li><a href=#_deployments>/deployments</a></li><li><a href=#_deployment__deploymentID_>/deployment/{deploymentID}</a></li><li><a href=#_links>/links</a></li><li><a href=#_link__linkID_>/link/{linkID}</a></li><li><a href=#_aliases>/aliases</a></li><li><a href=#_alias__aliasID_>/alias/{aliasID}</a></li><li><a href=#_builds>/builds</a></li><li><a href=#_builds__buildId_>/builds/{buildId}</a></li><li><a href=#_buildConfigs>/buildConfigs</a></li><li><a href=#_buildConfigs__configId_>/buildConfigs/{configId}</a></li><li><a href=#_buildConfigHooks__buildId___secret___plugin_>/buildConfigHooks/{buildId}/{secret}/{plugin}</a></li><li><a href=#_templates>/templates</a></li><li><a href=#_template__templateID_>/template/{templateID}</a></li><li><a href=#_pods>/pods</a></li><li><a href=#_replicationControllers>/replicationControllers</a></li><li><a href=#_lbservices>/lbservices</a></li></ul></div></div></div></div></body></html>
|
|
| 2001 | 1 |
\ No newline at end of file |
| 2002 | 2 |
deleted file mode 100644 |
| ... | ... |
@@ -1,481 +0,0 @@ |
| 1 |
-#%RAML 0.8 |
|
| 2 |
-# vim: set ft=yaml: |
|
| 3 |
-baseUri: http://server/broker/rest |
|
| 4 |
-title: OpenShiftV3 -- Draft |
|
| 5 |
-version: alpha |
|
| 6 |
-mediaType: application/json |
|
| 7 |
-documentation: |
|
| 8 |
- - title: Overview |
|
| 9 |
- content: !include doc/overview.md |
|
| 10 |
-/projects: |
|
| 11 |
- get: |
|
| 12 |
- description: | |
|
| 13 |
- List all projects for your account. |
|
| 14 |
- |
|
| 15 |
- Projects are a similar concept to v2 domains. A project is a grouping of services |
|
| 16 |
- with shared access control and resource limits. Applications can be assembled |
|
| 17 |
- from services in a project by linking them together via service endpoints. |
|
| 18 |
- responses: |
|
| 19 |
- 200: |
|
| 20 |
- body: |
|
| 21 |
- example: !include examples/project-list.json |
|
| 22 |
- post: |
|
| 23 |
- description: Create a new project |
|
| 24 |
- body: |
|
| 25 |
- example: !include examples/project.json |
|
| 26 |
- |
|
| 27 |
-/project/{projectID}:
|
|
| 28 |
- get: |
|
| 29 |
- description: Get a specific project |
|
| 30 |
- responses: |
|
| 31 |
- 200: |
|
| 32 |
- body: |
|
| 33 |
- example: !include examples/project.json |
|
| 34 |
- put: |
|
| 35 |
- description: Update a project |
|
| 36 |
- body: |
|
| 37 |
- example: !include examples/project-put.json |
|
| 38 |
- delete: |
|
| 39 |
- description: Delete a project |
|
| 40 |
- responses: |
|
| 41 |
- 200: |
|
| 42 |
- body: |
|
| 43 |
- example: !include examples/status-success.json |
|
| 44 |
- post: |
|
| 45 |
- description: Instantiate a template in the given project |
|
| 46 |
- body: |
|
| 47 |
- example: !include examples/project-post.json |
|
| 48 |
- |
|
| 49 |
-/imageRepositories: |
|
| 50 |
- get: |
|
| 51 |
- description: | |
|
| 52 |
- Lists all image repositories. |
|
| 53 |
- |
|
| 54 |
- An image repository is a collection of images that share the same metadata. It may |
|
| 55 |
- reference a Docker image repository on a Docker registry, but this is optional. An |
|
| 56 |
- image repository also contains a mapping of tags to images. |
|
| 57 |
- responses: |
|
| 58 |
- 200: |
|
| 59 |
- body: |
|
| 60 |
- example: !include examples/image-repositories.json |
|
| 61 |
- post: |
|
| 62 |
- description: Create a new image repository |
|
| 63 |
- body: |
|
| 64 |
- example: !include examples/create-image-repository.json |
|
| 65 |
- |
|
| 66 |
-/imageRepositories/{repositoryID}:
|
|
| 67 |
- get: |
|
| 68 |
- description: Get information about an image repository |
|
| 69 |
- body: |
|
| 70 |
- example: !include examples/image-repository.json |
|
| 71 |
- put: |
|
| 72 |
- description: Update an image repository |
|
| 73 |
- body: |
|
| 74 |
- example: !include examples/image-repository.json |
|
| 75 |
- delete: |
|
| 76 |
- description: Delete an image repository |
|
| 77 |
- responses: |
|
| 78 |
- 200: |
|
| 79 |
- body: |
|
| 80 |
- example: !include examples/status-success.json |
|
| 81 |
-/images: |
|
| 82 |
- get: |
|
| 83 |
- description: | |
|
| 84 |
- Lists all images. |
|
| 85 |
- |
|
| 86 |
- An image is a reference to an image in a Docker image repository on a Docker |
|
| 87 |
- registry, plus a set of metadata. The metadata that Openshift stores for an image |
|
| 88 |
- will augment the metadata that has already been specified in the image through |
|
| 89 |
- its Dockerfile. |
|
| 90 |
- responses: |
|
| 91 |
- 200: |
|
| 92 |
- body: |
|
| 93 |
- example: !include examples/images.json |
|
| 94 |
- post: |
|
| 95 |
- description: Create a new image definition |
|
| 96 |
- body: |
|
| 97 |
- example: !include examples/create-image.json |
|
| 98 |
- |
|
| 99 |
-/images/{imageID}:
|
|
| 100 |
- get: |
|
| 101 |
- description: Get image definition |
|
| 102 |
- body: |
|
| 103 |
- example: !include examples/image.json |
|
| 104 |
- delete: |
|
| 105 |
- description: Delete an image |
|
| 106 |
- responses: |
|
| 107 |
- 200: |
|
| 108 |
- body: |
|
| 109 |
- example: !include examples/status-success.json |
|
| 110 |
- |
|
| 111 |
-/imageRepositoryMappings: |
|
| 112 |
- post: |
|
| 113 |
- description: | |
|
| 114 |
- Creates an image and updates an image repository. |
|
| 115 |
- |
|
| 116 |
- This is designed as a webhook that a Docker registry can invoke when a |
|
| 117 |
- new tag is created. The image repository mapping contains a reference |
|
| 118 |
- to the repository, the image's metadata, and the name of the new tag. |
|
| 119 |
- Upon execution, a new image is created if it doesn't already exist, and |
|
| 120 |
- the image repository is updated with the new tag. |
|
| 121 |
- body: |
|
| 122 |
- example: !include examples/create-image-repository-mapping.json |
|
| 123 |
- |
|
| 124 |
-/services: |
|
| 125 |
- get: |
|
| 126 |
- description: | |
|
| 127 |
- Lists all services that your account has access to |
|
| 128 |
- |
|
| 129 |
- Services can be public or owned by a project. They contain a template of a pod and |
|
| 130 |
- reference image repositories that supply the images for those templates. A service may |
|
| 131 |
- be configured to react to an image being pushed to an image repository by initiating a |
|
| 132 |
- deployment. Deployments are associated with a service and make use of |
|
| 133 |
- Kubernetes replication controllers to manage pods in a cluster. |
|
| 134 |
- For deployments, a service contains a policy that constrains how deployments can occur. |
|
| 135 |
- For example, it may require that there exist at least 2 operational pods at all times. |
|
| 136 |
- A deployment needs to operate under those constraints when making changes. |
|
| 137 |
- queryParameters: |
|
| 138 |
- projectId: |
|
| 139 |
- description: filter the services owned by a particular project |
|
| 140 |
- responses: |
|
| 141 |
- 200: |
|
| 142 |
- body: |
|
| 143 |
- example: !include examples/services.json |
|
| 144 |
- post: |
|
| 145 |
- description: Create a new service |
|
| 146 |
- body: |
|
| 147 |
- example: !include examples/create-service.json |
|
| 148 |
-/service/{serviceID}:
|
|
| 149 |
- get: |
|
| 150 |
- description: Get a specific service definition |
|
| 151 |
- body: |
|
| 152 |
- example: !include examples/service.json |
|
| 153 |
- put: |
|
| 154 |
- description: Update a service |
|
| 155 |
- body: |
|
| 156 |
- example: !include examples/service.json |
|
| 157 |
- delete: |
|
| 158 |
- description: Delete a service |
|
| 159 |
- responses: |
|
| 160 |
- 200: |
|
| 161 |
- body: |
|
| 162 |
- example: !include examples/status-success.json |
|
| 163 |
- /environment-variables: |
|
| 164 |
- get: |
|
| 165 |
- description: Environment variables associated with this service |
|
| 166 |
- responses: |
|
| 167 |
- 200: |
|
| 168 |
- body: |
|
| 169 |
- example: !include examples/envvars.json |
|
| 170 |
- post: |
|
| 171 |
- description: Create/update environment variables |
|
| 172 |
- body: |
|
| 173 |
- example: !include examples/envvars.json |
|
| 174 |
- /{variableName}:
|
|
| 175 |
- get: |
|
| 176 |
- description: Get environment variable |
|
| 177 |
- body: |
|
| 178 |
- example: !include examples/envvar.json |
|
| 179 |
- put: |
|
| 180 |
- description: Update an environment variable's value |
|
| 181 |
- body: |
|
| 182 |
- example: !include examples/envvar.json |
|
| 183 |
- delete: |
|
| 184 |
- description: Delete an environment variable |
|
| 185 |
- responses: |
|
| 186 |
- 200: |
|
| 187 |
- body: |
|
| 188 |
- example: !include examples/status-success.json |
|
| 189 |
-/deployments: |
|
| 190 |
- get: |
|
| 191 |
- description: | |
|
| 192 |
- Lists active deployments in the current project |
|
| 193 |
- |
|
| 194 |
- Deployments effect change in a service such as scaling up, down, updating the |
|
| 195 |
- current image, etc. Deployments may use different policies for carrying out |
|
| 196 |
- the change. For example, a rolling update with a single pod change at a time, or |
|
| 197 |
- a batch update, etc. Deployments make use of Kubernetes replicationControllers |
|
| 198 |
- to bring about the changes. |
|
| 199 |
- responses: |
|
| 200 |
- 200: |
|
| 201 |
- body: |
|
| 202 |
- example: !include examples/deployments.json |
|
| 203 |
- post: |
|
| 204 |
- description: Create a new deployment |
|
| 205 |
- body: |
|
| 206 |
- example: !include examples/create-deployment.json |
|
| 207 |
-/deployment/{deploymentID}:
|
|
| 208 |
- get: |
|
| 209 |
- description: Get deployment details |
|
| 210 |
- body: |
|
| 211 |
- example: !include examples/deployment.json |
|
| 212 |
-/links: |
|
| 213 |
- get: |
|
| 214 |
- description: | |
|
| 215 |
- List of links between services in your account |
|
| 216 |
- |
|
| 217 |
- Unlike a Docker link, a Link in OpenShift defines a relationship between services |
|
| 218 |
- which may be composed by multiple Docker images. A link may include additional metadata |
|
| 219 |
- about the relationship such as the algorithm to use to distribute requests. |
|
| 220 |
- queryParameters: |
|
| 221 |
- projectId: |
|
| 222 |
- description: filter the links owned by a particular project |
|
| 223 |
- serviceId: |
|
| 224 |
- description: filter the links attached to a particular service |
|
| 225 |
- responses: |
|
| 226 |
- 200: |
|
| 227 |
- body: |
|
| 228 |
- example: !include examples/links.json |
|
| 229 |
- post: |
|
| 230 |
- description: Create a new link between this service and a different service |
|
| 231 |
- body: |
|
| 232 |
- example: !include examples/link.json |
|
| 233 |
-/link/{linkID}:
|
|
| 234 |
- get: |
|
| 235 |
- description: Get link details |
|
| 236 |
- body: |
|
| 237 |
- example: !include examples/link.json |
|
| 238 |
- put: |
|
| 239 |
- description: Update a link |
|
| 240 |
- body: |
|
| 241 |
- example: !include examples/link.json |
|
| 242 |
- delete: |
|
| 243 |
- description: Delete a link |
|
| 244 |
- responses: |
|
| 245 |
- 200: |
|
| 246 |
- body: |
|
| 247 |
- example: !include examples/status-success.json |
|
| 248 |
-/aliases: |
|
| 249 |
- get: |
|
| 250 |
- description: | |
|
| 251 |
- List all aliases visible to you |
|
| 252 |
- |
|
| 253 |
- Aliases in v3 perform the same function as aliases in v2. The main difference |
|
| 254 |
- is that in v3 an alias is associated with a service, not an application. |
|
| 255 |
- queryParameters: |
|
| 256 |
- serviceId: |
|
| 257 |
- description: filter aliases by associated service |
|
| 258 |
- responses: |
|
| 259 |
- 200: |
|
| 260 |
- body: |
|
| 261 |
- example: !include examples/aliases.json |
|
| 262 |
- post: |
|
| 263 |
- description: Create an alias for this service |
|
| 264 |
- body: |
|
| 265 |
- example: !include examples/alias.json |
|
| 266 |
-/alias/{aliasID}:
|
|
| 267 |
- get: |
|
| 268 |
- description: Get alias |
|
| 269 |
- body: |
|
| 270 |
- example: !include examples/alias.json |
|
| 271 |
- put: |
|
| 272 |
- description: Update an alias |
|
| 273 |
- body: |
|
| 274 |
- example: !include examples/alias.json |
|
| 275 |
- delete: |
|
| 276 |
- description: Delete an alias |
|
| 277 |
- responses: |
|
| 278 |
- 200: |
|
| 279 |
- body: |
|
| 280 |
- example: !include examples/status-success.json |
|
| 281 |
-/builds: |
|
| 282 |
- get: |
|
| 283 |
- description: | |
|
| 284 |
- Retrieves a list of builds |
|
| 285 |
- |
|
| 286 |
- Build encapsulates the inputs needed to produce a new deployable image, as well as |
|
| 287 |
- the status of the operation and a reference to the Pod which runs the build. |
|
| 288 |
- responses: |
|
| 289 |
- 200: |
|
| 290 |
- body: |
|
| 291 |
- example: !include examples/builds.json |
|
| 292 |
- post: |
|
| 293 |
- description: Create a new build |
|
| 294 |
- body: |
|
| 295 |
- example: !include examples/create_build.json |
|
| 296 |
-/builds/{buildId}:
|
|
| 297 |
- get: |
|
| 298 |
- description: Retrieve a single build definition |
|
| 299 |
- responses: |
|
| 300 |
- 200: |
|
| 301 |
- body: |
|
| 302 |
- example: !include examples/build.json |
|
| 303 |
- put: |
|
| 304 |
- description: Update a build definition |
|
| 305 |
- body: |
|
| 306 |
- example: !include examples/build.json |
|
| 307 |
- delete: |
|
| 308 |
- description: Delete a build definition |
|
| 309 |
- responses: |
|
| 310 |
- 200: |
|
| 311 |
- body: |
|
| 312 |
- example: !include examples/status-success.json |
|
| 313 |
-/buildConfigs: |
|
| 314 |
- get: |
|
| 315 |
- description: | |
|
| 316 |
- Retrieves a list of BuildConfigs |
|
| 317 |
- |
|
| 318 |
- BuildConfig contains the inputs needed to produce a new deployable image |
|
| 319 |
- responses: |
|
| 320 |
- 200: |
|
| 321 |
- body: |
|
| 322 |
- example: !include examples/buildConfigs.json |
|
| 323 |
- post: |
|
| 324 |
- description: Create a new build |
|
| 325 |
- body: |
|
| 326 |
- example: !include examples/create_buildConfig.json |
|
| 327 |
- |
|
| 328 |
-/buildConfigs/{configId}:
|
|
| 329 |
- get: |
|
| 330 |
- description: Retrieve a build configuration |
|
| 331 |
- responses: |
|
| 332 |
- 200: |
|
| 333 |
- body: |
|
| 334 |
- example: !include examples/buildConfig.json |
|
| 335 |
- put: |
|
| 336 |
- description: Update a build configuration |
|
| 337 |
- body: |
|
| 338 |
- example: !include examples/buildConfig.json |
|
| 339 |
- delete: |
|
| 340 |
- description: Delete a build configuration |
|
| 341 |
- responses: |
|
| 342 |
- 200: |
|
| 343 |
- body: |
|
| 344 |
- example: !include examples/status-success.json |
|
| 345 |
-/buildConfigHooks/{buildId}/{secret}/{plugin}:
|
|
| 346 |
- post: |
|
| 347 |
- description: | |
|
| 348 |
- Webhook on push event from external repository |
|
| 349 |
- |
|
| 350 |
- buildId specifies which build to trigger, whereas plugin defines source of |
|
| 351 |
- the request, this might be github, bitbucket or others. |
|
| 352 |
- responses: |
|
| 353 |
- 204: |
|
| 354 |
- description: No content |
|
| 355 |
- |
|
| 356 |
-/templates: |
|
| 357 |
- get: |
|
| 358 |
- description: | |
|
| 359 |
- Lists all templates that your account has access to |
|
| 360 |
- |
|
| 361 |
- A template defines 0..n services and 0..m links. When it is applied |
|
| 362 |
- to an existing project, those services and links are instantiated for |
|
| 363 |
- that project. |
|
| 364 |
- responses: |
|
| 365 |
- 200: |
|
| 366 |
- body: |
|
| 367 |
- example: !include examples/templates.json |
|
| 368 |
- post: |
|
| 369 |
- description: Create a new template |
|
| 370 |
- body: |
|
| 371 |
- example: !include examples/template.json |
|
| 372 |
-/template/{templateID}:
|
|
| 373 |
- get: |
|
| 374 |
- description: Get a specific template |
|
| 375 |
- body: |
|
| 376 |
- example: !include examples/template.json |
|
| 377 |
- put: |
|
| 378 |
- description: Update a template |
|
| 379 |
- body: |
|
| 380 |
- example: !include examples/template.json |
|
| 381 |
- delete: |
|
| 382 |
- description: Delete a template |
|
| 383 |
- responses: |
|
| 384 |
- 200: |
|
| 385 |
- body: |
|
| 386 |
- example: !include examples/status-success.json |
|
| 387 |
-/pods: |
|
| 388 |
- get: |
|
| 389 |
- description: List all pods on this cluster |
|
| 390 |
- responses: |
|
| 391 |
- 200: |
|
| 392 |
- body: |
|
| 393 |
- example: !include examples/pod-list.json |
|
| 394 |
- post: |
|
| 395 |
- description: Create a new pod. currentState is ignored if present. |
|
| 396 |
- body: |
|
| 397 |
- schema: !include doc/pod-schema.json |
|
| 398 |
- example: !include examples/pod.json |
|
| 399 |
- |
|
| 400 |
- /{podId}:
|
|
| 401 |
- get: |
|
| 402 |
- description: Get a specific pod |
|
| 403 |
- responses: |
|
| 404 |
- 200: |
|
| 405 |
- body: |
|
| 406 |
- example: !include examples/pod.json |
|
| 407 |
- put: |
|
| 408 |
- description: Update a pod |
|
| 409 |
- body: |
|
| 410 |
- schema: !include doc/pod-schema.json |
|
| 411 |
- example: !include examples/pod.json |
|
| 412 |
- delete: |
|
| 413 |
- description: Delete a specific pod |
|
| 414 |
- responses: |
|
| 415 |
- 200: |
|
| 416 |
- body: |
|
| 417 |
- example: !include examples/status-success.json |
|
| 418 |
- |
|
| 419 |
-/replicationControllers: |
|
| 420 |
- get: |
|
| 421 |
- description: List all replicationControllers on this cluster |
|
| 422 |
- responses: |
|
| 423 |
- 200: |
|
| 424 |
- body: |
|
| 425 |
- example: !include examples/controller-list.json |
|
| 426 |
- post: |
|
| 427 |
- description: Create a new controller. currentState is ignored if present. |
|
| 428 |
- body: |
|
| 429 |
- schema: !include doc/controller-schema.json |
|
| 430 |
- example: !include examples/controller.json |
|
| 431 |
- |
|
| 432 |
- /{controllerId}:
|
|
| 433 |
- get: |
|
| 434 |
- description: Get a specific controller |
|
| 435 |
- responses: |
|
| 436 |
- 200: |
|
| 437 |
- body: |
|
| 438 |
- example: !include examples/controller.json |
|
| 439 |
- put: |
|
| 440 |
- description: Update a controller |
|
| 441 |
- body: |
|
| 442 |
- schema: !include doc/controller-schema.json |
|
| 443 |
- example: !include examples/controller.json |
|
| 444 |
- delete: |
|
| 445 |
- description: Delete a specific controller |
|
| 446 |
- responses: |
|
| 447 |
- 200: |
|
| 448 |
- body: |
|
| 449 |
- example: !include examples/status-success.json |
|
| 450 |
- |
|
| 451 |
-/lbservices: |
|
| 452 |
- get: |
|
| 453 |
- description: List all services on this cluster |
|
| 454 |
- responses: |
|
| 455 |
- 200: |
|
| 456 |
- body: |
|
| 457 |
- example: !include examples/service-list.json |
|
| 458 |
- post: |
|
| 459 |
- description: Create a new service |
|
| 460 |
- body: |
|
| 461 |
- schema: !include doc/service-schema.json |
|
| 462 |
- example: !include examples/lbservice.json |
|
| 463 |
- |
|
| 464 |
- /{serviceId}:
|
|
| 465 |
- get: |
|
| 466 |
- description: Get a specific service |
|
| 467 |
- responses: |
|
| 468 |
- 200: |
|
| 469 |
- body: |
|
| 470 |
- example: !include examples/service.json |
|
| 471 |
- put: |
|
| 472 |
- description: Update a service |
|
| 473 |
- body: |
|
| 474 |
- schema: !include doc/service-schema.json |
|
| 475 |
- example: !include examples/service.json |
|
| 476 |
- delete: |
|
| 477 |
- description: Delete a specific service |
|
| 478 |
- responses: |
|
| 479 |
- 200: |
|
| 480 |
- body: |
|
| 481 |
- example: !include examples/status-success.json |
| 482 | 1 |
new file mode 100644 |
| ... | ... |
@@ -0,0 +1,2000 @@ |
| 0 |
+<!DOCTYPE HTML><html><head><title>OpenShiftV3 -- Draft API documentation</title><meta http-equiv=X-UA-Compatible content="IE=edge"><meta http-equiv=Content-Type content="text/html; charset=utf-8"><meta name=generator content="https://github.com/kevinrenskers/raml2html 1.0.3"><link rel=stylesheet href=http://netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css><link rel=stylesheet href=http://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.1/styles/default.min.css><script type=text/javascript src=http://code.jquery.com/jquery-1.11.0.min.js></script><script type=text/javascript src=http://netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js></script><script type=text/javascript src=http://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.1/highlight.min.js></script><script type=text/javascript> |
|
| 1 |
+ $(document).ready(function() {
|
|
| 2 |
+ $('.page-header pre code, .top-resource-description pre code').each(function(i, block) {
|
|
| 3 |
+ hljs.highlightBlock(block); |
|
| 4 |
+ }); |
|
| 5 |
+ |
|
| 6 |
+ $('[data-toggle]').click(function() {
|
|
| 7 |
+ var selector = $(this).data('target') + ' pre code';
|
|
| 8 |
+ $(selector).each(function(i, block) {
|
|
| 9 |
+ hljs.highlightBlock(block); |
|
| 10 |
+ }); |
|
| 11 |
+ }); |
|
| 12 |
+ }); |
|
| 13 |
+ </script><style> |
|
| 14 |
+ .hljs {
|
|
| 15 |
+ background: transparent; |
|
| 16 |
+ } |
|
| 17 |
+ .parent {
|
|
| 18 |
+ color: #999; |
|
| 19 |
+ } |
|
| 20 |
+ .list-group-item > .badge {
|
|
| 21 |
+ float: none; |
|
| 22 |
+ margin-right: 6px; |
|
| 23 |
+ } |
|
| 24 |
+ .panel-title > .methods {
|
|
| 25 |
+ float: right; |
|
| 26 |
+ } |
|
| 27 |
+ .badge {
|
|
| 28 |
+ border-radius: 0; |
|
| 29 |
+ text-transform: uppercase; |
|
| 30 |
+ width: 70px; |
|
| 31 |
+ font-weight: normal; |
|
| 32 |
+ color: #f3f3f6; |
|
| 33 |
+ line-height: normal; |
|
| 34 |
+ } |
|
| 35 |
+ .badge_get {
|
|
| 36 |
+ background-color: #63a8e2; |
|
| 37 |
+ } |
|
| 38 |
+ .badge_post {
|
|
| 39 |
+ background-color: #6cbd7d; |
|
| 40 |
+ } |
|
| 41 |
+ .badge_put {
|
|
| 42 |
+ background-color: #22bac4; |
|
| 43 |
+ } |
|
| 44 |
+ .badge_delete {
|
|
| 45 |
+ background-color: #d26460; |
|
| 46 |
+ } |
|
| 47 |
+ .list-group, .panel-group {
|
|
| 48 |
+ margin-bottom: 0; |
|
| 49 |
+ } |
|
| 50 |
+ .panel-group .panel+.panel-white {
|
|
| 51 |
+ margin-top: 0; |
|
| 52 |
+ } |
|
| 53 |
+ .panel-group .panel-white {
|
|
| 54 |
+ border-bottom: 1px solid #F5F5F5; |
|
| 55 |
+ border-radius: 0; |
|
| 56 |
+ } |
|
| 57 |
+ .panel-white:last-child {
|
|
| 58 |
+ border-bottom-color: white; |
|
| 59 |
+ -webkit-box-shadow: none; |
|
| 60 |
+ box-shadow: none; |
|
| 61 |
+ } |
|
| 62 |
+ .panel-white .panel-heading {
|
|
| 63 |
+ background: white; |
|
| 64 |
+ } |
|
| 65 |
+ .tab-pane ul {
|
|
| 66 |
+ padding-left: 2em; |
|
| 67 |
+ } |
|
| 68 |
+ .tab-pane h2 {
|
|
| 69 |
+ font-size: 1.2em; |
|
| 70 |
+ padding-bottom: 4px; |
|
| 71 |
+ border-bottom: 1px solid #ddd; |
|
| 72 |
+ } |
|
| 73 |
+ .tab-pane h3 {
|
|
| 74 |
+ font-size: 1.1em; |
|
| 75 |
+ } |
|
| 76 |
+ .tab-content {
|
|
| 77 |
+ border-left: 1px solid #ddd; |
|
| 78 |
+ border-right: 1px solid #ddd; |
|
| 79 |
+ border-bottom: 1px solid #ddd; |
|
| 80 |
+ padding: 10px; |
|
| 81 |
+ } |
|
| 82 |
+ #sidebar {
|
|
| 83 |
+ margin-top: 30px; |
|
| 84 |
+ } |
|
| 85 |
+ .top-resource-description {
|
|
| 86 |
+ border-bottom: 1px solid #ddd; |
|
| 87 |
+ background: #fcfcfc; |
|
| 88 |
+ padding: 15px 15px 0 15px; |
|
| 89 |
+ margin: -15px -15px 10px -15px; |
|
| 90 |
+ } |
|
| 91 |
+ .resource-description {
|
|
| 92 |
+ border-bottom: 1px solid #fcfcfc; |
|
| 93 |
+ background: #fcfcfc; |
|
| 94 |
+ padding: 15px 15px 0 15px; |
|
| 95 |
+ margin: -15px -15px 10px -15px; |
|
| 96 |
+ } |
|
| 97 |
+ .list-group .badge {
|
|
| 98 |
+ float: left; |
|
| 99 |
+ } |
|
| 100 |
+ .method_description {
|
|
| 101 |
+ margin-left: 85px; |
|
| 102 |
+ } |
|
| 103 |
+ .method_description p:last-child {
|
|
| 104 |
+ margin: 0; |
|
| 105 |
+ } |
|
| 106 |
+ .list-group-item {
|
|
| 107 |
+ cursor: pointer; |
|
| 108 |
+ } |
|
| 109 |
+ .list-group-item:hover {
|
|
| 110 |
+ background-color: #f5f5f5; |
|
| 111 |
+ } |
|
| 112 |
+ </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>OpenShiftV3 -- Draft API documentation <small>version alpha</small></h1><p>http://server/broker/rest</p><h3 id=Overview><a href=#Overview>Overview</a></h3><p>The 3.x model attempts to expose underlying Docker and Google models as accurately as possible, with a focus on easy composition of applications by a developer (install Ruby, push code, add MySQL). Unlike 2.x, more flexibility of configuration is exposed after creation in all aspects of the model. Terminology is still being weighed, but the concept of an application as a separate object is being removed in favor of more flexible composition of "services" - allowing two web containers to reuse a DB, or expose a DB directly to the edge of the network. The existing API will continue to be supported through 3.x, with concepts mapped as closely as possible to the new model.</p></div><div class="panel panel-default"><div class=panel-heading><h3 id=_projects class=panel-title>/projects</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=collapsed data-toggle=collapse href=#panel__projects><span class=parent></span>/projects</a> <span class=methods><a href=# data-toggle=modal data-target=#_projects_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_projects_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__projects class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_projects_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>List all projects for your account.</p><p>Projects are a similar concept to v2 domains. A project is a grouping of services with shared access control and resource limits. Applications can be assembled from services in a project by linking them together via service endpoints.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_projects_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new project</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_projects_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>/projects</h4></div><div class=modal-body><div class="alert alert-info"><p>List all projects for your account.</p><p>Projects are a similar concept to v2 domains. A project is a grouping of services with shared access control and resource limits. Applications can be assembled from services in a project by linking them together via service endpoints.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_projects_get_request data-toggle=tab>Request</a></li><li><a href=#_projects_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_projects_get_request></div><div class=tab-pane id=_projects_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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 113 |
+ "data": |
|
| 114 |
+ [ |
|
| 115 |
+ {
|
|
| 116 |
+ "id": "53c4249f076573c0f4000001", |
|
| 117 |
+ "suffix": "dev.rhcloud.com", |
|
| 118 |
+ "name": "mydomain", |
|
| 119 |
+ "members": [ |
|
| 120 |
+ {
|
|
| 121 |
+ "login": "adminuser", |
|
| 122 |
+ "role": "admin", |
|
| 123 |
+ "type": "user", |
|
| 124 |
+ "owner": true |
|
| 125 |
+ } |
|
| 126 |
+ ] |
|
| 127 |
+ }, |
|
| 128 |
+ {
|
|
| 129 |
+ "id": "54c4259f076573c0f4000023", |
|
| 130 |
+ "suffix": "dev.rhcloud.com", |
|
| 131 |
+ "name": "appdomain", |
|
| 132 |
+ "members": [ |
|
| 133 |
+ {
|
|
| 134 |
+ "login": "adminuser", |
|
| 135 |
+ "role": "admin", |
|
| 136 |
+ "type": "user", |
|
| 137 |
+ "owner": true |
|
| 138 |
+ } |
|
| 139 |
+ ] |
|
| 140 |
+ } |
|
| 141 |
+ ] |
|
| 142 |
+} |
|
| 143 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_projects_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>/projects</h4></div><div class=modal-body><div class="alert alert-info"><p>Create a new project</p></div><ul class="nav nav-tabs"><li class=active><a href=#_projects_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_projects_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 144 |
+ "data": |
|
| 145 |
+ {
|
|
| 146 |
+ "id": "53c4249f076573c0f4000001", |
|
| 147 |
+ "suffix": "dev.rhcloud.com", |
|
| 148 |
+ "name": "myproject", |
|
| 149 |
+ "members": [ |
|
| 150 |
+ {
|
|
| 151 |
+ "login": "adminuser", |
|
| 152 |
+ "role": "admin", |
|
| 153 |
+ "type": "user", |
|
| 154 |
+ "owner": true |
|
| 155 |
+ } |
|
| 156 |
+ ] |
|
| 157 |
+ } |
|
| 158 |
+} |
|
| 159 |
+</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_project__projectID_ class=panel-title>/project/{projectID}</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=collapsed data-toggle=collapse href=#panel__project__projectID_><span class=parent></span>/project/{projectID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_project__projectID__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_project__projectID__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_project__projectID__delete><span class="badge badge_delete">delete</span></a> <a href=# data-toggle=modal data-target=#_project__projectID__post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__project__projectID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_project__projectID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get a specific project</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_project__projectID__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a project</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_project__projectID__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a project</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_project__projectID__post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Instantiate a template in the given project</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_project__projectID__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>/project/{projectID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get a specific project</p></div><ul class="nav nav-tabs"><li class=active><a href=#_project__projectID__get_request data-toggle=tab>Request</a></li><li><a href=#_project__projectID__get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_project__projectID__get_request><h3>URI Parameters</h3><ul><li><strong>projectID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_project__projectID__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 160 |
+ "data": |
|
| 161 |
+ {
|
|
| 162 |
+ "id": "53c4249f076573c0f4000001", |
|
| 163 |
+ "suffix": "dev.rhcloud.com", |
|
| 164 |
+ "name": "myproject", |
|
| 165 |
+ "members": [ |
|
| 166 |
+ {
|
|
| 167 |
+ "login": "adminuser", |
|
| 168 |
+ "role": "admin", |
|
| 169 |
+ "type": "user", |
|
| 170 |
+ "owner": true |
|
| 171 |
+ } |
|
| 172 |
+ ] |
|
| 173 |
+ } |
|
| 174 |
+} |
|
| 175 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_project__projectID__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></span>/project/{projectID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update a project</p></div><ul class="nav nav-tabs"><li class=active><a href=#_project__projectID__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_project__projectID__put_request><h3>URI Parameters</h3><ul><li><strong>projectID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 176 |
+ "data": |
|
| 177 |
+ {
|
|
| 178 |
+ "id": "53c4249f076573c0f4000001", |
|
| 179 |
+ "name": "newproject-name" |
|
| 180 |
+ } |
|
| 181 |
+} |
|
| 182 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_project__projectID__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></span>/project/{projectID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete a project</p></div><ul class="nav nav-tabs"><li class=active><a href=#_project__projectID__delete_request data-toggle=tab>Request</a></li><li><a href=#_project__projectID__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_project__projectID__delete_request><h3>URI Parameters</h3><ul><li><strong>projectID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_project__projectID__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 183 |
+ "apiVersion": "v1beta1", |
|
| 184 |
+ "creationTimestamp": null, |
|
| 185 |
+ "kind": "Status", |
|
| 186 |
+ "status": "success" |
|
| 187 |
+} |
|
| 188 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_project__projectID__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>/project/{projectID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Instantiate a template in the given project</p></div><ul class="nav nav-tabs"><li class=active><a href=#_project__projectID__post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_project__projectID__post_request><h3>URI Parameters</h3><ul><li><strong>projectID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 189 |
+ "templateId": "the-template-id" |
|
| 190 |
+} |
|
| 191 |
+</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_imageRepositories class=panel-title>/imageRepositories</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=collapsed data-toggle=collapse href=#panel__imageRepositories><span class=parent></span>/imageRepositories</a> <span class=methods><a href=# data-toggle=modal data-target=#_imageRepositories_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_imageRepositories_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__imageRepositories class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_imageRepositories_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Lists all image repositories.</p><p>An image repository is a collection of images that share the same metadata. It may reference a Docker image repository on a Docker registry, but this is optional. An image repository also contains a mapping of tags to images.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_imageRepositories_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new image repository</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_imageRepositories_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>/imageRepositories</h4></div><div class=modal-body><div class="alert alert-info"><p>Lists all image repositories.</p><p>An image repository is a collection of images that share the same metadata. It may reference a Docker image repository on a Docker registry, but this is optional. An image repository also contains a mapping of tags to images.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_imageRepositories_get_request data-toggle=tab>Request</a></li><li><a href=#_imageRepositories_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_imageRepositories_get_request></div><div class=tab-pane id=_imageRepositories_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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 192 |
+ "apiVersion": "v1beta1", |
|
| 193 |
+ "creationTimestamp": null, |
|
| 194 |
+ "items": [ |
|
| 195 |
+ {
|
|
| 196 |
+ "creationTimestamp": "2014-09-10T12:23:01-04:00", |
|
| 197 |
+ "dockerImageRepository": "localhost:5000/someproject/somerepo", |
|
| 198 |
+ "id": "somerepo", |
|
| 199 |
+ "resourceVersion": 17, |
|
| 200 |
+ "tags": {
|
|
| 201 |
+ "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b", |
|
| 202 |
+ "latest": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b" |
|
| 203 |
+ } |
|
| 204 |
+ }, |
|
| 205 |
+ {
|
|
| 206 |
+ "creationTimestamp": "2014-09-10T09:33:42-04:00", |
|
| 207 |
+ "dockerImageRepository": "openshift/ruby-19-centos", |
|
| 208 |
+ "id": "test", |
|
| 209 |
+ "labels": {
|
|
| 210 |
+ "color": "blue" |
|
| 211 |
+ }, |
|
| 212 |
+ "resourceVersion": 14, |
|
| 213 |
+ "tags": {
|
|
| 214 |
+ "latest": "120e218dd395ec314e7b6249f39d2853911b3d6def6ea164ae05722649f34b16" |
|
| 215 |
+ } |
|
| 216 |
+ } |
|
| 217 |
+ ], |
|
| 218 |
+ "kind": "ImageRepositoryList", |
|
| 219 |
+ "resourceVersion": 22 |
|
| 220 |
+} |
|
| 221 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_imageRepositories_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>/imageRepositories</h4></div><div class=modal-body><div class="alert alert-info"><p>Create a new image repository</p></div><ul class="nav nav-tabs"><li class=active><a href=#_imageRepositories_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_imageRepositories_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 222 |
+ "apiVersion": "v1beta1", |
|
| 223 |
+ "dockerImageRepository": "openshift/ruby-19-centos", |
|
| 224 |
+ "id": "test", |
|
| 225 |
+ "kind": "ImageRepository", |
|
| 226 |
+ "labels": {
|
|
| 227 |
+ "color": "blue" |
|
| 228 |
+ }, |
|
| 229 |
+ "tags": {
|
|
| 230 |
+ "latest": "120e218dd395ec314e7b6249f39d2853911b3d6def6ea164ae05722649f34b16" |
|
| 231 |
+ } |
|
| 232 |
+} |
|
| 233 |
+</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_imageRepositories__repositoryID_ class=panel-title>/imageRepositories/{repositoryID}</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=collapsed data-toggle=collapse href=#panel__imageRepositories__repositoryID_><span class=parent></span>/imageRepositories/{repositoryID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_imageRepositories__repositoryID__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_imageRepositories__repositoryID__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_imageRepositories__repositoryID__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__imageRepositories__repositoryID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_imageRepositories__repositoryID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get information about an image repository</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_imageRepositories__repositoryID__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update an image repository</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_imageRepositories__repositoryID__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete an image repository</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_imageRepositories__repositoryID__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>/imageRepositories/{repositoryID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get information about an image repository</p></div><ul class="nav nav-tabs"><li class=active><a href=#_imageRepositories__repositoryID__get_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_imageRepositories__repositoryID__get_request><h3>URI Parameters</h3><ul><li><strong>repositoryID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 234 |
+ "apiVersion": "v1beta1", |
|
| 235 |
+ "creationTimestamp": "2014-09-10T09:33:42-04:00", |
|
| 236 |
+ "dockerImageRepository": "openshift/ruby-19-centos", |
|
| 237 |
+ "id": "test", |
|
| 238 |
+ "kind": "ImageRepository", |
|
| 239 |
+ "labels": {
|
|
| 240 |
+ "color": "blue" |
|
| 241 |
+ }, |
|
| 242 |
+ "resourceVersion": 14, |
|
| 243 |
+ "tags": {
|
|
| 244 |
+ "latest": "120e218dd395ec314e7b6249f39d2853911b3d6def6ea164ae05722649f34b16" |
|
| 245 |
+ } |
|
| 246 |
+} |
|
| 247 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_imageRepositories__repositoryID__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></span>/imageRepositories/{repositoryID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update an image repository</p></div><ul class="nav nav-tabs"><li class=active><a href=#_imageRepositories__repositoryID__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_imageRepositories__repositoryID__put_request><h3>URI Parameters</h3><ul><li><strong>repositoryID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 248 |
+ "apiVersion": "v1beta1", |
|
| 249 |
+ "creationTimestamp": "2014-09-10T09:33:42-04:00", |
|
| 250 |
+ "dockerImageRepository": "openshift/ruby-19-centos", |
|
| 251 |
+ "id": "test", |
|
| 252 |
+ "kind": "ImageRepository", |
|
| 253 |
+ "labels": {
|
|
| 254 |
+ "color": "blue" |
|
| 255 |
+ }, |
|
| 256 |
+ "resourceVersion": 14, |
|
| 257 |
+ "tags": {
|
|
| 258 |
+ "latest": "120e218dd395ec314e7b6249f39d2853911b3d6def6ea164ae05722649f34b16" |
|
| 259 |
+ } |
|
| 260 |
+} |
|
| 261 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_imageRepositories__repositoryID__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></span>/imageRepositories/{repositoryID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete an image repository</p></div><ul class="nav nav-tabs"><li class=active><a href=#_imageRepositories__repositoryID__delete_request data-toggle=tab>Request</a></li><li><a href=#_imageRepositories__repositoryID__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_imageRepositories__repositoryID__delete_request><h3>URI Parameters</h3><ul><li><strong>repositoryID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_imageRepositories__repositoryID__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 262 |
+ "apiVersion": "v1beta1", |
|
| 263 |
+ "creationTimestamp": null, |
|
| 264 |
+ "kind": "Status", |
|
| 265 |
+ "status": "success" |
|
| 266 |
+} |
|
| 267 |
+</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_images class=panel-title>/images</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=collapsed data-toggle=collapse href=#panel__images><span class=parent></span>/images</a> <span class=methods><a href=# data-toggle=modal data-target=#_images_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_images_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__images class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_images_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Lists all images.</p><p>An image is a reference to an image in a Docker image repository on a Docker registry, plus a set of metadata. The metadata that Openshift stores for an image will augment the metadata that has already been specified in the image through its Dockerfile.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_images_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new image definition</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_images_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>/images</h4></div><div class=modal-body><div class="alert alert-info"><p>Lists all images.</p><p>An image is a reference to an image in a Docker image repository on a Docker registry, plus a set of metadata. The metadata that Openshift stores for an image will augment the metadata that has already been specified in the image through its Dockerfile.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_images_get_request data-toggle=tab>Request</a></li><li><a href=#_images_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_images_get_request></div><div class=tab-pane id=_images_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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 268 |
+ "apiVersion": "v1beta1", |
|
| 269 |
+ "creationTimestamp": null, |
|
| 270 |
+ "items": [ |
|
| 271 |
+ {
|
|
| 272 |
+ "creationTimestamp": "2014-09-10T09:33:43-04:00", |
|
| 273 |
+ "dockerImageReference": "openshift/ruby-19-centos:latest", |
|
| 274 |
+ "id": "abcd1234", |
|
| 275 |
+ "metadata": {
|
|
| 276 |
+ "Size": 0, |
|
| 277 |
+ "containerconfig": {
|
|
| 278 |
+ "AttachStderr": false, |
|
| 279 |
+ "AttachStdin": false, |
|
| 280 |
+ "AttachStdout": false, |
|
| 281 |
+ "Cmd": null, |
|
| 282 |
+ "CpuShares": 0, |
|
| 283 |
+ "Dns": null, |
|
| 284 |
+ "Domainname": "", |
|
| 285 |
+ "Entrypoint": null, |
|
| 286 |
+ "Env": null, |
|
| 287 |
+ "ExposedPorts": null, |
|
| 288 |
+ "Hostname": "", |
|
| 289 |
+ "Image": "", |
|
| 290 |
+ "Memory": 0, |
|
| 291 |
+ "MemorySwap": 0, |
|
| 292 |
+ "NetworkDisabled": false, |
|
| 293 |
+ "OpenStdin": false, |
|
| 294 |
+ "PortSpecs": null, |
|
| 295 |
+ "StdinOnce": false, |
|
| 296 |
+ "Tty": false, |
|
| 297 |
+ "User": "", |
|
| 298 |
+ "Volumes": null, |
|
| 299 |
+ "VolumesFrom": "", |
|
| 300 |
+ "WorkingDir": "" |
|
| 301 |
+ }, |
|
| 302 |
+ "created": "0001-01-01T00:00:00Z", |
|
| 303 |
+ "id": "" |
|
| 304 |
+ }, |
|
| 305 |
+ "resourceVersion": 15 |
|
| 306 |
+ }, |
|
| 307 |
+ {
|
|
| 308 |
+ "creationTimestamp": "2014-09-10T12:23:24-04:00", |
|
| 309 |
+ "dockerImageReference": "localhost:5000/someproject/somerepo:c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b", |
|
| 310 |
+ "id": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b", |
|
| 311 |
+ "metadata": {
|
|
| 312 |
+ "Size": 0, |
|
| 313 |
+ "architecture": "amd64", |
|
| 314 |
+ "config": {
|
|
| 315 |
+ "AttachStderr": false, |
|
| 316 |
+ "AttachStdin": false, |
|
| 317 |
+ "AttachStdout": false, |
|
| 318 |
+ "Cmd": null, |
|
| 319 |
+ "CpuShares": 0, |
|
| 320 |
+ "Dns": null, |
|
| 321 |
+ "Domainname": "", |
|
| 322 |
+ "Entrypoint": null, |
|
| 323 |
+ "Env": null, |
|
| 324 |
+ "ExposedPorts": null, |
|
| 325 |
+ "Hostname": "", |
|
| 326 |
+ "Image": "", |
|
| 327 |
+ "Memory": 0, |
|
| 328 |
+ "MemorySwap": 0, |
|
| 329 |
+ "NetworkDisabled": false, |
|
| 330 |
+ "OpenStdin": false, |
|
| 331 |
+ "PortSpecs": null, |
|
| 332 |
+ "StdinOnce": false, |
|
| 333 |
+ "Tty": false, |
|
| 334 |
+ "User": "", |
|
| 335 |
+ "Volumes": null, |
|
| 336 |
+ "VolumesFrom": "", |
|
| 337 |
+ "WorkingDir": "" |
|
| 338 |
+ }, |
|
| 339 |
+ "container": "6b03c2dda0f8cbfa6186d96557e35e35c61915a70e4217a465f92f26c2d9290b", |
|
| 340 |
+ "containerconfig": {
|
|
| 341 |
+ "AttachStderr": false, |
|
| 342 |
+ "AttachStdin": false, |
|
| 343 |
+ "AttachStdout": false, |
|
| 344 |
+ "Cmd": null, |
|
| 345 |
+ "CpuShares": 0, |
|
| 346 |
+ "Dns": null, |
|
| 347 |
+ "Domainname": "", |
|
| 348 |
+ "Entrypoint": null, |
|
| 349 |
+ "Env": null, |
|
| 350 |
+ "ExposedPorts": null, |
|
| 351 |
+ "Hostname": "", |
|
| 352 |
+ "Image": "", |
|
| 353 |
+ "Memory": 0, |
|
| 354 |
+ "MemorySwap": 0, |
|
| 355 |
+ "NetworkDisabled": false, |
|
| 356 |
+ "OpenStdin": false, |
|
| 357 |
+ "PortSpecs": null, |
|
| 358 |
+ "StdinOnce": false, |
|
| 359 |
+ "Tty": false, |
|
| 360 |
+ "User": "", |
|
| 361 |
+ "Volumes": null, |
|
| 362 |
+ "VolumesFrom": "", |
|
| 363 |
+ "WorkingDir": "" |
|
| 364 |
+ }, |
|
| 365 |
+ "created": "0001-01-01T00:00:00Z", |
|
| 366 |
+ "id": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b", |
|
| 367 |
+ "parent": "32730be9f383719ce6308329c8ee5aac189ece9e41928dc10b8bc0fc35e9d1d5" |
|
| 368 |
+ }, |
|
| 369 |
+ "resourceVersion": 18 |
|
| 370 |
+ } |
|
| 371 |
+ ], |
|
| 372 |
+ "kind": "ImageList", |
|
| 373 |
+ "resourceVersion": 22 |
|
| 374 |
+} |
|
| 375 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_images_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>/images</h4></div><div class=modal-body><div class="alert alert-info"><p>Create a new image definition</p></div><ul class="nav nav-tabs"><li class=active><a href=#_images_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_images_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 376 |
+ "apiVersion": "v1beta1", |
|
| 377 |
+ "dockerImageReference": "localhost:5000/someproject/somerepo:c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b", |
|
| 378 |
+ "id": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b", |
|
| 379 |
+ "kind": "Image", |
|
| 380 |
+ "metadata": {
|
|
| 381 |
+ "Size": 0, |
|
| 382 |
+ "architecture": "amd64", |
|
| 383 |
+ "config": {
|
|
| 384 |
+ "AttachStderr": false, |
|
| 385 |
+ "AttachStdin": false, |
|
| 386 |
+ "AttachStdout": false, |
|
| 387 |
+ "Cmd": null, |
|
| 388 |
+ "CpuShares": 0, |
|
| 389 |
+ "Dns": null, |
|
| 390 |
+ "Domainname": "", |
|
| 391 |
+ "Entrypoint": null, |
|
| 392 |
+ "Env": null, |
|
| 393 |
+ "ExposedPorts": null, |
|
| 394 |
+ "Hostname": "", |
|
| 395 |
+ "Image": "", |
|
| 396 |
+ "Memory": 0, |
|
| 397 |
+ "MemorySwap": 0, |
|
| 398 |
+ "NetworkDisabled": false, |
|
| 399 |
+ "OpenStdin": false, |
|
| 400 |
+ "PortSpecs": null, |
|
| 401 |
+ "StdinOnce": false, |
|
| 402 |
+ "Tty": false, |
|
| 403 |
+ "User": "", |
|
| 404 |
+ "Volumes": null, |
|
| 405 |
+ "VolumesFrom": "", |
|
| 406 |
+ "WorkingDir": "" |
|
| 407 |
+ }, |
|
| 408 |
+ "container": "6b03c2dda0f8cbfa6186d96557e35e35c61915a70e4217a465f92f26c2d9290b", |
|
| 409 |
+ "containerconfig": {
|
|
| 410 |
+ "AttachStderr": false, |
|
| 411 |
+ "AttachStdin": false, |
|
| 412 |
+ "AttachStdout": false, |
|
| 413 |
+ "Cmd": null, |
|
| 414 |
+ "CpuShares": 0, |
|
| 415 |
+ "Dns": null, |
|
| 416 |
+ "Domainname": "", |
|
| 417 |
+ "Entrypoint": null, |
|
| 418 |
+ "Env": null, |
|
| 419 |
+ "ExposedPorts": null, |
|
| 420 |
+ "Hostname": "", |
|
| 421 |
+ "Image": "", |
|
| 422 |
+ "Memory": 0, |
|
| 423 |
+ "MemorySwap": 0, |
|
| 424 |
+ "NetworkDisabled": false, |
|
| 425 |
+ "OpenStdin": false, |
|
| 426 |
+ "PortSpecs": null, |
|
| 427 |
+ "StdinOnce": false, |
|
| 428 |
+ "Tty": false, |
|
| 429 |
+ "User": "", |
|
| 430 |
+ "Volumes": null, |
|
| 431 |
+ "VolumesFrom": "", |
|
| 432 |
+ "WorkingDir": "" |
|
| 433 |
+ }, |
|
| 434 |
+ "created": "0001-01-01T00:00:00Z", |
|
| 435 |
+ "id": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b", |
|
| 436 |
+ "parent": "32730be9f383719ce6308329c8ee5aac189ece9e41928dc10b8bc0fc35e9d1d5" |
|
| 437 |
+ }, |
|
| 438 |
+} |
|
| 439 |
+</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_images__imageID_ class=panel-title>/images/{imageID}</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=collapsed data-toggle=collapse href=#panel__images__imageID_><span class=parent></span>/images/{imageID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_images__imageID__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_images__imageID__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__images__imageID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_images__imageID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get image definition</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_images__imageID__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete an image</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_images__imageID__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>/images/{imageID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get image definition</p></div><ul class="nav nav-tabs"><li class=active><a href=#_images__imageID__get_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_images__imageID__get_request><h3>URI Parameters</h3><ul><li><strong>imageID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 440 |
+ "apiVersion": "v1beta1", |
|
| 441 |
+ "creationTimestamp": "2014-09-10T12:23:24-04:00", |
|
| 442 |
+ "dockerImageReference": "localhost:5000/someproject/somerepo:c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b", |
|
| 443 |
+ "id": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b", |
|
| 444 |
+ "kind": "Image", |
|
| 445 |
+ "metadata": {
|
|
| 446 |
+ "Size": 0, |
|
| 447 |
+ "architecture": "amd64", |
|
| 448 |
+ "config": {
|
|
| 449 |
+ "AttachStderr": false, |
|
| 450 |
+ "AttachStdin": false, |
|
| 451 |
+ "AttachStdout": false, |
|
| 452 |
+ "Cmd": null, |
|
| 453 |
+ "CpuShares": 0, |
|
| 454 |
+ "Dns": null, |
|
| 455 |
+ "Domainname": "", |
|
| 456 |
+ "Entrypoint": null, |
|
| 457 |
+ "Env": null, |
|
| 458 |
+ "ExposedPorts": null, |
|
| 459 |
+ "Hostname": "", |
|
| 460 |
+ "Image": "", |
|
| 461 |
+ "Memory": 0, |
|
| 462 |
+ "MemorySwap": 0, |
|
| 463 |
+ "NetworkDisabled": false, |
|
| 464 |
+ "OpenStdin": false, |
|
| 465 |
+ "PortSpecs": null, |
|
| 466 |
+ "StdinOnce": false, |
|
| 467 |
+ "Tty": false, |
|
| 468 |
+ "User": "", |
|
| 469 |
+ "Volumes": null, |
|
| 470 |
+ "VolumesFrom": "", |
|
| 471 |
+ "WorkingDir": "" |
|
| 472 |
+ }, |
|
| 473 |
+ "container": "6b03c2dda0f8cbfa6186d96557e35e35c61915a70e4217a465f92f26c2d9290b", |
|
| 474 |
+ "containerconfig": {
|
|
| 475 |
+ "AttachStderr": false, |
|
| 476 |
+ "AttachStdin": false, |
|
| 477 |
+ "AttachStdout": false, |
|
| 478 |
+ "Cmd": null, |
|
| 479 |
+ "CpuShares": 0, |
|
| 480 |
+ "Dns": null, |
|
| 481 |
+ "Domainname": "", |
|
| 482 |
+ "Entrypoint": null, |
|
| 483 |
+ "Env": null, |
|
| 484 |
+ "ExposedPorts": null, |
|
| 485 |
+ "Hostname": "", |
|
| 486 |
+ "Image": "", |
|
| 487 |
+ "Memory": 0, |
|
| 488 |
+ "MemorySwap": 0, |
|
| 489 |
+ "NetworkDisabled": false, |
|
| 490 |
+ "OpenStdin": false, |
|
| 491 |
+ "PortSpecs": null, |
|
| 492 |
+ "StdinOnce": false, |
|
| 493 |
+ "Tty": false, |
|
| 494 |
+ "User": "", |
|
| 495 |
+ "Volumes": null, |
|
| 496 |
+ "VolumesFrom": "", |
|
| 497 |
+ "WorkingDir": "" |
|
| 498 |
+ }, |
|
| 499 |
+ "created": "0001-01-01T00:00:00Z", |
|
| 500 |
+ "id": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b", |
|
| 501 |
+ "parent": "32730be9f383719ce6308329c8ee5aac189ece9e41928dc10b8bc0fc35e9d1d5" |
|
| 502 |
+ }, |
|
| 503 |
+ "resourceVersion": 18 |
|
| 504 |
+} |
|
| 505 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_images__imageID__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></span>/images/{imageID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete an image</p></div><ul class="nav nav-tabs"><li class=active><a href=#_images__imageID__delete_request data-toggle=tab>Request</a></li><li><a href=#_images__imageID__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_images__imageID__delete_request><h3>URI Parameters</h3><ul><li><strong>imageID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_images__imageID__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 506 |
+ "apiVersion": "v1beta1", |
|
| 507 |
+ "creationTimestamp": null, |
|
| 508 |
+ "kind": "Status", |
|
| 509 |
+ "status": "success" |
|
| 510 |
+} |
|
| 511 |
+</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_imageRepositoryMappings class=panel-title>/imageRepositoryMappings</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=collapsed data-toggle=collapse href=#panel__imageRepositoryMappings><span class=parent></span>/imageRepositoryMappings</a> <span class=methods><a href=# data-toggle=modal data-target=#_imageRepositoryMappings_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__imageRepositoryMappings class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_imageRepositoryMappings_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Creates an image and updates an image repository.</p><p>This is designed as a webhook that a Docker registry can invoke when a new tag is created. The image repository mapping contains a reference to the repository, the image's metadata, and the name of the new tag. Upon execution, a new image is created if it doesn't already exist, and the image repository is updated with the new tag.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_imageRepositoryMappings_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>/imageRepositoryMappings</h4></div><div class=modal-body><div class="alert alert-info"><p>Creates an image and updates an image repository.</p><p>This is designed as a webhook that a Docker registry can invoke when a new tag is created. The image repository mapping contains a reference to the repository, the image's metadata, and the name of the new tag. Upon execution, a new image is created if it doesn't already exist, and the image repository is updated with the new tag.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_imageRepositoryMappings_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_imageRepositoryMappings_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 512 |
+ "dockerImageRepository": "localhost:5000/someproject/somerepo", |
|
| 513 |
+ "image": {
|
|
| 514 |
+ "dockerImageReference": "localhost:5000/someproject/somerepo:c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b", |
|
| 515 |
+ "id": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b", |
|
| 516 |
+ "metadata": {
|
|
| 517 |
+ "Size": 0, |
|
| 518 |
+ "architecture": "amd64", |
|
| 519 |
+ "config": {
|
|
| 520 |
+ "AttachStderr": false, |
|
| 521 |
+ "AttachStdin": false, |
|
| 522 |
+ "AttachStdout": false, |
|
| 523 |
+ "Cmd": [ |
|
| 524 |
+ "/bin/sh" |
|
| 525 |
+ ], |
|
| 526 |
+ "CpuShares": 0, |
|
| 527 |
+ "Cpuset": "", |
|
| 528 |
+ "Domainname": "", |
|
| 529 |
+ "Entrypoint": null, |
|
| 530 |
+ "Env": [ |
|
| 531 |
+ "c=e", |
|
| 532 |
+ "b=2", |
|
| 533 |
+ "a=1", |
|
| 534 |
+ "HOME=/", |
|
| 535 |
+ "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin" |
|
| 536 |
+ ], |
|
| 537 |
+ "ExposedPorts": null, |
|
| 538 |
+ "Hostname": "", |
|
| 539 |
+ "Image": "", |
|
| 540 |
+ "Memory": 0, |
|
| 541 |
+ "MemorySwap": 0, |
|
| 542 |
+ "NetworkDisabled": false, |
|
| 543 |
+ "OnBuild": null, |
|
| 544 |
+ "OpenStdin": false, |
|
| 545 |
+ "PortSpecs": null, |
|
| 546 |
+ "StdinOnce": false, |
|
| 547 |
+ "Tty": false, |
|
| 548 |
+ "User": "", |
|
| 549 |
+ "Volumes": null, |
|
| 550 |
+ "WorkingDir": "" |
|
| 551 |
+ }, |
|
| 552 |
+ "container": "6b03c2dda0f8cbfa6186d96557e35e35c61915a70e4217a465f92f26c2d9290b", |
|
| 553 |
+ "container_config": {
|
|
| 554 |
+ "AttachStderr": true, |
|
| 555 |
+ "AttachStdin": false, |
|
| 556 |
+ "AttachStdout": true, |
|
| 557 |
+ "Cmd": [ |
|
| 558 |
+ "/bin/sh" |
|
| 559 |
+ ], |
|
| 560 |
+ "CpuShares": 0, |
|
| 561 |
+ "Cpuset": "", |
|
| 562 |
+ "Domainname": "", |
|
| 563 |
+ "Entrypoint": null, |
|
| 564 |
+ "Env": [ |
|
| 565 |
+ "c=e", |
|
| 566 |
+ "b=2", |
|
| 567 |
+ "a=1", |
|
| 568 |
+ "HOME=/", |
|
| 569 |
+ "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin" |
|
| 570 |
+ ], |
|
| 571 |
+ "ExposedPorts": null, |
|
| 572 |
+ "Hostname": "6b03c2dda0f8", |
|
| 573 |
+ "Image": "localhost:5000/someproject/somerepo", |
|
| 574 |
+ "Memory": 0, |
|
| 575 |
+ "MemorySwap": 0, |
|
| 576 |
+ "NetworkDisabled": false, |
|
| 577 |
+ "OnBuild": null, |
|
| 578 |
+ "OpenStdin": false, |
|
| 579 |
+ "PortSpecs": null, |
|
| 580 |
+ "StdinOnce": false, |
|
| 581 |
+ "Tty": false, |
|
| 582 |
+ "User": "", |
|
| 583 |
+ "Volumes": null, |
|
| 584 |
+ "WorkingDir": "" |
|
| 585 |
+ }, |
|
| 586 |
+ "created": "2014-09-04T17:43:39.863545902Z", |
|
| 587 |
+ "docker_version": "1.1.2", |
|
| 588 |
+ "id": "c115fca463efa744a5492ca580ef24b20ed5ef2155c624cc5b1262aefc14797b", |
|
| 589 |
+ "os": "linux", |
|
| 590 |
+ "parent": "32730be9f383719ce6308329c8ee5aac189ece9e41928dc10b8bc0fc35e9d1d5" |
|
| 591 |
+ } |
|
| 592 |
+ }, |
|
| 593 |
+ "kind": "ImageRepositoryMapping", |
|
| 594 |
+ "tag": "latest", |
|
| 595 |
+ "version": "v1beta1" |
|
| 596 |
+} |
|
| 597 |
+</code></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=collapsed data-toggle=collapse href=#panel__services><span class=parent></span>/services</a> <span class=methods><a href=# data-toggle=modal data-target=#_services_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_services_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__services class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_services_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Lists all services that your account has access to</p><p>Services can be public or owned by a project. They contain a template of a pod and reference image repositories that supply the images for those templates. A service may be configured to react to an image being pushed to an image repository by initiating a deployment. Deployments are associated with a service and make use of Kubernetes replication controllers to manage pods in a cluster. For deployments, a service contains a policy that constrains how deployments can occur. For example, it may require that there exist at least 2 operational pods at all times. A deployment needs to operate under those constraints when making changes.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_services_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new service</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 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>Lists all services that your account has access to</p><p>Services can be public or owned by a project. They contain a template of a pod and reference image repositories that supply the images for those templates. A service may be configured to react to an image being pushed to an image repository by initiating a deployment. Deployments are associated with a service and make use of Kubernetes replication controllers to manage pods in a cluster. For deployments, a service contains a policy that constrains how deployments can occur. For example, it may require that there exist at least 2 operational pods at all times. A deployment needs to operate under those constraints when making changes.</p></div><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><div class=tab-content><div class="tab-pane active" id=_services_get_request><h3>Query Parameters</h3><ul><li><strong>projectId</strong>: <em>(string)</em><p>filter the services owned by a particular project</p></li></ul></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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 598 |
+ "list": |
|
| 599 |
+ [ |
|
| 600 |
+ {
|
|
| 601 |
+ "id": "53c4249f076573c0f4000001", |
|
| 602 |
+ "name": "service-name", |
|
| 603 |
+ "domain": "domain-id", |
|
| 604 |
+ "desiredState": |
|
| 605 |
+ {
|
|
| 606 |
+ "replicas": 3, |
|
| 607 |
+ "replicaSelector": { "name": "service-name" },
|
|
| 608 |
+ "replicaPolicy": {
|
|
| 609 |
+ "atLeast": 2 |
|
| 610 |
+ }, |
|
| 611 |
+ "activeDeployment": "a_deployment_id", |
|
| 612 |
+ "podTemplate": |
|
| 613 |
+ {
|
|
| 614 |
+ "desiredState": |
|
| 615 |
+ {
|
|
| 616 |
+ "image": "server/domain/name", |
|
| 617 |
+ "network-ports": [ |
|
| 618 |
+ {
|
|
| 619 |
+ "hostPort": 8080, |
|
| 620 |
+ "containerPort": 80 |
|
| 621 |
+ } |
|
| 622 |
+ ], |
|
| 623 |
+ "owner": true |
|
| 624 |
+ }, |
|
| 625 |
+ "labels": {
|
|
| 626 |
+ "name": "service-name" |
|
| 627 |
+ } |
|
| 628 |
+ } |
|
| 629 |
+ } |
|
| 630 |
+ ] |
|
| 631 |
+ } |
|
| 632 |
+} |
|
| 633 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 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><ul class="nav nav-tabs"><li class=active><a href=#_services_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_services_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 634 |
+ "data": |
|
| 635 |
+ {
|
|
| 636 |
+ "name": "service-name", |
|
| 637 |
+ "desiredState": |
|
| 638 |
+ {
|
|
| 639 |
+ "replicas": 3, |
|
| 640 |
+ "replicaPolicy": {
|
|
| 641 |
+ "atLeast": 2 |
|
| 642 |
+ }, |
|
| 643 |
+ "podTemplate": |
|
| 644 |
+ {
|
|
| 645 |
+ "desiredState": |
|
| 646 |
+ {
|
|
| 647 |
+ "image": "server/domain/name", |
|
| 648 |
+ "network-ports": [ |
|
| 649 |
+ {
|
|
| 650 |
+ "hostPort": 8080, |
|
| 651 |
+ "containerPort": 80 |
|
| 652 |
+ } |
|
| 653 |
+ ] |
|
| 654 |
+ } |
|
| 655 |
+ } |
|
| 656 |
+ } |
|
| 657 |
+ } |
|
| 658 |
+} |
|
| 659 |
+</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_service__serviceID_ class=panel-title>/service/{serviceID}</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=collapsed data-toggle=collapse href=#panel__service__serviceID_><span class=parent></span>/service/{serviceID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_service__serviceID__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_service__serviceID__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_service__serviceID__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__service__serviceID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_service__serviceID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get a specific service definition</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_service__serviceID__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a service</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_service__serviceID__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a service</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_service__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></span>/service/{serviceID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get a specific service definition</p></div><ul class="nav nav-tabs"><li class=active><a href=#_service__serviceID__get_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_service__serviceID__get_request><h3>URI Parameters</h3><ul><li><strong>serviceID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 660 |
+ "data": |
|
| 661 |
+ {
|
|
| 662 |
+ "id": "53c4249f076573c0f4000001", |
|
| 663 |
+ "name": "service-name", |
|
| 664 |
+ "domain": "domain-id", |
|
| 665 |
+ "desiredState": |
|
| 666 |
+ {
|
|
| 667 |
+ "replicas": 3, |
|
| 668 |
+ "replicaSelector": { "name": "service-name" },
|
|
| 669 |
+ "replicaPolicy": {
|
|
| 670 |
+ "atLeast": 2 |
|
| 671 |
+ }, |
|
| 672 |
+ "activeDeployment": "a_deployment_id", |
|
| 673 |
+ "podTemplate": |
|
| 674 |
+ {
|
|
| 675 |
+ "desiredState": |
|
| 676 |
+ {
|
|
| 677 |
+ "image": "server/domain/name", |
|
| 678 |
+ "network-ports": [ |
|
| 679 |
+ {
|
|
| 680 |
+ "hostPort": 8080, |
|
| 681 |
+ "containerPort": 80 |
|
| 682 |
+ } |
|
| 683 |
+ ], |
|
| 684 |
+ "owner": true |
|
| 685 |
+ }, |
|
| 686 |
+ "labels": {
|
|
| 687 |
+ "name": "service-name" |
|
| 688 |
+ } |
|
| 689 |
+ } |
|
| 690 |
+ } |
|
| 691 |
+ } |
|
| 692 |
+} |
|
| 693 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_service__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></span>/service/{serviceID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update a service</p></div><ul class="nav nav-tabs"><li class=active><a href=#_service__serviceID__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_service__serviceID__put_request><h3>URI Parameters</h3><ul><li><strong>serviceID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 694 |
+ "data": |
|
| 695 |
+ {
|
|
| 696 |
+ "id": "53c4249f076573c0f4000001", |
|
| 697 |
+ "name": "service-name", |
|
| 698 |
+ "domain": "domain-id", |
|
| 699 |
+ "desiredState": |
|
| 700 |
+ {
|
|
| 701 |
+ "replicas": 3, |
|
| 702 |
+ "replicaSelector": { "name": "service-name" },
|
|
| 703 |
+ "replicaPolicy": {
|
|
| 704 |
+ "atLeast": 2 |
|
| 705 |
+ }, |
|
| 706 |
+ "activeDeployment": "a_deployment_id", |
|
| 707 |
+ "podTemplate": |
|
| 708 |
+ {
|
|
| 709 |
+ "desiredState": |
|
| 710 |
+ {
|
|
| 711 |
+ "image": "server/domain/name", |
|
| 712 |
+ "network-ports": [ |
|
| 713 |
+ {
|
|
| 714 |
+ "hostPort": 8080, |
|
| 715 |
+ "containerPort": 80 |
|
| 716 |
+ } |
|
| 717 |
+ ], |
|
| 718 |
+ "owner": true |
|
| 719 |
+ }, |
|
| 720 |
+ "labels": {
|
|
| 721 |
+ "name": "service-name" |
|
| 722 |
+ } |
|
| 723 |
+ } |
|
| 724 |
+ } |
|
| 725 |
+ } |
|
| 726 |
+} |
|
| 727 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_service__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></span>/service/{serviceID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete a service</p></div><ul class="nav nav-tabs"><li class=active><a href=#_service__serviceID__delete_request data-toggle=tab>Request</a></li><li><a href=#_service__serviceID__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_service__serviceID__delete_request><h3>URI Parameters</h3><ul><li><strong>serviceID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_service__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 728 |
+ "apiVersion": "v1beta1", |
|
| 729 |
+ "creationTimestamp": null, |
|
| 730 |
+ "kind": "Status", |
|
| 731 |
+ "status": "success" |
|
| 732 |
+} |
|
| 733 |
+</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__service__serviceID__environment_variables><span class=parent>/service/{serviceID}</span>/environment-variables</a> <span class=methods><a href=# data-toggle=modal data-target=#_service__serviceID__environment_variables_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_service__serviceID__environment_variables_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__service__serviceID__environment_variables class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_service__serviceID__environment_variables_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Environment variables associated with this service</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_service__serviceID__environment_variables_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create/update environment variables</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_service__serviceID__environment_variables_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>/service/{serviceID}</span>/environment-variables</h4></div><div class=modal-body><div class="alert alert-info"><p>Environment variables associated with this service</p></div><ul class="nav nav-tabs"><li class=active><a href=#_service__serviceID__environment_variables_get_request data-toggle=tab>Request</a></li><li><a href=#_service__serviceID__environment_variables_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_service__serviceID__environment_variables_get_request><h3>URI Parameters</h3><ul><li><strong>serviceID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_service__serviceID__environment_variables_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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 734 |
+ "data": |
|
| 735 |
+ [ |
|
| 736 |
+ { "name": "var1", "value": "value1" },
|
|
| 737 |
+ { "name": "var2", "value": "value2" }
|
|
| 738 |
+ ] |
|
| 739 |
+} |
|
| 740 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_service__serviceID__environment_variables_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>/service/{serviceID}</span>/environment-variables</h4></div><div class=modal-body><div class="alert alert-info"><p>Create/update environment variables</p></div><ul class="nav nav-tabs"><li class=active><a href=#_service__serviceID__environment_variables_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_service__serviceID__environment_variables_post_request><h3>URI Parameters</h3><ul><li><strong>serviceID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 741 |
+ "data": |
|
| 742 |
+ [ |
|
| 743 |
+ { "name": "var1", "value": "value1" },
|
|
| 744 |
+ { "name": "var2", "value": "value2" }
|
|
| 745 |
+ ] |
|
| 746 |
+} |
|
| 747 |
+</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__service__serviceID__environment_variables__variableName_><span class=parent>/service/{serviceID}/environment-variables</span>/{variableName}</a> <span class=methods><a href=# data-toggle=modal data-target=#_service__serviceID__environment_variables__variableName__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_service__serviceID__environment_variables__variableName__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_service__serviceID__environment_variables__variableName__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__service__serviceID__environment_variables__variableName_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_service__serviceID__environment_variables__variableName__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get environment variable</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_service__serviceID__environment_variables__variableName__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update an environment variable's value</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_service__serviceID__environment_variables__variableName__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete an environment variable</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_service__serviceID__environment_variables__variableName__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>/service/{serviceID}/environment-variables</span>/{variableName}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get environment variable</p></div><ul class="nav nav-tabs"><li class=active><a href=#_service__serviceID__environment_variables__variableName__get_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_service__serviceID__environment_variables__variableName__get_request><h3>URI Parameters</h3><ul><li><strong>serviceID</strong>: <em>required (string)</em></li><li><strong>variableName</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 748 |
+ "data": { "name": "var1", "value": "value1" }
|
|
| 749 |
+} |
|
| 750 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_service__serviceID__environment_variables__variableName__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>/service/{serviceID}/environment-variables</span>/{variableName}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update an environment variable's value</p></div><ul class="nav nav-tabs"><li class=active><a href=#_service__serviceID__environment_variables__variableName__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_service__serviceID__environment_variables__variableName__put_request><h3>URI Parameters</h3><ul><li><strong>serviceID</strong>: <em>required (string)</em></li><li><strong>variableName</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 751 |
+ "data": { "name": "var1", "value": "value1" }
|
|
| 752 |
+} |
|
| 753 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_service__serviceID__environment_variables__variableName__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>/service/{serviceID}/environment-variables</span>/{variableName}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete an environment variable</p></div><ul class="nav nav-tabs"><li class=active><a href=#_service__serviceID__environment_variables__variableName__delete_request data-toggle=tab>Request</a></li><li><a href=#_service__serviceID__environment_variables__variableName__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_service__serviceID__environment_variables__variableName__delete_request><h3>URI Parameters</h3><ul><li><strong>serviceID</strong>: <em>required (string)</em></li><li><strong>variableName</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_service__serviceID__environment_variables__variableName__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 754 |
+ "apiVersion": "v1beta1", |
|
| 755 |
+ "creationTimestamp": null, |
|
| 756 |
+ "kind": "Status", |
|
| 757 |
+ "status": "success" |
|
| 758 |
+} |
|
| 759 |
+</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_deployments class=panel-title>/deployments</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=collapsed data-toggle=collapse href=#panel__deployments><span class=parent></span>/deployments</a> <span class=methods><a href=# data-toggle=modal data-target=#_deployments_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_deployments_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__deployments class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_deployments_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Lists active deployments in the current project</p><p>Deployments effect change in a service such as scaling up, down, updating the current image, etc. Deployments may use different policies for carrying out the change. For example, a rolling update with a single pod change at a time, or a batch update, etc. Deployments make use of Kubernetes replicationControllers to bring about the changes.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_deployments_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new deployment</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_deployments_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>/deployments</h4></div><div class=modal-body><div class="alert alert-info"><p>Lists active deployments in the current project</p><p>Deployments effect change in a service such as scaling up, down, updating the current image, etc. Deployments may use different policies for carrying out the change. For example, a rolling update with a single pod change at a time, or a batch update, etc. Deployments make use of Kubernetes replicationControllers to bring about the changes.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_deployments_get_request data-toggle=tab>Request</a></li><li><a href=#_deployments_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_deployments_get_request></div><div class=tab-pane id=_deployments_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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 760 |
+ "list": [ |
|
| 761 |
+ {
|
|
| 762 |
+ "id": "1234235172374", |
|
| 763 |
+ "serviceId": "the-service-id", |
|
| 764 |
+ "replicationControllers": [ |
|
| 765 |
+ "replication-controller-id1", |
|
| 766 |
+ "replication-controller-id2", |
|
| 767 |
+ "replication-controller-id3" |
|
| 768 |
+ ], |
|
| 769 |
+ "currentState": {
|
|
| 770 |
+ "replicas": 1, |
|
| 771 |
+ "replicaSelector": {
|
|
| 772 |
+ "name": "nginx" |
|
| 773 |
+ }, |
|
| 774 |
+ "containers": [{
|
|
| 775 |
+ "image": "dockerfile/nginx", |
|
| 776 |
+ "ports": [{"containerPort": 80, "hostPort": 8080}]
|
|
| 777 |
+ }], |
|
| 778 |
+ }, |
|
| 779 |
+ "desiredState": {
|
|
| 780 |
+ "replicas": 2, |
|
| 781 |
+ "replicaSelector": {
|
|
| 782 |
+ "name": "nginx" |
|
| 783 |
+ }, |
|
| 784 |
+ "containers": [{
|
|
| 785 |
+ "image": "dockerfile/nginx/v2tag", |
|
| 786 |
+ "ports": [{"containerPort": 80, "hostPort": 8080}]
|
|
| 787 |
+ }], |
|
| 788 |
+ }, |
|
| 789 |
+ "status": "active" |
|
| 790 |
+ } |
|
| 791 |
+ ] |
|
| 792 |
+} |
|
| 793 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_deployments_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>/deployments</h4></div><div class=modal-body><div class="alert alert-info"><p>Create a new deployment</p></div><ul class="nav nav-tabs"><li class=active><a href=#_deployments_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_deployments_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 794 |
+ "object": {
|
|
| 795 |
+ "id": "1234235172374", |
|
| 796 |
+ "serviceId": "the-service-id", |
|
| 797 |
+ "desiredState": {
|
|
| 798 |
+ "replicas": 2, |
|
| 799 |
+ "replicaSelector": {
|
|
| 800 |
+ "name": "nginx" |
|
| 801 |
+ }, |
|
| 802 |
+ "containers": [{
|
|
| 803 |
+ "image": "dockerfile/nginx/v2tag", |
|
| 804 |
+ "ports": [{"containerPort": 80, "hostPort": 8080}]
|
|
| 805 |
+ }] |
|
| 806 |
+ } |
|
| 807 |
+ } |
|
| 808 |
+} |
|
| 809 |
+</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_deployment__deploymentID_ class=panel-title>/deployment/{deploymentID}</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=collapsed data-toggle=collapse href=#panel__deployment__deploymentID_><span class=parent></span>/deployment/{deploymentID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_deployment__deploymentID__get><span class="badge badge_get">get</span></a></span></h4></div><div id=panel__deployment__deploymentID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_deployment__deploymentID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get deployment details</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_deployment__deploymentID__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>/deployment/{deploymentID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get deployment details</p></div><ul class="nav nav-tabs"><li class=active><a href=#_deployment__deploymentID__get_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_deployment__deploymentID__get_request><h3>URI Parameters</h3><ul><li><strong>deploymentID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 810 |
+ "object": {
|
|
| 811 |
+ "id": "1234235172374", |
|
| 812 |
+ "serviceId": "the-service-id", |
|
| 813 |
+ "replicationControllers": [ |
|
| 814 |
+ "replication-controller-id1", |
|
| 815 |
+ "replication-controller-id2", |
|
| 816 |
+ "replication-controller-id3" |
|
| 817 |
+ ], |
|
| 818 |
+ "currentState": {
|
|
| 819 |
+ "replicas": 1, |
|
| 820 |
+ "replicaSelector": {
|
|
| 821 |
+ "name": "nginx" |
|
| 822 |
+ }, |
|
| 823 |
+ "containers": [{
|
|
| 824 |
+ "image": "dockerfile/nginx", |
|
| 825 |
+ "ports": [{"containerPort": 80, "hostPort": 8080}]
|
|
| 826 |
+ }], |
|
| 827 |
+ }, |
|
| 828 |
+ "desiredState": {
|
|
| 829 |
+ "replicas": 2, |
|
| 830 |
+ "replicaSelector": {
|
|
| 831 |
+ "name": "nginx" |
|
| 832 |
+ }, |
|
| 833 |
+ "containers": [{
|
|
| 834 |
+ "image": "dockerfile/nginx/v2tag", |
|
| 835 |
+ "ports": [{"containerPort": 80, "hostPort": 8080}]
|
|
| 836 |
+ }], |
|
| 837 |
+ }, |
|
| 838 |
+ "status": "active" |
|
| 839 |
+ } |
|
| 840 |
+} |
|
| 841 |
+</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_links class=panel-title>/links</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=collapsed data-toggle=collapse href=#panel__links><span class=parent></span>/links</a> <span class=methods><a href=# data-toggle=modal data-target=#_links_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_links_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__links class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_links_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>List of links between services in your account</p><p>Unlike a Docker link, a Link in OpenShift defines a relationship between services which may be composed by multiple Docker images. A link may include additional metadata about the relationship such as the algorithm to use to distribute requests.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_links_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new link between this service and a different service</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_links_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>/links</h4></div><div class=modal-body><div class="alert alert-info"><p>List of links between services in your account</p><p>Unlike a Docker link, a Link in OpenShift defines a relationship between services which may be composed by multiple Docker images. A link may include additional metadata about the relationship such as the algorithm to use to distribute requests.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_links_get_request data-toggle=tab>Request</a></li><li><a href=#_links_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_links_get_request><h3>Query Parameters</h3><ul><li><strong>projectId</strong>: <em>(string)</em><p>filter the links owned by a particular project</p></li><li><strong>serviceId</strong>: <em>(string)</em><p>filter the links attached to a particular service</p></li></ul></div><div class=tab-pane id=_links_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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 842 |
+ "list": |
|
| 843 |
+ [ |
|
| 844 |
+ {
|
|
| 845 |
+ "id": "53c4249f076573c0f4000001", |
|
| 846 |
+ "projectId": "myproject-1234123132", |
|
| 847 |
+ "source": {
|
|
| 848 |
+ "serviceId": "nginx-1893747912737" |
|
| 849 |
+ }, |
|
| 850 |
+ "destination": {
|
|
| 851 |
+ "serviceId": "ruby1.9-1237471273", |
|
| 852 |
+ "port": 8080 |
|
| 853 |
+ } |
|
| 854 |
+ "policy": "round-robin" |
|
| 855 |
+ } |
|
| 856 |
+ ] |
|
| 857 |
+} |
|
| 858 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_links_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>/links</h4></div><div class=modal-body><div class="alert alert-info"><p>Create a new link between this service and a different service</p></div><ul class="nav nav-tabs"><li class=active><a href=#_links_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_links_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 859 |
+ "data": |
|
| 860 |
+ {
|
|
| 861 |
+ "id": "53c4249f076573c0f4000001", |
|
| 862 |
+ "projectId": "myproject-1234123132", |
|
| 863 |
+ "source": {
|
|
| 864 |
+ "serviceId": "nginx-1893747912737" |
|
| 865 |
+ }, |
|
| 866 |
+ "destination": {
|
|
| 867 |
+ "serviceId": "ruby1.9-1237471273", |
|
| 868 |
+ "port": 8080 |
|
| 869 |
+ } |
|
| 870 |
+ "policy": "round-robin" |
|
| 871 |
+ } |
|
| 872 |
+} |
|
| 873 |
+</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_link__linkID_ class=panel-title>/link/{linkID}</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=collapsed data-toggle=collapse href=#panel__link__linkID_><span class=parent></span>/link/{linkID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_link__linkID__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_link__linkID__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_link__linkID__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__link__linkID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_link__linkID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get link details</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_link__linkID__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a link</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_link__linkID__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a link</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_link__linkID__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>/link/{linkID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get link details</p></div><ul class="nav nav-tabs"><li class=active><a href=#_link__linkID__get_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_link__linkID__get_request><h3>URI Parameters</h3><ul><li><strong>linkID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 874 |
+ "data": |
|
| 875 |
+ {
|
|
| 876 |
+ "id": "53c4249f076573c0f4000001", |
|
| 877 |
+ "projectId": "myproject-1234123132", |
|
| 878 |
+ "source": {
|
|
| 879 |
+ "serviceId": "nginx-1893747912737" |
|
| 880 |
+ }, |
|
| 881 |
+ "destination": {
|
|
| 882 |
+ "serviceId": "ruby1.9-1237471273", |
|
| 883 |
+ "port": 8080 |
|
| 884 |
+ } |
|
| 885 |
+ "policy": "round-robin" |
|
| 886 |
+ } |
|
| 887 |
+} |
|
| 888 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_link__linkID__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></span>/link/{linkID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update a link</p></div><ul class="nav nav-tabs"><li class=active><a href=#_link__linkID__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_link__linkID__put_request><h3>URI Parameters</h3><ul><li><strong>linkID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 889 |
+ "data": |
|
| 890 |
+ {
|
|
| 891 |
+ "id": "53c4249f076573c0f4000001", |
|
| 892 |
+ "projectId": "myproject-1234123132", |
|
| 893 |
+ "source": {
|
|
| 894 |
+ "serviceId": "nginx-1893747912737" |
|
| 895 |
+ }, |
|
| 896 |
+ "destination": {
|
|
| 897 |
+ "serviceId": "ruby1.9-1237471273", |
|
| 898 |
+ "port": 8080 |
|
| 899 |
+ } |
|
| 900 |
+ "policy": "round-robin" |
|
| 901 |
+ } |
|
| 902 |
+} |
|
| 903 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_link__linkID__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></span>/link/{linkID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete a link</p></div><ul class="nav nav-tabs"><li class=active><a href=#_link__linkID__delete_request data-toggle=tab>Request</a></li><li><a href=#_link__linkID__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_link__linkID__delete_request><h3>URI Parameters</h3><ul><li><strong>linkID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_link__linkID__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 904 |
+ "apiVersion": "v1beta1", |
|
| 905 |
+ "creationTimestamp": null, |
|
| 906 |
+ "kind": "Status", |
|
| 907 |
+ "status": "success" |
|
| 908 |
+} |
|
| 909 |
+</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_aliases class=panel-title>/aliases</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=collapsed data-toggle=collapse href=#panel__aliases><span class=parent></span>/aliases</a> <span class=methods><a href=# data-toggle=modal data-target=#_aliases_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_aliases_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__aliases class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_aliases_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>List all aliases visible to you</p><p>Aliases in v3 perform the same function as aliases in v2. The main difference is that in v3 an alias is associated with a service, not an application.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_aliases_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create an alias for this service</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_aliases_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>/aliases</h4></div><div class=modal-body><div class="alert alert-info"><p>List all aliases visible to you</p><p>Aliases in v3 perform the same function as aliases in v2. The main difference is that in v3 an alias is associated with a service, not an application.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_aliases_get_request data-toggle=tab>Request</a></li><li><a href=#_aliases_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_aliases_get_request><h3>Query Parameters</h3><ul><li><strong>serviceId</strong>: <em>(string)</em><p>filter aliases by associated service</p></li></ul></div><div class=tab-pane id=_aliases_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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 910 |
+ "list": |
|
| 911 |
+ [ |
|
| 912 |
+ {
|
|
| 913 |
+ "id": "myalias", |
|
| 914 |
+ "ssl_certificate": "-----BEGIN CERTIFICATE-----\nMIIDoDCCAogCCQDzF8AJCHnrbjANBgkqhkiG9w0BAQUFADCBkTELMAkGA1UEBhMC\nVVMxCzAJBgNVBAgMAkNBMRIwEAYDVQQHDAlTdW5ueXZhbGUxDzANBgNVBAoMBnJl\nZGhhdDESMBAGA1UECwwJb3BlbnNoaWZ0MRIwEAYDVQQDDAlvcGVuc2hpZnQxKDAm\nBgkqhkiG9w0BCQEWGWluZm9Ab3BlbnNoaWZ0LnJlZGhhdC5jb20wHhcNMTMwMjE5\nMjExMTQ4WhcNMTQwMjE5MjExMTQ4WjCBkTELMAkGA1UEBhMCVVMxCzAJBgNVBAgM\nAkNBMRIwEAYDVQQHDAlTdW5ueXZhbGUxDzANBgNVBAoMBnJlZGhhdDESMBAGA1UE\nCwwJb3BlbnNoaWZ0MRIwEAYDVQQDDAlvcGVuc2hpZnQxKDAmBgkqhkiG9w0BCQEW\nGWluZm9Ab3BlbnNoaWZ0LnJlZGhhdC5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IB\nDwAwggEKAoIBAQDAEbH4MCi3iIDP1HS+/Xwu8SjdSc5WJX6htV7hJpmFZ8HohV/8\nba0v6aM9IJIIt+sIe2J62t/9G3leOdIHBxeACN4fV2l/iA/fvxvlnFKeD7sHm9Oc\nYj1H6YYJ57sIOf/oLDpJl6l3Rw8VC3+3W0/lzlVpA8qt7fpkiW7XQJCPplUSrdVC\n3okQ2T5NAod5+wVIOqELgE5bLX1LRs5VPsjytHkJ7rKXs55FHR3kpsoImn5xD0Ky\n6lRn8cIMolQoyN5HIGr8f5P+07hrHibve8jje/DKTssb5yEUAEmh6iGHQsRAnsUW\nQoIEUOLqQCu9re2No4G52Kl2xQIjyJF7rCfxAgMBAAEwDQYJKoZIhvcNAQEFBQAD\nggEBAGHrya/ZkiAje2kHsOajXMlO2+y1iLfUDcRLuEWpUa8sI5EM4YtemQrsupFp\n8lVYG5C4Vh8476oF9t8Wex5eH3ocwbSvPIUqE07hdmrubiMq4wxFVRYq7g9lHAnx\nl+bABuN/orbAcPcGAGg7AkXVoAc3Fza/ZcgMcw7NOtDTEss70V9OdgCfQUJL0KdO\nhCO8bQ1EaEiq6zEh8RpZe8mu+f/GYATX1I+eJUc6F6cn83oJjE9bqAVzk7TzTHeK\nEBKN50C14wWtXeG7n2+ugaVO+0xnvHeUrQBLHSRyOHqxXrQQ5XmzcaBiyI0f2IQM\nHst1BVXyX0n/L/ZoYYsv5juJmDo=\n-----END CERTIFICATE-----", |
|
| 915 |
+ "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEAwBGx+DAot4iAz9R0vv18LvEo3UnOViV+obVe4SaZhWfB6IVf\n/G2tL+mjPSCSCLfrCHtietrf/Rt5XjnSBwcXgAjeH1dpf4gP378b5ZxSng+7B5vT\nnGI9R+mGCee7CDn/6Cw6SZepd0cPFQt/t1tP5c5VaQPKre36ZIlu10CQj6ZVEq3V\nQt6JENk+TQKHefsFSDqhC4BOWy19S0bOVT7I8rR5Ce6yl7OeRR0d5KbKCJp+cQ9C\nsupUZ/HCDKJUKMjeRyBq/H+T/tO4ax4m73vI43vwyk7LG+chFABJoeohh0LEQJ7F\nFkKCBFDi6kArva3tjaOBudipdsUCI8iRe6wn8QIDAQABAoIBAG/on4JVRRQSw8LU\nLiWt+jI7ryyoOUH2XL8JtzuGSwLwvomlVJT2rmbxQXx3Qr8zsgziHzIn30RRQrkF\nBXu0xRuDjzBBtSVqeJ1Mc4uoNncEAVxgjb5bewswZDnXPCGB8bosMtX4OPRXgdEo\nPwTtfjMOsrMaU3hd5Xu4m81tQA2BvwOlx8aYDyH0jeTnervc5uRGbeTBQG4Bu40E\nrWNmXvgNq2EzTAwbbN6Ma97gw9KgXnM4Nlh29Fxb5TBeUU9lkzuTZAZIDXKIm7AG\nUwMbj/A038yAumYQtThTE/3e4W3rn7F2Vko900bC4aAC1KQOAzjIeQqzqkVxWTWq\n4SUFQAECgYEA/ODwifOTuI6hdZK6JRgc4wp6Rc0fkqHuxLzABXoIGuSVlWyimqIN\nZySAkpo5EW6DNraRJxNCOBmWeGPEhHGrea+JPiPEwCK0F7SxvSmg3jzNzw3Es31T\necET7eDwuSOY9v4XDzLyiXXkEUUReD7Ng2hEYL+HaQrl5jWj4lxgq/ECgYEAwnCb\nKrz7FwX8AqtFAEi6uUrc12k1xYKQfrwSxbfdK2vBBUpgB71Iq/fqP+1BittEljDG\n8f4jEtMBFfEPhLzGIHaI3UiHUHXS4GetA77TRgR8lnKKpj1FcMIY2iKU479707O5\nQ08pgWRUDQ8BVg2ePgbo5QjLMc/rv7UF3AHvPAECgYB/auAIwqDGN6gHU/1TP4ke\npWLi1O55tfpXSzv+BnUbB96PQgPUop7aP7xBIlBrBiI7aVZOOBf/qHT3CF421geu\n8tHWa7NxlIrl/vgn9lfGYyDYmXlpb1amXLEsBVGGF/e1TGZWFDe9J5fZU9HvosVu\n1xTNIvSZ6xHYI2MGZcGYIQKBgEYeebaV5C7PV6xWu1F46O19U9rS9DM//H/XryVi\nQv4vo7IWuj7QQe7SPsXC98ntfPR0rqoCLf/R3ChfgGsr8H8wf/bc+v9HHj8S5E/f\ndy1e3Nccg2ej3PDm7jNsGSlwmmUkAQGHAL7KwYzcBm1UB+bycvZ1j2FtS+UckPpg\nMDgBAoGALD8PkxHb4U4DtbNFSYRrUdvS9heav/yph3lTMfifNkOir36io6v8RPgb\nD2bHKKZgmYlTgJrxD45Er9agC5jclJO35QRU/OfGf3GcnABkBI7vlvUKADAo65Sq\nweZkdJnbrIadcvLOHOzkKC9m+rxFTC9VoN1dwK2zwYvUXfa1VJA=\n-----END RSA PRIVATE KEY-----", |
|
| 916 |
+ "pass_phrase": "abcd" |
|
| 917 |
+ } |
|
| 918 |
+ ] |
|
| 919 |
+} |
|
| 920 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_aliases_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>/aliases</h4></div><div class=modal-body><div class="alert alert-info"><p>Create an alias for this service</p></div><ul class="nav nav-tabs"><li class=active><a href=#_aliases_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_aliases_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 921 |
+ "data": |
|
| 922 |
+ {
|
|
| 923 |
+ "id": "53c4249f076573c0f4000001", |
|
| 924 |
+ "suffix": "dev.rhcloud.com", |
|
| 925 |
+ "name": "mydomain", |
|
| 926 |
+ "members": [ |
|
| 927 |
+ {
|
|
| 928 |
+ "login": "adminuser", |
|
| 929 |
+ "role": "admin", |
|
| 930 |
+ "type": "user", |
|
| 931 |
+ "owner": true |
|
| 932 |
+ } |
|
| 933 |
+ ] |
|
| 934 |
+ } |
|
| 935 |
+} |
|
| 936 |
+</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_alias__aliasID_ class=panel-title>/alias/{aliasID}</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=collapsed data-toggle=collapse href=#panel__alias__aliasID_><span class=parent></span>/alias/{aliasID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_alias__aliasID__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_alias__aliasID__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_alias__aliasID__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__alias__aliasID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_alias__aliasID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get alias</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_alias__aliasID__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update an alias</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_alias__aliasID__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete an alias</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_alias__aliasID__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>/alias/{aliasID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get alias</p></div><ul class="nav nav-tabs"><li class=active><a href=#_alias__aliasID__get_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_alias__aliasID__get_request><h3>URI Parameters</h3><ul><li><strong>aliasID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 937 |
+ "data": |
|
| 938 |
+ {
|
|
| 939 |
+ "id": "53c4249f076573c0f4000001", |
|
| 940 |
+ "suffix": "dev.rhcloud.com", |
|
| 941 |
+ "name": "mydomain", |
|
| 942 |
+ "members": [ |
|
| 943 |
+ {
|
|
| 944 |
+ "login": "adminuser", |
|
| 945 |
+ "role": "admin", |
|
| 946 |
+ "type": "user", |
|
| 947 |
+ "owner": true |
|
| 948 |
+ } |
|
| 949 |
+ ] |
|
| 950 |
+ } |
|
| 951 |
+} |
|
| 952 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_alias__aliasID__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></span>/alias/{aliasID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update an alias</p></div><ul class="nav nav-tabs"><li class=active><a href=#_alias__aliasID__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_alias__aliasID__put_request><h3>URI Parameters</h3><ul><li><strong>aliasID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 953 |
+ "data": |
|
| 954 |
+ {
|
|
| 955 |
+ "id": "53c4249f076573c0f4000001", |
|
| 956 |
+ "suffix": "dev.rhcloud.com", |
|
| 957 |
+ "name": "mydomain", |
|
| 958 |
+ "members": [ |
|
| 959 |
+ {
|
|
| 960 |
+ "login": "adminuser", |
|
| 961 |
+ "role": "admin", |
|
| 962 |
+ "type": "user", |
|
| 963 |
+ "owner": true |
|
| 964 |
+ } |
|
| 965 |
+ ] |
|
| 966 |
+ } |
|
| 967 |
+} |
|
| 968 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_alias__aliasID__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></span>/alias/{aliasID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete an alias</p></div><ul class="nav nav-tabs"><li class=active><a href=#_alias__aliasID__delete_request data-toggle=tab>Request</a></li><li><a href=#_alias__aliasID__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_alias__aliasID__delete_request><h3>URI Parameters</h3><ul><li><strong>aliasID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_alias__aliasID__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 969 |
+ "apiVersion": "v1beta1", |
|
| 970 |
+ "creationTimestamp": null, |
|
| 971 |
+ "kind": "Status", |
|
| 972 |
+ "status": "success" |
|
| 973 |
+} |
|
| 974 |
+</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_builds class=panel-title>/builds</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=collapsed data-toggle=collapse href=#panel__builds><span class=parent></span>/builds</a> <span class=methods><a href=# data-toggle=modal data-target=#_builds_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_builds_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__builds class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_builds_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Retrieves a list of builds</p><p>Build encapsulates the inputs needed to produce a new deployable image, as well as the status of the operation and a reference to the Pod which runs the build.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_builds_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new build</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_builds_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>/builds</h4></div><div class=modal-body><div class="alert alert-info"><p>Retrieves a list of builds</p><p>Build encapsulates the inputs needed to produce a new deployable image, as well as the status of the operation and a reference to the Pod which runs the build.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_builds_get_request data-toggle=tab>Request</a></li><li><a href=#_builds_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_builds_get_request></div><div class=tab-pane id=_builds_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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 975 |
+ "apiVersion": "v1beta1", |
|
| 976 |
+ "creationTimestamp": null, |
|
| 977 |
+ "items": [ |
|
| 978 |
+ {
|
|
| 979 |
+ "creationTimestamp": "2014-09-16T02:58:19Z", |
|
| 980 |
+ "id": "5065bcf2-3d4d-11e4-a95b-0800279696e1", |
|
| 981 |
+ "input": {
|
|
| 982 |
+ "imageTag": "test/dockerbuild", |
|
| 983 |
+ "sourceURI": "git://github.com/test/dockerbuild", |
|
| 984 |
+ "type": "docker" |
|
| 985 |
+ }, |
|
| 986 |
+ "podID": "build-sti-5065bcf2-3d4d-11e4-a95b-0800279696e1", |
|
| 987 |
+ "resourceVersion": 114, |
|
| 988 |
+ "status": "new" |
|
| 989 |
+ } |
|
| 990 |
+ ], |
|
| 991 |
+ "kind": "BuildList", |
|
| 992 |
+ "resourceVersion": 116 |
|
| 993 |
+} |
|
| 994 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_builds_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>/builds</h4></div><div class=modal-body><div class="alert alert-info"><p>Create a new build</p></div><ul class="nav nav-tabs"><li class=active><a href=#_builds_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_builds_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 995 |
+ "kind": "Build", |
|
| 996 |
+ "apiVersion": "v1beta1", |
|
| 997 |
+ "input": {
|
|
| 998 |
+ "type": "docker", |
|
| 999 |
+ "sourceURI": "github.com/test/dockerBuild", |
|
| 1000 |
+ "imageTag": "test/dockerBuild" |
|
| 1001 |
+ } |
|
| 1002 |
+} |
|
| 1003 |
+</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_builds__buildId_ class=panel-title>/builds/{buildId}</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=collapsed data-toggle=collapse href=#panel__builds__buildId_><span class=parent></span>/builds/{buildId}</a> <span class=methods><a href=# data-toggle=modal data-target=#_builds__buildId__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_builds__buildId__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_builds__buildId__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__builds__buildId_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_builds__buildId__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Retrieve a single build definition</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_builds__buildId__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a build definition</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_builds__buildId__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a build definition</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_builds__buildId__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>/builds/{buildId}</h4></div><div class=modal-body><div class="alert alert-info"><p>Retrieve a single build definition</p></div><ul class="nav nav-tabs"><li class=active><a href=#_builds__buildId__get_request data-toggle=tab>Request</a></li><li><a href=#_builds__buildId__get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_builds__buildId__get_request><h3>URI Parameters</h3><ul><li><strong>buildId</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_builds__buildId__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1004 |
+ "apiVersion": "v1beta1", |
|
| 1005 |
+ "creationTimestamp": "2014-09-16T02:58:19Z", |
|
| 1006 |
+ "id": "5065bcf2-3d4d-11e4-a95b-0800279696e1", |
|
| 1007 |
+ "input": {
|
|
| 1008 |
+ "imageTag": "test/dockerBuild", |
|
| 1009 |
+ "sourceURI": "github.com/test/dockerBuild", |
|
| 1010 |
+ "type": "docker" |
|
| 1011 |
+ }, |
|
| 1012 |
+ "kind": "Build", |
|
| 1013 |
+ "podID": "build-sti-5065bcf2-3d4d-11e4-a95b-0800279696e1", |
|
| 1014 |
+ "resourceVersion": 114, |
|
| 1015 |
+ "status": "pending" |
|
| 1016 |
+} |
|
| 1017 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_builds__buildId__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></span>/builds/{buildId}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update a build definition</p></div><ul class="nav nav-tabs"><li class=active><a href=#_builds__buildId__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_builds__buildId__put_request><h3>URI Parameters</h3><ul><li><strong>buildId</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1018 |
+ "apiVersion": "v1beta1", |
|
| 1019 |
+ "creationTimestamp": "2014-09-16T02:58:19Z", |
|
| 1020 |
+ "id": "5065bcf2-3d4d-11e4-a95b-0800279696e1", |
|
| 1021 |
+ "input": {
|
|
| 1022 |
+ "imageTag": "test/dockerBuild", |
|
| 1023 |
+ "sourceURI": "github.com/test/dockerBuild", |
|
| 1024 |
+ "type": "docker" |
|
| 1025 |
+ }, |
|
| 1026 |
+ "kind": "Build", |
|
| 1027 |
+ "podID": "build-sti-5065bcf2-3d4d-11e4-a95b-0800279696e1", |
|
| 1028 |
+ "resourceVersion": 114, |
|
| 1029 |
+ "status": "pending" |
|
| 1030 |
+} |
|
| 1031 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_builds__buildId__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></span>/builds/{buildId}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete a build definition</p></div><ul class="nav nav-tabs"><li class=active><a href=#_builds__buildId__delete_request data-toggle=tab>Request</a></li><li><a href=#_builds__buildId__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_builds__buildId__delete_request><h3>URI Parameters</h3><ul><li><strong>buildId</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_builds__buildId__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1032 |
+ "apiVersion": "v1beta1", |
|
| 1033 |
+ "creationTimestamp": null, |
|
| 1034 |
+ "kind": "Status", |
|
| 1035 |
+ "status": "success" |
|
| 1036 |
+} |
|
| 1037 |
+</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_buildConfigs class=panel-title>/buildConfigs</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=collapsed data-toggle=collapse href=#panel__buildConfigs><span class=parent></span>/buildConfigs</a> <span class=methods><a href=# data-toggle=modal data-target=#_buildConfigs_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_buildConfigs_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__buildConfigs class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_buildConfigs_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Retrieves a list of BuildConfigs</p><p>BuildConfig contains the inputs needed to produce a new deployable image</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_buildConfigs_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new build</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_buildConfigs_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>/buildConfigs</h4></div><div class=modal-body><div class="alert alert-info"><p>Retrieves a list of BuildConfigs</p><p>BuildConfig contains the inputs needed to produce a new deployable image</p></div><ul class="nav nav-tabs"><li class=active><a href=#_buildConfigs_get_request data-toggle=tab>Request</a></li><li><a href=#_buildConfigs_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_buildConfigs_get_request></div><div class=tab-pane id=_buildConfigs_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></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_buildConfigs_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>/buildConfigs</h4></div><div class=modal-body><div class="alert alert-info"><p>Create a new build</p></div><ul class="nav nav-tabs"><li class=active><a href=#_buildConfigs_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_buildConfigs_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1038 |
+ "kind": "BuildConfig", |
|
| 1039 |
+ "apiVersion": "v1beta1", |
|
| 1040 |
+ "desiredInput": {
|
|
| 1041 |
+ "type": "sti", |
|
| 1042 |
+ "sourceURI": "git://github.com/pmorie/simple-ruby", |
|
| 1043 |
+ "builderImage": "openshift/ruby-19-centos", |
|
| 1044 |
+ "imageTag": "test-ruby-app" |
|
| 1045 |
+ } |
|
| 1046 |
+} |
|
| 1047 |
+</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_buildConfigs__configId_ class=panel-title>/buildConfigs/{configId}</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=collapsed data-toggle=collapse href=#panel__buildConfigs__configId_><span class=parent></span>/buildConfigs/{configId}</a> <span class=methods><a href=# data-toggle=modal data-target=#_buildConfigs__configId__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_buildConfigs__configId__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_buildConfigs__configId__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__buildConfigs__configId_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_buildConfigs__configId__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Retrieve a build configuration</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_buildConfigs__configId__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a build configuration</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_buildConfigs__configId__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a build configuration</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_buildConfigs__configId__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>/buildConfigs/{configId}</h4></div><div class=modal-body><div class="alert alert-info"><p>Retrieve a build configuration</p></div><ul class="nav nav-tabs"><li class=active><a href=#_buildConfigs__configId__get_request data-toggle=tab>Request</a></li><li><a href=#_buildConfigs__configId__get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_buildConfigs__configId__get_request><h3>URI Parameters</h3><ul><li><strong>configId</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_buildConfigs__configId__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1048 |
+ "apiVersion": "v1beta1", |
|
| 1049 |
+ "creationTimestamp": "2014-09-16T19:33:36Z", |
|
| 1050 |
+ "desiredInput": {
|
|
| 1051 |
+ "builderImage": "openshift/ruby-19-centos", |
|
| 1052 |
+ "imageTag": "test-ruby-app", |
|
| 1053 |
+ "sourceURI": "git://github.com/pmorie/simple-ruby", |
|
| 1054 |
+ "type": "sti" |
|
| 1055 |
+ }, |
|
| 1056 |
+ "id": "5a6a5b9c-3dd8-11e4-9d75-0800279696e1", |
|
| 1057 |
+ "kind": "BuildConfig", |
|
| 1058 |
+ "resourceVersion": 117 |
|
| 1059 |
+} |
|
| 1060 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_buildConfigs__configId__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></span>/buildConfigs/{configId}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update a build configuration</p></div><ul class="nav nav-tabs"><li class=active><a href=#_buildConfigs__configId__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_buildConfigs__configId__put_request><h3>URI Parameters</h3><ul><li><strong>configId</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1061 |
+ "apiVersion": "v1beta1", |
|
| 1062 |
+ "creationTimestamp": "2014-09-16T19:33:36Z", |
|
| 1063 |
+ "desiredInput": {
|
|
| 1064 |
+ "builderImage": "openshift/ruby-19-centos", |
|
| 1065 |
+ "imageTag": "test-ruby-app", |
|
| 1066 |
+ "sourceURI": "git://github.com/pmorie/simple-ruby", |
|
| 1067 |
+ "type": "sti" |
|
| 1068 |
+ }, |
|
| 1069 |
+ "id": "5a6a5b9c-3dd8-11e4-9d75-0800279696e1", |
|
| 1070 |
+ "kind": "BuildConfig", |
|
| 1071 |
+ "resourceVersion": 117 |
|
| 1072 |
+} |
|
| 1073 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_buildConfigs__configId__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></span>/buildConfigs/{configId}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete a build configuration</p></div><ul class="nav nav-tabs"><li class=active><a href=#_buildConfigs__configId__delete_request data-toggle=tab>Request</a></li><li><a href=#_buildConfigs__configId__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_buildConfigs__configId__delete_request><h3>URI Parameters</h3><ul><li><strong>configId</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_buildConfigs__configId__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1074 |
+ "apiVersion": "v1beta1", |
|
| 1075 |
+ "creationTimestamp": null, |
|
| 1076 |
+ "kind": "Status", |
|
| 1077 |
+ "status": "success" |
|
| 1078 |
+} |
|
| 1079 |
+</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_buildConfigHooks__buildId___secret___plugin_ class=panel-title>/buildConfigHooks/{buildId}/{secret}/{plugin}</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=collapsed data-toggle=collapse href=#panel__buildConfigHooks__buildId___secret___plugin_><span class=parent></span>/buildConfigHooks/{buildId}/{secret}/{plugin}</a> <span class=methods><a href=# data-toggle=modal data-target=#_buildConfigHooks__buildId___secret___plugin__post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__buildConfigHooks__buildId___secret___plugin_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_buildConfigHooks__buildId___secret___plugin__post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Webhook on push event from external repository</p><p>buildId specifies which build to trigger, whereas plugin defines source of the request, this might be github, bitbucket or others.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_buildConfigHooks__buildId___secret___plugin__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>/buildConfigHooks/{buildId}/{secret}/{plugin}</h4></div><div class=modal-body><div class="alert alert-info"><p>Webhook on push event from external repository</p><p>buildId specifies which build to trigger, whereas plugin defines source of the request, this might be github, bitbucket or others.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_buildConfigHooks__buildId___secret___plugin__post_request data-toggle=tab>Request</a></li><li><a href=#_buildConfigHooks__buildId___secret___plugin__post_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_buildConfigHooks__buildId___secret___plugin__post_request><h3>URI Parameters</h3><ul><li><strong>buildId</strong>: <em>required (string)</em></li><li><strong>secret</strong>: <em>required (string)</em></li><li><strong>plugin</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_buildConfigHooks__buildId___secret___plugin__post_response><h2>HTTP status code <a href=http://httpstatus.es/204 target=_blank>204</a></h2><p>No content</p></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_templates class=panel-title>/templates</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=collapsed data-toggle=collapse href=#panel__templates><span class=parent></span>/templates</a> <span class=methods><a href=# data-toggle=modal data-target=#_templates_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_templates_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__templates class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_templates_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Lists all templates that your account has access to</p><p>A template defines 0..n services and 0..m links. When it is applied to an existing project, those services and links are instantiated for that project.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_templates_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new template</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_templates_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>/templates</h4></div><div class=modal-body><div class="alert alert-info"><p>Lists all templates that your account has access to</p><p>A template defines 0..n services and 0..m links. When it is applied to an existing project, those services and links are instantiated for that project.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_templates_get_request data-toggle=tab>Request</a></li><li><a href=#_templates_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_templates_get_request></div><div class=tab-pane id=_templates_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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1080 |
+ "list": |
|
| 1081 |
+ [ |
|
| 1082 |
+ {
|
|
| 1083 |
+ "services": [ |
|
| 1084 |
+ {
|
|
| 1085 |
+ "name": "service-name", |
|
| 1086 |
+ "domain": "domain-id", |
|
| 1087 |
+ "desiredState": |
|
| 1088 |
+ {
|
|
| 1089 |
+ "replicas": 3, |
|
| 1090 |
+ "replicaSelector": { "name": "service-name" },
|
|
| 1091 |
+ "replicaPolicy": {
|
|
| 1092 |
+ "atLeast": 2 |
|
| 1093 |
+ }, |
|
| 1094 |
+ "activeDeployment": "a_deployment_id", |
|
| 1095 |
+ "podTemplate": |
|
| 1096 |
+ {
|
|
| 1097 |
+ "desiredState": |
|
| 1098 |
+ {
|
|
| 1099 |
+ "image": "server/domain/name", |
|
| 1100 |
+ "network-ports": [ |
|
| 1101 |
+ {
|
|
| 1102 |
+ "hostPort": 8080, |
|
| 1103 |
+ "containerPort": 80 |
|
| 1104 |
+ } |
|
| 1105 |
+ ], |
|
| 1106 |
+ "owner": true |
|
| 1107 |
+ }, |
|
| 1108 |
+ "labels": {
|
|
| 1109 |
+ "name": "service-name" |
|
| 1110 |
+ } |
|
| 1111 |
+ } |
|
| 1112 |
+ } |
|
| 1113 |
+ } |
|
| 1114 |
+ ], |
|
| 1115 |
+ "links": [ |
|
| 1116 |
+ {
|
|
| 1117 |
+ "id": "53c4249f076573c0f4000001", |
|
| 1118 |
+ "projectId": "myproject-1234123132", |
|
| 1119 |
+ "source": {
|
|
| 1120 |
+ "serviceId": "nginx-1893747912737" |
|
| 1121 |
+ }, |
|
| 1122 |
+ "destination": {
|
|
| 1123 |
+ "serviceId": "ruby1.9-1237471273", |
|
| 1124 |
+ "port": 8080 |
|
| 1125 |
+ } |
|
| 1126 |
+ "policy": "round-robin" |
|
| 1127 |
+ } |
|
| 1128 |
+ ] |
|
| 1129 |
+ } |
|
| 1130 |
+ ] |
|
| 1131 |
+} |
|
| 1132 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_templates_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>/templates</h4></div><div class=modal-body><div class="alert alert-info"><p>Create a new template</p></div><ul class="nav nav-tabs"><li class=active><a href=#_templates_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_templates_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1133 |
+ "data": |
|
| 1134 |
+ {
|
|
| 1135 |
+ "services": [ |
|
| 1136 |
+ {
|
|
| 1137 |
+ "name": "service-name", |
|
| 1138 |
+ "domain": "domain-id", |
|
| 1139 |
+ "desiredState": |
|
| 1140 |
+ {
|
|
| 1141 |
+ "replicas": 3, |
|
| 1142 |
+ "replicaSelector": { "name": "service-name" },
|
|
| 1143 |
+ "replicaPolicy": {
|
|
| 1144 |
+ "atLeast": 2 |
|
| 1145 |
+ }, |
|
| 1146 |
+ "activeDeployment": "a_deployment_id", |
|
| 1147 |
+ "podTemplate": |
|
| 1148 |
+ {
|
|
| 1149 |
+ "desiredState": |
|
| 1150 |
+ {
|
|
| 1151 |
+ "image": "server/domain/name", |
|
| 1152 |
+ "network-ports": [ |
|
| 1153 |
+ {
|
|
| 1154 |
+ "hostPort": 8080, |
|
| 1155 |
+ "containerPort": 80 |
|
| 1156 |
+ } |
|
| 1157 |
+ ], |
|
| 1158 |
+ "owner": true |
|
| 1159 |
+ }, |
|
| 1160 |
+ "labels": {
|
|
| 1161 |
+ "name": "service-name" |
|
| 1162 |
+ } |
|
| 1163 |
+ } |
|
| 1164 |
+ } |
|
| 1165 |
+ } |
|
| 1166 |
+ ], |
|
| 1167 |
+ "links": [ |
|
| 1168 |
+ {
|
|
| 1169 |
+ "id": "53c4249f076573c0f4000001", |
|
| 1170 |
+ "projectId": "myproject-1234123132", |
|
| 1171 |
+ "source": {
|
|
| 1172 |
+ "serviceId": "nginx-1893747912737" |
|
| 1173 |
+ }, |
|
| 1174 |
+ "destination": {
|
|
| 1175 |
+ "serviceId": "ruby1.9-1237471273", |
|
| 1176 |
+ "port": 8080 |
|
| 1177 |
+ } |
|
| 1178 |
+ "policy": "round-robin" |
|
| 1179 |
+ } |
|
| 1180 |
+ ] |
|
| 1181 |
+ } |
|
| 1182 |
+} |
|
| 1183 |
+</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_template__templateID_ class=panel-title>/template/{templateID}</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=collapsed data-toggle=collapse href=#panel__template__templateID_><span class=parent></span>/template/{templateID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_template__templateID__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_template__templateID__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_template__templateID__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__template__templateID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_template__templateID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get a specific template</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_template__templateID__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a template</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_template__templateID__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a template</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_template__templateID__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>/template/{templateID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get a specific template</p></div><ul class="nav nav-tabs"><li class=active><a href=#_template__templateID__get_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_template__templateID__get_request><h3>URI Parameters</h3><ul><li><strong>templateID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1184 |
+ "data": |
|
| 1185 |
+ {
|
|
| 1186 |
+ "services": [ |
|
| 1187 |
+ {
|
|
| 1188 |
+ "name": "service-name", |
|
| 1189 |
+ "domain": "domain-id", |
|
| 1190 |
+ "desiredState": |
|
| 1191 |
+ {
|
|
| 1192 |
+ "replicas": 3, |
|
| 1193 |
+ "replicaSelector": { "name": "service-name" },
|
|
| 1194 |
+ "replicaPolicy": {
|
|
| 1195 |
+ "atLeast": 2 |
|
| 1196 |
+ }, |
|
| 1197 |
+ "activeDeployment": "a_deployment_id", |
|
| 1198 |
+ "podTemplate": |
|
| 1199 |
+ {
|
|
| 1200 |
+ "desiredState": |
|
| 1201 |
+ {
|
|
| 1202 |
+ "image": "server/domain/name", |
|
| 1203 |
+ "network-ports": [ |
|
| 1204 |
+ {
|
|
| 1205 |
+ "hostPort": 8080, |
|
| 1206 |
+ "containerPort": 80 |
|
| 1207 |
+ } |
|
| 1208 |
+ ], |
|
| 1209 |
+ "owner": true |
|
| 1210 |
+ }, |
|
| 1211 |
+ "labels": {
|
|
| 1212 |
+ "name": "service-name" |
|
| 1213 |
+ } |
|
| 1214 |
+ } |
|
| 1215 |
+ } |
|
| 1216 |
+ } |
|
| 1217 |
+ ], |
|
| 1218 |
+ "links": [ |
|
| 1219 |
+ {
|
|
| 1220 |
+ "id": "53c4249f076573c0f4000001", |
|
| 1221 |
+ "projectId": "myproject-1234123132", |
|
| 1222 |
+ "source": {
|
|
| 1223 |
+ "serviceId": "nginx-1893747912737" |
|
| 1224 |
+ }, |
|
| 1225 |
+ "destination": {
|
|
| 1226 |
+ "serviceId": "ruby1.9-1237471273", |
|
| 1227 |
+ "port": 8080 |
|
| 1228 |
+ } |
|
| 1229 |
+ "policy": "round-robin" |
|
| 1230 |
+ } |
|
| 1231 |
+ ] |
|
| 1232 |
+ } |
|
| 1233 |
+} |
|
| 1234 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_template__templateID__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></span>/template/{templateID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update a template</p></div><ul class="nav nav-tabs"><li class=active><a href=#_template__templateID__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_template__templateID__put_request><h3>URI Parameters</h3><ul><li><strong>templateID</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1235 |
+ "data": |
|
| 1236 |
+ {
|
|
| 1237 |
+ "services": [ |
|
| 1238 |
+ {
|
|
| 1239 |
+ "name": "service-name", |
|
| 1240 |
+ "domain": "domain-id", |
|
| 1241 |
+ "desiredState": |
|
| 1242 |
+ {
|
|
| 1243 |
+ "replicas": 3, |
|
| 1244 |
+ "replicaSelector": { "name": "service-name" },
|
|
| 1245 |
+ "replicaPolicy": {
|
|
| 1246 |
+ "atLeast": 2 |
|
| 1247 |
+ }, |
|
| 1248 |
+ "activeDeployment": "a_deployment_id", |
|
| 1249 |
+ "podTemplate": |
|
| 1250 |
+ {
|
|
| 1251 |
+ "desiredState": |
|
| 1252 |
+ {
|
|
| 1253 |
+ "image": "server/domain/name", |
|
| 1254 |
+ "network-ports": [ |
|
| 1255 |
+ {
|
|
| 1256 |
+ "hostPort": 8080, |
|
| 1257 |
+ "containerPort": 80 |
|
| 1258 |
+ } |
|
| 1259 |
+ ], |
|
| 1260 |
+ "owner": true |
|
| 1261 |
+ }, |
|
| 1262 |
+ "labels": {
|
|
| 1263 |
+ "name": "service-name" |
|
| 1264 |
+ } |
|
| 1265 |
+ } |
|
| 1266 |
+ } |
|
| 1267 |
+ } |
|
| 1268 |
+ ], |
|
| 1269 |
+ "links": [ |
|
| 1270 |
+ {
|
|
| 1271 |
+ "id": "53c4249f076573c0f4000001", |
|
| 1272 |
+ "projectId": "myproject-1234123132", |
|
| 1273 |
+ "source": {
|
|
| 1274 |
+ "serviceId": "nginx-1893747912737" |
|
| 1275 |
+ }, |
|
| 1276 |
+ "destination": {
|
|
| 1277 |
+ "serviceId": "ruby1.9-1237471273", |
|
| 1278 |
+ "port": 8080 |
|
| 1279 |
+ } |
|
| 1280 |
+ "policy": "round-robin" |
|
| 1281 |
+ } |
|
| 1282 |
+ ] |
|
| 1283 |
+ } |
|
| 1284 |
+} |
|
| 1285 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_template__templateID__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></span>/template/{templateID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete a template</p></div><ul class="nav nav-tabs"><li class=active><a href=#_template__templateID__delete_request data-toggle=tab>Request</a></li><li><a href=#_template__templateID__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_template__templateID__delete_request><h3>URI Parameters</h3><ul><li><strong>templateID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_template__templateID__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1286 |
+ "apiVersion": "v1beta1", |
|
| 1287 |
+ "creationTimestamp": null, |
|
| 1288 |
+ "kind": "Status", |
|
| 1289 |
+ "status": "success" |
|
| 1290 |
+} |
|
| 1291 |
+</code></pre></div></div></div></div></div></div></div></div></div></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=collapsed data-toggle=collapse href=#panel__pods><span class=parent></span>/pods</a> <span class=methods><a href=# data-toggle=modal data-target=#_pods_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_pods_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__pods class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_pods_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>List all pods on this cluster</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_pods_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new pod. currentState is ignored if present.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 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><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><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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1292 |
+ "items": [ |
|
| 1293 |
+ {
|
|
| 1294 |
+ "id": "my-pod-1", |
|
| 1295 |
+ "labels": {
|
|
| 1296 |
+ "name": "testRun", |
|
| 1297 |
+ "replicationController": "testRun" |
|
| 1298 |
+ }, |
|
| 1299 |
+ "desiredState": {
|
|
| 1300 |
+ "manifest": {
|
|
| 1301 |
+ "version": "v1beta1", |
|
| 1302 |
+ "id": "my-pod-1", |
|
| 1303 |
+ "containers": [{
|
|
| 1304 |
+ "image": "dockerfile/nginx", |
|
| 1305 |
+ "ports": [{
|
|
| 1306 |
+ "hostPort": 8080, |
|
| 1307 |
+ "containerPort": 80 |
|
| 1308 |
+ }] |
|
| 1309 |
+ } |
|
| 1310 |
+ } |
|
| 1311 |
+ }, |
|
| 1312 |
+ "currentState": {
|
|
| 1313 |
+ "host": "host-1" |
|
| 1314 |
+ } |
|
| 1315 |
+ }, |
|
| 1316 |
+ {
|
|
| 1317 |
+ "id": "my-pod-2", |
|
| 1318 |
+ "labels": {
|
|
| 1319 |
+ "name": "testRun", |
|
| 1320 |
+ "replicationController": "testRun" |
|
| 1321 |
+ }, |
|
| 1322 |
+ "desiredState": {
|
|
| 1323 |
+ "manifest": {
|
|
| 1324 |
+ "version": "v1beta1", |
|
| 1325 |
+ "id": "my-pod-2", |
|
| 1326 |
+ "containers": [{
|
|
| 1327 |
+ "image": "dockerfile/nginx", |
|
| 1328 |
+ "ports": [{
|
|
| 1329 |
+ "hostPort": 8080, |
|
| 1330 |
+ "containerPort": 80 |
|
| 1331 |
+ }] |
|
| 1332 |
+ } |
|
| 1333 |
+ } |
|
| 1334 |
+ }, |
|
| 1335 |
+ "currentState": {
|
|
| 1336 |
+ "host": "host-2" |
|
| 1337 |
+ } |
|
| 1338 |
+ } |
|
| 1339 |
+ ] |
|
| 1340 |
+} |
|
| 1341 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 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><ul class="nav nav-tabs"><li class=active><a href=#_pods_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_pods_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
|
|
| 1342 |
+ "$schema": "http://json-schema.org/draft-03/schema", |
|
| 1343 |
+ "type": "object", |
|
| 1344 |
+ "required": false, |
|
| 1345 |
+ "description": "Pod resource. A pod corresponds to a co-located group of [Docker containers](http://docker.io).", |
|
| 1346 |
+ "properties": {
|
|
| 1347 |
+ "kind": {
|
|
| 1348 |
+ "type": "string", |
|
| 1349 |
+ "required": false |
|
| 1350 |
+ }, |
|
| 1351 |
+ "id": {
|
|
| 1352 |
+ "type": "string", |
|
| 1353 |
+ "required": false |
|
| 1354 |
+ }, |
|
| 1355 |
+ "creationTimestamp": {
|
|
| 1356 |
+ "type": "string", |
|
| 1357 |
+ "required": false |
|
| 1358 |
+ }, |
|
| 1359 |
+ "selfLink": {
|
|
| 1360 |
+ "type": "string", |
|
| 1361 |
+ "required": false |
|
| 1362 |
+ }, |
|
| 1363 |
+ "desiredState": {
|
|
| 1364 |
+ "type": "object", |
|
| 1365 |
+ "required": false, |
|
| 1366 |
+ "description": "The desired configuration of the pod", |
|
| 1367 |
+ "properties": {
|
|
| 1368 |
+ "manifest": {
|
|
| 1369 |
+ "type": "object", |
|
| 1370 |
+ "required": false, |
|
| 1371 |
+ "description": "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)" |
|
| 1372 |
+ }, |
|
| 1373 |
+ "status": {
|
|
| 1374 |
+ "type": "string", |
|
| 1375 |
+ "required": false, |
|
| 1376 |
+ "description": "" |
|
| 1377 |
+ }, |
|
| 1378 |
+ "host": {
|
|
| 1379 |
+ "type": "string", |
|
| 1380 |
+ "required": false, |
|
| 1381 |
+ "description": "" |
|
| 1382 |
+ }, |
|
| 1383 |
+ "hostIP": {
|
|
| 1384 |
+ "type": "string", |
|
| 1385 |
+ "required": false, |
|
| 1386 |
+ "description": "" |
|
| 1387 |
+ }, |
|
| 1388 |
+ "info": {
|
|
| 1389 |
+ "type": "object", |
|
| 1390 |
+ "required": false, |
|
| 1391 |
+ "description": "" |
|
| 1392 |
+ } |
|
| 1393 |
+ } |
|
| 1394 |
+ }, |
|
| 1395 |
+ "currentState": {
|
|
| 1396 |
+ "type": "object", |
|
| 1397 |
+ "required": false, |
|
| 1398 |
+ "description": "The current configuration and status of the pod. Fields in common with desiredState have the same meaning.", |
|
| 1399 |
+ "properties": {
|
|
| 1400 |
+ "manifest": {
|
|
| 1401 |
+ "type": "object", |
|
| 1402 |
+ "required": false |
|
| 1403 |
+ }, |
|
| 1404 |
+ "status": {
|
|
| 1405 |
+ "type": "string", |
|
| 1406 |
+ "required": false |
|
| 1407 |
+ }, |
|
| 1408 |
+ "host": {
|
|
| 1409 |
+ "type": "string", |
|
| 1410 |
+ "required": false |
|
| 1411 |
+ }, |
|
| 1412 |
+ "hostIP": {
|
|
| 1413 |
+ "type": "string", |
|
| 1414 |
+ "required": false |
|
| 1415 |
+ }, |
|
| 1416 |
+ "info": {
|
|
| 1417 |
+ "type": "object", |
|
| 1418 |
+ "required": false |
|
| 1419 |
+ } |
|
| 1420 |
+ } |
|
| 1421 |
+ }, |
|
| 1422 |
+ "labels": {
|
|
| 1423 |
+ "type": "object", |
|
| 1424 |
+ "required": false |
|
| 1425 |
+ } |
|
| 1426 |
+ } |
|
| 1427 |
+} |
|
| 1428 |
+</code></pre><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1429 |
+ "id": "php", |
|
| 1430 |
+ "desiredState": {
|
|
| 1431 |
+ "manifest": {
|
|
| 1432 |
+ "version": "v1beta1", |
|
| 1433 |
+ "id": "php", |
|
| 1434 |
+ "containers": [{
|
|
| 1435 |
+ "name": "nginx", |
|
| 1436 |
+ "image": "dockerfile/nginx", |
|
| 1437 |
+ "ports": [{
|
|
| 1438 |
+ "containerPort": 80, |
|
| 1439 |
+ "hostPort": 8080 |
|
| 1440 |
+ }], |
|
| 1441 |
+ "livenessProbe": {
|
|
| 1442 |
+ "enabled": true, |
|
| 1443 |
+ "type": "http", |
|
| 1444 |
+ "initialDelaySeconds": 30, |
|
| 1445 |
+ "httpGet": {
|
|
| 1446 |
+ "path": "/index.html", |
|
| 1447 |
+ "port": "8080" |
|
| 1448 |
+ } |
|
| 1449 |
+ } |
|
| 1450 |
+ }] |
|
| 1451 |
+ } |
|
| 1452 |
+ }, |
|
| 1453 |
+ "labels": {
|
|
| 1454 |
+ "name": "foo" |
|
| 1455 |
+ } |
|
| 1456 |
+} |
|
| 1457 |
+ |
|
| 1458 |
+</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__pods__podId_><span class=parent>/pods</span>/{podId}</a> <span class=methods><a href=# data-toggle=modal data-target=#_pods__podId__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_pods__podId__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_pods__podId__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__pods__podId_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_pods__podId__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get a specific pod</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_pods__podId__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a pod</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_pods__podId__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a specific pod</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 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><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><div class=tab-content><div class="tab-pane active" id=_pods__podId__get_request><h3>URI Parameters</h3><ul><li><strong>podId</strong>: <em>required (string)</em></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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1459 |
+ "id": "php", |
|
| 1460 |
+ "desiredState": {
|
|
| 1461 |
+ "manifest": {
|
|
| 1462 |
+ "version": "v1beta1", |
|
| 1463 |
+ "id": "php", |
|
| 1464 |
+ "containers": [{
|
|
| 1465 |
+ "name": "nginx", |
|
| 1466 |
+ "image": "dockerfile/nginx", |
|
| 1467 |
+ "ports": [{
|
|
| 1468 |
+ "containerPort": 80, |
|
| 1469 |
+ "hostPort": 8080 |
|
| 1470 |
+ }], |
|
| 1471 |
+ "livenessProbe": {
|
|
| 1472 |
+ "enabled": true, |
|
| 1473 |
+ "type": "http", |
|
| 1474 |
+ "initialDelaySeconds": 30, |
|
| 1475 |
+ "httpGet": {
|
|
| 1476 |
+ "path": "/index.html", |
|
| 1477 |
+ "port": "8080" |
|
| 1478 |
+ } |
|
| 1479 |
+ } |
|
| 1480 |
+ }] |
|
| 1481 |
+ } |
|
| 1482 |
+ }, |
|
| 1483 |
+ "labels": {
|
|
| 1484 |
+ "name": "foo" |
|
| 1485 |
+ } |
|
| 1486 |
+} |
|
| 1487 |
+ |
|
| 1488 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 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><ul class="nav nav-tabs"><li class=active><a href=#_pods__podId__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_pods__podId__put_request><h3>URI Parameters</h3><ul><li><strong>podId</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
|
|
| 1489 |
+ "$schema": "http://json-schema.org/draft-03/schema", |
|
| 1490 |
+ "type": "object", |
|
| 1491 |
+ "required": false, |
|
| 1492 |
+ "description": "Pod resource. A pod corresponds to a co-located group of [Docker containers](http://docker.io).", |
|
| 1493 |
+ "properties": {
|
|
| 1494 |
+ "kind": {
|
|
| 1495 |
+ "type": "string", |
|
| 1496 |
+ "required": false |
|
| 1497 |
+ }, |
|
| 1498 |
+ "id": {
|
|
| 1499 |
+ "type": "string", |
|
| 1500 |
+ "required": false |
|
| 1501 |
+ }, |
|
| 1502 |
+ "creationTimestamp": {
|
|
| 1503 |
+ "type": "string", |
|
| 1504 |
+ "required": false |
|
| 1505 |
+ }, |
|
| 1506 |
+ "selfLink": {
|
|
| 1507 |
+ "type": "string", |
|
| 1508 |
+ "required": false |
|
| 1509 |
+ }, |
|
| 1510 |
+ "desiredState": {
|
|
| 1511 |
+ "type": "object", |
|
| 1512 |
+ "required": false, |
|
| 1513 |
+ "description": "The desired configuration of the pod", |
|
| 1514 |
+ "properties": {
|
|
| 1515 |
+ "manifest": {
|
|
| 1516 |
+ "type": "object", |
|
| 1517 |
+ "required": false, |
|
| 1518 |
+ "description": "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)" |
|
| 1519 |
+ }, |
|
| 1520 |
+ "status": {
|
|
| 1521 |
+ "type": "string", |
|
| 1522 |
+ "required": false, |
|
| 1523 |
+ "description": "" |
|
| 1524 |
+ }, |
|
| 1525 |
+ "host": {
|
|
| 1526 |
+ "type": "string", |
|
| 1527 |
+ "required": false, |
|
| 1528 |
+ "description": "" |
|
| 1529 |
+ }, |
|
| 1530 |
+ "hostIP": {
|
|
| 1531 |
+ "type": "string", |
|
| 1532 |
+ "required": false, |
|
| 1533 |
+ "description": "" |
|
| 1534 |
+ }, |
|
| 1535 |
+ "info": {
|
|
| 1536 |
+ "type": "object", |
|
| 1537 |
+ "required": false, |
|
| 1538 |
+ "description": "" |
|
| 1539 |
+ } |
|
| 1540 |
+ } |
|
| 1541 |
+ }, |
|
| 1542 |
+ "currentState": {
|
|
| 1543 |
+ "type": "object", |
|
| 1544 |
+ "required": false, |
|
| 1545 |
+ "description": "The current configuration and status of the pod. Fields in common with desiredState have the same meaning.", |
|
| 1546 |
+ "properties": {
|
|
| 1547 |
+ "manifest": {
|
|
| 1548 |
+ "type": "object", |
|
| 1549 |
+ "required": false |
|
| 1550 |
+ }, |
|
| 1551 |
+ "status": {
|
|
| 1552 |
+ "type": "string", |
|
| 1553 |
+ "required": false |
|
| 1554 |
+ }, |
|
| 1555 |
+ "host": {
|
|
| 1556 |
+ "type": "string", |
|
| 1557 |
+ "required": false |
|
| 1558 |
+ }, |
|
| 1559 |
+ "hostIP": {
|
|
| 1560 |
+ "type": "string", |
|
| 1561 |
+ "required": false |
|
| 1562 |
+ }, |
|
| 1563 |
+ "info": {
|
|
| 1564 |
+ "type": "object", |
|
| 1565 |
+ "required": false |
|
| 1566 |
+ } |
|
| 1567 |
+ } |
|
| 1568 |
+ }, |
|
| 1569 |
+ "labels": {
|
|
| 1570 |
+ "type": "object", |
|
| 1571 |
+ "required": false |
|
| 1572 |
+ } |
|
| 1573 |
+ } |
|
| 1574 |
+} |
|
| 1575 |
+</code></pre><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1576 |
+ "id": "php", |
|
| 1577 |
+ "desiredState": {
|
|
| 1578 |
+ "manifest": {
|
|
| 1579 |
+ "version": "v1beta1", |
|
| 1580 |
+ "id": "php", |
|
| 1581 |
+ "containers": [{
|
|
| 1582 |
+ "name": "nginx", |
|
| 1583 |
+ "image": "dockerfile/nginx", |
|
| 1584 |
+ "ports": [{
|
|
| 1585 |
+ "containerPort": 80, |
|
| 1586 |
+ "hostPort": 8080 |
|
| 1587 |
+ }], |
|
| 1588 |
+ "livenessProbe": {
|
|
| 1589 |
+ "enabled": true, |
|
| 1590 |
+ "type": "http", |
|
| 1591 |
+ "initialDelaySeconds": 30, |
|
| 1592 |
+ "httpGet": {
|
|
| 1593 |
+ "path": "/index.html", |
|
| 1594 |
+ "port": "8080" |
|
| 1595 |
+ } |
|
| 1596 |
+ } |
|
| 1597 |
+ }] |
|
| 1598 |
+ } |
|
| 1599 |
+ }, |
|
| 1600 |
+ "labels": {
|
|
| 1601 |
+ "name": "foo" |
|
| 1602 |
+ } |
|
| 1603 |
+} |
|
| 1604 |
+ |
|
| 1605 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 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><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><div class=tab-content><div class="tab-pane active" id=_pods__podId__delete_request><h3>URI Parameters</h3><ul><li><strong>podId</strong>: <em>required (string)</em></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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1606 |
+ "apiVersion": "v1beta1", |
|
| 1607 |
+ "creationTimestamp": null, |
|
| 1608 |
+ "kind": "Status", |
|
| 1609 |
+ "status": "success" |
|
| 1610 |
+} |
|
| 1611 |
+</code></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=collapsed data-toggle=collapse href=#panel__replicationControllers><span class=parent></span>/replicationControllers</a> <span class=methods><a href=# data-toggle=modal data-target=#_replicationControllers_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_replicationControllers_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__replicationControllers class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_replicationControllers_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>List all replicationControllers on this cluster</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_replicationControllers_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new controller. currentState is ignored if present.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 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><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><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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1612 |
+ "items": [ |
|
| 1613 |
+ {
|
|
| 1614 |
+ "id": "testRun", |
|
| 1615 |
+ "desiredState": {
|
|
| 1616 |
+ "replicas": 2, |
|
| 1617 |
+ "replicaSelector": {
|
|
| 1618 |
+ "name": "testRun" |
|
| 1619 |
+ }, |
|
| 1620 |
+ "podTemplate": {
|
|
| 1621 |
+ "desiredState": {
|
|
| 1622 |
+ "image": "dockerfile/nginx", |
|
| 1623 |
+ "networkPorts": [ |
|
| 1624 |
+ {
|
|
| 1625 |
+ "hostPort": 8080, |
|
| 1626 |
+ "containerPort": 80 |
|
| 1627 |
+ } |
|
| 1628 |
+ ] |
|
| 1629 |
+ }, |
|
| 1630 |
+ "labels": {
|
|
| 1631 |
+ "name": "testRun" |
|
| 1632 |
+ } |
|
| 1633 |
+ } |
|
| 1634 |
+ }, |
|
| 1635 |
+ "labels": {
|
|
| 1636 |
+ "name": "testRun" |
|
| 1637 |
+ } |
|
| 1638 |
+ } |
|
| 1639 |
+ ] |
|
| 1640 |
+}</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 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><ul class="nav nav-tabs"><li class=active><a href=#_replicationControllers_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_replicationControllers_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
|
|
| 1641 |
+ "$schema": "http://json-schema.org/draft-03/schema", |
|
| 1642 |
+ "type": "object", |
|
| 1643 |
+ "required": false, |
|
| 1644 |
+ "description": "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.", |
|
| 1645 |
+ "properties": {
|
|
| 1646 |
+ "kind": {
|
|
| 1647 |
+ "type": "string", |
|
| 1648 |
+ "required": false |
|
| 1649 |
+ }, |
|
| 1650 |
+ "id": {
|
|
| 1651 |
+ "type": "string", |
|
| 1652 |
+ "required": false |
|
| 1653 |
+ }, |
|
| 1654 |
+ "creationTimestamp": {
|
|
| 1655 |
+ "type": "string", |
|
| 1656 |
+ "required": false |
|
| 1657 |
+ }, |
|
| 1658 |
+ "selfLink": {
|
|
| 1659 |
+ "type": "string", |
|
| 1660 |
+ "required": false |
|
| 1661 |
+ }, |
|
| 1662 |
+ "desiredState": {
|
|
| 1663 |
+ "type": "object", |
|
| 1664 |
+ "required": false, |
|
| 1665 |
+ "description": "The desired configuration of the replicationController", |
|
| 1666 |
+ "properties": {
|
|
| 1667 |
+ "replicas": {
|
|
| 1668 |
+ "type": "number", |
|
| 1669 |
+ "required": false, |
|
| 1670 |
+ "description": "Number of pods desired in the set" |
|
| 1671 |
+ }, |
|
| 1672 |
+ "replicaSelector": {
|
|
| 1673 |
+ "type": "object", |
|
| 1674 |
+ "required": false, |
|
| 1675 |
+ "description": "Required labels used to identify pods in the set" |
|
| 1676 |
+ }, |
|
| 1677 |
+ "podTemplate": {
|
|
| 1678 |
+ "type": "object", |
|
| 1679 |
+ "required": false, |
|
| 1680 |
+ "description": "Template from which to create new pods, as necessary. Identical to pod schema." |
|
| 1681 |
+ } |
|
| 1682 |
+ } |
|
| 1683 |
+ }, |
|
| 1684 |
+ "labels": {
|
|
| 1685 |
+ "type": "object", |
|
| 1686 |
+ "required": false |
|
| 1687 |
+ } |
|
| 1688 |
+ } |
|
| 1689 |
+} |
|
| 1690 |
+</code></pre><p><strong>Example</strong>:</p><pre><code> {
|
|
| 1691 |
+ "id": "nginxController", |
|
| 1692 |
+ "desiredState": {
|
|
| 1693 |
+ "replicas": 2, |
|
| 1694 |
+ "replicaSelector": {"name": "nginx"},
|
|
| 1695 |
+ "podTemplate": {
|
|
| 1696 |
+ "desiredState": {
|
|
| 1697 |
+ "manifest": {
|
|
| 1698 |
+ "version": "v1beta1", |
|
| 1699 |
+ "id": "nginxController", |
|
| 1700 |
+ "containers": [{
|
|
| 1701 |
+ "name": "nginx", |
|
| 1702 |
+ "image": "dockerfile/nginx", |
|
| 1703 |
+ "ports": [{"containerPort": 80, "hostPort": 8080}]
|
|
| 1704 |
+ }] |
|
| 1705 |
+ } |
|
| 1706 |
+ }, |
|
| 1707 |
+ "labels": {"name": "nginx"}
|
|
| 1708 |
+ }}, |
|
| 1709 |
+ "labels": {"name": "nginx"}
|
|
| 1710 |
+ } |
|
| 1711 |
+</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__replicationControllers__controllerId_><span class=parent>/replicationControllers</span>/{controllerId}</a> <span class=methods><a href=# data-toggle=modal data-target=#_replicationControllers__controllerId__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_replicationControllers__controllerId__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_replicationControllers__controllerId__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__replicationControllers__controllerId_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_replicationControllers__controllerId__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get a specific controller</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_replicationControllers__controllerId__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a controller</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_replicationControllers__controllerId__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a specific controller</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 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><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><div class=tab-content><div class="tab-pane active" id=_replicationControllers__controllerId__get_request><h3>URI Parameters</h3><ul><li><strong>controllerId</strong>: <em>required (string)</em></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><p><strong>Example</strong>:</p><pre><code> {
|
|
| 1712 |
+ "id": "nginxController", |
|
| 1713 |
+ "desiredState": {
|
|
| 1714 |
+ "replicas": 2, |
|
| 1715 |
+ "replicaSelector": {"name": "nginx"},
|
|
| 1716 |
+ "podTemplate": {
|
|
| 1717 |
+ "desiredState": {
|
|
| 1718 |
+ "manifest": {
|
|
| 1719 |
+ "version": "v1beta1", |
|
| 1720 |
+ "id": "nginxController", |
|
| 1721 |
+ "containers": [{
|
|
| 1722 |
+ "name": "nginx", |
|
| 1723 |
+ "image": "dockerfile/nginx", |
|
| 1724 |
+ "ports": [{"containerPort": 80, "hostPort": 8080}]
|
|
| 1725 |
+ }] |
|
| 1726 |
+ } |
|
| 1727 |
+ }, |
|
| 1728 |
+ "labels": {"name": "nginx"}
|
|
| 1729 |
+ }}, |
|
| 1730 |
+ "labels": {"name": "nginx"}
|
|
| 1731 |
+ } |
|
| 1732 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 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><ul class="nav nav-tabs"><li class=active><a href=#_replicationControllers__controllerId__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_replicationControllers__controllerId__put_request><h3>URI Parameters</h3><ul><li><strong>controllerId</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
|
|
| 1733 |
+ "$schema": "http://json-schema.org/draft-03/schema", |
|
| 1734 |
+ "type": "object", |
|
| 1735 |
+ "required": false, |
|
| 1736 |
+ "description": "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.", |
|
| 1737 |
+ "properties": {
|
|
| 1738 |
+ "kind": {
|
|
| 1739 |
+ "type": "string", |
|
| 1740 |
+ "required": false |
|
| 1741 |
+ }, |
|
| 1742 |
+ "id": {
|
|
| 1743 |
+ "type": "string", |
|
| 1744 |
+ "required": false |
|
| 1745 |
+ }, |
|
| 1746 |
+ "creationTimestamp": {
|
|
| 1747 |
+ "type": "string", |
|
| 1748 |
+ "required": false |
|
| 1749 |
+ }, |
|
| 1750 |
+ "selfLink": {
|
|
| 1751 |
+ "type": "string", |
|
| 1752 |
+ "required": false |
|
| 1753 |
+ }, |
|
| 1754 |
+ "desiredState": {
|
|
| 1755 |
+ "type": "object", |
|
| 1756 |
+ "required": false, |
|
| 1757 |
+ "description": "The desired configuration of the replicationController", |
|
| 1758 |
+ "properties": {
|
|
| 1759 |
+ "replicas": {
|
|
| 1760 |
+ "type": "number", |
|
| 1761 |
+ "required": false, |
|
| 1762 |
+ "description": "Number of pods desired in the set" |
|
| 1763 |
+ }, |
|
| 1764 |
+ "replicaSelector": {
|
|
| 1765 |
+ "type": "object", |
|
| 1766 |
+ "required": false, |
|
| 1767 |
+ "description": "Required labels used to identify pods in the set" |
|
| 1768 |
+ }, |
|
| 1769 |
+ "podTemplate": {
|
|
| 1770 |
+ "type": "object", |
|
| 1771 |
+ "required": false, |
|
| 1772 |
+ "description": "Template from which to create new pods, as necessary. Identical to pod schema." |
|
| 1773 |
+ } |
|
| 1774 |
+ } |
|
| 1775 |
+ }, |
|
| 1776 |
+ "labels": {
|
|
| 1777 |
+ "type": "object", |
|
| 1778 |
+ "required": false |
|
| 1779 |
+ } |
|
| 1780 |
+ } |
|
| 1781 |
+} |
|
| 1782 |
+</code></pre><p><strong>Example</strong>:</p><pre><code> {
|
|
| 1783 |
+ "id": "nginxController", |
|
| 1784 |
+ "desiredState": {
|
|
| 1785 |
+ "replicas": 2, |
|
| 1786 |
+ "replicaSelector": {"name": "nginx"},
|
|
| 1787 |
+ "podTemplate": {
|
|
| 1788 |
+ "desiredState": {
|
|
| 1789 |
+ "manifest": {
|
|
| 1790 |
+ "version": "v1beta1", |
|
| 1791 |
+ "id": "nginxController", |
|
| 1792 |
+ "containers": [{
|
|
| 1793 |
+ "name": "nginx", |
|
| 1794 |
+ "image": "dockerfile/nginx", |
|
| 1795 |
+ "ports": [{"containerPort": 80, "hostPort": 8080}]
|
|
| 1796 |
+ }] |
|
| 1797 |
+ } |
|
| 1798 |
+ }, |
|
| 1799 |
+ "labels": {"name": "nginx"}
|
|
| 1800 |
+ }}, |
|
| 1801 |
+ "labels": {"name": "nginx"}
|
|
| 1802 |
+ } |
|
| 1803 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 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><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><div class=tab-content><div class="tab-pane active" id=_replicationControllers__controllerId__delete_request><h3>URI Parameters</h3><ul><li><strong>controllerId</strong>: <em>required (string)</em></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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1804 |
+ "apiVersion": "v1beta1", |
|
| 1805 |
+ "creationTimestamp": null, |
|
| 1806 |
+ "kind": "Status", |
|
| 1807 |
+ "status": "success" |
|
| 1808 |
+} |
|
| 1809 |
+</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_lbservices class=panel-title>/lbservices</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=collapsed data-toggle=collapse href=#panel__lbservices><span class=parent></span>/lbservices</a> <span class=methods><a href=# data-toggle=modal data-target=#_lbservices_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_lbservices_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__lbservices class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_lbservices_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>List all services on this cluster</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_lbservices_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new service</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_lbservices_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>/lbservices</h4></div><div class=modal-body><div class="alert alert-info"><p>List all services on this cluster</p></div><ul class="nav nav-tabs"><li class=active><a href=#_lbservices_get_request data-toggle=tab>Request</a></li><li><a href=#_lbservices_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_lbservices_get_request></div><div class=tab-pane id=_lbservices_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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1810 |
+ "items": [ |
|
| 1811 |
+ {
|
|
| 1812 |
+ "id": "example1", |
|
| 1813 |
+ "port": 8000, |
|
| 1814 |
+ "labels": {
|
|
| 1815 |
+ "name": "nginx" |
|
| 1816 |
+ } |
|
| 1817 |
+ "selector": {
|
|
| 1818 |
+ "name": "nginx" |
|
| 1819 |
+ } |
|
| 1820 |
+ }, |
|
| 1821 |
+ {
|
|
| 1822 |
+ "id": "example2", |
|
| 1823 |
+ "port": 8080, |
|
| 1824 |
+ "labels": {
|
|
| 1825 |
+ "env": "prod", |
|
| 1826 |
+ "name": "jetty" |
|
| 1827 |
+ } |
|
| 1828 |
+ "selector": {
|
|
| 1829 |
+ "env": "prod", |
|
| 1830 |
+ "name": "jetty" |
|
| 1831 |
+ } |
|
| 1832 |
+ } |
|
| 1833 |
+ ] |
|
| 1834 |
+} |
|
| 1835 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_lbservices_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>/lbservices</h4></div><div class=modal-body><div class="alert alert-info"><p>Create a new service</p></div><ul class="nav nav-tabs"><li class=active><a href=#_lbservices_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_lbservices_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
|
|
| 1836 |
+ "$schema": "http://json-schema.org/draft-03/schema", |
|
| 1837 |
+ "type": "object", |
|
| 1838 |
+ "required": false, |
|
| 1839 |
+ "description": "A service resource.", |
|
| 1840 |
+ "properties": {
|
|
| 1841 |
+ "kind": {
|
|
| 1842 |
+ "type": "string", |
|
| 1843 |
+ "required": false |
|
| 1844 |
+ }, |
|
| 1845 |
+ "id": {
|
|
| 1846 |
+ "type": "string", |
|
| 1847 |
+ "required": false |
|
| 1848 |
+ }, |
|
| 1849 |
+ "creationTimestamp": {
|
|
| 1850 |
+ "type": "string", |
|
| 1851 |
+ "required": false |
|
| 1852 |
+ }, |
|
| 1853 |
+ "selfLink": {
|
|
| 1854 |
+ "type": "string", |
|
| 1855 |
+ "required": false |
|
| 1856 |
+ }, |
|
| 1857 |
+ "name": {
|
|
| 1858 |
+ "type": "string", |
|
| 1859 |
+ "required": false |
|
| 1860 |
+ }, |
|
| 1861 |
+ "port": {
|
|
| 1862 |
+ "type": "number", |
|
| 1863 |
+ "required": false |
|
| 1864 |
+ }, |
|
| 1865 |
+ "labels": {
|
|
| 1866 |
+ "type": "object", |
|
| 1867 |
+ "required": false |
|
| 1868 |
+ }, |
|
| 1869 |
+ "selector": {
|
|
| 1870 |
+ "type": "object", |
|
| 1871 |
+ "required": false |
|
| 1872 |
+ } |
|
| 1873 |
+ } |
|
| 1874 |
+} |
|
| 1875 |
+</code></pre><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1876 |
+ "id": "example", |
|
| 1877 |
+ "port": 8000, |
|
| 1878 |
+ "labels": {
|
|
| 1879 |
+ "name": "nginx" |
|
| 1880 |
+ }, |
|
| 1881 |
+ "selector": {
|
|
| 1882 |
+ "name": "nginx" |
|
| 1883 |
+ } |
|
| 1884 |
+} |
|
| 1885 |
+</code></pre></div></div></div></div></div></div></div><div class="panel panel-white"><div class=panel-heading><h4 class=panel-title><a class=collapsed data-toggle=collapse href=#panel__lbservices__serviceId_><span class=parent>/lbservices</span>/{serviceId}</a> <span class=methods><a href=# data-toggle=modal data-target=#_lbservices__serviceId__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_lbservices__serviceId__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_lbservices__serviceId__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__lbservices__serviceId_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_lbservices__serviceId__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get a specific service</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_lbservices__serviceId__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a service</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_lbservices__serviceId__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a specific service</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_lbservices__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>/lbservices</span>/{serviceId}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get a specific service</p></div><ul class="nav nav-tabs"><li class=active><a href=#_lbservices__serviceId__get_request data-toggle=tab>Request</a></li><li><a href=#_lbservices__serviceId__get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_lbservices__serviceId__get_request><h3>URI Parameters</h3><ul><li><strong>serviceId</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_lbservices__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1886 |
+ "data": |
|
| 1887 |
+ {
|
|
| 1888 |
+ "id": "53c4249f076573c0f4000001", |
|
| 1889 |
+ "name": "service-name", |
|
| 1890 |
+ "domain": "domain-id", |
|
| 1891 |
+ "desiredState": |
|
| 1892 |
+ {
|
|
| 1893 |
+ "replicas": 3, |
|
| 1894 |
+ "replicaSelector": { "name": "service-name" },
|
|
| 1895 |
+ "replicaPolicy": {
|
|
| 1896 |
+ "atLeast": 2 |
|
| 1897 |
+ }, |
|
| 1898 |
+ "activeDeployment": "a_deployment_id", |
|
| 1899 |
+ "podTemplate": |
|
| 1900 |
+ {
|
|
| 1901 |
+ "desiredState": |
|
| 1902 |
+ {
|
|
| 1903 |
+ "image": "server/domain/name", |
|
| 1904 |
+ "network-ports": [ |
|
| 1905 |
+ {
|
|
| 1906 |
+ "hostPort": 8080, |
|
| 1907 |
+ "containerPort": 80 |
|
| 1908 |
+ } |
|
| 1909 |
+ ], |
|
| 1910 |
+ "owner": true |
|
| 1911 |
+ }, |
|
| 1912 |
+ "labels": {
|
|
| 1913 |
+ "name": "service-name" |
|
| 1914 |
+ } |
|
| 1915 |
+ } |
|
| 1916 |
+ } |
|
| 1917 |
+ } |
|
| 1918 |
+} |
|
| 1919 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_lbservices__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>/lbservices</span>/{serviceId}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update a service</p></div><ul class="nav nav-tabs"><li class=active><a href=#_lbservices__serviceId__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_lbservices__serviceId__put_request><h3>URI Parameters</h3><ul><li><strong>serviceId</strong>: <em>required (string)</em></li></ul><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
|
|
| 1920 |
+ "$schema": "http://json-schema.org/draft-03/schema", |
|
| 1921 |
+ "type": "object", |
|
| 1922 |
+ "required": false, |
|
| 1923 |
+ "description": "A service resource.", |
|
| 1924 |
+ "properties": {
|
|
| 1925 |
+ "kind": {
|
|
| 1926 |
+ "type": "string", |
|
| 1927 |
+ "required": false |
|
| 1928 |
+ }, |
|
| 1929 |
+ "id": {
|
|
| 1930 |
+ "type": "string", |
|
| 1931 |
+ "required": false |
|
| 1932 |
+ }, |
|
| 1933 |
+ "creationTimestamp": {
|
|
| 1934 |
+ "type": "string", |
|
| 1935 |
+ "required": false |
|
| 1936 |
+ }, |
|
| 1937 |
+ "selfLink": {
|
|
| 1938 |
+ "type": "string", |
|
| 1939 |
+ "required": false |
|
| 1940 |
+ }, |
|
| 1941 |
+ "name": {
|
|
| 1942 |
+ "type": "string", |
|
| 1943 |
+ "required": false |
|
| 1944 |
+ }, |
|
| 1945 |
+ "port": {
|
|
| 1946 |
+ "type": "number", |
|
| 1947 |
+ "required": false |
|
| 1948 |
+ }, |
|
| 1949 |
+ "labels": {
|
|
| 1950 |
+ "type": "object", |
|
| 1951 |
+ "required": false |
|
| 1952 |
+ }, |
|
| 1953 |
+ "selector": {
|
|
| 1954 |
+ "type": "object", |
|
| 1955 |
+ "required": false |
|
| 1956 |
+ } |
|
| 1957 |
+ } |
|
| 1958 |
+} |
|
| 1959 |
+</code></pre><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1960 |
+ "data": |
|
| 1961 |
+ {
|
|
| 1962 |
+ "id": "53c4249f076573c0f4000001", |
|
| 1963 |
+ "name": "service-name", |
|
| 1964 |
+ "domain": "domain-id", |
|
| 1965 |
+ "desiredState": |
|
| 1966 |
+ {
|
|
| 1967 |
+ "replicas": 3, |
|
| 1968 |
+ "replicaSelector": { "name": "service-name" },
|
|
| 1969 |
+ "replicaPolicy": {
|
|
| 1970 |
+ "atLeast": 2 |
|
| 1971 |
+ }, |
|
| 1972 |
+ "activeDeployment": "a_deployment_id", |
|
| 1973 |
+ "podTemplate": |
|
| 1974 |
+ {
|
|
| 1975 |
+ "desiredState": |
|
| 1976 |
+ {
|
|
| 1977 |
+ "image": "server/domain/name", |
|
| 1978 |
+ "network-ports": [ |
|
| 1979 |
+ {
|
|
| 1980 |
+ "hostPort": 8080, |
|
| 1981 |
+ "containerPort": 80 |
|
| 1982 |
+ } |
|
| 1983 |
+ ], |
|
| 1984 |
+ "owner": true |
|
| 1985 |
+ }, |
|
| 1986 |
+ "labels": {
|
|
| 1987 |
+ "name": "service-name" |
|
| 1988 |
+ } |
|
| 1989 |
+ } |
|
| 1990 |
+ } |
|
| 1991 |
+ } |
|
| 1992 |
+} |
|
| 1993 |
+</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_lbservices__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>/lbservices</span>/{serviceId}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete a specific service</p></div><ul class="nav nav-tabs"><li class=active><a href=#_lbservices__serviceId__delete_request data-toggle=tab>Request</a></li><li><a href=#_lbservices__serviceId__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_lbservices__serviceId__delete_request><h3>URI Parameters</h3><ul><li><strong>serviceId</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_lbservices__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><p><strong>Example</strong>:</p><pre><code>{
|
|
| 1994 |
+ "apiVersion": "v1beta1", |
|
| 1995 |
+ "creationTimestamp": null, |
|
| 1996 |
+ "kind": "Status", |
|
| 1997 |
+ "status": "success" |
|
| 1998 |
+} |
|
| 1999 |
+</code></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=#_projects>/projects</a></li><li><a href=#_project__projectID_>/project/{projectID}</a></li><li><a href=#_imageRepositories>/imageRepositories</a></li><li><a href=#_imageRepositories__repositoryID_>/imageRepositories/{repositoryID}</a></li><li><a href=#_images>/images</a></li><li><a href=#_images__imageID_>/images/{imageID}</a></li><li><a href=#_imageRepositoryMappings>/imageRepositoryMappings</a></li><li><a href=#_services>/services</a></li><li><a href=#_service__serviceID_>/service/{serviceID}</a></li><li><a href=#_deployments>/deployments</a></li><li><a href=#_deployment__deploymentID_>/deployment/{deploymentID}</a></li><li><a href=#_links>/links</a></li><li><a href=#_link__linkID_>/link/{linkID}</a></li><li><a href=#_aliases>/aliases</a></li><li><a href=#_alias__aliasID_>/alias/{aliasID}</a></li><li><a href=#_builds>/builds</a></li><li><a href=#_builds__buildId_>/builds/{buildId}</a></li><li><a href=#_buildConfigs>/buildConfigs</a></li><li><a href=#_buildConfigs__configId_>/buildConfigs/{configId}</a></li><li><a href=#_buildConfigHooks__buildId___secret___plugin_>/buildConfigHooks/{buildId}/{secret}/{plugin}</a></li><li><a href=#_templates>/templates</a></li><li><a href=#_template__templateID_>/template/{templateID}</a></li><li><a href=#_pods>/pods</a></li><li><a href=#_replicationControllers>/replicationControllers</a></li><li><a href=#_lbservices>/lbservices</a></li></ul></div></div></div></div></body></html>
|
|
| 0 | 2000 |
\ No newline at end of file |
| 1 | 2001 |
new file mode 100644 |
| ... | ... |
@@ -0,0 +1,481 @@ |
| 0 |
+#%RAML 0.8 |
|
| 1 |
+# vim: set ft=yaml: |
|
| 2 |
+baseUri: http://server/broker/rest |
|
| 3 |
+title: OpenShift 3 |
|
| 4 |
+version: v1beta1 |
|
| 5 |
+mediaType: application/json |
|
| 6 |
+documentation: |
|
| 7 |
+ - title: Overview |
|
| 8 |
+ content: !include doc/overview.md |
|
| 9 |
+/projects: |
|
| 10 |
+ get: |
|
| 11 |
+ description: | |
|
| 12 |
+ List all projects for your account. |
|
| 13 |
+ |
|
| 14 |
+ Projects are a similar concept to v2 domains. A project is a grouping of services |
|
| 15 |
+ with shared access control and resource limits. Applications can be assembled |
|
| 16 |
+ from services in a project by linking them together via service endpoints. |
|
| 17 |
+ responses: |
|
| 18 |
+ 200: |
|
| 19 |
+ body: |
|
| 20 |
+ example: !include examples/project-list.json |
|
| 21 |
+ post: |
|
| 22 |
+ description: Create a new project |
|
| 23 |
+ body: |
|
| 24 |
+ example: !include examples/project.json |
|
| 25 |
+ |
|
| 26 |
+/project/{projectID}:
|
|
| 27 |
+ get: |
|
| 28 |
+ description: Get a specific project |
|
| 29 |
+ responses: |
|
| 30 |
+ 200: |
|
| 31 |
+ body: |
|
| 32 |
+ example: !include examples/project.json |
|
| 33 |
+ put: |
|
| 34 |
+ description: Update a project |
|
| 35 |
+ body: |
|
| 36 |
+ example: !include examples/project-put.json |
|
| 37 |
+ delete: |
|
| 38 |
+ description: Delete a project |
|
| 39 |
+ responses: |
|
| 40 |
+ 200: |
|
| 41 |
+ body: |
|
| 42 |
+ example: !include examples/status-success.json |
|
| 43 |
+ post: |
|
| 44 |
+ description: Instantiate a template in the given project |
|
| 45 |
+ body: |
|
| 46 |
+ example: !include examples/project-post.json |
|
| 47 |
+ |
|
| 48 |
+/imageRepositories: |
|
| 49 |
+ get: |
|
| 50 |
+ description: | |
|
| 51 |
+ Lists all image repositories. |
|
| 52 |
+ |
|
| 53 |
+ An image repository is a collection of images that share the same metadata. It may |
|
| 54 |
+ reference a Docker image repository on a Docker registry, but this is optional. An |
|
| 55 |
+ image repository also contains a mapping of tags to images. |
|
| 56 |
+ responses: |
|
| 57 |
+ 200: |
|
| 58 |
+ body: |
|
| 59 |
+ example: !include examples/image-repositories.json |
|
| 60 |
+ post: |
|
| 61 |
+ description: Create a new image repository |
|
| 62 |
+ body: |
|
| 63 |
+ example: !include examples/create-image-repository.json |
|
| 64 |
+ |
|
| 65 |
+/imageRepositories/{repositoryID}:
|
|
| 66 |
+ get: |
|
| 67 |
+ description: Get information about an image repository |
|
| 68 |
+ body: |
|
| 69 |
+ example: !include examples/image-repository.json |
|
| 70 |
+ put: |
|
| 71 |
+ description: Update an image repository |
|
| 72 |
+ body: |
|
| 73 |
+ example: !include examples/image-repository.json |
|
| 74 |
+ delete: |
|
| 75 |
+ description: Delete an image repository |
|
| 76 |
+ responses: |
|
| 77 |
+ 200: |
|
| 78 |
+ body: |
|
| 79 |
+ example: !include examples/status-success.json |
|
| 80 |
+/images: |
|
| 81 |
+ get: |
|
| 82 |
+ description: | |
|
| 83 |
+ Lists all images. |
|
| 84 |
+ |
|
| 85 |
+ An image is a reference to an image in a Docker image repository on a Docker |
|
| 86 |
+ registry, plus a set of metadata. The metadata that Openshift stores for an image |
|
| 87 |
+ will augment the metadata that has already been specified in the image through |
|
| 88 |
+ its Dockerfile. |
|
| 89 |
+ responses: |
|
| 90 |
+ 200: |
|
| 91 |
+ body: |
|
| 92 |
+ example: !include examples/images.json |
|
| 93 |
+ post: |
|
| 94 |
+ description: Create a new image definition |
|
| 95 |
+ body: |
|
| 96 |
+ example: !include examples/create-image.json |
|
| 97 |
+ |
|
| 98 |
+/images/{imageID}:
|
|
| 99 |
+ get: |
|
| 100 |
+ description: Get image definition |
|
| 101 |
+ body: |
|
| 102 |
+ example: !include examples/image.json |
|
| 103 |
+ delete: |
|
| 104 |
+ description: Delete an image |
|
| 105 |
+ responses: |
|
| 106 |
+ 200: |
|
| 107 |
+ body: |
|
| 108 |
+ example: !include examples/status-success.json |
|
| 109 |
+ |
|
| 110 |
+/imageRepositoryMappings: |
|
| 111 |
+ post: |
|
| 112 |
+ description: | |
|
| 113 |
+ Creates an image and updates an image repository. |
|
| 114 |
+ |
|
| 115 |
+ This is designed as a webhook that a Docker registry can invoke when a |
|
| 116 |
+ new tag is created. The image repository mapping contains a reference |
|
| 117 |
+ to the repository, the image's metadata, and the name of the new tag. |
|
| 118 |
+ Upon execution, a new image is created if it doesn't already exist, and |
|
| 119 |
+ the image repository is updated with the new tag. |
|
| 120 |
+ body: |
|
| 121 |
+ example: !include examples/create-image-repository-mapping.json |
|
| 122 |
+ |
|
| 123 |
+/services: |
|
| 124 |
+ get: |
|
| 125 |
+ description: | |
|
| 126 |
+ Lists all services that your account has access to |
|
| 127 |
+ |
|
| 128 |
+ Services can be public or owned by a project. They contain a template of a pod and |
|
| 129 |
+ reference image repositories that supply the images for those templates. A service may |
|
| 130 |
+ be configured to react to an image being pushed to an image repository by initiating a |
|
| 131 |
+ deployment. Deployments are associated with a service and make use of |
|
| 132 |
+ Kubernetes replication controllers to manage pods in a cluster. |
|
| 133 |
+ For deployments, a service contains a policy that constrains how deployments can occur. |
|
| 134 |
+ For example, it may require that there exist at least 2 operational pods at all times. |
|
| 135 |
+ A deployment needs to operate under those constraints when making changes. |
|
| 136 |
+ queryParameters: |
|
| 137 |
+ projectId: |
|
| 138 |
+ description: filter the services owned by a particular project |
|
| 139 |
+ responses: |
|
| 140 |
+ 200: |
|
| 141 |
+ body: |
|
| 142 |
+ example: !include examples/services.json |
|
| 143 |
+ post: |
|
| 144 |
+ description: Create a new service |
|
| 145 |
+ body: |
|
| 146 |
+ example: !include examples/create-service.json |
|
| 147 |
+/service/{serviceID}:
|
|
| 148 |
+ get: |
|
| 149 |
+ description: Get a specific service definition |
|
| 150 |
+ body: |
|
| 151 |
+ example: !include examples/service.json |
|
| 152 |
+ put: |
|
| 153 |
+ description: Update a service |
|
| 154 |
+ body: |
|
| 155 |
+ example: !include examples/service.json |
|
| 156 |
+ delete: |
|
| 157 |
+ description: Delete a service |
|
| 158 |
+ responses: |
|
| 159 |
+ 200: |
|
| 160 |
+ body: |
|
| 161 |
+ example: !include examples/status-success.json |
|
| 162 |
+ /environment-variables: |
|
| 163 |
+ get: |
|
| 164 |
+ description: Environment variables associated with this service |
|
| 165 |
+ responses: |
|
| 166 |
+ 200: |
|
| 167 |
+ body: |
|
| 168 |
+ example: !include examples/envvars.json |
|
| 169 |
+ post: |
|
| 170 |
+ description: Create/update environment variables |
|
| 171 |
+ body: |
|
| 172 |
+ example: !include examples/envvars.json |
|
| 173 |
+ /{variableName}:
|
|
| 174 |
+ get: |
|
| 175 |
+ description: Get environment variable |
|
| 176 |
+ body: |
|
| 177 |
+ example: !include examples/envvar.json |
|
| 178 |
+ put: |
|
| 179 |
+ description: Update an environment variable's value |
|
| 180 |
+ body: |
|
| 181 |
+ example: !include examples/envvar.json |
|
| 182 |
+ delete: |
|
| 183 |
+ description: Delete an environment variable |
|
| 184 |
+ responses: |
|
| 185 |
+ 200: |
|
| 186 |
+ body: |
|
| 187 |
+ example: !include examples/status-success.json |
|
| 188 |
+/deployments: |
|
| 189 |
+ get: |
|
| 190 |
+ description: | |
|
| 191 |
+ Lists active deployments in the current project |
|
| 192 |
+ |
|
| 193 |
+ Deployments effect change in a service such as scaling up, down, updating the |
|
| 194 |
+ current image, etc. Deployments may use different policies for carrying out |
|
| 195 |
+ the change. For example, a rolling update with a single pod change at a time, or |
|
| 196 |
+ a batch update, etc. Deployments make use of Kubernetes replicationControllers |
|
| 197 |
+ to bring about the changes. |
|
| 198 |
+ responses: |
|
| 199 |
+ 200: |
|
| 200 |
+ body: |
|
| 201 |
+ example: !include examples/deployments.json |
|
| 202 |
+ post: |
|
| 203 |
+ description: Create a new deployment |
|
| 204 |
+ body: |
|
| 205 |
+ example: !include examples/create-deployment.json |
|
| 206 |
+/deployment/{deploymentID}:
|
|
| 207 |
+ get: |
|
| 208 |
+ description: Get deployment details |
|
| 209 |
+ body: |
|
| 210 |
+ example: !include examples/deployment.json |
|
| 211 |
+/links: |
|
| 212 |
+ get: |
|
| 213 |
+ description: | |
|
| 214 |
+ List of links between services in your account |
|
| 215 |
+ |
|
| 216 |
+ Unlike a Docker link, a Link in OpenShift defines a relationship between services |
|
| 217 |
+ which may be composed by multiple Docker images. A link may include additional metadata |
|
| 218 |
+ about the relationship such as the algorithm to use to distribute requests. |
|
| 219 |
+ queryParameters: |
|
| 220 |
+ projectId: |
|
| 221 |
+ description: filter the links owned by a particular project |
|
| 222 |
+ serviceId: |
|
| 223 |
+ description: filter the links attached to a particular service |
|
| 224 |
+ responses: |
|
| 225 |
+ 200: |
|
| 226 |
+ body: |
|
| 227 |
+ example: !include examples/links.json |
|
| 228 |
+ post: |
|
| 229 |
+ description: Create a new link between this service and a different service |
|
| 230 |
+ body: |
|
| 231 |
+ example: !include examples/link.json |
|
| 232 |
+/link/{linkID}:
|
|
| 233 |
+ get: |
|
| 234 |
+ description: Get link details |
|
| 235 |
+ body: |
|
| 236 |
+ example: !include examples/link.json |
|
| 237 |
+ put: |
|
| 238 |
+ description: Update a link |
|
| 239 |
+ body: |
|
| 240 |
+ example: !include examples/link.json |
|
| 241 |
+ delete: |
|
| 242 |
+ description: Delete a link |
|
| 243 |
+ responses: |
|
| 244 |
+ 200: |
|
| 245 |
+ body: |
|
| 246 |
+ example: !include examples/status-success.json |
|
| 247 |
+/aliases: |
|
| 248 |
+ get: |
|
| 249 |
+ description: | |
|
| 250 |
+ List all aliases visible to you |
|
| 251 |
+ |
|
| 252 |
+ Aliases in v3 perform the same function as aliases in v2. The main difference |
|
| 253 |
+ is that in v3 an alias is associated with a service, not an application. |
|
| 254 |
+ queryParameters: |
|
| 255 |
+ serviceId: |
|
| 256 |
+ description: filter aliases by associated service |
|
| 257 |
+ responses: |
|
| 258 |
+ 200: |
|
| 259 |
+ body: |
|
| 260 |
+ example: !include examples/aliases.json |
|
| 261 |
+ post: |
|
| 262 |
+ description: Create an alias for this service |
|
| 263 |
+ body: |
|
| 264 |
+ example: !include examples/alias.json |
|
| 265 |
+/alias/{aliasID}:
|
|
| 266 |
+ get: |
|
| 267 |
+ description: Get alias |
|
| 268 |
+ body: |
|
| 269 |
+ example: !include examples/alias.json |
|
| 270 |
+ put: |
|
| 271 |
+ description: Update an alias |
|
| 272 |
+ body: |
|
| 273 |
+ example: !include examples/alias.json |
|
| 274 |
+ delete: |
|
| 275 |
+ description: Delete an alias |
|
| 276 |
+ responses: |
|
| 277 |
+ 200: |
|
| 278 |
+ body: |
|
| 279 |
+ example: !include examples/status-success.json |
|
| 280 |
+/builds: |
|
| 281 |
+ get: |
|
| 282 |
+ description: | |
|
| 283 |
+ Retrieves a list of builds |
|
| 284 |
+ |
|
| 285 |
+ Build encapsulates the inputs needed to produce a new deployable image, as well as |
|
| 286 |
+ the status of the operation and a reference to the Pod which runs the build. |
|
| 287 |
+ responses: |
|
| 288 |
+ 200: |
|
| 289 |
+ body: |
|
| 290 |
+ example: !include examples/builds.json |
|
| 291 |
+ post: |
|
| 292 |
+ description: Create a new build |
|
| 293 |
+ body: |
|
| 294 |
+ example: !include examples/create_build.json |
|
| 295 |
+/builds/{buildId}:
|
|
| 296 |
+ get: |
|
| 297 |
+ description: Retrieve a single build definition |
|
| 298 |
+ responses: |
|
| 299 |
+ 200: |
|
| 300 |
+ body: |
|
| 301 |
+ example: !include examples/build.json |
|
| 302 |
+ put: |
|
| 303 |
+ description: Update a build definition |
|
| 304 |
+ body: |
|
| 305 |
+ example: !include examples/build.json |
|
| 306 |
+ delete: |
|
| 307 |
+ description: Delete a build definition |
|
| 308 |
+ responses: |
|
| 309 |
+ 200: |
|
| 310 |
+ body: |
|
| 311 |
+ example: !include examples/status-success.json |
|
| 312 |
+/buildConfigs: |
|
| 313 |
+ get: |
|
| 314 |
+ description: | |
|
| 315 |
+ Retrieves a list of BuildConfigs |
|
| 316 |
+ |
|
| 317 |
+ BuildConfig contains the inputs needed to produce a new deployable image |
|
| 318 |
+ responses: |
|
| 319 |
+ 200: |
|
| 320 |
+ body: |
|
| 321 |
+ example: !include examples/buildConfigs.json |
|
| 322 |
+ post: |
|
| 323 |
+ description: Create a new build |
|
| 324 |
+ body: |
|
| 325 |
+ example: !include examples/create_buildConfig.json |
|
| 326 |
+ |
|
| 327 |
+/buildConfigs/{configId}:
|
|
| 328 |
+ get: |
|
| 329 |
+ description: Retrieve a build configuration |
|
| 330 |
+ responses: |
|
| 331 |
+ 200: |
|
| 332 |
+ body: |
|
| 333 |
+ example: !include examples/buildConfig.json |
|
| 334 |
+ put: |
|
| 335 |
+ description: Update a build configuration |
|
| 336 |
+ body: |
|
| 337 |
+ example: !include examples/buildConfig.json |
|
| 338 |
+ delete: |
|
| 339 |
+ description: Delete a build configuration |
|
| 340 |
+ responses: |
|
| 341 |
+ 200: |
|
| 342 |
+ body: |
|
| 343 |
+ example: !include examples/status-success.json |
|
| 344 |
+/buildConfigHooks/{buildId}/{secret}/{plugin}:
|
|
| 345 |
+ post: |
|
| 346 |
+ description: | |
|
| 347 |
+ Webhook on push event from external repository |
|
| 348 |
+ |
|
| 349 |
+ buildId specifies which build to trigger, whereas plugin defines source of |
|
| 350 |
+ the request, this might be github, bitbucket or others. |
|
| 351 |
+ responses: |
|
| 352 |
+ 204: |
|
| 353 |
+ description: No content |
|
| 354 |
+ |
|
| 355 |
+/templates: |
|
| 356 |
+ get: |
|
| 357 |
+ description: | |
|
| 358 |
+ Lists all templates that your account has access to |
|
| 359 |
+ |
|
| 360 |
+ A template defines 0..n services and 0..m links. When it is applied |
|
| 361 |
+ to an existing project, those services and links are instantiated for |
|
| 362 |
+ that project. |
|
| 363 |
+ responses: |
|
| 364 |
+ 200: |
|
| 365 |
+ body: |
|
| 366 |
+ example: !include examples/templates.json |
|
| 367 |
+ post: |
|
| 368 |
+ description: Create a new template |
|
| 369 |
+ body: |
|
| 370 |
+ example: !include examples/template.json |
|
| 371 |
+/template/{templateID}:
|
|
| 372 |
+ get: |
|
| 373 |
+ description: Get a specific template |
|
| 374 |
+ body: |
|
| 375 |
+ example: !include examples/template.json |
|
| 376 |
+ put: |
|
| 377 |
+ description: Update a template |
|
| 378 |
+ body: |
|
| 379 |
+ example: !include examples/template.json |
|
| 380 |
+ delete: |
|
| 381 |
+ description: Delete a template |
|
| 382 |
+ responses: |
|
| 383 |
+ 200: |
|
| 384 |
+ body: |
|
| 385 |
+ example: !include examples/status-success.json |
|
| 386 |
+/pods: |
|
| 387 |
+ get: |
|
| 388 |
+ description: List all pods on this cluster |
|
| 389 |
+ responses: |
|
| 390 |
+ 200: |
|
| 391 |
+ body: |
|
| 392 |
+ example: !include examples/pod-list.json |
|
| 393 |
+ post: |
|
| 394 |
+ description: Create a new pod. currentState is ignored if present. |
|
| 395 |
+ body: |
|
| 396 |
+ schema: !include doc/pod-schema.json |
|
| 397 |
+ example: !include examples/pod.json |
|
| 398 |
+ |
|
| 399 |
+ /{podId}:
|
|
| 400 |
+ get: |
|
| 401 |
+ description: Get a specific pod |
|
| 402 |
+ responses: |
|
| 403 |
+ 200: |
|
| 404 |
+ body: |
|
| 405 |
+ example: !include examples/pod.json |
|
| 406 |
+ put: |
|
| 407 |
+ description: Update a pod |
|
| 408 |
+ body: |
|
| 409 |
+ schema: !include doc/pod-schema.json |
|
| 410 |
+ example: !include examples/pod.json |
|
| 411 |
+ delete: |
|
| 412 |
+ description: Delete a specific pod |
|
| 413 |
+ responses: |
|
| 414 |
+ 200: |
|
| 415 |
+ body: |
|
| 416 |
+ example: !include examples/status-success.json |
|
| 417 |
+ |
|
| 418 |
+/replicationControllers: |
|
| 419 |
+ get: |
|
| 420 |
+ description: List all replicationControllers on this cluster |
|
| 421 |
+ responses: |
|
| 422 |
+ 200: |
|
| 423 |
+ body: |
|
| 424 |
+ example: !include examples/controller-list.json |
|
| 425 |
+ post: |
|
| 426 |
+ description: Create a new controller. currentState is ignored if present. |
|
| 427 |
+ body: |
|
| 428 |
+ schema: !include doc/controller-schema.json |
|
| 429 |
+ example: !include examples/controller.json |
|
| 430 |
+ |
|
| 431 |
+ /{controllerId}:
|
|
| 432 |
+ get: |
|
| 433 |
+ description: Get a specific controller |
|
| 434 |
+ responses: |
|
| 435 |
+ 200: |
|
| 436 |
+ body: |
|
| 437 |
+ example: !include examples/controller.json |
|
| 438 |
+ put: |
|
| 439 |
+ description: Update a controller |
|
| 440 |
+ body: |
|
| 441 |
+ schema: !include doc/controller-schema.json |
|
| 442 |
+ example: !include examples/controller.json |
|
| 443 |
+ delete: |
|
| 444 |
+ description: Delete a specific controller |
|
| 445 |
+ responses: |
|
| 446 |
+ 200: |
|
| 447 |
+ body: |
|
| 448 |
+ example: !include examples/status-success.json |
|
| 449 |
+ |
|
| 450 |
+/lbservices: |
|
| 451 |
+ get: |
|
| 452 |
+ description: List all services on this cluster |
|
| 453 |
+ responses: |
|
| 454 |
+ 200: |
|
| 455 |
+ body: |
|
| 456 |
+ example: !include examples/service-list.json |
|
| 457 |
+ post: |
|
| 458 |
+ description: Create a new service |
|
| 459 |
+ body: |
|
| 460 |
+ schema: !include doc/service-schema.json |
|
| 461 |
+ example: !include examples/lbservice.json |
|
| 462 |
+ |
|
| 463 |
+ /{serviceId}:
|
|
| 464 |
+ get: |
|
| 465 |
+ description: Get a specific service |
|
| 466 |
+ responses: |
|
| 467 |
+ 200: |
|
| 468 |
+ body: |
|
| 469 |
+ example: !include examples/service.json |
|
| 470 |
+ put: |
|
| 471 |
+ description: Update a service |
|
| 472 |
+ body: |
|
| 473 |
+ schema: !include doc/service-schema.json |
|
| 474 |
+ example: !include examples/service.json |
|
| 475 |
+ delete: |
|
| 476 |
+ description: Delete a specific service |
|
| 477 |
+ responses: |
|
| 478 |
+ 200: |
|
| 479 |
+ body: |
|
| 480 |
+ example: !include examples/status-success.json |
| ... | ... |
@@ -7,7 +7,7 @@ set -o pipefail |
| 7 | 7 |
hackdir=$(CDPATH="" cd $(dirname $0); pwd) |
| 8 | 8 |
|
| 9 | 9 |
cd $hackdir/../api && docker build -t kubernetes/raml2html . |
| 10 |
-docker rm oov3docgen &>/dev/null || : |
|
| 11 |
-docker run --name=oov3docgen kubernetes/raml2html |
|
| 12 |
-docker cp oov3docgen:/data/oov3.html $hackdir/../api/ |
|
| 13 |
-docker rm oov3docgen &>/dev/null || : |
|
| 10 |
+docker rm openshift3docgen &>/dev/null || : |
|
| 11 |
+docker run --name=openshift3docgen kubernetes/raml2html |
|
| 12 |
+docker cp openshift3docgen:/data/openshift3.html $hackdir/../api/ |
|
| 13 |
+docker rm openshift3docgen &>/dev/null || : |