Files
my-rook-config/pkg/operator/ceph/object/spec_test.go
T
Blaine Gardner a777b1d7d1 object: do not create service for external object stores
External CephObjectStores already have endpoints defined by
spec.gateway.externalRgwEndpoints, and if the external store is
configured with TLS (HTTPS), the store's certificates will likely not
accept connections intended for the Service endpoint Rook creates. Some
users might not be able to easily add the service endpoint to their
certificates. Therefore, don't even bother creating a Service for
external clusters.

This does introduce a few issues. The Service seems to have been
initially created to allow multiple external RGW endpoints to be
addressable via a single address in Rook. For all connections to an
external CephObjectStore with multiple endpoints, simply choose an
endpoint at random. Random selection will prevent Rook from failing to
create buckets or users on an external store if one of the external
store's endpoints fails.

The latest OBC library (lib-bucket-provisioner) allows updating the
endpoints on ObjectBuckets after they are created. This allows Rook
users to change endpoints on external CephObjectStores without breaking
all existing OBCs. It requires implementation of the new GetUserID()
library call, requires updating Provision() and Grant() calls to be
idempotent, and it requires removing the Update() call.

Signed-off-by: Blaine Gardner <blaine.gardner@redhat.com>
2022-11-04 17:30:30 -06:00

936 lines
34 KiB
Go

