azurefile

package
v1.31.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 9, 2025 License: Apache-2.0 Imports: 71 Imported by: 0

Documentation

Overview

Package azurefile is a generated GoMock package.

Index

Constants

View Source 
const (
	DefaultAzureCredentialFileEnv = "AZURE_CREDENTIAL_FILE"
	DefaultCredFilePathLinux      = "/etc/kubernetes/azure.json"
	DefaultCredFilePathWindows    = "C:\\k\\azure.json"
)
View Source 
const (
	DefaultDriverName = "file.csi.azure.com"

	VolumeID         = "volumeid"
	SourceResourceID = "source_resource_id"
	SnapshotName     = "snapshot_name"
	SnapshotID       = "snapshot_id"

	FSGroupChangeNone = "None"
)
View Source 
const (
	MSI = "MSI"
	SPN = "SPN"
)
View Source 
const (
	// FileShareAccountNamePrefix is the file share account name prefix
	FileShareAccountNamePrefix = "f"
)

Variables

This section is empty.

Functions

func CleanupMountPoint added in v0.6.0 

func CleanupMountPoint(m *mount.SafeFormatAndMount, target string, extensiveMountCheck bool) error

func ConvertTagsToMap added in v1.2.0 

func ConvertTagsToMap(tags string, tagsDelimiter string) (map[string]string, error)

func GetFileShareInfo added in v0.8.0 

func GetFileShareInfo(id string) (string, string, string, string, string, string, error)

get file share info according to volume id, e.g. input: "rg#f5713de20cde511e8ba4900#fileShareName#diskname.vhd#uuid#namespace#subsID" output: rg, f5713de20cde511e8ba4900, fileShareName, diskname.vhd, namespace, subsID

func GetUserAgent added in v1.6.0 

func GetUserAgent(driverName, customUserAgent, userAgentSuffix string) string

GetUserAgent returns user agent of the driver

func GetVersionYAML 

func GetVersionYAML(driverName string) (string, error)

GetVersionYAML returns the version information of the driver in YAML format

func GetVolumeStats added in v1.28.2 

func GetVolumeStats(path string, _ bool) (*csi.NodeGetVolumeStatsResponse, error)

GetVolumeStats returns volume stats based on the given path.

func IsCorruptedDir added in v0.5.0 

func IsCorruptedDir(dir string) bool

func NewFakeMounter added in v1.0.0 

func NewFakeMounter() (*mount.SafeFormatAndMount, error)

NewFakeMounter fake mounter

func SMBMount added in v0.6.0 

func SMBMount(m *mount.SafeFormatAndMount, source, target, fsType string, options, sensitiveMountOptions []string) error

func SMBUnmount added in v0.6.0 

func SMBUnmount(m *mount.SafeFormatAndMount, target string, extensiveMountCheck, _ bool) error

func SetVolumeOwnership added in v1.7.0 

func SetVolumeOwnership(path, gid, policy string) error

SetVolumeOwnership would set gid for path recursively

Types

type DirectVolume added in v1.31.0 

type DirectVolume interface {
	Add(volumePath string, mountInfo string) error
	Remove(volumePath string) error
	VolumeMountInfo(volumePath string) (*volume.MountInfo, error)
	RecordSandboxID(sandboxID string, volumePath string) error
	GetSandboxIDForVolume(volumePath string) (string, error)
}

type Driver 

type Driver struct {
	csicommon.CSIDriver
	// Embed UnimplementedXXXServer to ensure the driver returns Unimplemented for any
	// new RPC methods that might be introduced in future versions of the spec.
	csi.UnimplementedControllerServer
	csi.UnimplementedIdentityServer
	csi.UnimplementedNodeServer
	// contains filtered or unexported fields
}

Driver implements all interfaces of CSI drivers

func NewDriver 

func NewDriver(options *DriverOptions) *Driver

NewDriver Creates a NewCSIDriver object. Assumes vendor version is equal to driver version & does not support optional driver plugin info manifest field. Refer to CSI spec for more details.

func (*Driver) ControllerExpandVolume 

