- Remove Kubernetes API endpoints
- Link external Kubernetes API docs
- Remove some more obsolete files
- Add baseUri
| 1 | 1 |
deleted file mode 100644 |
| ... | ... |
@@ -1,9 +0,0 @@ |
| 1 |
-An image stream is a collection of images that share the same metadata. It contains multiple |
|
| 2 |
-versions of an image as it evolves over time with new builds of the codebase. |
|
| 3 |
- |
|
| 4 |
-An image stream is one of the sources of image metadata. Metadata for an image can come from one of three places: |
|
| 5 |
-* The original image binary as specified by the Dockerfile - this includes environment variables, command to execute, ports exposed, etc. |
|
| 6 |
-* The image definition in the OpenShift environment. This can be used to override metadata from the Dockerfile |
|
| 7 |
-* The image stream which overrides individual image metadata. |
|
| 8 |
- |
|
| 9 |
-Some images can be used as services while others can be used as single execution jobs. |
| 10 | 1 |
deleted file mode 100644 |
| ... | ... |
@@ -1,10 +0,0 @@ |
| 1 |
-The 3.x model attempts to expose underlying Docker and Google models as |
|
| 2 |
-accurately as possible, with a focus on easy composition of applications |
|
| 3 |
-by a developer (install Ruby, push code, add MySQL). Unlike 2.x, more |
|
| 4 |
-flexibility of configuration is exposed after creation in all aspects |
|
| 5 |
-of the model. Terminology is still being weighed, but the concept of an |
|
| 6 |
-application as a separate object is being removed in favor of more flexible |
|
| 7 |
-composition of "services" - allowing two web containers to reuse a DB, |
|
| 8 |
-or expose a DB directly to the edge of the network. |
|
| 9 |
-The existing API will continue to be supported through 3.x, |
|
| 10 |
-with concepts mapped as closely as possible to the new model. |
| ... | ... |
@@ -1,12 +1,27 @@ |
| 1 | 1 |
#%RAML 0.8 |
| 2 | 2 |
# vim: set ft=yaml: |
| 3 |
-baseUri: http://server/broker/rest |
|
| 4 | 3 |
title: OpenShift 3 |
| 5 | 4 |
version: v1beta1 |
| 5 |
+baseUri: http://localhost:8080/osapi/{version}
|
|
| 6 | 6 |
mediaType: application/json |
| 7 | 7 |
documentation: |
| 8 | 8 |
- title: Overview |
| 9 |
- content: !include doc/overview.md |
|
| 9 |
+ content: | |
|
| 10 |
+ The OpenShift 3.x model attempts to expose underlying Docker and Kubernetes |
|
| 11 |
+ models as accurately as possible, with a focus on easy composition of |
|
| 12 |
+ applications by a developer (install Ruby, push code, add MySQL). |
|
| 13 |
+ |
|
| 14 |
+ Unlike 2.x, more flexibility of configuration is exposed after creation in |
|
| 15 |
+ all aspects of the model. Terminology is still being weighed, but the |
|
| 16 |
+ concept of an application as a separate object is being removed in favor of |
|
| 17 |
+ more flexible composition of "services" - allowing two web containers to |
|
| 18 |
+ reuse a DB, or expose a DB directly to the edge of the network. The |
|
| 19 |
+ existing API will continue to be supported through 3.x, with concepts |
|
| 20 |
+ mapped as closely as possible to the new model. |
|
| 21 |
+ |
|
| 22 |
+ - title: Kubernetes API |
|
| 23 |
+ content: | |
|
| 24 |
+ OpenShift exposes [Kubernetes API](http://htmlpreview.github.io/?https://github.com/GoogleCloudPlatform/kubernetes/blob/master/api/kubernetes.html) at http://localhost:8080/api/v1beta1/. |
|
| 10 | 25 |
|
| 11 | 26 |
/projects: |
| 12 | 27 |
displayName: /projects (NOT IMPLEMENTED) |
| ... | ... |
@@ -494,99 +509,3 @@ documentation: |
| 494 | 494 |
200: |
| 495 | 495 |
body: |
| 496 | 496 |
example: !include examples/status-success.json |
| 497 |
- |
|
| 498 |
-/pods: |
|
| 499 |
- get: |
|
| 500 |
- description: List all pods on this cluster. |
|
| 501 |
- responses: |
|
| 502 |
- 200: |
|
| 503 |
- body: |
|
| 504 |
- example: !include examples/pod-list.json |
|
| 505 |
- post: |
|
| 506 |
- description: Create a new pod. currentState is ignored if present. |
|
| 507 |
- body: |
|
| 508 |
- schema: !include doc/pod-schema.json |
|
| 509 |
- example: !include examples/pod.json |
|
| 510 |
- |
|
| 511 |
- /{podID}:
|
|
| 512 |
- get: |
|
| 513 |
- description: Get a specific pod. |
|
| 514 |
- responses: |
|
| 515 |
- 200: |
|
| 516 |
- body: |
|
| 517 |
- example: !include examples/pod.json |
|
| 518 |
- put: |
|
| 519 |
- description: Update a specific pod. |
|
| 520 |
- body: |
|
| 521 |
- schema: !include doc/pod-schema.json |
|
| 522 |
- example: !include examples/pod.json |
|
| 523 |
- delete: |
|
| 524 |
- description: Delete a specific pod. |
|
| 525 |
- responses: |
|
| 526 |
- 200: |
|
| 527 |
- body: |
|
| 528 |
- example: !include examples/status-success.json |
|
| 529 |
- |
|
| 530 |
-/replicationControllers: |
|
| 531 |
- get: |
|
| 532 |
- description: List all replicationControllers on this cluster. |
|
| 533 |
- responses: |
|
| 534 |
- 200: |
|
| 535 |
- body: |
|
| 536 |
- example: !include examples/controller-list.json |
|
| 537 |
- post: |
|
| 538 |
- description: Create a new controller. currentState is ignored if present. |
|
| 539 |
- body: |
|
| 540 |
- schema: !include doc/controller-schema.json |
|
| 541 |
- example: !include examples/controller.json |
|
| 542 |
- |
|
| 543 |
- /{controllerID}:
|
|
| 544 |
- get: |
|
| 545 |
- description: Get a specific controller. |
|
| 546 |
- responses: |
|
| 547 |
- 200: |
|
| 548 |
- body: |
|
| 549 |
- example: !include examples/controller.json |
|
| 550 |
- put: |
|
| 551 |
- description: Update a specific controller. |
|
| 552 |
- body: |
|
| 553 |
- schema: !include doc/controller-schema.json |
|
| 554 |
- example: !include examples/controller.json |
|
| 555 |
- delete: |
|
| 556 |
- description: Delete a specific controller. |
|
| 557 |
- responses: |
|
| 558 |
- 200: |
|
| 559 |
- body: |
|
| 560 |
- example: !include examples/status-success.json |
|
| 561 |
- |
|
| 562 |
-/services: |
|
| 563 |
- get: |
|
| 564 |
- description: List all services on this cluster. |
|
| 565 |
- responses: |
|
| 566 |
- 200: |
|
| 567 |
- body: |
|
| 568 |
- example: !include examples/service-list.json |
|
| 569 |
- post: |
|
| 570 |
- description: Create a new service. |
|
| 571 |
- body: |
|
| 572 |
- schema: !include doc/service-schema.json |
|
| 573 |
- example: !include examples/service.json |
|
| 574 |
- |
|
| 575 |
- /{serviceID}:
|
|
| 576 |
- get: |
|
| 577 |
- description: Get a specific service. |
|
| 578 |
- responses: |
|
| 579 |
- 200: |
|
| 580 |
- body: |
|
| 581 |
- example: !include examples/service.json |
|
| 582 |
- put: |
|
| 583 |
- description: Update a specific service. |
|
| 584 |
- body: |
|
| 585 |
- schema: !include doc/service-schema.json |
|
| 586 |
- example: !include examples/service.json |
|
| 587 |
- delete: |
|
| 588 |
- description: Delete a specific service. |
|
| 589 |
- responses: |
|
| 590 |
- 200: |
|
| 591 |
- body: |
|
| 592 |
- example: !include examples/status-success.json |