watcher.go

package usage

import (
	context2 "context"
	"fmt"

	"github.com/caicloud/nirvana/log"
	appsv1 "k8s.io/api/apps/v1"
	corev1 "k8s.io/api/core/v1"
	"k8s.io/apimachinery/pkg/api/resource"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/client-go/kubernetes"

	"github.com/caicloud/cyclone/pkg/apis/cyclone/v1alpha1"
	"github.com/caicloud/cyclone/pkg/meta"
	"github.com/caicloud/cyclone/pkg/server/common"
	"github.com/caicloud/cyclone/pkg/server/config"
)

const (
	// ReportURLEnvName ...
	ReportURLEnvName = "REPORT_URL"
	// HeartbeatIntervalEnvName ...
	HeartbeatIntervalEnvName = "HEARTBEAT_INTERVAL"
	// NamespaceEnvName ...
	NamespaceEnvName = "NAMESPACE"

	// PVCWatcherLabelName ...
	PVCWatcherLabelName = "pod.cyclone.dev/name"
	// PVCWatcherLabelValue ...
	PVCWatcherLabelValue = "pvc-watcher"
)

// PVCWatcherName is name of the PVC watcher deployment and pod
const PVCWatcherName = "pvc-watchdog"

// LaunchPVCUsageWatcher launches a pod in a given namespace to report PVC usage regularly.
func LaunchPVCUsageWatcher(client kubernetes.Interface, tenant string, context v1alpha1.ExecutionContext) error {
	if len(context.PVC) == 0 {
		return fmt.Errorf("no pvc in execution namespace %s", context.Namespace)
	}

	watcherConfig := config.Config.StorageUsageWatcher

	_, err := client.AppsV1().Deployments(context.Namespace).Create(context2.TODO(), &appsv1.Deployment{
		ObjectMeta: metav1.ObjectMeta{
			Name:      PVCWatcherName,
			Namespace: context.Namespace,
		},
		Spec: appsv1.DeploymentSpec{
			Selector: &metav1.LabelSelector{
				MatchLabels: map[string]string{
					PVCWatcherLabelName: PVCWatcherLabelValue,
				},
			},
			Template: corev1.PodTemplateSpec{
				ObjectMeta: metav1.ObjectMeta{
					Name:      PVCWatcherName,
					Namespace: context.Namespace,
					Labels: map[string]string{
						PVCWatcherLabelName: PVCWatcherLabelValue,
						meta.LabelPodKind:   meta.PodKindPVCWatcher.String(),
					},
				},
				Spec: corev1.PodSpec{
					Containers: []corev1.Container{
						{
							Name:  "c0",
							Image: watcherConfig.Image,
							Env: []corev1.EnvVar{
								{
									Name:  ReportURLEnvName,
									Value: watcherConfig.ReportURL,
								},
								{
									Name:  HeartbeatIntervalEnvName,
									Value: watcherConfig.IntervalSeconds,
								},
								{
									Name:  NamespaceEnvName,
									Value: common.TenantNamespace(tenant),
								},
							},
							Resources: corev1.ResourceRequirements{
								Requests: corev1.ResourceList{
									corev1.ResourceCPU:    resource.MustParse(getOrDefault(&watcherConfig, corev1.ResourceRequestsCPU, "50m")),
									corev1.ResourceMemory: resource.MustParse(getOrDefault(&watcherConfig, corev1.ResourceRequestsMemory, "32Mi")),
								},
								Limits: corev1.ResourceList{
									corev1.ResourceCPU:    resource.MustParse(getOrDefault(&watcherConfig, corev1.ResourceLimitsCPU, "100m")),
									corev1.ResourceMemory: resource.MustParse(getOrDefault(&watcherConfig, corev1.ResourceLimitsMemory, "128Mi")),
								},
							},
							VolumeMounts: []corev1.VolumeMount{
								{
									Name:      "cv",
									ReadOnly:  true,
									MountPath: "/pvc-data",
								},
							},
						},
					},
					Volumes: []corev1.Volume{
						{
							Name: "cv",
							VolumeSource: corev1.VolumeSource{
								PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
									ClaimName: context.PVC,
									ReadOnly:  true,
								},
							},
						},
					},
					RestartPolicy: corev1.RestartPolicyAlways,
				},
			},
		},
	}, metav1.CreateOptions{})

	return err
}

// getOrDefault gets resource requirement from config, if not set, use default value.
func getOrDefault(watcherConfig *config.StorageUsageWatcher, key corev1.ResourceName, defaultValue string) string {
	v, ok := watcherConfig.ResourceRequirements[key]
	if ok {
		return v
	}

	return defaultValue
}

// DeletePVCUsageWatcher delete the pvc usage watcher deployment
func DeletePVCUsageWatcher(client kubernetes.Interface, namespace string) error {
	foreground := metav1.DeletePropagationForeground
	err := client.AppsV1().Deployments(namespace).Delete(context2.TODO(), PVCWatcherName, metav1.DeleteOptions{
		PropagationPolicy: &foreground,
	})

	if err != nil {
		return err
	}

	// Try to delete pvc watcher pod immediately to accelerate the related pvc deletion.
	pods, err := client.CoreV1().Pods(namespace).List(context2.TODO(), metav1.ListOptions{
		LabelSelector: fmt.Sprintf("%s=%s", PVCWatcherLabelName, PVCWatcherLabelValue),
	})
	if err != nil {
		log.Warning("list pvc watcher pods error: ", err)
		return nil
	}

	var zero int64
	for _, pod := range pods.Items {
		err = client.CoreV1().Pods(namespace).Delete(context2.TODO(), pod.Name, metav1.DeleteOptions{
			PropagationPolicy:  &foreground,
			GracePeriodSeconds: &zero,
		})
		if err != nil {
			log.Warningf("delete pvc watcher pods: %s error: %v", pod.Name, err)
		}
	}

	return nil
}

// GetPVCUsageWatcher gets the pvc watch dog deployment.
func GetPVCUsageWatcher(client kubernetes.Interface, namespace string) (*appsv1.Deployment, error) {
	return client.AppsV1().Deployments(namespace).Get(context2.TODO(), PVCWatcherName, metav1.GetOptions{})
}