func (d *Driver) ControllerExpandVolume(ctx context.Context, req *csi.ControllerExpandVolumeRequest) (*csi.ControllerExpandVolumeResponse, error)

ControllerExpandVolume controller expand volume

func (*Driver) ControllerGetCapabilities 

func (d *Driver) ControllerGetCapabilities(_ context.Context, _ *csi.ControllerGetCapabilitiesRequest) (*csi.ControllerGetCapabilitiesResponse, error)

ControllerGetCapabilities returns the capabilities of the Controller plugin

func (*Driver) ControllerGetVolume added in v0.8.0 

func (d *Driver) ControllerGetVolume(context.Context, *csi.ControllerGetVolumeRequest) (*csi.ControllerGetVolumeResponse, error)

ControllerGetVolume get volume

func (*Driver) ControllerModifyVolume added in v1.31.0 

func (d *Driver) ControllerModifyVolume(context.Context, *csi.ControllerModifyVolumeRequest) (*csi.ControllerModifyVolumeResponse, error)

ControllerModifyVolume modify volume

func (*Driver) ControllerPublishVolume 

func (d *Driver) ControllerPublishVolume(_ context.Context, _ *csi.ControllerPublishVolumeRequest) (*csi.ControllerPublishVolumeResponse, error)

ControllerPublishVolume make a volume available on some required node

func (*Driver) ControllerUnpublishVolume 

func (d *Driver) ControllerUnpublishVolume(_ context.Context, _ *csi.ControllerUnpublishVolumeRequest) (*csi.ControllerUnpublishVolumeResponse, error)

ControllerUnpublishVolume detach the volume on a specified node

func (*Driver) CreateFileShare added in v0.9.0 

func (d *Driver) CreateFileShare(ctx context.Context, accountOptions *azure.AccountOptions, shareOptions *ShareOptions, secrets map[string]string) error

CreateFileShare creates a file share

func (*Driver) CreateSnapshot 

func (d *Driver) CreateSnapshot(ctx context.Context, req *csi.CreateSnapshotRequest) (*csi.CreateSnapshotResponse, error)

CreateSnapshot create a snapshot

func (*Driver) CreateVolume 

func (d *Driver) CreateVolume(ctx context.Context, req *csi.CreateVolumeRequest) (*csi.CreateVolumeResponse, error)

CreateVolume provisions an azure file

func (*Driver) DeleteFileShare added in v0.9.0 

func (d *Driver) DeleteFileShare(ctx context.Context, subsID, resourceGroup, accountName, shareName string, secrets map[string]string) error

DeleteFileShare deletes a file share using storage account name and key

func (*Driver) DeleteSnapshot 

func (d *Driver) DeleteSnapshot(ctx context.Context, req *csi.DeleteSnapshotRequest) (*csi.DeleteSnapshotResponse, error)

DeleteSnapshot delete a snapshot (todo)

func (*Driver) DeleteVolume 

func (d *Driver) DeleteVolume(ctx context.Context, req *csi.DeleteVolumeRequest) (*csi.DeleteVolumeResponse, error)

DeleteVolume delete an azure file

func (*Driver) GetAccountInfo added in v0.7.0 

func (d *Driver) GetAccountInfo(ctx context.Context, volumeID string, secrets, reqContext map[string]string) (string, string, string, string, string, string, error)

GetAccountInfo get account info return <rgName, accountName, accountKey, fileShareName, diskName, subsID, err>

func (*Driver) GetCapacity 

func (d *Driver) GetCapacity(_ context.Context, _ *csi.GetCapacityRequest) (*csi.GetCapacityResponse, error)

GetCapacity returns the capacity of the total available storage pool

func (*Driver) GetPluginCapabilities 

func (f *Driver) GetPluginCapabilities(_ context.Context, _ *csi.GetPluginCapabilitiesRequest) (*csi.GetPluginCapabilitiesResponse, error)

GetPluginCapabilities returns the capabilities of the plugin

func (*Driver) GetPluginInfo 

func (f *Driver) GetPluginInfo(_ context.Context, _ *csi.GetPluginInfoRequest) (*csi.GetPluginInfoResponse, error)

