152 lines
4.0 KiB
Go
152 lines
4.0 KiB
Go
/*
|
|
Copyright 2021 DigitalOcean
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package doks
|
|
|
|
import (
|
|
"github.com/digitalocean/clusterlint/checks"
|
|
"github.com/digitalocean/clusterlint/kube"
|
|
corev1 "k8s.io/api/core/v1"
|
|
st "k8s.io/api/storage/v1"
|
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
|
)
|
|
|
|
const (
|
|
DOCSIDriver = "dobs.csi.digitalocean.com"
|
|
LegacyCSIDriver = "com.digitalocean.csi.dobs"
|
|
DOBlockStorageName = "do-block-storage"
|
|
)
|
|
|
|
func init() {
|
|
checks.Register(&dobsPodOwner{})
|
|
}
|
|
|
|
type dobsPodOwner struct{}
|
|
|
|
// Name returns a unique name for this check.
|
|
func (p *dobsPodOwner) Name() string {
|
|
return "dobs-pod-owner"
|
|
}
|
|
|
|
// Groups returns a list of group names this check should be part of.
|
|
func (p *dobsPodOwner) Groups() []string {
|
|
return []string{"doks"}
|
|
}
|
|
|
|
// Description returns a detailed human-readable description of what this check
|
|
// does.
|
|
func (p *dobsPodOwner) Description() string {
|
|
return "Checks if pods referencing dobs volumes are owned by a stateful set."
|
|
}
|
|
|
|
// Run runs this check on a set of Kubernetes objects. It can return warnings
|
|
// (low-priority problems) and errors (high-priority problems) as well as an
|
|
// error value indicating that the check failed to run.
|
|
func (p *dobsPodOwner) Run(objects *kube.Objects) ([]checks.Diagnostic, error) {
|
|
var diagnostics []checks.Diagnostic
|
|
var dobsPods []corev1.Pod
|
|
for _, pod := range objects.Pods.Items {
|
|
pod := pod
|
|
for _, volume := range pod.Spec.Volumes {
|
|
if isDOBSVolume(volume, pod.Namespace, objects) {
|
|
dobsPods = append(dobsPods, pod)
|
|
}
|
|
}
|
|
}
|
|
for _, pod := range dobsPods {
|
|
pod := pod
|
|
if pod.OwnerReferences != nil && ownedByStatefulSet(pod.OwnerReferences) {
|
|
continue
|
|
}
|
|
d := checks.Diagnostic{
|
|
Severity: checks.Warning,
|
|
Message: "Pod referencing DOBS volumes must be owned by StatefulSet",
|
|
Kind: checks.Pod,
|
|
Object: &pod.ObjectMeta,
|
|
Owners: pod.ObjectMeta.GetOwnerReferences(),
|
|
}
|
|
diagnostics = append(diagnostics, d)
|
|
}
|
|
|
|
return diagnostics, nil
|
|
}
|
|
|
|
func isDOBSVolume(volume corev1.Volume, namespace string, objects *kube.Objects) bool {
|
|
if volume.PersistentVolumeClaim != nil {
|
|
claim := getPVC(objects.PersistentVolumeClaims, volume.PersistentVolumeClaim.ClaimName, namespace)
|
|
if claim == nil {
|
|
return false
|
|
}
|
|
|
|
scn := getStorageClassName(claim)
|
|
if scn == nil && isDOCSI(objects.DefaultStorageClass.Provisioner) {
|
|
return true
|
|
}
|
|
sc := getStorageClass(objects.StorageClasses, scn)
|
|
if sc != nil && isDOCSI(sc.Provisioner) {
|
|
return true
|
|
}
|
|
}
|
|
|
|
if volume.CSI != nil {
|
|
if isDOCSI(volume.CSI.Driver) {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
func getStorageClassName(claim *corev1.PersistentVolumeClaim) *string{
|
|
if claim.Spec.StorageClassName != nil {
|
|
return claim.Spec.StorageClassName
|
|
}
|
|
if scn, found := claim.Annotations["volume.beta.kubernetes.io/storage-class"]; found {
|
|
return &scn
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func isDOCSI(referrer string) bool {
|
|
return referrer == DOCSIDriver || referrer == LegacyCSIDriver
|
|
}
|
|
|
|
func getStorageClass(classes *st.StorageClassList, name *string) *st.StorageClass {
|
|
for _, c := range classes.Items {
|
|
if c.Name == *name {
|
|
return &c
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func getPVC(claims *corev1.PersistentVolumeClaimList, name string, namespace string) *corev1.PersistentVolumeClaim {
|
|
for _, c := range claims.Items {
|
|
if c.Name == name && c.Namespace == namespace {
|
|
return &c
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func ownedByStatefulSet(references []metav1.OwnerReference) bool {
|
|
for _, ref := range references {
|
|
if ref.Kind == "StatefulSet" {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|