Introduce ObjectMeta and TypeMeta information to presentation models (#729)

With this we'll be able to do generic stuff, e.g., deletion or YAML
edition.

Author: bryk

src/app/backend/resource/common/types.go

@@ -16,9 +16,76 @@ package common
 
 import (
 	"bytes"
+
 	"k8s.io/kubernetes/pkg/api"
+	"k8s.io/kubernetes/pkg/api/unversioned"
 )
 
+type ResourceType string
+
+const (
+	ResourceTypeReplicaSet            = "replicaset"
+	ResourceTypeReplicationController = "replicationcontroller"
+)
+
+func CreateObjectMeta(k8SObjectMeta api.ObjectMeta) ObjectMeta {
+	return ObjectMeta{
+		Name:              k8SObjectMeta.Name,
+		Namespace:         k8SObjectMeta.Namespace,
+		Labels:            k8SObjectMeta.Labels,
+		CreationTimestamp: k8SObjectMeta.CreationTimestamp,
+	}
+}
+
+func CreateTypeMeta(k8STypeMeta unversioned.TypeMeta) TypeMeta {
+	return TypeMeta{
+		Kind: k8STypeMeta.Kind,
+	}
+}
+
+type ObjectMeta struct {
+	// Name is unique within a namespace. Name is primarily intended for creation
+	// idempotence and configuration definition.
+	Name string `json:"name,omitempty"`
+
+	// Namespace defines the space within which name must be unique. An empty namespace is
+	// equivalent to the "default" namespace, but "default" is the canonical representation.
+	// Not all objects are required to be scoped to a namespace - the value of this field for
+	// those objects will be empty.
+	Namespace string `json:"namespace,omitempty"`
+
+	// Labels are key value pairs that may be used to scope and select individual resources.
+	// Label keys are of the form:
+	//     label-key ::= prefixed-name | name
+	//     prefixed-name ::= prefix '/' name
+	//     prefix ::= DNS_SUBDOMAIN
+	//     name ::= DNS_LABEL
+	// The prefix is optional.  If the prefix is not specified, the key is assumed to be private
+	// to the user.  Other system components that wish to use labels must specify a prefix.
+	Labels map[string]string `json:"labels,omitempty"`
+
+	// Annotations are unstructured key value data stored with a resource that may be set by
+	// external tooling. They are not queryable and should be preserved when modifying
+	// objects.  Annotation keys have the same formatting restrictions as Label keys. See the
+	// comments on Labels for details.
+	Annotations map[string]string `json:"annotations,omitempty"`
+
+	// CreationTimestamp is a timestamp representing the server time when this object was
+	// created. It is not guaranteed to be set in happens-before order across separate operations.
+	// Clients may not set this value. It is represented in RFC3339 form and is in UTC.
+	CreationTimestamp unversioned.Time `json:"creationTimestamp,omitempty"`
+}
+
+// TypeMeta describes an individual object in an API response or request
+// with strings representing the type of the object.
+type TypeMeta struct {
+	// Kind is a string value representing the REST resource this object represents.
+	// Servers may infer this from the endpoint the client submits requests to.
+	// In smalllettercase.
+	// More info: http://releases.k8s.io/HEAD/docs/devel/api-conventions.md#types-kinds
+	Kind string `json:"kind,omitempty"`
+}
+
 // Endpoint describes an endpoint that is host and a list of available ports for that host.
 type Endpoint struct {
 	// Hostname, either as a domain name or IP address.

src/app/backend/resource/deployment/deploymentlist.go

@@ -21,7 +21,6 @@ import (
 	"github.com/kubernetes/dashboard/resource/replicationcontroller"
 	"k8s.io/kubernetes/pkg/api"
 	k8serrors "k8s.io/kubernetes/pkg/api/errors"
-	"k8s.io/kubernetes/pkg/api/unversioned"
 	"k8s.io/kubernetes/pkg/apis/extensions"
 	client "k8s.io/kubernetes/pkg/client/unversioned"
 )
@@ -36,28 +35,19 @@ type DeploymentList struct {
 // it is Deployment plus additional augumented data we can get from other sources
 // (like services that target the same pods).
 type Deployment struct {
-	// Name of the Deployment.
-	Name string `json:"name"`
-
-	// Namespace this Deployment is in.
-	Namespace string `json:"namespace"`
-
-	// Label of this Deployment.
-	Labels map[string]string `json:"labels"`
+	ObjectMeta common.ObjectMeta `json:"objectMeta"`
+	TypeMeta   common.TypeMeta   `json:"typeMeta"`
 
 	// Aggregate information about pods belonging to this Deployment.
 	Pods common.PodInfo `json:"pods"`
 
 	// Container images of the Deployment.
 	ContainerImages []string `json:"containerImages"`
-
-	// Time the replication controller was created.
-	CreationTime unversioned.Time `json:"creationTime"`
 }
 
 // GetDeploymentList returns a list of all Deployments in the cluster.
 func GetDeploymentList(client client.Interface) (*DeploymentList, error) {
-	log.Printf("Getting list of all replica sets in the cluster")
+	log.Printf("Getting list of all deployments in the cluster")
 
 	channels := &common.ResourceChannels{
 		DeploymentList: common.GetDeploymentListChannel(client.Extensions(), 1),
@@ -126,12 +116,10 @@ func getDeploymentList(deployments []extensions.Deployment,
 
 		deploymentList.Deployments = append(deploymentList.Deployments,
 			Deployment{
-				Name:            deployment.ObjectMeta.Name,
-				Namespace:       deployment.ObjectMeta.Namespace,
-				Labels:          deployment.ObjectMeta.Labels,
+				ObjectMeta:      common.CreateObjectMeta(deployment.ObjectMeta),
+				TypeMeta:        common.CreateTypeMeta(deployment.TypeMeta),
 				ContainerImages: replicationcontroller.GetContainerImages(&deployment.Spec.Template.Spec),
 				Pods:            podInfo,
-				CreationTime:    deployment.ObjectMeta.CreationTimestamp,
 			})
 	}
 

src/app/backend/resource/pod/podlist.go

@@ -20,7 +20,6 @@ import (
 	"github.com/kubernetes/dashboard/client"
 	"github.com/kubernetes/dashboard/resource/common"
 	"k8s.io/kubernetes/pkg/api"
-	"k8s.io/kubernetes/pkg/api/unversioned"
 	k8sClient "k8s.io/kubernetes/pkg/client/unversioned"
 )
 
@@ -34,21 +33,12 @@ type PodList struct {
 // it is Pod plus additional augumented data we can get from other sources
 // (like services that target it).
 type Pod struct {
-	// Name of the Pod.
-	Name string `json:"name"`
-
-	// Namespace this Pod is in.
-	Namespace string `json:"namespace"`
-
-	// Label of this Pod.
-	Labels map[string]string `json:"labels"`
+	ObjectMeta common.ObjectMeta `json:"objectMeta"`
+	TypeMeta   common.TypeMeta   `json:"typeMeta"`
 
 	// Container images of the Pod.
 	ContainerImages []string `json:"containerImages"`
 
-	// Time the replication controller was created.
-	CreationTime unversioned.Time `json:"creationTime"`
-
 	// Status of the Pod. See Kubernetes API for reference.
 	PodPhase api.PodPhase `json:"podPhase"`
 
@@ -102,11 +92,10 @@ func CreatePodList(pods []api.Pod, heapsterClient client.HeapsterClient) PodList
 
 	for _, pod := range pods {
 		podDetail := Pod{
-			Name:         pod.Name,
+			ObjectMeta:   common.CreateObjectMeta(pod.ObjectMeta),
+			TypeMeta:     common.CreateTypeMeta(pod.TypeMeta),
 			PodPhase:     pod.Status.Phase,
-			CreationTime: pod.ObjectMeta.CreationTimestamp,
 			PodIP:        pod.Status.PodIP,
-			NodeName:     pod.Spec.NodeName,
 			RestartCount: getRestartCount(pod),
 		}
 		if metrics != nil && metrics.MetricsMap[pod.Namespace] != nil {

src/app/backend/resource/replicaset/replicasetlist.go

@@ -21,7 +21,6 @@ import (
 	"github.com/kubernetes/dashboard/resource/replicationcontroller"
 	"k8s.io/kubernetes/pkg/api"
 	k8serrors "k8s.io/kubernetes/pkg/api/errors"
-	"k8s.io/kubernetes/pkg/api/unversioned"
 	"k8s.io/kubernetes/pkg/apis/extensions"
 	client "k8s.io/kubernetes/pkg/client/unversioned"
 )
@@ -36,23 +35,14 @@ type ReplicaSetList struct {
 // it is Replica Set plus additional augumented data we can get from other sources
 // (like services that target the same pods).
 type ReplicaSet struct {
-	// Name of the Replica Set.
-	Name string `json:"name"`
-
-	// Namespace this Replica Set is in.
-	Namespace string `json:"namespace"`
-
-	// Label of this Replica Set.
-	Labels map[string]string `json:"labels"`
+	ObjectMeta common.ObjectMeta `json:"objectMeta"`
+	TypeMeta   common.TypeMeta   `json:"typeMeta"`
 
 	// Aggregate information about pods belonging to this Replica Set.
 	Pods common.PodInfo `json:"pods"`
 
 	// Container images of the Replica Set.
 	ContainerImages []string `json:"containerImages"`
-
-	// Time the replication controller was created.
-	CreationTime unversioned.Time `json:"creationTime"`
 }
 
 // GetReplicaSetList returns a list of all Replica Sets in the cluster.
@@ -126,12 +116,10 @@ func getReplicaSetList(replicaSets []extensions.ReplicaSet,
 
 		replicaSetList.ReplicaSets = append(replicaSetList.ReplicaSets,
 			ReplicaSet{
-				Name:            replicaSet.ObjectMeta.Name,
-				Namespace:       replicaSet.ObjectMeta.Namespace,
-				Labels:          replicaSet.ObjectMeta.Labels,
+				ObjectMeta:      common.CreateObjectMeta(replicaSet.ObjectMeta),
+				TypeMeta:        common.CreateTypeMeta(replicaSet.TypeMeta),
 				ContainerImages: replicationcontroller.GetContainerImages(&replicaSet.Spec.Template.Spec),
 				Pods:            podInfo,
-				CreationTime:    replicaSet.ObjectMeta.CreationTimestamp,
 			})
 	}
 

src/app/backend/resource/replicationcontroller/replicationcontrollerdetail.go

@@ -29,14 +29,8 @@ import (
 
 // ReplicationControllerDetail represents detailed information about a Replication Controller.
 type ReplicationControllerDetail struct {
-	// Name of the Replication Controller.
-	Name string `json:"name"`
-
-	// Namespace the Replication Controller is in.
-	Namespace string `json:"namespace"`
-
-	// Label mapping of the Replication Controller.
-	Labels map[string]string `json:"labels"`
+	ObjectMeta common.ObjectMeta `json:"objectMeta"`
+	TypeMeta   common.TypeMeta   `json:"typeMeta"`
 
 	// Label selector of the Replication Controller.
 	LabelSelector map[string]string `json:"labelSelector"`
@@ -91,9 +85,8 @@ func GetReplicationControllerDetail(client k8sClient.Interface, heapsterClient c
 	}
 
 	replicationControllerDetail := &ReplicationControllerDetail{
-		Name:          replicationController.Name,
-		Namespace:     replicationController.Namespace,
-		Labels:        replicationController.ObjectMeta.Labels,
+		ObjectMeta:    common.CreateObjectMeta(replicationController.ObjectMeta),
+		TypeMeta:      common.CreateTypeMeta(replicationController.TypeMeta),
 		LabelSelector: replicationController.Spec.Selector,
 		PodInfo:       getReplicationPodInfo(replicationController, pods.Items),
 	}
@@ -102,7 +95,7 @@ func GetReplicationControllerDetail(client k8sClient.Interface, heapsterClient c
 
 	for _, service := range matchingServices {
 		replicationControllerDetail.Services = append(replicationControllerDetail.Services,
-			getServiceDetail(service, *replicationController, pods.Items, nodes.Items))
+			getService(service, *replicationController, pods.Items, nodes.Items))
 	}
 
 	for _, container := range replicationController.Spec.Template.Spec.Containers {
@@ -208,10 +201,11 @@ func UpdateReplicasCount(client k8sClient.Interface, namespace, name string,
 }
 
 // Returns detailed information about service from given service
-func getServiceDetail(service api.Service, replicationController api.ReplicationController,
+func getService(service api.Service, replicationController api.ReplicationController,
 	pods []api.Pod, nodes []api.Node) resourceService.Service {
 	return resourceService.Service{
-		Name: service.ObjectMeta.Name,
+		ObjectMeta: common.CreateObjectMeta(service.ObjectMeta),
+		TypeMeta:   common.CreateTypeMeta(service.TypeMeta),
 		InternalEndpoint: common.GetInternalEndpoint(service.Name, service.Namespace,
 			service.Spec.Ports),
 		ExternalEndpoints: getExternalEndpoints(replicationController, pods, service, nodes),

src/app/backend/resource/replicationcontroller/replicationcontrollerlist.go

@@ -18,10 +18,8 @@ import (
 	"log"
 
 	"github.com/kubernetes/dashboard/resource/common"
-	// TODO(maciaszczykm): Avoid using dot-imports.
-	. "github.com/kubernetes/dashboard/resource/event"
+	"github.com/kubernetes/dashboard/resource/event"
 	"k8s.io/kubernetes/pkg/api"
-	"k8s.io/kubernetes/pkg/api/unversioned"
 	client "k8s.io/kubernetes/pkg/client/unversioned"
 )
 
@@ -34,27 +32,15 @@ type ReplicationControllerList struct {
 // ReplicationController (aka. Replication Controller) plus zero or more Kubernetes services that
 // target the Replication Controller.
 type ReplicationController struct {
-	// Name of the Replication Controller.
-	Name string `json:"name"`
-
-	// Namespace this Replication Controller is in.
-	Namespace string `json:"namespace"`
-
-	// Human readable description of this Replication Controller.
-	Description string `json:"description"`
-
-	// Label of this Replication Controller.
-	Labels map[string]string `json:"labels"`
+	ObjectMeta common.ObjectMeta `json:"objectMeta"`
+	TypeMeta   common.TypeMeta   `json:"typeMeta"`
 
 	// Aggregate information about pods belonging to this Replication Controller.
 	Pods common.PodInfo `json:"pods"`
 
 	// Container images of the Replication Controller.
 	ContainerImages []string `json:"containerImages"`
 
-	// Time the replication controller was created.
-	CreationTime unversioned.Time `json:"creationTime"`
-
 	// Internal endpoints of all Kubernetes services have the same label selector as this Replication Controller.
 	InternalEndpoints []common.Endpoint `json:"internalEndpoints"`
 
@@ -143,19 +129,16 @@ func getReplicationControllerList(replicationControllers []api.ReplicationContro
 			}
 		}
 		podInfo := getReplicationPodInfo(&replicationController, matchingPods)
-		podErrors := GetPodsEventWarnings(events, matchingPods)
+		podErrors := event.GetPodsEventWarnings(events, matchingPods)
 
 		podInfo.Warnings = podErrors
 
 		replicationControllerList.ReplicationControllers = append(replicationControllerList.ReplicationControllers,
 			ReplicationController{
-				Name:              replicationController.ObjectMeta.Name,
-				Namespace:         replicationController.ObjectMeta.Namespace,
-				Description:       replicationController.Annotations[DescriptionAnnotationKey],
-				Labels:            replicationController.ObjectMeta.Labels,
+				ObjectMeta:        common.CreateObjectMeta(replicationController.ObjectMeta),
+				TypeMeta:          common.CreateTypeMeta(replicationController.TypeMeta),
 				Pods:              podInfo,
 				ContainerImages:   GetContainerImages(&replicationController.Spec.Template.Spec),
-				CreationTime:      replicationController.ObjectMeta.CreationTimestamp,
 				InternalEndpoints: internalEndpoints,
 				ExternalEndpoints: externalEndpoints,
 			})