GetPluginInfo return the version and name of the plugin

func (*Driver) GetStorageAccesskey added in v0.10.0 

func (d *Driver) GetStorageAccesskey(ctx context.Context, accountOptions *azure.AccountOptions, secrets map[string]string, secretName, secretNamespace string) (string, error)

GetStorageAccesskey get Azure storage account key from

  1. secrets (if not empty)
  2. use k8s client identity to read from k8s secret
  3. use cluster identity to get from storage account directly

func (*Driver) GetStorageAccountFromSecret added in v1.3.0 

func (d *Driver) GetStorageAccountFromSecret(ctx context.Context, secretName, secretNamespace string) (string, string, error)

GetStorageAccountFromSecret get storage account key from k8s secret return <accountName, accountKey, error>

func (*Driver) GetTotalAccountQuota added in v1.24.6 

func (d *Driver) GetTotalAccountQuota(ctx context.Context, subsID, resourceGroup, accountName string) (int32, int32, error)

GetTotalAccountQuota returns the total quota in GB of all file shares in the storage account and the number of file shares

func (*Driver) ListSnapshots 

func (d *Driver) ListSnapshots(_ context.Context, _ *csi.ListSnapshotsRequest) (*csi.ListSnapshotsResponse, error)

ListSnapshots list all snapshots (todo)

func (*Driver) ListVolumes 

func (d *Driver) ListVolumes(_ context.Context, _ *csi.ListVolumesRequest) (*csi.ListVolumesResponse, error)

ListVolumes return all available volumes

func (*Driver) NodeExpandVolume 

func (d *Driver) NodeExpandVolume(_ context.Context, _ *csi.NodeExpandVolumeRequest) (*csi.NodeExpandVolumeResponse, error)

NodeExpandVolume node expand volume N/A for azure file

func (*Driver) NodeGetCapabilities 

func (d *Driver) NodeGetCapabilities(_ context.Context, _ *csi.NodeGetCapabilitiesRequest) (*csi.NodeGetCapabilitiesResponse, error)

NodeGetCapabilities return the capabilities of the Node plugin

func (*Driver) NodeGetInfo 

func (d *Driver) NodeGetInfo(_ context.Context, _ *csi.NodeGetInfoRequest) (*csi.NodeGetInfoResponse, error)

NodeGetInfo return info of the node on which this plugin is running

func (*Driver) NodeGetVolumeStats 

func (d *Driver) NodeGetVolumeStats(ctx context.Context, req *csi.NodeGetVolumeStatsRequest) (*csi.NodeGetVolumeStatsResponse, error)

NodeGetVolumeStats get volume stats

func (*Driver) NodePublishVolume 

func (d *Driver) NodePublishVolume(ctx context.Context, req *csi.NodePublishVolumeRequest) (*csi.NodePublishVolumeResponse, error)

NodePublishVolume mount the volume from staging to target path

func (*Driver) NodeStageVolume 

func (d *Driver) NodeStageVolume(ctx context.Context, req *csi.NodeStageVolumeRequest) (*csi.NodeStageVolumeResponse, error)

NodeStageVolume mount the volume to a staging path

func (*Driver) NodeUnpublishVolume 

func (d *Driver) NodeUnpublishVolume(_ context.Context, req *csi.NodeUnpublishVolumeRequest) (*csi.NodeUnpublishVolumeResponse, error)

NodeUnpublishVolume unmount the volume from the target path

func (*Driver) NodeUnstageVolume 

func (d *Driver) NodeUnstageVolume(_ context.Context, req *csi.NodeUnstageVolumeRequest) (*csi.NodeUnstageVolumeResponse, error)

NodeUnstageVolume unmount the volume from the staging path

func (*Driver) Probe 

func (f *Driver) Probe(_ context.Context, _ *csi.ProbeRequest) (*csi.ProbeResponse, error)

Probe check whether the plugin is running or not. This method does not need to return anything. Currently the spec does not dictate what you should return either. Hence, return an empty response

