feat(ps): query k8s to get the ps:list information instead of db

Fetches all the information directly from k8s and uses the pod name in the output. Can no longer do a limit fetch as the k8s API does not support it

Fixes #160

Author: helgi

client/cmd/ps.go

@@ -14,7 +14,6 @@ import (
 // PsList lists an app's processes.
 func PsList(appID string, results int) error {
 	c, appID, err := load(appID)
-
 	if err != nil {
 		return err
 	}
@@ -23,13 +22,12 @@ func PsList(appID string, results int) error {
 		results = c.ResponseLimit
 	}
 
-	processes, count, err := ps.List(c, appID, results)
-
+	processes, _, err := ps.List(c, appID, results)
 	if err != nil {
 		return err
 	}
 
-	printProcesses(appID, processes, count)
+	printProcesses(appID, processes)
 
 	return nil
 }
@@ -73,13 +71,12 @@ func PsScale(appID string, targets []string) error {
 
 	fmt.Printf("done in %ds\n", int(time.Since(startTime).Seconds()))
 
-	processes, count, err := ps.List(c, appID, c.ResponseLimit)
-
+	processes, _, err := ps.List(c, appID, c.ResponseLimit)
 	if err != nil {
 		return err
 	}
 
-	printProcesses(appID, processes, count)
+	printProcesses(appID, processes)
 	return nil
 }
 
@@ -123,26 +120,25 @@ func PsRestart(appID, target string) error {
 
 	fmt.Printf("done in %ds\n", int(time.Since(startTime).Seconds()))
 
-	processes, count, err := ps.List(c, appID, c.ResponseLimit)
-
+	processes, _, err := ps.List(c, appID, c.ResponseLimit)
 	if err != nil {
 		return err
 	}
 
-	printProcesses(appID, processes, count)
+	printProcesses(appID, processes)
 	return nil
 }
 
-func printProcesses(appID string, processes []api.Process, count int) {
+func printProcesses(appID string, processes []api.Pods) {
 	psMap := ps.ByType(processes)
 
-	fmt.Printf("=== %s Processes%s", appID, limitCount(len(processes), count))
+	fmt.Printf("=== %s Processes\n", appID)
 
 	for psType, procs := range psMap {
 		fmt.Printf("--- %s:\n", psType)
 
 		for _, proc := range procs {
-			fmt.Printf("%s.%d %s (%s)\n", proc.Type, proc.Num, proc.State, proc.Release)
+			fmt.Printf("%s %s (%s)\n", proc.Name, proc.State, proc.Release)
 		}
 	}
 }

client/controller/api/ps.go

@@ -12,3 +12,11 @@ type Process struct {
 	Num     int    `json:"num"`
 	State   string `json:"state"`
 }
+
+// Pods defines the structure of a process.
+type Pods struct {
+	Release string `json:"release"`
+	Type    string `json:"type"`
+	Name    string `json:"name"`
+	State   string `json:"state"`
+}

client/controller/models/ps/ps.go

@@ -10,17 +10,16 @@ import (
 )
 
 // List an app's processes.
-func List(c *client.Client, appID string, results int) ([]api.Process, int, error) {
-	u := fmt.Sprintf("/v2/apps/%s/containers/", appID)
+func List(c *client.Client, appID string, results int) ([]api.Pods, int, error) {
+	u := fmt.Sprintf("/v2/apps/%s/pods/", appID)
 	body, count, err := c.LimitedRequest(u, results)
-
 	if err != nil {
-		return []api.Process{}, -1, err
+		return []api.Pods{}, -1, err
 	}
 
-	var procs []api.Process
+	var procs []api.Pods
 	if err = json.Unmarshal([]byte(body), &procs); err != nil {
-		return []api.Process{}, -1, err
+		return []api.Pods{}, -1, err
 	}
 
 	return procs, count, nil
@@ -69,8 +68,8 @@ func Restart(c *client.Client, appID string, procType string, num int) ([]api.Pr
 }
 
 // ByType organizes processes of an app by process type.
-func ByType(processes []api.Process) map[string][]api.Process {
-	psMap := make(map[string][]api.Process)
+func ByType(processes []api.Pods) map[string][]api.Pods {
+	psMap := make(map[string][]api.Pods)
 
 	for _, ps := range processes {
 		psMap[ps.Type] = append(psMap[ps.Type], ps)

client/controller/models/ps/ps_test.go

@@ -21,14 +21,9 @@ const processesFixture string = `
     "previous": null,
     "results": [
         {
-            "owner": "test",
-            "app": "example-go",
             "release": "v2",
-            "created": "2014-01-01T00:00:00UTC",
-            "updated": "2014-01-01T00:00:00UTC",
-            "uuid": "de1bf5b5-4a72-4f94-a10c-d2a3741cdf75",
             "type": "web",
-            "num": 1,
+            "name": "example-go-v2-web-45678",
             "state": "up"
         }
     ]
@@ -86,7 +81,7 @@ type fakeHTTPServer struct{}
 func (fakeHTTPServer) ServeHTTP(res http.ResponseWriter, req *http.Request) {
 	res.Header().Add("DEIS_API_VERSION", version.APIVersion)
 
-	if req.URL.Path == "/v2/apps/example-go/containers/" && req.Method == "GET" {
+	if req.URL.Path == "/v2/apps/example-go/pods/" && req.Method == "GET" {
 		res.Write([]byte(processesFixture))
 		return
 	}
@@ -135,16 +130,11 @@ func (fakeHTTPServer) ServeHTTP(res http.ResponseWriter, req *http.Request) {
 func TestProcessesList(t *testing.T) {
 	t.Parallel()
 
-	expected := []api.Process{
+	expected := []api.Pods{
 		{
-			Owner:   "test",
-			App:     "example-go",
 			Release: "v2",
-			Created: "2014-01-01T00:00:00UTC",
-			Updated: "2014-01-01T00:00:00UTC",
-			UUID:    "de1bf5b5-4a72-4f94-a10c-d2a3741cdf75",
 			Type:    "web",
-			Num:     1,
+			Name:    "example-go-v2-web-45678",
 			State:   "up",
 		},
 	}

client/parser/ps.go

@@ -48,23 +48,15 @@ Usage: deis ps:list [options]
 Options:
   -a --app=<app>
     the uniquely identifiable name for the application.
-  -l --limit=<num>
-    the maximum number of results to display, defaults to config setting
 `
 
 	args, err := docopt.Parse(usage, argv, true, "", false, true)
-
-	if err != nil {
-		return err
-	}
-
-	results, err := responseLimit(safeGetValue(args, "--limit"))
-
 	if err != nil {
 		return err
 	}
 
-	return cmd.PsList(safeGetValue(args, "--app"), results)
+	// The 1000 is fake for now until API understands limits
+	return cmd.PsList(safeGetValue(args, "--app"), 1000)
 }
 
 func psRestart(argv []string) error {

rootfs/api/models/app.py

@@ -44,6 +44,10 @@ def validate_reserved_names(value):
         raise ValidationError('{} is a reserved name.'.format(value))
 
 
+class Pod(object):
+    pass
+
+
 class App(UuidAuditedModel):
     """
     Application used to service requests on behalf of end-users
@@ -428,3 +432,40 @@ def run(self, user, command):
         # SECURITY: shell-escape user input
         escaped_command = command.replace("'", "'\\''")
         return c.run(escaped_command)
+
+    def list_pods(self, *args, **kwargs):
+        """Used to list basic information about pods running for a given application"""
+        try:
+            labels = {'app': str(self)}
+
+            if 'release' in kwargs:
+                if kwargs['release'] is None:
+                    release = self.release_set.latest()
+
+                version = "v{}".format(release.version)
+                labels.update({'version': version})
+
+            if 'type' in kwargs:
+                labels.update({'type': kwargs['type']})
+
+            pods = self._scheduler._get_pods(str(self), labels=labels).json()
+
+            data = []
+            for pod in pods['items']:
+                # specifically ignore run pods
+                if pod['metadata']['labels']['type'] == 'run':
+                    continue
+
+                item = Pod()
+                item.name = pod['metadata']['name']
+                item.state = self._scheduler.resolve_state(pod).name
+                item.release = pod['metadata']['labels']['version']
+                item.type = pod['metadata']['labels']['type']
+
+                data.append(item)
+
+            return data
+        except Exception as e:
+            err = '(list pods): {}'.format(e)
+            log_event(self, err, logging.ERROR)
+            raise

rootfs/api/serializers.py

@@ -309,3 +309,18 @@ class Meta:
         model = models.Push
         fields = ['owner', 'app', 'sha', 'fingerprint', 'receive_user', 'receive_repo',
                   'ssh_connection', 'ssh_original_command', 'created', 'updated']
+
+
+class PodSerializer(serializers.BaseSerializer):
+    name = serializers.CharField()
+    state = serializers.CharField()
+    type = serializers.CharField()
+    release = serializers.CharField()
+
+    def to_representation(self, obj):
+        return {
+            'name': obj.name,
+            'state': obj.state,
+            'type': obj.type,
+            'release': obj.release
+        }

rootfs/api/urls.py

@@ -44,6 +44,14 @@
         views.ContainerViewSet.as_view({'get': 'list'})),
     url(r"^apps/(?P<id>{})/containers/?".format(settings.APP_URL_REGEX),
         views.ContainerViewSet.as_view({'get': 'list'})),
+    # list pods
+    url(r"^apps/(?P<id>{})/pods/(?P<type>[-_\w]+)/(?P<name>[-_\w]+)/?".format(
+        settings.APP_URL_REGEX),
+        views.PodViewSet.as_view({'get': 'list'})),
+    url(r"^apps/(?P<id>{})/pods/(?P<type>[-_\w.]+)/?".format(settings.APP_URL_REGEX),
+        views.PodViewSet.as_view({'get': 'list'})),
+    url(r"^apps/(?P<id>{})/pods/?".format(settings.APP_URL_REGEX),
+        views.PodViewSet.as_view({'get': 'list'})),
     # application domains
     url(r"^apps/(?P<id>{})/domains/(?P<domain>\**\.?[-\._\w]+)/?".format(settings.APP_URL_REGEX),
         views.DomainViewSet.as_view({'delete': 'destroy'})),

rootfs/api/views.py

@@ -335,6 +335,23 @@ def restart(self, *args, **kwargs):
             return Response({'detail': str(e)}, status=status.HTTP_503_SERVICE_UNAVAILABLE)
 
 
+class PodViewSet(AppResourceViewSet):
+    model = models.App
+    serializer_class = serializers.PodSerializer
+
+    def list(self, *args, **kwargs):
+        app = self.get_app()
+
+        try:
+            pods = app.list_pods(*args, **kwargs)
+            data = self.get_serializer(pods, many=True).data
+            # fake out pagination for now
+            pagination = {'results': data, 'count': len(data)}
+            return Response(pagination, status=status.HTTP_200_OK)
+        except Exception as e:
+            return Response({'detail': str(e)}, status=status.HTTP_503_SERVICE_UNAVAILABLE)
+
+
 class DomainViewSet(AppResourceViewSet):
     """A viewset for interacting with Domain objects."""
     model = models.Domain