forked from openshift/origin
/
openshift3.html
2381 lines (2379 loc) · 159 KB
/
openshift3.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE HTML><html><head><title>OpenShift 3 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.4"><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>
$(document).ready(function() {
$('.page-header pre code, .top-resource-description pre code').each(function(i, block) {
hljs.highlightBlock(block);
});
$('[data-toggle]').click(function() {
var selector = $(this).data('target') + ' pre code';
$(selector).each(function(i, block) {
hljs.highlightBlock(block);
});
});
});
</script><style>
.hljs {
background: transparent;
}
.parent {
color: #999;
}
.list-group-item > .badge {
float: none;
margin-right: 6px;
}
.panel-title > .methods {
float: right;
}
.badge {
border-radius: 0;
text-transform: uppercase;
width: 70px;
font-weight: normal;
color: #f3f3f6;
line-height: normal;
}
.badge_get {
background-color: #63a8e2;
}
.badge_post {
background-color: #6cbd7d;
}
.badge_put {
background-color: #22bac4;
}
.badge_delete {
background-color: #d26460;
}
.list-group, .panel-group {
margin-bottom: 0;
}
.panel-group .panel+.panel-white {
margin-top: 0;
}
.panel-group .panel-white {
border-bottom: 1px solid #F5F5F5;
border-radius: 0;
}
.panel-white:last-child {
border-bottom-color: white;
-webkit-box-shadow: none;
box-shadow: none;
}
.panel-white .panel-heading {
background: white;
}
.tab-pane ul {
padding-left: 2em;
}
.tab-pane h2 {
font-size: 1.2em;
padding-bottom: 4px;
border-bottom: 1px solid #ddd;
}
.tab-pane h3 {
font-size: 1.1em;
}
.tab-content {
border-left: 1px solid #ddd;
border-right: 1px solid #ddd;
border-bottom: 1px solid #ddd;
padding: 10px;
}
#sidebar {
margin-top: 30px;
}
.top-resource-description {
border-bottom: 1px solid #ddd;
background: #fcfcfc;
padding: 15px 15px 0 15px;
margin: -15px -15px 10px -15px;
}
.resource-description {
border-bottom: 1px solid #fcfcfc;
background: #fcfcfc;
padding: 15px 15px 0 15px;
margin: -15px -15px 10px -15px;
}
.list-group .badge {
float: left;
}
.method_description {
margin-left: 85px;
}
.method_description p:last-child {
margin: 0;
}
.list-group-item {
cursor: pointer;
}
.list-group-item:hover {
background-color: #f5f5f5;
}
</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>OpenShift 3 API documentation <small>version v1beta1</small></h1><p>http://localhost:8080/osapi/v1beta1</p><h3 id=Overview><a href=#Overview>Overview</a></h3><p>The OpenShift 3.x model attempts to expose underlying Docker and Kubernetes models as accurately as possible, with a focus on easy composition of applications by a developer (install Ruby, push code, add MySQL).</p><p>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><h3 id=Kubernetes-API><a href=#Kubernetes-API>Kubernetes API</a></h3><p>OpenShift exposes <a href=http://htmlpreview.github.io/?https://github.com/GoogleCloudPlatform/kubernetes/blob/master/api/kubernetes.html>Kubernetes API</a> at <a href="http://localhost:8080/api/v1beta1/">http://localhost:8080/api/v1beta1/</a>.</p></div><div class="panel panel-default"><div class=panel-heading><h3 id=_aliases class=panel-title>/aliases (NOT IMPLEMENTED)</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>{
"list":
[
{
"id": "myalias",
"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-----",
"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-----",
"pass_phrase": "abcd"
}
]
}
</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>{
"data":
{
"id": "53c4249f076573c0f4000001",
"suffix": "dev.rhcloud.com",
"name": "mydomain",
"members": [
{
"login": "adminuser",
"role": "admin",
"type": "user",
"owner": true
}
]
}
}
</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__aliases__aliasID_><span class=parent>/aliases</span>/{aliasID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_aliases__aliasID__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_aliases__aliasID__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_aliases__aliasID__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__aliases__aliasID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_aliases__aliasID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get a specific alias.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_aliases__aliasID__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a specific alias.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_aliases__aliasID__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a specific alias.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_aliases__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>/aliases</span>/{aliasID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get a specific alias.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_aliases__aliasID__get_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_aliases__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>{
"data":
{
"id": "53c4249f076573c0f4000001",
"suffix": "dev.rhcloud.com",
"name": "mydomain",
"members": [
{
"login": "adminuser",
"role": "admin",
"type": "user",
"owner": true
}
]
}
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_aliases__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>/aliases</span>/{aliasID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update a specific alias.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_aliases__aliasID__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_aliases__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>{
"data":
{
"id": "53c4249f076573c0f4000001",
"suffix": "dev.rhcloud.com",
"name": "mydomain",
"members": [
{
"login": "adminuser",
"role": "admin",
"type": "user",
"owner": true
}
]
}
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_aliases__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>/aliases</span>/{aliasID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete a specific alias.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_aliases__aliasID__delete_request data-toggle=tab>Request</a></li><li><a href=#_aliases__aliasID__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_aliases__aliasID__delete_request><h3>URI Parameters</h3><ul><li><strong>aliasID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_aliases__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>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"kind": "Status",
"status": "success"
}
</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=_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>List all 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>List all 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><p><strong>Example</strong>:</p><pre><code>[{
"apiVersion": "v1beta1",
"creationTimestamp": "2014-09-10T19:30:36Z",
"desiredInput": {
"imageTag": "test-database",
"registry": "localhost:5000",
"sourceURI": "git://github.com/pmorie/simple-ruby",
"stiInput": {
"builderImage": "mysql"
}
},
"id": "9a3a5b7c-4ee9-11e4-9d75-0800279696e1",
"kind": "BuildConfig",
"resourceVersion": 116
},
{
"apiVersion": "v1beta1",
"creationTimestamp": "2014-09-16T19:33:36Z",
"desiredInput": {
"imageTag": "test-ruby-app",
"registry": "localhost:5000",
"sourceURI": "git://github.com/pmorie/simple-ruby",
"stiInput": {
"builderImage": "openshift/ruby-19-centos"
}
},
"id": "5a6a5b9c-3dd8-11e4-9d75-0800279696e1",
"kind": "BuildConfig",
"resourceVersion": 117
}]
</code></pre></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>{
"kind": "BuildConfig",
"apiVersion": "v1beta1",
"desiredInput": {
"sourceURI": "git://github.com/pmorie/simple-ruby",
"imageTag": "test-ruby-app",
"stiInput": {
"builderImage": "openshift/ruby-19-centos",
}
}
}
</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__buildConfigs__configID_><span class=parent>/buildConfigs</span>/{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>Get a specific 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 specific 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 specific 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>/buildConfigs</span>/{configID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get a specific 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>{
"apiVersion": "v1beta1",
"creationTimestamp": "2014-09-16T19:33:36Z",
"desiredInput": {
"imageTag": "test-ruby-app",
"registry": "localhost:5000",
"sourceURI": "git://github.com/pmorie/simple-ruby",
"stiInput": {
"builderImage": "openshift/ruby-19-centos"
}
},
"id": "5a6a5b9c-3dd8-11e4-9d75-0800279696e1",
"kind": "BuildConfig",
"resourceVersion": 117
}
</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>/buildConfigs</span>/{configID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update a specific 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>{
"apiVersion": "v1beta1",
"creationTimestamp": "2014-09-16T19:33:36Z",
"desiredInput": {
"imageTag": "test-ruby-app",
"registry": "localhost:5000",
"sourceURI": "git://github.com/pmorie/simple-ruby",
"stiInput": {
"builderImage": "openshift/ruby-19-centos"
}
},
"id": "5a6a5b9c-3dd8-11e4-9d75-0800279696e1",
"kind": "BuildConfig",
"resourceVersion": 117
}
</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>/buildConfigs</span>/{configID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete a specific 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>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"kind": "Status",
"status": "success"
}
</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>List all 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>List all 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>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"items": [
{
"creationTimestamp": "2014-09-16T02:58:19Z",
"id": "5065bcf2-3d4d-11e4-a95b-0800279696e1",
"parameters": {
"source": {
"type": "Git",
"git": {
"uri": "git://github.com/test/dockerbuild"
}
},
"strategy": {
"type": "Docker"
},
"output": {
"imageTag": "test/dockerbuild"
}
},
"podID": "build-sti-5065bcf2-3d4d-11e4-a95b-0800279696e1",
"resourceVersion": 114,
"status": "new"
}
],
"kind": "BuildList",
"resourceVersion": 116
}
</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>{
"kind": "Build",
"apiVersion": "v1beta1",
"parameters": {
"source": {
"type": "Git",
"git": {
"uri": "git://github.com/test/dockerbuild"
}
},
"strategy": {
"type": "Docker"
},
"output": {
"imageTag": "test/dockerbuild"
}
}
}
</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__builds__buildID_><span class=parent>/builds</span>/{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>Get details about a specific build.</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 specific build.</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 specific build.</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>/builds</span>/{buildID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get details about a specific build.</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>{
"apiVersion": "v1beta1",
"creationTimestamp": "2014-09-16T02:58:19Z",
"id": "5065bcf2-3d4d-11e4-a95b-0800279696e1",
"parameters": {
"source": {
"type": "Git",
"git": {
"uri": "git://github.com/test/dockerbuild"
}
},
"strategy": {
"type": "Docker"
},
"output": {
"imageTag": "test/dockerbuild"
}
},
"kind": "Build",
"podID": "build-sti-5065bcf2-3d4d-11e4-a95b-0800279696e1",
"resourceVersion": 114,
"status": "pending"
}
</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>/builds</span>/{buildID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update a specific build.</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>{
"apiVersion": "v1beta1",
"creationTimestamp": "2014-09-16T02:58:19Z",
"id": "5065bcf2-3d4d-11e4-a95b-0800279696e1",
"parameters": {
"source": {
"type": "Git",
"git": {
"uri": "git://github.com/test/dockerbuild"
}
},
"strategy": {
"type": "Docker"
},
"output": {
"imageTag": "test/dockerbuild"
}
},
"kind": "Build",
"podID": "build-sti-5065bcf2-3d4d-11e4-a95b-0800279696e1",
"resourceVersion": 114,
"status": "pending"
}
</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>/builds</span>/{buildID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete a specific build.</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>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"kind": "Status",
"status": "success"
}
</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_configs class=panel-title>/configs (NOT IMPLEMENTED)</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__configs><span class=parent></span>/configs</a> <span class=methods><a href=# data-toggle=modal data-target=#_configs_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_configs_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__configs class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_configs_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>List all configs that your account has access to.</p><p>A config defines 0..n Kubernetes resources.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_configs_post class=list-group-item><span class="badge badge_post">post</span><div class=method_description><p>Create a new config.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_configs_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>/configs</h4></div><div class=modal-body><div class="alert alert-info"><p>List all configs that your account has access to.</p><p>A config defines 0..n Kubernetes resources.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_configs_get_request data-toggle=tab>Request</a></li><li><a href=#_configs_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_configs_get_request></div><div class=tab-pane id=_configs_get_response><h2>HTTP status code <a href=http://httpstatus.es/200 target=_blank>200</a></h2></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_configs_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>/configs</h4></div><div class=modal-body><div class="alert alert-info"><p>Create a new config.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_configs_post_request data-toggle=tab>Request</a></li><li><a href=#_configs_post_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_configs_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Schema</strong>:</p><pre><code>{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"required": true,
"description": "Config resource.",
"properties": {
"id": {
"type": "string",
"required": true
},
"name": {
"type": "string",
"required": true
},
"description": {
"type": "string",
"required": false
},
"items": {
"type": "array",
"required": false,
"items": {
"type": "object",
"required": true,
"properties": {
"kind": {
"type": "string",
"required": true
},
"id": {
"type": "string",
"required": true
}
}
}
}
}
}</code></pre><p><strong>Example</strong>:</p><pre><code>{
"kind": "Config",
"id": "example1",
"name": "My awesome PHP app",
"description": "Example PHP application with PostgreSQL database",
"apiVersion": "v1beta1",
"creationTimestamp": "2014-09-22T09:48:27Z",
"items": [
{
"kind": "Service",
"id": "frontend",
"creationTimestamp": null,
"apiVersion": "v1beta1",
"port": 8080,
"containerPort": 9292,
"selector": {
"name": "frontend"
}
},
{
"kind": "Service",
"id": "database",
"creationTimestamp": null,
"apiVersion": "v1beta1",
"port": 5432,
"containerPort": 5432,
"selector": {
"name": "database"
}
},
{
"kind": "ReplicationController",
"id": "frontendController",
"creationTimestamp": null,
"apiVersion": "v1beta1",
"desiredState": {
"replicas": 2,
"replicaSelector": {
"name": "frontend"
},
"podTemplate": {
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "frontendController",
"volumes": null,
"containers": [
{
"name": "nginx-php-app",
"image": "mfojtik/nginx-php-app",
"ports": [
{
"hostPort": 8080,
"containerPort": 9292,
"protocol": "TCP"
}
],
"env": [
{
"name": "PGPASSWORD",
"key": "PGPASSWORD",
"value": "MPbGM5T0"
},
{
"name": "PGUSER",
"key": "PGUSER",
"value": "adminO8bR"
},
{
"name": "PGDATABASE",
"key": "PGDATABASE",
"value": "mydb"
}
]
}
]
},
"restartpolicy": {}
},
"labels": {
"name": "frontend"
}
}
},
"labels": {
"name": "frontend"
}
},
{
"kind": "Pod",
"id": "postgresql",
"creationTimestamp": null,
"apiVersion": "v1beta1",
"labels": {
"name": "database"
},
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "database",
"volumes": null,
"containers": [
{
"name": "postgresql",
"image": "postgres",
"ports": [
{
"hostPort": 5432,
"containerPort": 5432,
"protocol": "TCP"
}
],
"env": [
{
"name": "PGPASSWORD",
"key": "PGPASSWORD",
"value": "MPbGM5T0"
},
{
"name": "PGUSER",
"key": "PGUSER",
"value": "adminO8bR"
},
{
"name": "PGDATABASE",
"key": "PGDATABASE",
"value": "mydb"
}
]
}
]
},
"restartpolicy": {
"type": "RestartAlways"
}
},
"currentState": {
"manifest": {
"version": "",
"id": "",
"volumes": null,
"containers": null
},
"restartpolicy": {}
}
}
]
}</code></pre></div><div class=tab-pane id=_configs_post_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>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"kind": "Status",
"status": "success"
}
</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__configs__configID_><span class=parent>/configs</span>/{configID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_configs__configID__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_configs__configID__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_configs__configID__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__configs__configID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_configs__configID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get a specific config.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_configs__configID__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a specific config.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_configs__configID__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a specific config.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_configs__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>/configs</span>/{configID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get a specific config.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_configs__configID__get_request data-toggle=tab>Request</a></li><li><a href=#_configs__configID__get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_configs__configID__get_request><h3>URI Parameters</h3><ul><li><strong>configID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_configs__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>{
"kind": "Config",
"id": "example1",
"name": "My awesome PHP app",
"description": "Example PHP application with PostgreSQL database",
"apiVersion": "v1beta1",
"creationTimestamp": "2014-09-22T09:48:27Z",
"items": [
{
"kind": "Service",
"id": "frontend",
"creationTimestamp": null,
"apiVersion": "v1beta1",
"port": 8080,
"containerPort": 9292,
"selector": {
"name": "frontend"
}
},
{
"kind": "Service",
"id": "database",
"creationTimestamp": null,
"apiVersion": "v1beta1",
"port": 5432,
"containerPort": 5432,
"selector": {
"name": "database"
}
},
{
"kind": "ReplicationController",
"id": "frontendController",
"creationTimestamp": null,
"apiVersion": "v1beta1",
"desiredState": {
"replicas": 2,
"replicaSelector": {
"name": "frontend"
},
"podTemplate": {
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "frontendController",
"volumes": null,
"containers": [
{
"name": "nginx-php-app",
"image": "mfojtik/nginx-php-app",
"ports": [
{
"hostPort": 8080,
"containerPort": 9292,
"protocol": "TCP"
}
],
"env": [
{
"name": "PGPASSWORD",
"key": "PGPASSWORD",
"value": "MPbGM5T0"
},
{
"name": "PGUSER",
"key": "PGUSER",
"value": "adminO8bR"
},
{
"name": "PGDATABASE",
"key": "PGDATABASE",
"value": "mydb"
}
]
}
]
},
"restartpolicy": {}
},
"labels": {
"name": "frontend"
}
}
},
"labels": {
"name": "frontend"
}
},
{
"kind": "Pod",
"id": "postgresql",
"creationTimestamp": null,
"apiVersion": "v1beta1",
"labels": {
"name": "database"
},
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "database",
"volumes": null,
"containers": [
{
"name": "postgresql",
"image": "postgres",
"ports": [
{
"hostPort": 5432,
"containerPort": 5432,
"protocol": "TCP"
}
],
"env": [
{
"name": "PGPASSWORD",
"key": "PGPASSWORD",
"value": "MPbGM5T0"
},
{
"name": "PGUSER",
"key": "PGUSER",
"value": "adminO8bR"
},
{
"name": "PGDATABASE",
"key": "PGDATABASE",
"value": "mydb"
}
]
}
]
},
"restartpolicy": {
"type": "RestartAlways"
}
},
"currentState": {
"manifest": {
"version": "",
"id": "",
"volumes": null,
"containers": null
},
"restartpolicy": {}
}
}
]
}</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_configs__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>/configs</span>/{configID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update a specific config.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_configs__configID__put_request data-toggle=tab>Request</a></li><li><a href=#_configs__configID__put_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_configs__configID__put_request><h3>URI Parameters</h3><ul><li><strong>configID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_configs__configID__put_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>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"kind": "Status",
"status": "success"
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_configs__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>/configs</span>/{configID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete a specific config.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_configs__configID__delete_request data-toggle=tab>Request</a></li><li><a href=#_configs__configID__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_configs__configID__delete_request><h3>URI Parameters</h3><ul><li><strong>configID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_configs__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>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"kind": "Status",
"status": "success"
}
</code></pre></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class=panel-heading><h3 id=_deploymentConfigs class=panel-title>/deploymentConfigs</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__deploymentConfigs><span class=parent></span>/deploymentConfigs</a> <span class=methods><a href=# data-toggle=modal data-target=#_deploymentConfigs_get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_deploymentConfigs_post><span class="badge badge_post">post</span></a></span></h4></div><div id=panel__deploymentConfigs class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_deploymentConfigs_get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>List all DeploymentConfigs.</p><p>A DeploymentConfig represents a configuration for a single deployment of a replication controller: a template for the deployment, how new deployments are triggered, what the current deployed state is.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_deploymentConfigs_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=_deploymentConfigs_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>/deploymentConfigs</h4></div><div class=modal-body><div class="alert alert-info"><p>List all DeploymentConfigs.</p><p>A DeploymentConfig represents a configuration for a single deployment of a replication controller: a template for the deployment, how new deployments are triggered, what the current deployed state is.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_deploymentConfigs_get_request data-toggle=tab>Request</a></li><li><a href=#_deploymentConfigs_get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_deploymentConfigs_get_request></div><div class=tab-pane id=_deploymentConfigs_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>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"kind": "DeploymentConfigList",
"items": [
{
"id": "redisslave-config",
"kind": "DeploymentConfig",
"apiVersion": "v1beta1",
"triggerPolicy": "manual",
"template": {
"strategy": {
"type": "CustomPod",
"customPod": {
"image": "127.0.0.1:5000/openshift/origin-deployer"
}
},
"controllerTemplate": {
"replicas": 2,
"replicaSelector": {
"name": "redisslave"
},
"podTemplate": {
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "redisSlaveController",
"containers": [
{
"name": "slave",
"image": "brendanburns/redis-slave",
"env": [
{
"name": "REDIS_PASSWORD",
"value": "secret"
}
],
"ports": [
{
"containerPort": 6379
}
]
}
]
}
},
"labels": {
"name": "redisslave"
}
}
}
}
}
]
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_deploymentConfigs_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>/deploymentConfigs</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=#_deploymentConfigs_post_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_deploymentConfigs_post_request><h3>Body</h3><p><strong>Type: application/json</strong></p><p><strong>Example</strong>:</p><pre><code>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"kind": "Status",
"status": "success"
}
</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__deploymentConfigs__configID_><span class=parent>/deploymentConfigs</span>/{configID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_deploymentConfigs__configID__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_deploymentConfigs__configID__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_deploymentConfigs__configID__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__deploymentConfigs__configID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_deploymentConfigs__configID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get a specific build configuration.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_deploymentConfigs__configID__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a specific build configuration.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_deploymentConfigs__configID__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a specific build configuration.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_deploymentConfigs__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>/deploymentConfigs</span>/{configID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get a specific build configuration.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_deploymentConfigs__configID__get_request data-toggle=tab>Request</a></li><li><a href=#_deploymentConfigs__configID__get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_deploymentConfigs__configID__get_request><h3>URI Parameters</h3><ul><li><strong>configID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_deploymentConfigs__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>{
"id": "redisslave-config",
"kind": "DeploymentConfig",
"apiVersion": "v1beta1",
"triggerPolicy": "manual",
"template": {
"strategy": {
"type": "CustomPod",
"customPod": {
"image": "127.0.0.1:5000/openshift/origin-deployer"
}
},
"controllerTemplate": {
"replicas": 2,
"replicaSelector": {
"name": "redisslave"
},
"podTemplate": {
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "redisSlaveController",
"containers": [
{
"name": "slave",
"image": "brendanburns/redis-slave",
"env": [
{
"name": "REDIS_PASSWORD",
"value": "secret"
}
],
"ports": [
{
"containerPort": 6379
}
]
}
]
}
},
"labels": {
"name": "redisslave"
}
}
}
}
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_deploymentConfigs__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>/deploymentConfigs</span>/{configID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Update a specific build configuration.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_deploymentConfigs__configID__put_request data-toggle=tab>Request</a></li></ul><div class=tab-content><div class="tab-pane active" id=_deploymentConfigs__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>{
"id": "redisslave-config",
"kind": "DeploymentConfig",
"apiVersion": "v1beta1",
"triggerPolicy": "manual",
"template": {
"strategy": {
"type": "CustomPod",
"customPod": {
"image": "127.0.0.1:5000/openshift/origin-deployer"
}
},
"controllerTemplate": {
"replicas": 2,
"replicaSelector": {
"name": "redisslave"
},
"podTemplate": {
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "redisSlaveController",
"containers": [
{
"name": "slave",
"image": "brendanburns/redis-slave",
"env": [
{
"name": "REDIS_PASSWORD",
"value": "secret"
}
],
"ports": [
{
"containerPort": 6379
}
]
}
]
}
},
"labels": {
"name": "redisslave"
}
}
}
}
}
</code></pre></div></div></div></div></div></div><div class="modal fade" tabindex=0 id=_deploymentConfigs__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>/deploymentConfigs</span>/{configID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Delete a specific build configuration.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_deploymentConfigs__configID__delete_request data-toggle=tab>Request</a></li><li><a href=#_deploymentConfigs__configID__delete_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_deploymentConfigs__configID__delete_request><h3>URI Parameters</h3><ul><li><strong>configID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_deploymentConfigs__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>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"kind": "Status",
"status": "success"
}
</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>List all deployments.</p><p>A deployment represents a single unique realization of a deployment config.</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>List all deployments.</p><p>A deployment represents a single unique realization of a deployment config.</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>{
"apiVersion": "v1beta1",
"creationTimestamp": null,
"kind": "DeploymentList",
"items": [
{
"id": "redisslave-deploy",
"kind": "Deployment",
"apiVersion": "v1beta1",
"triggerPolicy": "manual",
"configId": "redisslave-config",
"strategy": {
"type": "CustomPod",
"customPod": {
"image": "127.0.0.1:5000/openshift/origin-deployer"
}
},
"controllerTemplate": {
"replicas": 2,
"replicaSelector": {
"name": "redisslave"
},
"podTemplate": {
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "redisSlaveController",
"containers": [
{
"name": "slave",
"image": "brendanburns/redis-slave",
"env": [
{
"name": "REDIS_PASSWORD",
"value": "secret"
}
],
"ports": [
{
"containerPort": 6379
}
]
}
]
}
},
"labels": {
"name": "redisslave"
}
}
}
}
]
}
</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>{
"id": "redisslave-deploy",
"kind": "Deployment",
"apiVersion": "v1beta1",
"triggerPolicy": "manual",
"configId": "redisslave-config",
"strategy": {
"type": "CustomPod",
"customPod": {
"image": "127.0.0.1:5000/openshift/origin-deployer"
}
},
"controllerTemplate": {
"replicas": 2,
"replicaSelector": {
"name": "redisslave"
},
"podTemplate": {
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "redisSlaveController",
"containers": [
{
"name": "slave",
"image": "brendanburns/redis-slave",
"env": [
{
"name": "REDIS_PASSWORD",
"value": "secret"
}
],
"ports": [
{
"containerPort": 6379
}
]
}
]
}
},
"labels": {
"name": "redisslave"
}
}
}
}
</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__deployments__deploymentID_><span class=parent>/deployments</span>/{deploymentID}</a> <span class=methods><a href=# data-toggle=modal data-target=#_deployments__deploymentID__get><span class="badge badge_get">get</span></a> <a href=# data-toggle=modal data-target=#_deployments__deploymentID__put><span class="badge badge_put">put</span></a> <a href=# data-toggle=modal data-target=#_deployments__deploymentID__delete><span class="badge badge_delete">delete</span></a></span></h4></div><div id=panel__deployments__deploymentID_ class="panel-collapse collapse"><div class=panel-body><div class=list-group><div data-toggle=modal data-target=#_deployments__deploymentID__get class=list-group-item><span class="badge badge_get">get</span><div class=method_description><p>Get details about a specific deployment.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_deployments__deploymentID__put class=list-group-item><span class="badge badge_put">put</span><div class=method_description><p>Update a specific deployment.</p></div><div class=clearfix></div></div><div data-toggle=modal data-target=#_deployments__deploymentID__delete class=list-group-item><span class="badge badge_delete">delete</span><div class=method_description><p>Delete a specific deployment.</p></div><div class=clearfix></div></div></div></div></div><div class="modal fade" tabindex=0 id=_deployments__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>/deployments</span>/{deploymentID}</h4></div><div class=modal-body><div class="alert alert-info"><p>Get details about a specific deployment.</p></div><ul class="nav nav-tabs"><li class=active><a href=#_deployments__deploymentID__get_request data-toggle=tab>Request</a></li><li><a href=#_deployments__deploymentID__get_response data-toggle=tab>Response</a></li></ul><div class=tab-content><div class="tab-pane active" id=_deployments__deploymentID__get_request><h3>URI Parameters</h3><ul><li><strong>deploymentID</strong>: <em>required (string)</em></li></ul></div><div class=tab-pane id=_deployments__deploymentID__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>{
"id": "redisslave-deploy",
"kind": "Deployment",
"apiVersion": "v1beta1",
"triggerPolicy": "manual",
"configId": "redisslave-config",
"strategy": {
"type": "CustomPod",
"customPod": {
"image": "127.0.0.1:5000/openshift/origin-deployer"
}
},
"controllerTemplate": {
"replicas": 2,
"replicaSelector": {
"name": "redisslave"
},
"podTemplate": {
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "redisSlaveController",
"containers": [
{
"name": "slave",
"image": "brendanburns/redis-slave",
"env": [
{
"name": "REDIS_PASSWORD",
"value": "secret"
}
],
"ports": [