func (*Driver) RemoveStorageAccountTag added in v1.1.0 

func (d *Driver) RemoveStorageAccountTag(ctx context.Context, subsID, resourceGroup, account, key string) error

RemoveStorageAccountTag remove tag from storage account

func (*Driver) ResizeFileShare added in v0.9.0 

func (d *Driver) ResizeFileShare(ctx context.Context, subsID, resourceGroup, accountName, shareName string, sizeGiB int, secrets map[string]string) error

ResizeFileShare resizes a file share

func (*Driver) Run 

func (d *Driver) Run(ctx context.Context) error

Run driver initialization

func (*Driver) SetAzureCredentials added in v1.2.0 

func (d *Driver) SetAzureCredentials(ctx context.Context, accountName, accountKey, secretName, secretNamespace string) (string, error)

func (*Driver) ValidateVolumeCapabilities 

func (d *Driver) ValidateVolumeCapabilities(ctx context.Context, req *csi.ValidateVolumeCapabilitiesRequest) (*csi.ValidateVolumeCapabilitiesResponse, error)

ValidateVolumeCapabilities return the capabilities of the volume

type DriverOptions added in v1.5.0 

type DriverOptions struct {
	NodeID                                 string
	DriverName                             string
	CloudConfigSecretName                  string
	CloudConfigSecretNamespace             string
	CustomUserAgent                        string
	UserAgentSuffix                        string
	AllowEmptyCloudConfig                  bool
	AllowInlineVolumeKeyAccessWithIdentity bool
	EnableVHDDiskFeature                   bool
	EnableVolumeMountGroup                 bool
	EnableGetVolumeStats                   bool
	EnableKataCCMount                      bool
	AppendMountErrorHelpLink               bool
	MountPermissions                       uint64
	FSGroupChangePolicy                    string
	KubeAPIQPS                             float64
	KubeAPIBurst                           int
	EnableWindowsHostProcess               bool
	RemoveSMBMountOnWindows                bool
	AppendClosetimeoOption                 bool
	AppendNoShareSockOption                bool
	AppendNoResvPortOption                 bool
	AppendActimeoOption                    bool
	SkipMatchingTagCacheExpireInMinutes    int
	VolStatsCacheExpireInMinutes           int
	PrintVolumeStatsCallLogs               bool
	SasTokenExpirationMinutes              int
	WaitForAzCopyTimeoutMinutes            int
	GoMaxProcs                             int
	KubeConfig                             string
	Endpoint                               string
}

DriverOptions defines driver parameters specified in driver deployment

func (*DriverOptions) AddFlags added in v1.30.0 

func (o *DriverOptions) AddFlags() *flag.FlagSet

type MockAzureFileClient added in v1.30.0 

type MockAzureFileClient struct {
	// contains filtered or unexported fields
}

MockAzureFileClient is a mock of AzureFileClient interface.

func NewMockAzureFileClient added in v1.30.0 

func NewMockAzureFileClient(ctrl *gomock.Controller) *MockAzureFileClient

NewMockAzureFileClient creates a new mock instance.

func (*MockAzureFileClient) CreateFileShare added in v1.30.0 

func (m *MockAzureFileClient) CreateFileShare(ctx context.Context, shareOptions *ShareOptions) error

CreateFileShare mocks base method.

func (*MockAzureFileClient) DeleteFileShare added in v1.30.0 

func (m *MockAzureFileClient) DeleteFileShare(ctx context.Context, name string) error

DeleteFileShare mocks base method.

func (*MockAzureFileClient) EXPECT added in v1.30.0 

func (m *MockAzureFileClient) EXPECT() *MockAzureFileClientMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockAzureFileClient) GetFileShareQuota added in v1.30.0 

func (m *MockAzureFileClient) GetFileShareQuota(ctx context.Context, name string) (int, error)

GetFileShareQuota mocks base method.

func (*MockAzureFileClient) ResizeFileShare added in v1.30.0 

func (m *MockAzureFileClient) ResizeFileShare(ctx context.Context, name string, sizeGiB int) error

ResizeFileShare mocks base method.

