forked from rook/rook
Blaine Gardner
4f555dbbcb
Add new CSI_DISABLE_HOLDER_PODS option for rook-ceph-operator. This option will disable holder pods when set to "true". In the long term, Rook plans to deprecate the holder pods entirely. This new option will allow users to choose to migrate their clusters to non-holder clusters when they are ready and able, giving them time to gracefully migrate before the holders are permanently removed. This option is set to "false" by default so that upgrading users don't have their CSI pods modified unexpectedly. Example manifests are modified to set this value to true so that new clusters will not deploy holder pods. Migrating users are provided with documentation to instruct them about the new requirements they need to satisfy to successfully remove holder pods, a procedure for migrating pods from holder to non-holder mounts, and a way to delete holder pods once they are no longer in use. When users set CSI_DISABLE_HOLDER_PODS="true", the CSI controller will no longer deploy or update the holder pod Daemonsets, but it does not delete any existing Daemonsets. This allows already-attached PVCs to continue operating normally with their network connection continuing to exist in the current holder pod. This is critical to avoid causing ia cluster-wide storage outage. More info: https://github.com/rook/rook/issues/13055 Signed-off-by: Blaine Gardner <blaine.gardner@ibm.com>
277 lines
9.1 KiB
Go
277 lines
9.1 KiB
Go
/*
|
|
Copyright 2021 The Rook Authors. All rights reserved.
|
|
|
|
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 csi
|
|
|
|
import (
|
|
"context"
|
|
"os"
|
|
"testing"
|
|
|
|
"github.com/coreos/pkg/capnslog"
|
|
cephv1 "github.com/rook/rook/pkg/apis/ceph.rook.io/v1"
|
|
rookclient "github.com/rook/rook/pkg/client/clientset/versioned/fake"
|
|
"github.com/rook/rook/pkg/client/clientset/versioned/scheme"
|
|
"github.com/rook/rook/pkg/clusterd"
|
|
"github.com/rook/rook/pkg/daemon/ceph/client"
|
|
"github.com/rook/rook/pkg/operator/ceph/controller"
|
|
"github.com/rook/rook/pkg/operator/k8sutil"
|
|
"github.com/rook/rook/pkg/operator/test"
|
|
"github.com/stretchr/testify/assert"
|
|
v1 "k8s.io/api/core/v1"
|
|
apifake "k8s.io/apiextensions-apiserver/pkg/client/clientset/clientset/fake"
|
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
|
"k8s.io/apimachinery/pkg/runtime"
|
|
"k8s.io/apimachinery/pkg/types"
|
|
"k8s.io/client-go/kubernetes"
|
|
"sigs.k8s.io/controller-runtime/pkg/client/fake"
|
|
"sigs.k8s.io/controller-runtime/pkg/reconcile"
|
|
)
|
|
|
|
func TestCephCSIController(t *testing.T) {
|
|
oldReconcileSaveCSIDriverOptions := reconcileSaveCSIDriverOptions
|
|
defer func() { reconcileSaveCSIDriverOptions = oldReconcileSaveCSIDriverOptions }()
|
|
saveCSIDriverOptionsCalledForClusterNS := []string{}
|
|
reconcileSaveCSIDriverOptions = func(clientset kubernetes.Interface, clusterNamespace string, clusterInfo *client.ClusterInfo) error {
|
|
saveCSIDriverOptionsCalledForClusterNS = append(saveCSIDriverOptionsCalledForClusterNS, clusterNamespace)
|
|
return nil
|
|
}
|
|
|
|
ctx := context.TODO()
|
|
var (
|
|
name = "rook-ceph"
|
|
namespace = "rook-ceph"
|
|
)
|
|
// Set DEBUG logging
|
|
capnslog.SetGlobalLogLevel(capnslog.DEBUG)
|
|
os.Setenv("ROOK_LOG_LEVEL", "DEBUG")
|
|
t.Setenv(k8sutil.PodNameEnvVar, "rook-ceph-operator")
|
|
t.Setenv(k8sutil.PodNamespaceEnvVar, namespace)
|
|
|
|
t.Setenv("ROOK_CSI_ALLOW_UNSUPPORTED_VERSION", "true")
|
|
CSIParam = Param{
|
|
CSIPluginImage: "image",
|
|
RegistrarImage: "image",
|
|
ProvisionerImage: "image",
|
|
AttacherImage: "image",
|
|
SnapshotterImage: "image",
|
|
}
|
|
req := reconcile.Request{
|
|
NamespacedName: types.NamespacedName{
|
|
Name: name,
|
|
Namespace: namespace,
|
|
},
|
|
}
|
|
|
|
t.Run("failure because no CephCluster", func(t *testing.T) {
|
|
fakeClientSet := test.New(t, 1)
|
|
test.SetFakeKubernetesVersion(fakeClientSet, "v1.21.0")
|
|
c := &clusterd.Context{
|
|
Clientset: fakeClientSet,
|
|
RookClientset: rookclient.NewSimpleClientset(),
|
|
}
|
|
|
|
_, err := c.Clientset.CoreV1().Pods(namespace).Create(ctx, test.FakeOperatorPod(namespace), metav1.CreateOptions{})
|
|
assert.NoError(t, err)
|
|
_, err = c.Clientset.AppsV1().ReplicaSets(namespace).Create(context.TODO(), test.FakeReplicaSet(namespace), metav1.CreateOptions{})
|
|
assert.NoError(t, err)
|
|
// Register operator types with the runtime scheme.
|
|
s := scheme.Scheme
|
|
s.AddKnownTypes(cephv1.SchemeGroupVersion, &v1.ConfigMap{}, &v1.ConfigMapList{}, &cephv1.CephClusterList{})
|
|
|
|
// Create a fake client to mock API calls.
|
|
cl := fake.NewClientBuilder().WithScheme(s).Build()
|
|
c.Client = cl
|
|
|
|
// Create a ReconcileCSI object with the scheme and fake client.
|
|
r := &ReconcileCSI{
|
|
client: cl,
|
|
context: c,
|
|
opConfig: controller.OperatorConfig{
|
|
OperatorNamespace: namespace,
|
|
Image: "rook",
|
|
ServiceAccount: "foo",
|
|
},
|
|
}
|
|
|
|
res, err := r.Reconcile(ctx, req)
|
|
assert.NoError(t, err)
|
|
assert.False(t, res.Requeue)
|
|
})
|
|
|
|
t.Run("success ceph csi deployment", func(t *testing.T) {
|
|
fakeClientSet := test.New(t, 1)
|
|
test.SetFakeKubernetesVersion(fakeClientSet, "v1.21.0")
|
|
c := &clusterd.Context{
|
|
Clientset: fakeClientSet,
|
|
RookClientset: rookclient.NewSimpleClientset(),
|
|
ApiExtensionsClient: apifake.NewSimpleClientset(),
|
|
}
|
|
_, err := c.Clientset.CoreV1().Pods(namespace).Create(ctx, test.FakeOperatorPod(namespace), metav1.CreateOptions{})
|
|
assert.NoError(t, err)
|
|
_, err = c.Clientset.AppsV1().ReplicaSets(namespace).Create(context.TODO(), test.FakeReplicaSet(namespace), metav1.CreateOptions{})
|
|
assert.NoError(t, err)
|
|
cephCluster := &cephv1.CephCluster{
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
Name: namespace,
|
|
Namespace: namespace,
|
|
},
|
|
Status: cephv1.ClusterStatus{
|
|
Phase: "",
|
|
CephVersion: &cephv1.ClusterVersion{
|
|
Version: "14.2.9-0",
|
|
},
|
|
CephStatus: &cephv1.CephStatus{
|
|
Health: "",
|
|
},
|
|
},
|
|
}
|
|
// Mock clusterInfo
|
|
secrets := map[string][]byte{
|
|
"fsid": []byte(name),
|
|
"mon-secret": []byte("monsecret"),
|
|
"admin-secret": []byte("adminsecret"),
|
|
}
|
|
secret := &v1.Secret{
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
Name: "rook-ceph-mon",
|
|
Namespace: namespace,
|
|
},
|
|
Data: secrets,
|
|
Type: k8sutil.RookType,
|
|
}
|
|
_, err = c.Clientset.CoreV1().Secrets(namespace).Create(ctx, secret, metav1.CreateOptions{})
|
|
assert.NoError(t, err)
|
|
s := scheme.Scheme
|
|
s.AddKnownTypes(cephv1.SchemeGroupVersion, &cephv1.CephCluster{}, &cephv1.CephClusterList{}, &v1.ConfigMap{})
|
|
saveCSIDriverOptionsCalledForClusterNS = []string{}
|
|
|
|
object := []runtime.Object{
|
|
cephCluster,
|
|
}
|
|
// Create a fake client to mock API calls.
|
|
cl := fake.NewClientBuilder().WithScheme(s).WithRuntimeObjects(object...).Build()
|
|
c.Client = cl
|
|
// // Create a ReconcileCSI object with the scheme and fake client.
|
|
r := &ReconcileCSI{
|
|
client: cl,
|
|
context: c,
|
|
opConfig: controller.OperatorConfig{
|
|
OperatorNamespace: namespace,
|
|
Image: "rook",
|
|
ServiceAccount: "foo",
|
|
},
|
|
}
|
|
|
|
res, err := r.Reconcile(ctx, req)
|
|
assert.NoError(t, err)
|
|
assert.False(t, res.Requeue)
|
|
|
|
ds, err := c.Clientset.AppsV1().DaemonSets(namespace).List(ctx, metav1.ListOptions{})
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, 2, len(ds.Items), ds)
|
|
|
|
assert.Equal(t, []string{namespace}, saveCSIDriverOptionsCalledForClusterNS)
|
|
})
|
|
|
|
t.Run("success ceph csi deployment with multus", func(t *testing.T) {
|
|
fakeClientSet := test.New(t, 1)
|
|
test.SetFakeKubernetesVersion(fakeClientSet, "v1.21.0")
|
|
c := &clusterd.Context{
|
|
Clientset: fakeClientSet,
|
|
RookClientset: rookclient.NewSimpleClientset(),
|
|
ApiExtensionsClient: apifake.NewSimpleClientset(),
|
|
}
|
|
_, err := c.Clientset.CoreV1().Pods(namespace).Create(ctx, test.FakeOperatorPod(namespace), metav1.CreateOptions{})
|
|
assert.NoError(t, err)
|
|
_, err = c.Clientset.AppsV1().ReplicaSets(namespace).Create(context.TODO(), test.FakeReplicaSet(namespace), metav1.CreateOptions{})
|
|
assert.NoError(t, err)
|
|
cephCluster := &cephv1.CephCluster{
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
Name: namespace,
|
|
Namespace: namespace,
|
|
},
|
|
Spec: cephv1.ClusterSpec{
|
|
Network: cephv1.NetworkSpec{
|
|
Provider: cephv1.NetworkProviderMultus,
|
|
Selectors: map[cephv1.CephNetworkType]string{"public": "public-net", "cluster": "cluster-net"},
|
|
},
|
|
},
|
|
Status: cephv1.ClusterStatus{
|
|
Phase: "",
|
|
CephVersion: &cephv1.ClusterVersion{
|
|
Version: "14.2.9-0",
|
|
},
|
|
CephStatus: &cephv1.CephStatus{
|
|
FSID: "89d00089-d6e6-4445-b596-96898ce31793",
|
|
},
|
|
},
|
|
}
|
|
// Mock clusterInfo
|
|
secrets := map[string][]byte{
|
|
"fsid": []byte(name),
|
|
"mon-secret": []byte("monsecret"),
|
|
"admin-secret": []byte("adminsecret"),
|
|
}
|
|
secret := &v1.Secret{
|
|
ObjectMeta: metav1.ObjectMeta{
|
|
Name: "rook-ceph-mon",
|
|
Namespace: namespace,
|
|
},
|
|
Data: secrets,
|
|
Type: k8sutil.RookType,
|
|
}
|
|
_, err = c.Clientset.CoreV1().Secrets(namespace).Create(ctx, secret, metav1.CreateOptions{})
|
|
assert.NoError(t, err)
|
|
s := scheme.Scheme
|
|
s.AddKnownTypes(cephv1.SchemeGroupVersion, &cephv1.CephCluster{}, &cephv1.CephClusterList{}, &v1.ConfigMap{})
|
|
saveCSIDriverOptionsCalledForClusterNS = []string{}
|
|
|
|
object := []runtime.Object{
|
|
cephCluster,
|
|
}
|
|
// Create a fake client to mock API calls.
|
|
cl := fake.NewClientBuilder().WithScheme(s).WithRuntimeObjects(object...).Build()
|
|
c.Client = cl
|
|
// Create a ReconcileCSI object with the scheme and fake client.
|
|
r := &ReconcileCSI{
|
|
scheme: s,
|
|
client: cl,
|
|
context: c,
|
|
opConfig: controller.OperatorConfig{
|
|
OperatorNamespace: namespace,
|
|
Image: "rook",
|
|
ServiceAccount: "foo",
|
|
},
|
|
}
|
|
|
|
res, err := r.Reconcile(ctx, req)
|
|
assert.NoError(t, err)
|
|
assert.False(t, res.Requeue)
|
|
|
|
ds, err := c.Clientset.AppsV1().DaemonSets(namespace).List(ctx, metav1.ListOptions{})
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, 4, len(ds.Items), ds)
|
|
assert.Equal(t, "csi-cephfsplugin", ds.Items[0].Name)
|
|
assert.Equal(t, "csi-cephfsplugin-holder-rook-ceph", ds.Items[1].Name)
|
|
assert.Equal(t, "csi-rbdplugin", ds.Items[2].Name)
|
|
assert.Equal(t, "csi-rbdplugin-holder-rook-ceph", ds.Items[3].Name)
|
|
assert.Equal(t, `[{"name":"public-net","namespace":"rook-ceph"}]`, ds.Items[1].Spec.Template.Annotations["k8s.v1.cni.cncf.io/networks"], ds.Items[1].Spec.Template.Annotations)
|
|
|
|
assert.Equal(t, []string{namespace}, saveCSIDriverOptionsCalledForClusterNS)
|
|
})
|
|
}
|