Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use resizing secrets #42

Merged
merged 2 commits into from
Jun 20, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions Gopkg.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions Gopkg.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@
# go-tests = true
# unused-packages = true

[[constraint]]
[[override]]
name = "k8s.io/api"
version = "kubernetes-1.14.0"
branch = "release-1.15"

[[constraint]]
name = "k8s.io/apimachinery"
Expand Down
3 changes: 0 additions & 3 deletions deploy/kubernetes/rbac.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,6 @@ rules:
- apiGroups: [""]
resources: ["persistentvolumeclaims/status"]
verbs: ["update", "patch"]
- apiGroups: ["storage.k8s.io"]
resources: ["storageclasses"]
verbs: ["get", "list", "watch"]
- apiGroups: [""]
resources: ["events"]
verbs: ["list", "watch", "create", "update", "patch"]
Expand Down
7 changes: 7 additions & 0 deletions pkg/csi/mock_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ type MockClient struct {
supportsNodeResize bool
supportsControllerResize bool
supportsPluginControllerService bool
usedSecrets map[string]string
}

func (c *MockClient) GetDriverName(context.Context) (string, error) {
Expand All @@ -43,5 +44,11 @@ func (c *MockClient) Expand(
requestBytes int64,
secrets map[string]string) (int64, bool, error) {
// TODO: Determine whether the operation succeeds or fails by parameters.
c.usedSecrets = secrets
return requestBytes, c.supportsNodeResize, nil
}

// GetSecrets returns secrets used for volume expansion
func (c *MockClient) GetSecrets() map[string]string {
return c.usedSecrets
}
110 changes: 4 additions & 106 deletions pkg/resizer/csi_resizer.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,27 +20,18 @@ import (
"context"
"errors"
"fmt"
"os"
"time"

"github.com/kubernetes-csi/external-resizer/pkg/csi"

"k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/resource"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/util/sets"
"k8s.io/apimachinery/pkg/util/validation"
"k8s.io/client-go/informers"
"k8s.io/client-go/kubernetes"
storagev1listers "k8s.io/client-go/listers/storage/v1"
"k8s.io/klog"
)

const (
resizerSecretNameKey = "csi.storage.k8s.io/resizer-secret-name"
resizerSecretNamespaceKey = "csi.storage.k8s.io/resizer-secret-namespace"
)

var (
controllerServiceNotSupportErr = errors.New("CSI driver does not support controller service")
resizeNotSupportErr = errors.New("CSI driver neither supports controller resize nor node resize")
Expand Down Expand Up @@ -101,7 +92,6 @@ func NewResizerFromClient(
timeout: timeout,

k8sClient: k8sClient,
scLister: informerFactory.Storage().V1().StorageClasses().Lister(),
}, nil
}

Expand All @@ -111,7 +101,6 @@ type csiResizer struct {
timeout time.Duration

k8sClient kubernetes.Interface
scLister storagev1listers.StorageClassLister
}

func (r *csiResizer) Name() string {
Expand Down Expand Up @@ -144,18 +133,10 @@ func (r *csiResizer) Resize(pv *v1.PersistentVolume, requestSize resource.Quanti
}

var secrets map[string]string
// Get expand secrets from StorageClass parameters.
scName := pv.Spec.StorageClassName
if len(scName) > 0 {
storageClass, err := r.scLister.Get(scName)
if err != nil {
return oldSize, false, fmt.Errorf("get StorageClass %s failed: %v", scName, err)
}
expandSecretRef, err := getSecretReference(storageClass.Parameters, pv.Name)
if err != nil {
return oldSize, false, err
}
secrets, err = getCredentials(r.k8sClient, expandSecretRef)
secreRef := source.ControllerExpandSecretRef
if secreRef != nil {
var err error
secrets, err = getCredentials(r.k8sClient, secreRef)
if err != nil {
return oldSize, false, err
}
Expand Down Expand Up @@ -198,89 +179,6 @@ func timeoutCtx(timeout time.Duration) (context.Context, context.CancelFunc) {
return context.WithTimeout(context.Background(), timeout)
}

// verifyAndGetSecretNameAndNamespaceTemplate gets the values (templates) associated
// with the parameters specified in "secret" and verifies that they are specified correctly.
func verifyAndGetSecretNameAndNamespaceTemplate(storageClassParams map[string]string) (string, string, error) {
nameTemplate := storageClassParams[resizerSecretNameKey]
namespaceTemplate := storageClassParams[resizerSecretNamespaceKey]

// Name and namespaces are both specified.
if nameTemplate != "" && namespaceTemplate != "" {
return nameTemplate, namespaceTemplate, nil
}

// No secrets specified
if nameTemplate == "" && namespaceTemplate == "" {
return "", "", nil
}

// Only one of the names and namespaces is set.
return "", "", errors.New("resizer secrets specified in parameters but value of either namespace or name is empty")
}

// getSecretReference returns a reference to the secret specified in the given nameTemplate
// and namespaceTemplate, or an error if the templates are not specified correctly.
// no lookup of the referenced secret is performed, and the secret may or may not exist.
//
// supported tokens for name resolution:
// - ${pv.name}
// - ${pvc.namespace}
// - ${pvc.name}
// - ${pvc.annotations['ANNOTATION_KEY']} (e.g. ${pvc.annotations['example.com/node-publish-secret-name']})
//
// supported tokens for namespace resolution:
// - ${pv.name}
// - ${pvc.namespace}
//
// an error is returned in the following situations:
// - the nameTemplate or namespaceTemplate contains a token that cannot be resolved
// - the resolved name is not a valid secret name
// - the resolved namespace is not a valid namespace name
func getSecretReference(storageClassParams map[string]string, pvName string) (*v1.SecretReference, error) {
nameTemplate, namespaceTemplate, err := verifyAndGetSecretNameAndNamespaceTemplate(storageClassParams)
if err != nil {
return nil, fmt.Errorf("failed to get name and namespace template from params: %v", err)
}
if nameTemplate == "" && namespaceTemplate == "" {
return nil, nil
}

// Secret name and namespace template can make use of the PV name.
// Note that neither of those things are under the control of the user.
params := map[string]string{"pv.name": pvName}
resolvedNamespace, err := resolveTemplate("namespace", namespaceTemplate, params)
if err != nil {
return nil, fmt.Errorf("error resolving secret namespace %q: %v", namespaceTemplate, err)
}
resolvedName, err := resolveTemplate("name", nameTemplate, params)
if err != nil {
return nil, fmt.Errorf("error resolving value %q: %v", nameTemplate, err)
}

return &v1.SecretReference{Name: resolvedName, Namespace: resolvedNamespace}, nil
}

func resolveTemplate(field, template string, params map[string]string) (string, error) {
missingParams := sets.NewString()
resolved := os.Expand(template, func(k string) string {
v, ok := params[k]
if !ok {
missingParams.Insert(k)
}
return v
})
if missingParams.Len() > 0 {
return "", fmt.Errorf("invalid tokens: %q", missingParams.List())
}
if len(validation.IsDNS1123Label(resolved)) > 0 {
if template != resolved {
return "", fmt.Errorf("%q resolved to %q which is not a valid %s name", template, resolved, field)
}
return "", fmt.Errorf("%q is not a valid %s name", template, field)
}
return resolved, nil
}

func getCredentials(k8sClient kubernetes.Interface, ref *v1.SecretReference) (map[string]string, error) {
if ref == nil {
return nil, nil
Expand Down
94 changes: 94 additions & 0 deletions pkg/resizer/csi_resizer_test.go
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
package resizer

import (
"fmt"
"testing"
"time"

"github.com/kubernetes-csi/external-resizer/pkg/csi"
"k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/resource"
meta "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/informers"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/kubernetes/fake"
Expand Down Expand Up @@ -66,6 +71,95 @@ func TestNewResizer(t *testing.T) {
}
}

func TestResizeWithSecret(t *testing.T) {
tests := []struct {
name string
hasExpansionSecret bool
expectSecrets bool
}{
{
name: "when CSI source has expansion secret",
hasExpansionSecret: true,
expectSecrets: true,
},
{
name: "when CSI source has no secret",
hasExpansionSecret: false,
expectSecrets: false,
},
}
for _, tc := range tests {
client := csi.NewMockClient(true, true, true)
secret := makeSecret("some-secret", "secret-namespace")
k8sClient := fake.NewSimpleClientset(secret)
pv := makeTestPV("test-csi", 2, "ebs-csi", "vol-abcde", tc.hasExpansionSecret)
csiResizer := &csiResizer{
name: "ebs-csi",
client: client,
timeout: 10 * time.Second,
k8sClient: k8sClient,
}
_, _, err := csiResizer.Resize(pv, resource.MustParse("10Gi"))
if err != nil {
t.Errorf("unexpected error while expansion : %v", err)
}
usedSecrets := client.GetSecrets()
if !tc.expectSecrets && len(usedSecrets) > 0 {
t.Errorf("expected no secrets, got : %+v", usedSecrets)
}

if tc.expectSecrets && len(usedSecrets) == 0 {
t.Errorf("expected secrets got none")
}
}

}

func makeSecret(name string, namespace string) *v1.Secret {
return &v1.Secret{
ObjectMeta: meta.ObjectMeta{
Name: name,
Namespace: namespace,
UID: "23456",
ResourceVersion: "1",
},
Type: "Opaque",
Data: map[string][]byte{
"mykey": []byte("mydata"),
},
}
}

func makeTestPV(name string, sizeGig int, driverName, volID string, withSecret bool) *v1.PersistentVolume {
pv := &v1.PersistentVolume{
ObjectMeta: meta.ObjectMeta{
Name: name,
},
Spec: v1.PersistentVolumeSpec{
AccessModes: []v1.PersistentVolumeAccessMode{v1.ReadWriteOnce},
Capacity: v1.ResourceList{
v1.ResourceName(v1.ResourceStorage): resource.MustParse(
fmt.Sprintf("%dGi", sizeGig),
),
},
PersistentVolumeSource: v1.PersistentVolumeSource{
CSI: &v1.CSIPersistentVolumeSource{
Driver: driverName,
VolumeHandle: volID,
ReadOnly: false,
},
},
},
}
if withSecret {
pv.Spec.CSI.ControllerExpandSecretRef = &v1.SecretReference{
Name: "some-secret",
Namespace: "secret-namespace",
}
}
return pv
}

func fakeK8s() (kubernetes.Interface, informers.SharedInformerFactory) {
client := fake.NewSimpleClientset()
informerFactory := informers.NewSharedInformerFactory(client, 0)
Expand Down
Loading