Skip to content

Commit a3a444d

Browse files
author
Matthew Fisher
committed
ref(reference-guide): remove containers for pods
1 parent 7bdd02a commit a3a444d

1 file changed

Lines changed: 32 additions & 56 deletions

File tree

  • src/reference-guide/controller-api

src/reference-guide/controller-api/v2.0.md

Lines changed: 32 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -483,14 +483,14 @@ DEIS_API_VERSION: 2.0
483483
DEIS_PLATFORM_VERSION: 1.12.1
484484
```
485485

486-
## Containers
486+
## Pods
487487

488-
### List all Containers
488+
### List all Pods
489489

490490
Example Request:
491491

492492
```
493-
GET /v1/apps/example-go/containers/ HTTP/1.1
493+
GET /v1/apps/example-go/pods/ HTTP/1.1
494494
Host: deis.example.com
495495
Authorization: token abc123
496496
```
@@ -505,30 +505,24 @@ Content-Type: application/json
505505
506506
{
507507
"count": 1,
508-
"next": null,
509-
"previous": null,
510508
"results": [
511509
{
512-
"owner": "test",
513-
"app": "example-go",
510+
"name": "go-v2-web-e7dej",
514511
"release": "v2",
515-
"created": "2014-01-01T00:00:00UTC",
516-
"updated": "2014-01-01T00:00:00UTC",
517-
"uuid": "de1bf5b5-4a72-4f94-a10c-d2a3741cdf75",
518-
"type": "web",
519-
"num": 1,
520-
"state": "up"
512+
"started": "2014-01-01T00:00:00Z",
513+
"state": "up",
514+
"type": "web"
521515
}
522516
]
523517
}
524518
```
525519

526-
### List all Containers by Type
520+
### List all Pods by Type
527521

528522
Example Request:
529523

530524
```
531-
GET /v1/apps/example-go/containers/web/ HTTP/1.1
525+
GET /v1/apps/example-go/pods/web/ HTTP/1.1
532526
Host: deis.example.com
533527
Authorization: token abc123
534528
```
@@ -543,30 +537,24 @@ Content-Type: application/json
543537
544538
{
545539
"count": 1,
546-
"next": null,
547-
"previous": null,
548540
"results": [
549541
{
550-
"owner": "test",
551-
"app": "example-go",
542+
"name": "go-v2-web-e7dej",
552543
"release": "v2",
553-
"created": "2014-01-01T00:00:00UTC",
554-
"updated": "2014-01-01T00:00:00UTC",
555-
"uuid": "de1bf5b5-4a72-4f94-a10c-d2a3741cdf75",
556-
"type": "web",
557-
"num": 1,
558-
"state": "up"
544+
"started": "2014-01-01T00:00:00Z",
545+
"state": "up",
546+
"type": "web"
559547
}
560548
]
561549
}
562550
```
563551

564-
### Restart All Containers
552+
### Restart All Pods
565553

566554
Example Request:
567555

568556
```
569-
POST /v1/apps/example-go/containers/restart/ HTTP/1.1
557+
POST /v1/apps/example-go/pods/restart/ HTTP/1.1
570558
Host: deis.example.com
571559
Authorization: token abc123
572560
```
@@ -581,25 +569,21 @@ Content-Type: application/json
581569
582570
[
583571
{
584-
"owner": "test",
585-
"app": "example-go",
572+
"name": "go-v2-web-atots",
586573
"release": "v2",
587-
"created": "2014-01-01T00:00:00UTC",
588-
"updated": "2014-01-01T00:00:00UTC",
589-
"uuid": "de1bf5b5-4a72-4f94-a10c-d2a3741cdf75",
590-
"type": "web",
591-
"num": 1,
592-
"state": "up"
574+
"started": "2016-04-11T21:07:54Z",
575+
"state": "up",
576+
"type": "web"
593577
}
594578
]
595579
```
596580

597-
### Restart Containers by Type
581+
### Restart Pods by Type
598582

599583
Example Request:
600584

601585
```
602-
POST /v1/apps/example-go/containers/web/restart/ HTTP/1.1
586+
POST /v1/apps/example-go/pods/web/restart/ HTTP/1.1
603587
Host: deis.example.com
604588
Authorization: token abc123
605589
```
@@ -614,25 +598,21 @@ Content-Type: application/json
614598
615599
[
616600
{
617-
"owner": "test",
618-
"app": "example-go",
601+
"name": "go-v2-web-atots",
619602
"release": "v2",
620-
"created": "2014-01-01T00:00:00UTC",
621-
"updated": "2014-01-01T00:00:00UTC",
622-
"uuid": "de1bf5b5-4a72-4f94-a10c-d2a3741cdf75",
623-
"type": "web",
624-
"num": 1,
625-
"state": "up"
603+
"started": "2016-04-11T21:07:54Z",
604+
"state": "up",
605+
"type": "web"
626606
}
627607
]
628608
```
629609

630-
### Restart Containers by Type and Number
610+
### Restart Pods by Type and Name
631611

632612
Example Request:
633613

634614
```
635-
POST /v1/apps/example-go/containers/web/1/restart/ HTTP/1.1
615+
POST /v1/apps/example-go/pods/go-v2-web-atots/restart/ HTTP/1.1
636616
Host: deis.example.com
637617
Authorization: token abc123
638618
```
@@ -647,20 +627,16 @@ Content-Type: application/json
647627
648628
[
649629
{
650-
"owner": "test",
651-
"app": "example-go",
630+
"name": "go-v2-web-atots",
652631
"release": "v2",
653-
"created": "2014-01-01T00:00:00UTC",
654-
"updated": "2014-01-01T00:00:00UTC",
655-
"uuid": "de1bf5b5-4a72-4f94-a10c-d2a3741cdf75",
656-
"type": "web",
657-
"num": 1,
658-
"state": "up"
632+
"started": "2016-04-11T21:07:54Z",
633+
"state": "up",
634+
"type": "web"
659635
}
660636
]
661637
```
662638

663-
### Scale Containers
639+
### Scale Pods
664640

665641
Example Request:
666642

0 commit comments

Comments
 (0)