shared_volume_type.go

/*
MIT License

Copyright (c) 2021 StorageOS

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/

package storageos

import (
	"errors"

	corev1 "k8s.io/api/core/v1"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/apimachinery/pkg/util/intstr"

	stosv1 "github.com/storageos/api-manager/api/v1"
	"github.com/storageos/api-manager/internal/pkg/endpoint"
)

const (
	// NFSPort is the port exposed by the service.  Each service will have a
	// unique ip, so it can be fixed to the default NFS port.
	NFSPort int32 = 2049
	// NFSPortName is used as the name of the NFS port in the service definition.
	NFSPortName = "nfs"
	// NFSProtocol is the prtocol to be used for NFS.
	NFSProtocol = "TCP"
)

// SharedVolumeList is a collection of SharedVolumes.
type SharedVolumeList []*SharedVolume

// SharedVolume represents a single StorageOS shared volume.
type SharedVolume struct {
	*stosv1.Volume
}

// IsEqual returns true if the given SharedVolume object is equivalent.
func (v *SharedVolume) IsEqual(obj *SharedVolume) bool {
	if obj == nil ||
		obj.ServiceName() != v.ServiceName() ||
		obj.PVCName() != v.PVCName() ||
		obj.PVCNamespace() != v.PVCNamespace() ||
		obj.InternalEndpoint() != v.InternalEndpoint() ||
		obj.ExternalEndpoint() != v.ExternalEndpoint() {
		return false
	}
	return true
}

// ID returns the id of the volume.
func (v *SharedVolume) ID() string {
	return v.Status.VolumeID
}

// ServiceName returns the name of the service.
func (v *SharedVolume) ServiceName() string {
	return v.Spec.ConfigLabels[ReservedLabelK8sPVName]
}

// PVName returns the name of the PV.
func (v *SharedVolume) PVName() string {
	return v.Spec.ConfigLabels[ReservedLabelK8sPVName]
}

// PVCName returns the name of the PVC.
func (v *SharedVolume) PVCName() string {
	return v.Spec.ConfigLabels[ReservedLabelK8sPVCName]
}

// PVCNamespace returns the namespace of the PVC.
func (v *SharedVolume) PVCNamespace() string {
	return v.Spec.ConfigLabels[ReservedLabelK8sPVCNamespace]
}

// InternalEndpoint returns the name of the internal endpoint.
func (v *SharedVolume) InternalEndpoint() string {
	if v.Spec.NFS.ServiceEndpoint == nil {
		return ""
	}
	return *v.Spec.NFS.ServiceEndpoint
}

// ExternalEndpoint returns the name of the internal endpoint.
func (v *SharedVolume) ExternalEndpoint() string {
	return v.Spec.ConfigLabels[ReservedLabelNFSMountEndpoint]
}

// InternalAddress returns the address of the intenral SharedVolume listener.
func (v *SharedVolume) InternalAddress() string {
	address, _, err := endpoint.SplitAddressPort(v.InternalEndpoint())
	if err != nil {
		return ""
	}
	return address
}

// InternalPort returns the port of the intenral SharedVolume listener.
func (v *SharedVolume) InternalPort() int {
	_, port, err := endpoint.SplitAddressPort(v.InternalEndpoint())
	if err != nil {
		return 0
	}
	return port
}

// Service returns the desired service corresponding to the SharedVolume.
// ClusterIP can be provided if an existing ClusterIP should be re-used.
// The ownerRef must be set to the volume's PersistentVolumeClaim.
func (v *SharedVolume) Service(ownerRef metav1.OwnerReference) *corev1.Service {
	return &corev1.Service{
		ObjectMeta: metav1.ObjectMeta{
			Name:      v.ServiceName(),
			Namespace: v.PVCNamespace(),
			Labels: map[string]string{
				ReservedLabelVolumeID: v.ID(),
			},
			OwnerReferences: []metav1.OwnerReference{ownerRef},
		},
		Spec: corev1.ServiceSpec{
			Type: corev1.ServiceTypeClusterIP,
			Ports: []corev1.ServicePort{
				{
					Name:       NFSPortName,
					Port:       NFSPort,
					Protocol:   NFSProtocol,
					TargetPort: intstr.FromInt(v.InternalPort()),
				},
			},
		},
	}
}

// ServiceIsEqual returns true if the service provided matches the desired state
// of the SharedVolume.
func (v *SharedVolume) ServiceIsEqual(svc *corev1.Service) bool {
	if svc == nil ||
		svc.Name != v.ServiceName() ||
		svc.Namespace != v.PVCNamespace() ||
		svc.Spec.Type != corev1.ServiceTypeClusterIP {
		return false
	}
	if len(svc.Spec.Ports) != 1 ||
		svc.Spec.Ports[0].Name != NFSPortName ||
		svc.Spec.Ports[0].Port != NFSPort ||
		svc.Spec.Ports[0].Protocol != NFSProtocol ||
		svc.Spec.Ports[0].TargetPort.IntVal != intstr.FromInt(v.InternalPort()).IntVal {
		return false
	}
	return true
}

// ServiceUpdate returns the provided service, with updates to match the
// SharedVolume.
func (v *SharedVolume) ServiceUpdate(svc *corev1.Service) *corev1.Service {
	if len(svc.Spec.Ports) != 1 {
		svc.Spec.Ports = []corev1.ServicePort{
			{
				Name:       NFSPortName,
				Port:       NFSPort,
				Protocol:   NFSProtocol,
				TargetPort: intstr.FromInt(v.InternalPort()),
			},
		}
		return svc
	}
	svc.Spec.Ports[0].TargetPort = intstr.FromInt(v.InternalPort())
	return svc
}

// Endpoints returns the desired endpoints corresponding to the SharedVolume.
func (v *SharedVolume) Endpoints() *corev1.Endpoints {
	return &corev1.Endpoints{
		ObjectMeta: metav1.ObjectMeta{
			Name:      v.ServiceName(),
			Namespace: v.PVCNamespace(),
			Labels: map[string]string{
				ReservedLabelVolumeID: v.ID(),
			},
		},
		Subsets: []corev1.EndpointSubset{
			{
				Addresses: []corev1.EndpointAddress{
					{
						IP: v.InternalAddress(),
					},
				},
				Ports: []corev1.EndpointPort{
					{
						Name:     NFSPortName,
						Port:     intstr.FromInt(v.InternalPort()).IntVal,
						Protocol: NFSProtocol,
					},
				},
			},
		},
	}
}

// EndpointsIsEqual returns true if the endpoints provided matches the desired
// state of the SharedVolume.
func (v *SharedVolume) EndpointsIsEqual(e *corev1.Endpoints) bool {
	if e == nil ||
		e.Name != v.ServiceName() ||
		e.Namespace != v.PVCNamespace() {
		return false
	}
	if len(e.Subsets) != 1 {
		return false
	}
	if len(e.Subsets[0].Addresses) == 0 ||
		e.Subsets[0].Addresses[0].IP != v.InternalAddress() {
		return false
	}
	if len(e.Subsets[0].Ports) == 0 ||
		e.Subsets[0].Ports[0].Name != NFSPortName ||
		e.Subsets[0].Ports[0].Port != intstr.FromInt(v.InternalPort()).IntVal ||
		e.Subsets[0].Ports[0].Protocol != NFSProtocol {
		return false
	}
	return true
}

// EndpointsUpdate returns the provided endpoints, with updates to match the
// SharedVolume.
func (v *SharedVolume) EndpointsUpdate(e *corev1.Endpoints) *corev1.Endpoints {
	if len(e.Subsets) != 1 || len(e.Subsets[0].Addresses) != 1 || len(e.Subsets[0].Ports) != 1 {
		e.Subsets = []corev1.EndpointSubset{
			{
				Addresses: []corev1.EndpointAddress{
					{
						IP: v.InternalAddress(),
					},
				},
				Ports: []corev1.EndpointPort{
					{
						Name:     NFSPortName,
						Port:     intstr.FromInt(v.InternalPort()).IntVal,
						Protocol: NFSProtocol,
					},
				},
			},
		}
		return e
	}
	e.Subsets[0].Addresses[0].IP = v.InternalAddress()
	e.Subsets[0].Ports[0].Port = intstr.FromInt(v.InternalPort()).IntVal
	return e
}

// NewSharedVolume creates a new SharedVolume.
func NewSharedVolume(vol *stosv1.Volume) (*SharedVolume, error) {
	// Skip non-k8s volumes.  The PV name & PVC namespace will be used as the
	// Service and Endpoints name & namespace.  The PVC name is required to set
	// the Service ownerRef to the PVC.
	pvName := vol.Spec.ConfigLabels[ReservedLabelK8sPVName]
	pvcName := vol.Spec.ConfigLabels[ReservedLabelK8sPVCName]
	pvcNamespace := vol.Spec.ConfigLabels[ReservedLabelK8sPVCNamespace]
	if pvName == "" || pvcName == "" || pvcNamespace == "" {
		return nil, errors.New("volume is not StorageOS shared volume")
	}

	return &SharedVolume{Volume: vol}, nil
}