Skip to content
Open
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
21 changes: 9 additions & 12 deletions cmd/manila-csi-plugin/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,8 @@ func main() {
ManilaClientBuilder: manilaClientBuilder,
CSIClientBuilder: csiClientBuilder,
ClusterID: clusterID,
NodeID: nodeID,
NodeAZ: nodeAZ,
PVCLister: csi.GetPVCLister(),
}

Expand All @@ -104,10 +106,12 @@ func main() {
}

if provideNodeService {
// Initialize metadata
metadata := metadata.GetMetadataProvider("")
var md metadata.IMetadata
if nodeID == "" || (withTopology && nodeAZ == "") {
md = metadata.GetMetadataProvider("")
}

err = d.SetupNodeService(metadata)
err = d.SetupNodeService(nodeID, nodeAZ, md)
if err != nil {
klog.Fatalf("Driver node service initialization failed: %v", err)
}
Expand All @@ -126,15 +130,8 @@ func main() {

cmd.PersistentFlags().StringVar(&driverName, "drivername", "manila.csi.openstack.org", "name of the driver")

cmd.PersistentFlags().StringVar(&nodeID, "nodeid", "", "this node's ID")
if err := cmd.PersistentFlags().MarkDeprecated("nodeid", "This option is now ignored by the driver. It will be removed in a future release."); err != nil {
klog.Fatalf("Unable to mark flag nodeid to be deprecated: %v", err)
}

cmd.PersistentFlags().StringVar(&nodeAZ, "nodeaz", "", "this node's availability zone")
if err := cmd.PersistentFlags().MarkDeprecated("nodeaz", "This option is now ignored by the driver. It will be removed in a future release."); err != nil {
klog.Fatalf("Unable to mark flag nodeaz to be deprecated: %v", err)
}
cmd.PersistentFlags().StringVar(&nodeID, "nodeid", "", "this node's ID. When set, the metadata service is not used to retrieve the node ID.")
cmd.PersistentFlags().StringVar(&nodeAZ, "nodeaz", "", "this node's availability zone. When set, the metadata service is not used to retrieve the availability zone.")

cmd.PersistentFlags().StringVar(&runtimeConfigFile, "runtime-config-file", "", "path to the runtime configuration file")

Expand Down
66 changes: 66 additions & 0 deletions pkg/csi/manila/adapters_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
/*
Copyright 2026 The Kubernetes Authors.

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 manila

import (
"testing"

"k8s.io/cloud-provider-openstack/pkg/csi/manila/options"
)

func TestGetAccessIDs(t *testing.T) {
tests := []struct {
name string
opts *options.NodeVolumeContext
expected []string
}{
{
name: "shareAccessIDs takes precedence over shareAccessID",
opts: &options.NodeVolumeContext{ShareAccessIDs: "new-1,new-2", ShareAccessID: "old-1"},
expected: []string{"new-1", "new-2"},
},
{
name: "only shareAccessIDs",
opts: &options.NodeVolumeContext{ShareAccessIDs: "id-1,id-2,id-3"},
expected: []string{"id-1", "id-2", "id-3"},
},
{
name: "only shareAccessID (deprecated)",
opts: &options.NodeVolumeContext{ShareAccessID: "id-1"},
expected: []string{"id-1"},
},
{
name: "neither set",
opts: &options.NodeVolumeContext{},
expected: nil,
},
}

for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
result := getAccessIDs(tc.opts)
if len(result) != len(tc.expected) {
t.Fatalf("got %v, want %v", result, tc.expected)
}
for i := range result {
if result[i] != tc.expected[i] {
t.Errorf("index %d: got %q, want %q", i, result[i], tc.expected[i])
}
}
})
}
}
45 changes: 43 additions & 2 deletions pkg/csi/manila/driver.go
Original file line number Diff line number Diff line change
Expand Up @@ -72,12 +72,43 @@ type DriverOpts struct {
ServerCSIEndpoint string
FwdCSIEndpoint string

NodeID string
NodeAZ string

ManilaClientBuilder manilaclient.Builder
CSIClientBuilder csiclient.Builder

PVCLister v1.PersistentVolumeClaimLister
}

type staticMetadata struct {
nodeID string
nodeAZ string
}

func (m *staticMetadata) GetInstanceID() (string, error) { return m.nodeID, nil }
func (m *staticMetadata) GetAvailabilityZone() (string, error) { return m.nodeAZ, nil }

type overrideMetadata struct {
nodeID string
nodeAZ string
fallback metadata.IMetadata
}

func (m *overrideMetadata) GetInstanceID() (string, error) {
if m.nodeID != "" {
return m.nodeID, nil
}
return m.fallback.GetInstanceID()
}

func (m *overrideMetadata) GetAvailabilityZone() (string, error) {
if m.nodeAZ != "" {
return m.nodeAZ, nil
}
return m.fallback.GetAvailabilityZone()
}

type nonBlockingGRPCServer struct {
wg sync.WaitGroup
server *grpc.Server
Expand Down Expand Up @@ -174,9 +205,19 @@ func (d *Driver) SetupControllerService() error {
return nil
}

func (d *Driver) SetupNodeService(metadata metadata.IMetadata) error {
func (d *Driver) SetupNodeService(nodeID, nodeAZ string, md metadata.IMetadata) error {
klog.Info("Providing node service")

var effectiveMD metadata.IMetadata
switch {
case nodeID != "" && nodeAZ != "":
effectiveMD = &staticMetadata{nodeID: nodeID, nodeAZ: nodeAZ}
case nodeID != "" || nodeAZ != "":
effectiveMD = &overrideMetadata{nodeID: nodeID, nodeAZ: nodeAZ, fallback: md}
default:
effectiveMD = md
}

var supportsNodeStage bool

nodeCapsMap, err := d.initProxiedDriver()
Expand All @@ -196,7 +237,7 @@ func (d *Driver) SetupNodeService(metadata metadata.IMetadata) error {

d.ns = &nodeServer{
d: d,
metadata: metadata,
metadata: effectiveMD,
supportsNodeStage: supportsNodeStage,
nodeStageCache: make(map[volumeID]stageCacheEntry),
}
Expand Down
146 changes: 146 additions & 0 deletions pkg/csi/manila/metadata_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
/*
Copyright 2026 The Kubernetes Authors.

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 manila

import (
"errors"
"testing"
)

type fakeMetadataProvider struct {
instanceID string
availabilityZone string
err error
}

func (f *fakeMetadataProvider) GetInstanceID() (string, error) {
if f.err != nil {
return "", f.err
}
return f.instanceID, nil
}

func (f *fakeMetadataProvider) GetAvailabilityZone() (string, error) {
if f.err != nil {
return "", f.err
}
return f.availabilityZone, nil
}

func TestStaticMetadata(t *testing.T) {
m := &staticMetadata{nodeID: "my-node", nodeAZ: "az1"}

id, err := m.GetInstanceID()
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
if id != "my-node" {
t.Errorf("expected node ID %q, got %q", "my-node", id)
}

az, err := m.GetAvailabilityZone()
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
if az != "az1" {
t.Errorf("expected AZ %q, got %q", "az1", az)
}
}

func TestOverrideMetadataNodeIDSet(t *testing.T) {
fallback := &fakeMetadataProvider{instanceID: "meta-id", availabilityZone: "meta-az"}
m := &overrideMetadata{nodeID: "flag-id", fallback: fallback}

id, err := m.GetInstanceID()
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
if id != "flag-id" {
t.Errorf("expected node ID %q, got %q", "flag-id", id)
}

az, err := m.GetAvailabilityZone()
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
if az != "meta-az" {
t.Errorf("expected AZ %q, got %q", "meta-az", az)
}
}

func TestOverrideMetadataNodeAZSet(t *testing.T) {
fallback := &fakeMetadataProvider{instanceID: "meta-id", availabilityZone: "meta-az"}
m := &overrideMetadata{nodeAZ: "flag-az", fallback: fallback}

id, err := m.GetInstanceID()
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
if id != "meta-id" {
t.Errorf("expected node ID %q, got %q", "meta-id", id)
}

az, err := m.GetAvailabilityZone()
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
if az != "flag-az" {
t.Errorf("expected AZ %q, got %q", "flag-az", az)
}
}

func TestOverrideMetadataBothSet(t *testing.T) {
fallback := &fakeMetadataProvider{err: errors.New("should not be called")}
m := &overrideMetadata{nodeID: "flag-id", nodeAZ: "flag-az", fallback: fallback}

id, err := m.GetInstanceID()
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
if id != "flag-id" {
t.Errorf("expected node ID %q, got %q", "flag-id", id)
}

az, err := m.GetAvailabilityZone()
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
if az != "flag-az" {
t.Errorf("expected AZ %q, got %q", "flag-az", az)
}
}

func TestOverrideMetadataNeitherSet(t *testing.T) {
fallback := &fakeMetadataProvider{instanceID: "meta-id", availabilityZone: "meta-az"}
m := &overrideMetadata{fallback: fallback}

id, err := m.GetInstanceID()
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
if id != "meta-id" {
t.Errorf("expected node ID %q, got %q", "meta-id", id)
}

az, err := m.GetAvailabilityZone()
if err != nil {
t.Fatalf("unexpected error: %v", err)
}
if az != "meta-az" {
t.Errorf("expected AZ %q, got %q", "meta-az", az)
}
}
4 changes: 2 additions & 2 deletions pkg/csi/manila/options/shareoptions.go
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ type ControllerVolumeContext struct {
type NodeVolumeContext struct {
ShareID string `name:"shareID" value:"optionalIf:shareName=." precludes:"shareName"`
ShareName string `name:"shareName" value:"optionalIf:shareID=." precludes:"shareID"`
ShareAccessID string `name:"shareAccessID" value:"optionalIf:shareAccessIDs=." precludes:"shareAccessIDs"` // Keep this for backwards compatibility
ShareAccessIDs string `name:"shareAccessIDs" value:"optionalIf:shareAccessID=." precludes:"shareAccessID"`
ShareAccessID string `name:"shareAccessID" value:"optional"` // Deprecated: use shareAccessIDs
ShareAccessIDs string `name:"shareAccessIDs" value:"optional"` // Preferred; takes precedence over shareAccessID

// Adapter options

Expand Down
Loading