/*
Copyright 2016 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 object
import (
"context"
"fmt"
"testing"
"github.com/pkg/errors"
cephv1 "github.com/rook/rook/pkg/apis/ceph.rook.io/v1"
"github.com/rook/rook/pkg/clusterd"
"github.com/rook/rook/pkg/daemon/ceph/client"
clienttest "github.com/rook/rook/pkg/daemon/ceph/client/test"
cephconfig "github.com/rook/rook/pkg/operator/ceph/config"
cephtest "github.com/rook/rook/pkg/operator/ceph/test"
cephver "github.com/rook/rook/pkg/operator/ceph/version"
"github.com/rook/rook/pkg/operator/test"
exectest "github.com/rook/rook/pkg/util/exec/test"
"github.com/stretchr/testify/assert"
v1 "k8s.io/api/core/v1"
k8serrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/api/resource"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/util/intstr"
)
func configureSSE(t *testing.T, c *clusterConfig, kms bool, s3 bool) {
c.store.Spec.Security = &cephv1.ObjectStoreSecuritySpec{}
if kms {
c.store.Spec.Security.KeyManagementService = cephv1.KeyManagementServiceSpec{ConnectionDetails: map[string]string{}}
c.store.Spec.Security.KeyManagementService.TokenSecretName = "vault-token"
c.store.Spec.Security.KeyManagementService.ConnectionDetails["KMS_PROVIDER"] = "vault"
c.store.Spec.Security.KeyManagementService.ConnectionDetails["VAULT_ADDR"] = "https://1.1.1.1:8200"
}
if s3 {
c.store.Spec.Security.ServerSideEncryptionS3 = cephv1.KeyManagementServiceSpec{ConnectionDetails: map[string]string{}}
c.store.Spec.Security.ServerSideEncryptionS3.TokenSecretName = "vault-token"
c.store.Spec.Security.ServerSideEncryptionS3.ConnectionDetails["KMS_PROVIDER"] = "vault"
c.store.Spec.Security.ServerSideEncryptionS3.ConnectionDetails["VAULT_ADDR"] = "https://1.1.1.1:8200"
}
s := &v1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: "vault-token",
Namespace: c.store.Namespace,
},
Data: map[string][]byte{
"token": []byte("myt-otkenbenvqrev"),
},
}
_, err := c.context.Clientset.CoreV1().Secrets(c.store.Namespace).Create(c.clusterInfo.Context, s, metav1.CreateOptions{})
if err != nil && !k8serrors.IsAlreadyExists(err) {
assert.Error(t, err)
}
}
func TestPodSpecs(t *testing.T) {
store := simpleStore()
store.Spec.Gateway.Resources = v1.ResourceRequirements{
Limits: v1.ResourceList{
v1.ResourceCPU: *resource.NewQuantity(200.0, resource.BinarySI),
v1.ResourceMemory: *resource.NewQuantity(1337.0, resource.BinarySI),
},
Requests: v1.ResourceList{
v1.ResourceCPU: *resource.NewQuantity(100.0, resource.BinarySI),
v1.ResourceMemory: *resource.NewQuantity(500.0, resource.BinarySI),
},
}
store.Spec.Gateway.PriorityClassName = "my-priority-class"
info := clienttest.CreateTestClusterInfo(1)
info.CephVersion = cephver.Quincy
data := cephconfig.NewStatelessDaemonDataPathMap(cephconfig.RgwType, "default", "rook-ceph", "/var/lib/rook/")
c := &clusterConfig{
clusterInfo: info,
store: store,
rookVersion: "rook/rook:myversion",
clusterSpec: &cephv1.ClusterSpec{
CephVersion: cephv1.CephVersionSpec{Image: "quay.io/ceph/ceph:v15"},
Network: cephv1.NetworkSpec{
HostNetwork: true,
},
},
DataPathMap: data,
}
resourceName := fmt.Sprintf("%s-%s", AppName, c.store.Name)
rgwConfig := &rgwConfig{
ResourceName: resourceName,
DaemonID: "default",
}
s, err := c.makeRGWPodSpec(rgwConfig)
assert.NoError(t, err)
// Check pod anti affinity is well added to be compliant with HostNetwork setting
assert.Equal(t,
1,
len(s.Spec.Affinity.PodAntiAffinity.RequiredDuringSchedulingIgnoredDuringExecution))
assert.Equal(t,
getLabels(c.store.Name, c.store.Namespace, false),
s.Spec.Affinity.PodAntiAffinity.RequiredDuringSchedulingIgnoredDuringExecution[0].LabelSelector.MatchLabels)
podTemplate := cephtest.NewPodTemplateSpecTester(t, &s)
podTemplate.RunFullSuite(cephconfig.RgwType, "default", "rook-ceph-rgw", "mycluster", "quay.io/ceph/ceph:myversion",
"200", "100", "1337", "500", /* resources */
"my-priority-class", "default", "cephobjectstores.ceph.rook.io", "ceph-rgw")
t.Run(("check rgw ConfigureProbe"), func(t *testing.T) {
c.store.Spec.HealthCheck.StartupProbe = &cephv1.ProbeSpec{Disabled: false, Probe: &v1.Probe{InitialDelaySeconds: 1000}}
c.store.Spec.HealthCheck.LivenessProbe = &cephv1.ProbeSpec{Disabled: false, Probe: &v1.Probe{InitialDelaySeconds: 900}}
deployment, err := c.makeDaemonContainer(rgwConfig)
assert.NoError(t, err)
assert.NotNil(t, c.store.Spec.HealthCheck.LivenessProbe)
assert.NotNil(t, c.store.Spec.HealthCheck.StartupProbe)
assert.Equal(t, int32(900), deployment.LivenessProbe.InitialDelaySeconds)
assert.Equal(t, int32(1000), deployment.StartupProbe.InitialDelaySeconds)
})
}
func TestSSLPodSpec(t *testing.T) {
ctx := context.TODO()
// Placeholder
context := &clusterd.Context{Clientset: test.New(t, 3)}
store := simpleStore()
store.Spec.Gateway.Resources = v1.ResourceRequirements{
Limits: v1.ResourceList{
v1.ResourceCPU: *resource.NewQuantity(200.0, resource.BinarySI),
v1.ResourceMemory: *resource.NewQuantity(1337.0, resource.BinarySI),
},
Requests: v1.ResourceList{
v1.ResourceCPU: *resource.NewQuantity(100.0, resource.BinarySI),
v1.ResourceMemory: *resource.NewQuantity(500.0, resource.BinarySI),
},
}
store.Spec.Gateway.PriorityClassName = "my-priority-class"
info := clienttest.CreateTestClusterInfo(1)
info.CephVersion = cephver.Quincy
info.Namespace = store.Namespace
data := cephconfig.NewStatelessDaemonDataPathMap(cephconfig.RgwType, "default", "rook-ceph", "/var/lib/rook/")
store.Spec.Gateway.SecurePort = 443
c := &clusterConfig{
clusterInfo: info,
store: store,
context: context,
rookVersion: "rook/rook:myversion",
clusterSpec: &cephv1.ClusterSpec{
CephVersion: cephv1.CephVersionSpec{Image: "quay.io/ceph/ceph:v17.2.5"},
Network: cephv1.NetworkSpec{
HostNetwork: true,
},
},
DataPathMap: data,
}
resourceName := fmt.Sprintf("%s-%s", AppName, c.store.Name)
rgwConfig := &rgwConfig{
ResourceName: resourceName,
DaemonID: "default",
}
_, err := c.makeRGWPodSpec(rgwConfig)
// No TLS certs specified, will return error
assert.Error(t, err)
// Using SSLCertificateRef
// Opaque Secret
c.store.Spec.Gateway.SSLCertificateRef = "mycert"
rgwtlssecret := &v1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: c.store.Spec.Gateway.SSLCertificateRef,
Namespace: c.store.Namespace,
},
Data: map[string][]byte{
"cert": []byte("tlssecrettesting"),
},
Type: v1.SecretTypeOpaque,
}
_, err = c.context.Clientset.CoreV1().Secrets(store.Namespace).Create(ctx, rgwtlssecret, metav1.CreateOptions{})
assert.NoError(t, err)
secretVolSrc, err := c.generateVolumeSourceWithTLSSecret()
assert.NoError(t, err)
assert.Equal(t, secretVolSrc.SecretName, "mycert")
s, err := c.makeRGWPodSpec(rgwConfig)
assert.NoError(t, err)
podTemplate := cephtest.NewPodTemplateSpecTester(t, &s)
podTemplate.RunFullSuite(cephconfig.RgwType, "default", "rook-ceph-rgw", "mycluster", "quay.io/ceph/ceph:myversion",
"200", "100", "1337", "500", /* resources */
"my-priority-class", "default", "cephobjectstores.ceph.rook.io", "ceph-rgw")
// TLS Secret
c.store.Spec.Gateway.SSLCertificateRef = "tlscert"
rgwtlssecret = &v1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: c.store.Spec.Gateway.SSLCertificateRef,
Namespace: c.store.Namespace,
},
Data: map[string][]byte{
"tls.crt": []byte("tlssecrettestingcert"),
"tls.key": []byte("tlssecrettestingkey"),
},
Type: v1.SecretTypeTLS,
}
_, err = c.context.Clientset.CoreV1().Secrets(store.Namespace).Create(ctx, rgwtlssecret, metav1.CreateOptions{})
assert.NoError(t, err)
secretVolSrc, err = c.generateVolumeSourceWithTLSSecret()
assert.NoError(t, err)
assert.Equal(t, secretVolSrc.SecretName, "tlscert")
s, err = c.makeRGWPodSpec(rgwConfig)
assert.NoError(t, err)
podTemplate = cephtest.NewPodTemplateSpecTester(t, &s)
podTemplate.RunFullSuite(cephconfig.RgwType, "default", "rook-ceph-rgw", "mycluster", "quay.io/ceph/ceph:myversion",
"200", "100", "1337", "500", /* resources */
"my-priority-class", "default", "cephobjectstores.ceph.rook.io", "ceph-rgw")
// Using service serving cert
c.store.Spec.Gateway.SSLCertificateRef = ""
c.store.Spec.Gateway.Service = &(cephv1.RGWServiceSpec{Annotations: cephv1.Annotations{cephv1.ServiceServingCertKey: "rgw-cert"}})
secretVolSrc, err = c.generateVolumeSourceWithTLSSecret()
assert.NoError(t, err)
assert.Equal(t, secretVolSrc.SecretName, "rgw-cert")
// Using caBundleRef
// Opaque Secret
c.store.Spec.Gateway.CaBundleRef = "mycabundle"
cabundlesecret := &v1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: c.store.Spec.Gateway.CaBundleRef,
Namespace: c.store.Namespace,
},
Data: map[string][]byte{
"cabundle": []byte("cabundletesting"),
},
Type: v1.SecretTypeOpaque,
}
_, err = c.context.Clientset.CoreV1().Secrets(store.Namespace).Create(ctx, cabundlesecret, metav1.CreateOptions{})
assert.NoError(t, err)
caBundleVolSrc, err := c.generateVolumeSourceWithCaBundleSecret()
assert.NoError(t, err)
assert.Equal(t, caBundleVolSrc.SecretName, "mycabundle")
s, err = c.makeRGWPodSpec(rgwConfig)
assert.NoError(t, err)
podTemplate = cephtest.NewPodTemplateSpecTester(t, &s)
podTemplate.RunFullSuite(cephconfig.RgwType, "default", "rook-ceph-rgw", "mycluster", "quay.io/ceph/ceph:myversion",
"200", "100", "1337", "500", /* resources */
"my-priority-class", "default", "cephobjectstores.ceph.rook.io", "ceph-rgw")
assert.True(t, s.Spec.HostNetwork)
assert.Equal(t, v1.DNSClusterFirstWithHostNet, s.Spec.DNSPolicy)
}
func TestValidateSpec(t *testing.T) {
executor := &exectest.MockExecutor{}
executor.MockExecuteCommandWithOutput = func(command string, args ...string) (string, error) {
logger.Infof("Command: %s %v", command, args)
if args[1] == "crush" && args[2] == "dump" {
return `{"types":[{"type_id": 0,"name": "osd"}, {"type_id": 1,"name": "host"}],"buckets":[{"id": -1,"name":"default"},{"id": -2,"name":"good"}, {"id": -3,"name":"host"}]}`, nil
}
return "", errors.Errorf("unexpected ceph command %q", args)
}
context := &clusterd.Context{Executor: executor}
r := &ReconcileCephObjectStore{
context: context,
clusterSpec: &cephv1.ClusterSpec{
External: cephv1.ExternalSpec{
Enable: false,
},
},
clusterInfo: &client.ClusterInfo{
CephCred: client.CephCred{
Username: "client.admin",
},
},
}
// valid store
s := simpleStore()
err := r.validateStore(s)
assert.Nil(t, err)
// no name
s.Name = ""
err = r.validateStore(s)
assert.NotNil(t, err)
s.Name = "default"
err = r.validateStore(s)
assert.Nil(t, err)
// no namespace
s.Namespace = ""
err = r.validateStore(s)
assert.NotNil(t, err)
s.Namespace = "mycluster"
err = r.validateStore(s)
assert.Nil(t, err)
// no replication or EC is valid
s.Spec.MetadataPool.Replicated.Size = 0
err = r.validateStore(s)
assert.Nil(t, err)
s.Spec.MetadataPool.Replicated.Size = 1
err = r.validateStore(s)
assert.Nil(t, err)
// external with endpoints, success
s.Spec.Gateway.ExternalRgwEndpoints = []cephv1.EndpointAddress{
{
IP: "192.168.0.1",
},
}
err = r.validateStore(s)
assert.Nil(t, err)
}
func TestDefaultLivenessProbe(t *testing.T) {
store := simpleStore()
c := &clusterConfig{
store: store,
clusterSpec: &cephv1.ClusterSpec{
Network: cephv1.NetworkSpec{
HostNetwork: false,
},
},
}
desiredProbe := &v1.Probe{
ProbeHandler: v1.ProbeHandler{
TCPSocket: &v1.TCPSocketAction{
Port: intstr.FromInt(8080),
},
},
InitialDelaySeconds: 10,
}
// No SSL - HostNetwork is disabled - using internal port
p := c.defaultLivenessProbe()
assert.Equal(t, desiredProbe, p)
// No SSL - HostNetwork is enabled
c.store.Spec.Gateway.Port = 123
c.store.Spec.Gateway.SecurePort = 0
c.clusterSpec.Network.HostNetwork = true
p = c.defaultLivenessProbe()
desiredProbe.ProbeHandler.TCPSocket.Port = intstr.FromInt(123)
assert.Equal(t, desiredProbe, p)
// SSL - HostNetwork is enabled
c.store.Spec.Gateway.Port = 0
c.store.Spec.Gateway.SecurePort = 321
c.store.Spec.Gateway.SSLCertificateRef = "foo"
p = c.defaultLivenessProbe()
desiredProbe.ProbeHandler.TCPSocket.Port = intstr.FromInt(321)
assert.Equal(t, desiredProbe, p)
// Both Non-SSL and SSL are enabled
// livenessProbe just on Non-SSL
c.store.Spec.Gateway.Port = 123
c.store.Spec.Gateway.SecurePort = 321
p = c.defaultLivenessProbe()
desiredProbe.ProbeHandler.TCPSocket.Port = intstr.FromInt(123)
assert.Equal(t, desiredProbe, p)
}
func TestDefaultStartupProbe(t *testing.T) {
store := simpleStore()
c := &clusterConfig{
store: store,
clusterSpec: &cephv1.ClusterSpec{
Network: cephv1.NetworkSpec{
HostNetwork: false,
},
},
}
desiredProbe := &v1.Probe{
ProbeHandler: v1.ProbeHandler{
TCPSocket: &v1.TCPSocketAction{
Port: intstr.FromInt(8080),
},
},
InitialDelaySeconds: 10,
PeriodSeconds: 10,
FailureThreshold: 18,
}
// No SSL - HostNetwork is disabled - using internal port
p := c.defaultStartupProbe()
assert.Equal(t, desiredProbe, p)
// No SSL - HostNetwork is enabled
c.store.Spec.Gateway.Port = 123
c.store.Spec.Gateway.SecurePort = 0
c.clusterSpec.Network.HostNetwork = true
p = c.defaultStartupProbe()
desiredProbe.ProbeHandler.TCPSocket.Port = intstr.FromInt(123)
assert.Equal(t, desiredProbe, p)
// SSL - HostNetwork is enabled
c.store.Spec.Gateway.Port = 0
c.store.Spec.Gateway.SecurePort = 321
c.store.Spec.Gateway.SSLCertificateRef = "foo"
p = c.defaultStartupProbe()
desiredProbe.ProbeHandler.TCPSocket.Port = intstr.FromInt(321)
assert.Equal(t, desiredProbe, p)
// Both Non-SSL and SSL are enabled
// livenessProbe just on Non-SSL
c.store.Spec.Gateway.Port = 123
c.store.Spec.Gateway.SecurePort = 321
p = c.defaultStartupProbe()
desiredProbe.ProbeHandler.TCPSocket.Port = intstr.FromInt(123)
assert.Equal(t, desiredProbe, p)
}
func TestDefaultReadinessProbe(t *testing.T) {
store := simpleStore()
c := &clusterConfig{
store: store,
clusterSpec: &cephv1.ClusterSpec{
Network: cephv1.NetworkSpec{
HostNetwork: false,
},
},
}
desiredProbe := &v1.Probe{
ProbeHandler: v1.ProbeHandler{
HTTPGet: &v1.HTTPGetAction{
Path: readinessProbePath,
Port: intstr.FromInt(8080),
Scheme: v1.URISchemeHTTP,
},
},
InitialDelaySeconds: 10,
}
// No SSL - HostNetwork is disabled - using internal port
p := c.defaultReadinessProbe()
assert.Equal(t, desiredProbe, p)
// No SSL - HostNetwork is enabled
c.store.Spec.Gateway.Port = 123
c.store.Spec.Gateway.SecurePort = 0
c.clusterSpec.Network.HostNetwork = true
p = c.defaultReadinessProbe()
desiredProbe.ProbeHandler.HTTPGet.Port = intstr.FromInt(123)
assert.Equal(t, desiredProbe, p)
// SSL - HostNetwork is enabled
c.store.Spec.Gateway.Port = 0
c.store.Spec.Gateway.SecurePort = 321
c.store.Spec.Gateway.SSLCertificateRef = "foo"
p = c.defaultReadinessProbe()
desiredProbe.ProbeHandler.HTTPGet.Port = intstr.FromInt(321)
desiredProbe.ProbeHandler.HTTPGet.Scheme = v1.URISchemeHTTPS
assert.Equal(t, desiredProbe, p)
// Both Non-SSL and SSL are enabled
// readinessProbe just on Non-SSL
c.store.Spec.Gateway.Port = 123
c.store.Spec.Gateway.SecurePort = 321
p = c.defaultReadinessProbe()
desiredProbe.ProbeHandler.HTTPGet.Port = intstr.FromInt(123)
desiredProbe.ProbeHandler.HTTPGet.Scheme = v1.URISchemeHTTP
assert.Equal(t, desiredProbe, p)
}
func TestCheckRGWKMS(t *testing.T) {
ctx := context.TODO()
setupTest := func() *clusterConfig {
context := &clusterd.Context{Clientset: test.New(t, 3)}
store := simpleStore()
return &clusterConfig{
context: context,
store: store,
clusterInfo: &client.ClusterInfo{Context: ctx},
}
}
t.Run("KMS is disabled", func(t *testing.T) {
c := setupTest()
b, err := c.CheckRGWKMS()
assert.False(t, b)
assert.NoError(t, err)
})
t.Run("Vault Secret Engine is missing", func(t *testing.T) {
c := setupTest()
configureSSE(t, c, true, false)
b, err := c.CheckRGWKMS()
assert.False(t, b)
assert.Error(t, err)
})
t.Run("Vault Secret Engine is kv with v1", func(t *testing.T) {
c := setupTest()
configureSSE(t, c, true, false)
c.store.Spec.Security.KeyManagementService.ConnectionDetails["VAULT_SECRET_ENGINE"] = "kv"
b, err := c.CheckRGWKMS()
assert.False(t, b)
assert.Error(t, err)
})
t.Run("Vault Secret Engine is kv with v2", func(t *testing.T) {
c := setupTest()
configureSSE(t, c, true, false)
c.store.Spec.Security.KeyManagementService.ConnectionDetails["VAULT_SECRET_ENGINE"] = "kv"
c.store.Spec.Security.KeyManagementService.ConnectionDetails["VAULT_BACKEND"] = "v2"
b, err := c.CheckRGWKMS()
assert.True(t, b)
assert.NoError(t, err)
})
t.Run("Vault Secret Engine is transit", func(t *testing.T) {
c := setupTest()
configureSSE(t, c, true, false)
c.store.Spec.Security.KeyManagementService.ConnectionDetails["VAULT_SECRET_ENGINE"] = "transit"
b, err := c.CheckRGWKMS()
assert.True(t, b)
assert.NoError(t, err)
})
t.Run("TLS is configured but secrets do not exist", func(t *testing.T) {
c := setupTest()
configureSSE(t, c, true, false)
c.store.Spec.Security.KeyManagementService.ConnectionDetails["VAULT_SECRET_ENGINE"] = "transit"
c.store.Spec.Security.KeyManagementService.ConnectionDetails["VAULT_CACERT"] = "vault-ca-secret"
b, err := c.CheckRGWKMS()
assert.False(t, b)
assert.Error(t, err, "")
assert.EqualError(t, err, "failed to validate vault connection details: failed to find TLS connection details k8s secret \"vault-ca-secret\": secrets \"vault-ca-secret\" not found")
})
t.Run("TLS secret exists but empty key", func(t *testing.T) {
c := setupTest()
configureSSE(t, c, true, false)
c.store.Spec.Security.KeyManagementService.ConnectionDetails["VAULT_SECRET_ENGINE"] = "transit"
c.store.Spec.Security.KeyManagementService.ConnectionDetails["VAULT_CACERT"] = "vault-ca-secret"
tlsSecret := &v1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: "vault-ca-secret",
Namespace: c.store.Namespace,
},
}
_, err := c.context.Clientset.CoreV1().Secrets(c.store.Namespace).Create(context.TODO(), tlsSecret, metav1.CreateOptions{})
assert.NoError(t, err)
b, err := c.CheckRGWKMS()
assert.False(t, b)
assert.Error(t, err, "")
assert.EqualError(t, err, "failed to validate vault connection details: failed to find TLS connection key \"cert\" for \"VAULT_CACERT\" in k8s secret \"vault-ca-secret\"")
})
t.Run("TLS config is valid", func(t *testing.T) {
c := setupTest()
configureSSE(t, c, true, false)
c.store.Spec.Security.KeyManagementService.ConnectionDetails["VAULT_SECRET_ENGINE"] = "transit"
c.store.Spec.Security.KeyManagementService.ConnectionDetails["VAULT_CACERT"] = "vault-ca-secret"
tlsSecret := &v1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: "vault-ca-secret",
Namespace: c.store.Namespace,
},
}
tlsSecret.Data = map[string][]byte{"cert": []byte("envnrevbnbvsbjkrtn")}
_, err := c.context.Clientset.CoreV1().Secrets(c.store.Namespace).Create(context.TODO(), tlsSecret, metav1.CreateOptions{})
assert.NoError(t, err)
b, err := c.CheckRGWKMS()
assert.True(t, b)
assert.NoError(t, err, "")
})
}
func TestCheckRGWSSES3Enabled(t *testing.T) {
ctx := context.TODO()
setupTest := func() *clusterConfig {
context := &clusterd.Context{Clientset: test.New(t, 3)}
store := simpleStore()
return &clusterConfig{
context: context,
store: store,
clusterInfo: &client.ClusterInfo{Context: ctx, CephVersion: cephver.CephVersion{Major: 17, Minor: 2, Extra: 3}},
clusterSpec: &cephv1.ClusterSpec{
CephVersion: cephv1.CephVersionSpec{Image: "quay.io/ceph/ceph:v17.2.5"},
},
}
}
t.Run("KMS is disabled", func(t *testing.T) {
c := setupTest()
b, err := c.CheckRGWSSES3Enabled()
assert.False(t, b)
assert.NoError(t, err)
})
t.Run("Vault Secret Engine is missing", func(t *testing.T) {
c := setupTest()
configureSSE(t, c, false, true)
b, err := c.CheckRGWSSES3Enabled()
assert.False(t, b)
assert.Error(t, err)
})
t.Run("Vault Secret Engine is kv with v1", func(t *testing.T) {
c := setupTest()
configureSSE(t, c, false, true)
c.store.Spec.Security.ServerSideEncryptionS3.ConnectionDetails["VAULT_SECRET_ENGINE"] = "kv"
b, err := c.CheckRGWSSES3Enabled()
assert.False(t, b)
assert.Error(t, err)
})
t.Run("Vault Secret Engine is kv with v2", func(t *testing.T) {
c := setupTest()
configureSSE(t, c, false, true)
c.store.Spec.Security.ServerSideEncryptionS3.ConnectionDetails["VAULT_SECRET_ENGINE"] = "kv"
c.store.Spec.Security.ServerSideEncryptionS3.ConnectionDetails["VAULT_BACKEND"] = "v2"
b, err := c.CheckRGWSSES3Enabled()
assert.False(t, b)
assert.Error(t, err)
})
t.Run("Vault Secret Engine is transit", func(t *testing.T) {
c := setupTest()
configureSSE(t, c, false, true)
c.store.Spec.Security.ServerSideEncryptionS3.ConnectionDetails["VAULT_SECRET_ENGINE"] = "transit"
b, err := c.CheckRGWSSES3Enabled()
assert.True(t, b)
assert.NoError(t, err)
})
t.Run("TLS is configured but secrets do not exist", func(t *testing.T) {
c := setupTest()
configureSSE(t, c, false, true)
c.store.Spec.Security.ServerSideEncryptionS3.ConnectionDetails["VAULT_SECRET_ENGINE"] = "transit"
c.store.Spec.Security.ServerSideEncryptionS3.ConnectionDetails["VAULT_CACERT"] = "vault-ca-secret"
b, err := c.CheckRGWSSES3Enabled()
assert.False(t, b)
assert.Error(t, err, "")
assert.EqualError(t, err, "failed to validate vault connection details: failed to find TLS connection details k8s secret \"vault-ca-secret\": secrets \"vault-ca-secret\" not found")
})
t.Run("TLS secret exists but empty key", func(t *testing.T) {
c := setupTest()
configureSSE(t, c, false, true)
c.store.Spec.Security.ServerSideEncryptionS3.ConnectionDetails["VAULT_SECRET_ENGINE"] = "transit"
c.store.Spec.Security.ServerSideEncryptionS3.ConnectionDetails["VAULT_CACERT"] = "vault-ca-secret"
tlsSecret := &v1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: "vault-ca-secret",
Namespace: c.store.Namespace,
},
}
_, err := c.context.Clientset.CoreV1().Secrets(c.store.Namespace).Create(context.TODO(), tlsSecret, metav1.CreateOptions{})
assert.NoError(t, err)
b, err := c.CheckRGWSSES3Enabled()
assert.False(t, b)
assert.Error(t, err, "")
assert.EqualError(t, err, "failed to validate vault connection details: failed to find TLS connection key \"cert\" for \"VAULT_CACERT\" in k8s secret \"vault-ca-secret\"")
})
t.Run("TLS config is valid", func(t *testing.T) {
c := setupTest()
configureSSE(t, c, false, true)
c.store.Spec.Security.ServerSideEncryptionS3.ConnectionDetails["VAULT_SECRET_ENGINE"] = "transit"
c.store.Spec.Security.ServerSideEncryptionS3.ConnectionDetails["VAULT_CACERT"] = "vault-ca-secret"
tlsSecret := &v1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: "vault-ca-secret",
Namespace: c.store.Namespace,
},
}
tlsSecret.Data = map[string][]byte{"cert": []byte("envnrevbnbvsbjkrtn")}
_, err := c.context.Clientset.CoreV1().Secrets(c.store.Namespace).Create(context.TODO(), tlsSecret, metav1.CreateOptions{})
assert.NoError(t, err)
b, err := c.CheckRGWSSES3Enabled()
assert.True(t, b)
assert.NoError(t, err, "")
})
}
func TestGetDaemonName(t *testing.T) {
context := &clusterd.Context{Clientset: test.New(t, 3)}
store := simpleStore()
tests := []struct {
storeName string
testDaemonName string
daemonID string
}{
{"default", "ceph-client.rgw.default.a", "a"},
{"my-store", "ceph-client.rgw.my.store.b", "b"},
}
for _, tt := range tests {
t.Run(tt.storeName, func(t *testing.T) {
c := &clusterConfig{
context: context,
store: store,
}
c.store.Name = tt.storeName
daemonName := fmt.Sprintf("%s-%s", c.store.Name, tt.daemonID)
resourceName := fmt.Sprintf("%s-%s", AppName, daemonName)
rgwconfig := &rgwConfig{
ResourceName: resourceName,
DaemonID: daemonName,
}
daemon := getDaemonName(rgwconfig)
assert.Equal(t, tt.testDaemonName, daemon)
})
}
}
func TestMakeRGWPodSpec(t *testing.T) {
store := simpleStore()
info := clienttest.CreateTestClusterInfo(1)
data := cephconfig.NewStatelessDaemonDataPathMap(cephconfig.RgwType, "default", "rook-ceph", "/var/lib/rook/")
c := &clusterConfig{
store: store,
rookVersion: "rook/rook:myversion",
clusterSpec: &cephv1.ClusterSpec{
CephVersion: cephv1.CephVersionSpec{Image: "quay.io/ceph/ceph:v15"},
Network: cephv1.NetworkSpec{
HostNetwork: true,
},
},
clusterInfo: info,
DataPathMap: data,
}
resourceName := fmt.Sprintf("%s-%s", AppName, c.store.Name)
rgwConfig := &rgwConfig{
ResourceName: resourceName,
DaemonID: "default",
}
tests := []struct {
name string
isSet bool
enabled bool
}{
{"host networking is not set to rgw daemon", false, false},
{"host networking is set to rgw daemon but not enabled", true, false},
{"host networking is enabled for the rgw daemon", true, true},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if tt.isSet {
if tt.enabled {
c.store.Spec.Gateway.HostNetwork = func(hostNetwork bool) *bool { return &hostNetwork }(true)
} else {
c.store.Spec.Gateway.HostNetwork = new(bool)
}
}
podTemplateSpec, _ := c.makeRGWPodSpec(rgwConfig)
if tt.isSet {
assert.Equal(t, *c.store.Spec.Gateway.HostNetwork, podTemplateSpec.Spec.HostNetwork)
} else {
assert.Equal(t, c.clusterSpec.Network.IsHost(), podTemplateSpec.Spec.HostNetwork)
}
})
}
}
func TestAWSServerSideEncryption(t *testing.T) {
ctx := context.TODO()
// Placeholder
context := &clusterd.Context{Clientset: test.New(t, 3)}
store := simpleStore()
info := clienttest.CreateTestClusterInfo(1)
info.CephVersion = cephver.CephVersion{Major: 17, Minor: 2, Extra: 3}
info.Namespace = store.Namespace
data := cephconfig.NewStatelessDaemonDataPathMap(cephconfig.RgwType, "default", "rook-ceph", "/var/lib/rook/")
c := &clusterConfig{
clusterInfo: info,
store: store,
context: context,
rookVersion: "rook/rook:myversion",
clusterSpec: &cephv1.ClusterSpec{
CephVersion: cephv1.CephVersionSpec{Image: "quay.io/ceph/ceph:v17.3"},
Network: cephv1.NetworkSpec{
HostNetwork: true,
},
},
DataPathMap: data,
}
resourceName := fmt.Sprintf("%s-%s", AppName, c.store.Name)
rgwConfig := &rgwConfig{
ResourceName: resourceName,
DaemonID: "default",
}
checkRGWOptions := func(allRGWOptions, optionsNeeded []string) bool {
if len(optionsNeeded) == 0 {
return false
}
optionMap := make(map[string]bool)
for _, option := range allRGWOptions {
optionMap[option] = true
}
for _, option := range optionsNeeded {
if _, found := optionMap[option]; !found {
return false
}
}
return true
}
t.Run("SecuritySpec is not configured no options will be configured", func(t *testing.T) {
rgwContainer, err := c.makeDaemonContainer(rgwConfig)
assert.NoError(t, err)
assert.False(t, checkRGWOptions(rgwContainer.Args, c.sseKMSDefaultOptions(false)))
assert.False(t, checkRGWOptions(rgwContainer.Args, c.sseS3DefaultOptions(false)))
assert.False(t, checkRGWOptions(rgwContainer.Args, c.sseKMSVaultTokenOptions(false)))
assert.False(t, checkRGWOptions(rgwContainer.Args, c.sseS3VaultTokenOptions(false)))
assert.False(t, checkRGWOptions(rgwContainer.Args, c.sseKMSVaultTLSOptions(false)))
assert.False(t, checkRGWOptions(rgwContainer.Args, c.sseS3VaultTLSOptions(false)))
})
configureSSE(t, c, true, false)
t.Run("Invalid Security Spec configured, no options will be configured", func(t *testing.T) {
rgwContainer, err := c.makeDaemonContainer(rgwConfig)
assert.Error(t, err)
assert.False(t, checkRGWOptions(rgwContainer.Args, c.sseKMSDefaultOptions(false)))
assert.False(t, checkRGWOptions(rgwContainer.Args, c.sseS3DefaultOptions(false)))
assert.False(t, checkRGWOptions(rgwContainer.Args, c.sseKMSVaultTokenOptions(false)))
assert.False(t, checkRGWOptions(rgwContainer.Args, c.sseS3VaultTokenOptions(false)))
assert.False(t, checkRGWOptions(rgwContainer.Args, c.sseKMSVaultTLSOptions(false)))
assert.False(t, checkRGWOptions(rgwContainer.Args, c.sseS3VaultTLSOptions(false)))
})
t.Run("Security Spec configured with kms only,so kms options will be configured", func(t *testing.T) {
c.store.Spec.Security.KeyManagementService.ConnectionDetails["VAULT_SECRET_ENGINE"] = "transit"
rgwContainer, err := c.makeDaemonContainer(rgwConfig)
assert.NoError(t, err)
assert.True(t, checkRGWOptions(rgwContainer.Args, c.sseKMSDefaultOptions(true)))
assert.False(t, checkRGWOptions(rgwContainer.Args, c.sseS3DefaultOptions(false)))
assert.True(t, checkRGWOptions(rgwContainer.Args, c.sseKMSVaultTokenOptions(true)))
assert.False(t, checkRGWOptions(rgwContainer.Args, c.sseS3VaultTokenOptions(false)))
assert.False(t, checkRGWOptions(rgwContainer.Args, c.sseKMSVaultTLSOptions(false)))
assert.False(t, checkRGWOptions(rgwContainer.Args, c.sseS3VaultTLSOptions(false)))
})
t.Run("Security Spec configured with s3 only, so s3 options will be configured", func(t *testing.T) {
configureSSE(t, c, false, true)
c.store.Spec.Security.ServerSideEncryptionS3.ConnectionDetails["VAULT_SECRET_ENGINE"] = "transit"
rgwContainer, err := c.makeDaemonContainer(rgwConfig)
assert.NoError(t, err)
assert.False(t, checkRGWOptions(rgwContainer.Args, c.sseKMSDefaultOptions(false)))
assert.True(t, checkRGWOptions(rgwContainer.Args, c.sseS3DefaultOptions(true)))
assert.False(t, checkRGWOptions(rgwContainer.Args, c.sseKMSVaultTokenOptions(false)))
assert.True(t, checkRGWOptions(rgwContainer.Args, c.sseS3VaultTokenOptions(true)))
assert.False(t, checkRGWOptions(rgwContainer.Args, c.sseKMSVaultTLSOptions(false)))
assert.False(t, checkRGWOptions(rgwContainer.Args, c.sseS3VaultTLSOptions(false)))
})
t.Run("Security Spec configured with both kms and s3 settings, so both kms and s3 options will be configured", func(t *testing.T) {
configureSSE(t, c, true, true)
c.store.Spec.Security.KeyManagementService.ConnectionDetails["VAULT_SECRET_ENGINE"] = "transit"
c.store.Spec.Security.ServerSideEncryptionS3.ConnectionDetails["VAULT_SECRET_ENGINE"] = "transit"
rgwContainer, err := c.makeDaemonContainer(rgwConfig)
assert.NoError(t, err)
assert.True(t, checkRGWOptions(rgwContainer.Args, c.sseKMSDefaultOptions(true)))
assert.True(t, checkRGWOptions(rgwContainer.Args, c.sseS3DefaultOptions(true)))
assert.True(t, checkRGWOptions(rgwContainer.Args, c.sseKMSVaultTokenOptions(true)))
assert.True(t, checkRGWOptions(rgwContainer.Args, c.sseS3VaultTokenOptions(true)))
assert.False(t, checkRGWOptions(rgwContainer.Args, c.sseKMSVaultTLSOptions(false)))
assert.False(t, checkRGWOptions(rgwContainer.Args, c.sseS3VaultTLSOptions(false)))
})
tlsSecret := &v1.Secret{
ObjectMeta: metav1.ObjectMeta{
Name: "vault-ca-secret",
Namespace: c.store.Namespace,
},
}
tlsSecret.Data = map[string][]byte{"cert": []byte("envnrevbnbvsbjkrtn")}
_, err := c.context.Clientset.CoreV1().Secrets(c.store.Namespace).Create(ctx, tlsSecret, metav1.CreateOptions{})
assert.NoError(t, err)
t.Run("Security Spec configured with kms along with TLS, so kms including TLS options will be configured", func(t *testing.T) {
configureSSE(t, c, true, false)
c.store.Spec.Security.KeyManagementService.ConnectionDetails["VAULT_SECRET_ENGINE"] = "transit"
c.store.Spec.Security.KeyManagementService.ConnectionDetails["VAULT_CACERT"] = "vault-ca-secret"
rgwContainer, err := c.makeDaemonContainer(rgwConfig)
assert.NoError(t, err)
assert.True(t, checkRGWOptions(rgwContainer.Args, c.sseKMSDefaultOptions(true)))
assert.False(t, checkRGWOptions(rgwContainer.Args, c.sseS3DefaultOptions(false)))
assert.True(t, checkRGWOptions(rgwContainer.Args, c.sseKMSVaultTokenOptions(true)))
assert.False(t, checkRGWOptions(rgwContainer.Args, c.sseS3VaultTokenOptions(false)))
assert.True(t, checkRGWOptions(rgwContainer.Args, c.sseKMSVaultTLSOptions(true)))
assert.False(t, checkRGWOptions(rgwContainer.Args, c.sseS3VaultTLSOptions(false)))
})
t.Run("Security Spec configured with s3 along with TLS, so s3 including TLS options will be configured", func(t *testing.T) {
configureSSE(t, c, false, true)
c.store.Spec.Security.ServerSideEncryptionS3.ConnectionDetails["VAULT_SECRET_ENGINE"] = "transit"
c.store.Spec.Security.ServerSideEncryptionS3.ConnectionDetails["VAULT_CACERT"] = "vault-ca-secret"
rgwContainer, err := c.makeDaemonContainer(rgwConfig)
assert.NoError(t, err)
assert.False(t, checkRGWOptions(rgwContainer.Args, c.sseKMSDefaultOptions(false)))
assert.True(t, checkRGWOptions(rgwContainer.Args, c.sseS3DefaultOptions(true)))
assert.False(t, checkRGWOptions(rgwContainer.Args, c.sseKMSVaultTokenOptions(false)))
assert.True(t, checkRGWOptions(rgwContainer.Args, c.sseS3VaultTokenOptions(true)))
assert.False(t, checkRGWOptions(rgwContainer.Args, c.sseKMSVaultTLSOptions(true)))
assert.True(t, checkRGWOptions(rgwContainer.Args, c.sseS3VaultTLSOptions(true)))
})
t.Run("Security Spec configured both kms and s3 aloong with TLS, all the serverr side encryption related options will be configured", func(t *testing.T) {
configureSSE(t, c, true, true)
c.store.Spec.Security.KeyManagementService.ConnectionDetails["VAULT_SECRET_ENGINE"] = "transit"
c.store.Spec.Security.ServerSideEncryptionS3.ConnectionDetails["VAULT_SECRET_ENGINE"] = "transit"
c.store.Spec.Security.KeyManagementService.ConnectionDetails["VAULT_CACERT"] = "vault-ca-secret"
c.store.Spec.Security.ServerSideEncryptionS3.ConnectionDetails["VAULT_CACERT"] = "vault-ca-secret"
rgwContainer, err := c.makeDaemonContainer(rgwConfig)
assert.NoError(t, err)
assert.True(t, checkRGWOptions(rgwContainer.Args, c.sseKMSDefaultOptions(true)))
assert.True(t, checkRGWOptions(rgwContainer.Args, c.sseS3DefaultOptions(true)))
assert.True(t, checkRGWOptions(rgwContainer.Args, c.sseKMSVaultTokenOptions(true)))
assert.True(t, checkRGWOptions(rgwContainer.Args, c.sseS3VaultTokenOptions(true)))
assert.True(t, checkRGWOptions(rgwContainer.Args, c.sseKMSVaultTLSOptions(true)))
assert.True(t, checkRGWOptions(rgwContainer.Args, c.sseS3VaultTLSOptions(true)))
})
}