type MockAzureFileClientMockRecorder added in v1.30.0 

type MockAzureFileClientMockRecorder struct {
	// contains filtered or unexported fields
}

MockAzureFileClientMockRecorder is the mock recorder for MockAzureFileClient.

func (*MockAzureFileClientMockRecorder) CreateFileShare added in v1.30.0 

func (mr *MockAzureFileClientMockRecorder) CreateFileShare(ctx, shareOptions any) *gomock.Call

CreateFileShare indicates an expected call of CreateFileShare.

func (*MockAzureFileClientMockRecorder) DeleteFileShare added in v1.30.0 

func (mr *MockAzureFileClientMockRecorder) DeleteFileShare(ctx, name any) *gomock.Call

DeleteFileShare indicates an expected call of DeleteFileShare.

func (*MockAzureFileClientMockRecorder) GetFileShareQuota added in v1.30.0 

func (mr *MockAzureFileClientMockRecorder) GetFileShareQuota(ctx, name any) *gomock.Call

GetFileShareQuota indicates an expected call of GetFileShareQuota.

func (*MockAzureFileClientMockRecorder) ResizeFileShare added in v1.30.0 

func (mr *MockAzureFileClientMockRecorder) ResizeFileShare(ctx, name, sizeGiB any) *gomock.Call

ResizeFileShare indicates an expected call of ResizeFileShare.

type MockDirectVolume added in v1.31.0 

type MockDirectVolume struct {
	// contains filtered or unexported fields
}

MockDirectVolume is a mock of DirectVolume interface.

func NewMockDirectVolume added in v1.31.0 

func NewMockDirectVolume(ctrl *gomock.Controller) *MockDirectVolume

NewMockDirectVolume creates a new mock instance.

func (*MockDirectVolume) Add added in v1.31.0 

func (m *MockDirectVolume) Add(volumePath, mountInfo string) error

Add mocks base method.

func (*MockDirectVolume) EXPECT added in v1.31.0 

func (m *MockDirectVolume) EXPECT() *MockDirectVolumeMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockDirectVolume) GetSandboxIDForVolume added in v1.31.0 

func (m *MockDirectVolume) GetSandboxIDForVolume(volumePath string) (string, error)

GetSandboxIDForVolume mocks base method. nolint: var-naming

func (*MockDirectVolume) RecordSandboxID added in v1.31.0 

func (m *MockDirectVolume) RecordSandboxID(sandboxID, volumePath string) error

RecordSandboxID mocks base method.

func (*MockDirectVolume) Remove added in v1.31.0 

func (m *MockDirectVolume) Remove(volumePath string) error

Remove mocks base method.

func (*MockDirectVolume) VolumeMountInfo added in v1.31.0 

func (m *MockDirectVolume) VolumeMountInfo(volumePath string) (*volume.MountInfo, error)

VolumeMountInfo mocks base method.

type MockDirectVolumeMockRecorder added in v1.31.0 

type MockDirectVolumeMockRecorder struct {
	// contains filtered or unexported fields
}

MockDirectVolumeMockRecorder is the mock recorder for MockDirectVolume.

func (*MockDirectVolumeMockRecorder) Add added in v1.31.0 

func (mr *MockDirectVolumeMockRecorder) Add(volumePath, mountInfo interface{}) *gomock.Call

Add indicates an expected call of Add.

func (*MockDirectVolumeMockRecorder) GetSandboxIDForVolume added in v1.31.0 

func (mr *MockDirectVolumeMockRecorder) GetSandboxIDForVolume(volumePath interface{}) *gomock.Call

GetSandboxIDForVolume indicates an expected call of GetSandboxIDForVolume.

func (*MockDirectVolumeMockRecorder) RecordSandboxID added in v1.31.0 

func (mr *MockDirectVolumeMockRecorder) RecordSandboxID(sandboxID, volumePath interface{}) *gomock.Call

RecordSandboxID indicates an expected call of RecordSandboxID.

func (*MockDirectVolumeMockRecorder) Remove added in v1.31.0 

func (mr *MockDirectVolumeMockRecorder) Remove(volumePath interface{}) *gomock.Call

Remove indicates an expected call of Remove.

func (*MockDirectVolumeMockRecorder) VolumeMountInfo added in v1.31.0 

func (mr *MockDirectVolumeMockRecorder) VolumeMountInfo(volumePath interface{}) *gomock.Call

VolumeMountInfo indicates an expected call of VolumeMountInfo.

type MockResolver added in v1.31.0 

type MockResolver struct {
	// contains filtered or unexported fields
}

MockResolver is a mock of Resolver interface.

func NewMockResolver added in v1.31.0 

func NewMockResolver(ctrl *gomock.Controller) *MockResolver

NewMockResolver creates a new mock instance.

func (*MockResolver) EXPECT added in v1.31.0 

func (m *MockResolver) EXPECT() *MockResolverMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockResolver) ResolveIPAddr added in v1.31.0 

func (m *MockResolver) ResolveIPAddr(network, address string) (*net.IPAddr, error)

ResolveIPAddr mocks base method.

type MockResolverMockRecorder added in v1.31.0 

type MockResolverMockRecorder struct {
	// contains filtered or unexported fields
}

MockResolverMockRecorder is the mock recorder for MockResolver.

func (*MockResolverMockRecorder) ResolveIPAddr added in v1.31.0 

func (mr *MockResolverMockRecorder) ResolveIPAddr(network, address interface{}) *gomock.Call

ResolveIPAddr indicates an expected call of ResolveIPAddr.

type NetResolver added in v1.31.0 

type NetResolver struct{}

NetResolver is the real implementation of the Resolver interface.

func (*NetResolver) ResolveIPAddr added in v1.31.0 

func (r *NetResolver) ResolveIPAddr(network, address string) (*net.IPAddr, error)

ResolveIPAddr resolves the IP address using net.ResolveIPAddr.

type Resolver added in v1.31.0 

type Resolver interface {
	ResolveIPAddr(network, address string) (*net.IPAddr, error)
}

Resolver is an interface for resolving IP addresses.

type ShareOptions added in v1.31.0 

type ShareOptions struct {
	Name       string
	Protocol   armstorage.EnabledProtocols
	RequestGiB int
	// supported values: ""(by default), "TransactionOptimized", "Cool", "Hot", "Premium"
	AccessTier string
	// supported values: ""(by default), "AllSquash", "NoRootSquash", "RootSquash"
	RootSquash string
	// Metadata - A name-value pair to associate with the share as metadata.
	Metadata map[string]*string
}

ShareOptions contains the fields which are used to create file share.

type VersionInfo 

type VersionInfo struct {
	DriverName    string `json:"Driver Name"`
	DriverVersion string `json:"Driver Version"`
	GitCommit     string `json:"Git Commit"`
	BuildDate     string `json:"Build Date"`
	GoVersion     string `json:"Go Version"`
	Compiler      string `json:"Compiler"`
	Platform      string `json:"Platform"`
}

VersionInfo holds the version information of the driver

func GetVersion 

func GetVersion(driverName string) VersionInfo

GetVersion returns the version information of the driver

type VolumeMounter added in v1.7.0 

type VolumeMounter struct {
	// contains filtered or unexported fields
}

func (*VolumeMounter) CanMount added in v1.7.0 

func (l *VolumeMounter) CanMount() error

func (*VolumeMounter) GetAttributes added in v1.7.0 

func (l *VolumeMounter) GetAttributes() volume.Attributes

func (*VolumeMounter) GetMetrics added in v1.7.0 

func (l *VolumeMounter) GetMetrics() (*volume.Metrics, error)

func (*VolumeMounter) GetPath added in v1.7.0 

func (l *VolumeMounter) GetPath() string

func (*VolumeMounter) SetUp added in v1.7.0 

func (l *VolumeMounter) SetUp(_ volume.MounterArgs) error

func (*VolumeMounter) SetUpAt added in v1.7.0 

func (l *VolumeMounter) SetUpAt(_ string, _ volume.MounterArgs) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.