v1alpha1

package
v1.4.7 Latest Latest
Warning

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

 Go to latest Published: Dec 7, 2024 License: Apache-2.0 Imports: 8 Imported by: 26

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var CSIDriverProvider_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "v1alpha1.CSIDriverProvider",
	HandlerType: (*CSIDriverProviderServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Version",
			Handler:    _CSIDriverProvider_Version_Handler,
		},
		{
			MethodName: "Mount",
			Handler:    _CSIDriverProvider_Mount_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "provider/v1alpha1/service.proto",
}

CSIDriverProvider_ServiceDesc is the grpc.ServiceDesc for CSIDriverProvider service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var File_provider_v1alpha1_service_proto protoreflect.FileDescriptor

Functions

func RegisterCSIDriverProviderServer 

func RegisterCSIDriverProviderServer(s grpc.ServiceRegistrar, srv CSIDriverProviderServer)

Types

type CSIDriverProviderClient 

type CSIDriverProviderClient interface {
	// Version returns the runtime name and runtime version of the Secrets Store CSI Driver Provider
	// TODO (aramase) This will be used later to ensure the provider the driver is talking to supports
	// the current version
	Version(ctx context.Context, in *VersionRequest, opts ...grpc.CallOption) (*VersionResponse, error)
	// Execute mount operation in provider
	Mount(ctx context.Context, in *MountRequest, opts ...grpc.CallOption) (*MountResponse, error)
}

CSIDriverProviderClient is the client API for CSIDriverProvider service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewCSIDriverProviderClient 

func NewCSIDriverProviderClient(cc grpc.ClientConnInterface) CSIDriverProviderClient

type CSIDriverProviderServer 

type CSIDriverProviderServer interface {
	// Version returns the runtime name and runtime version of the Secrets Store CSI Driver Provider
	// TODO (aramase) This will be used later to ensure the provider the driver is talking to supports
	// the current version
	Version(context.Context, *VersionRequest) (*VersionResponse, error)
	// Execute mount operation in provider
	Mount(context.Context, *MountRequest) (*MountResponse, error)
}

CSIDriverProviderServer is the server API for CSIDriverProvider service. All implementations should embed UnimplementedCSIDriverProviderServer for forward compatibility

type Error 

type Error struct {

	// Code is the error code that the provider can return which will be used for publishing metrics
	Code string `protobuf:"bytes,1,opt,name=code,proto3" json:"code,omitempty"`
	// contains filtered or unexported fields
}

func (*Error) Descriptor deprecated 

func (*Error) Descriptor() ([]byte, []int)

Deprecated: Use Error.ProtoReflect.Descriptor instead.

func (*Error) GetCode 

func (x *Error) GetCode() string

func (*Error) ProtoMessage 

func (*Error) ProtoMessage()

func (*Error) ProtoReflect 

func (x *Error) ProtoReflect() protoreflect.Message

func (*Error) Reset 

func (x *Error) Reset()

func (*Error) String 

func (x *Error) String() string

type File added in v0.0.21 

type File struct {

	// The relative path of the file within the mount.
	// May not be an absolute path.
	// May not contain the path element '..'.
	// May not start with the string '..'.
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// The mode bits used to set permissions on this file.
	// Must be a decimal value between 0 and 511.
	Mode int32 `protobuf:"varint,2,opt,name=mode,proto3" json:"mode,omitempty"`
	// The file contents.
	Contents []byte `protobuf:"bytes,3,opt,name=contents,proto3" json:"contents,omitempty"`
	// contains filtered or unexported fields
}

File holds secret file contents and location in the mount path to write the file.

func (*File) Descriptor deprecated added in v0.0.21 

func (*File) Descriptor() ([]byte, []int)

Deprecated: Use File.ProtoReflect.Descriptor instead.

func (*File) GetContents added in v0.0.21 

func (x *File) GetContents() []byte

func (*File) GetMode added in v0.0.21 

func (x *File) GetMode() int32

func (*File) GetPath added in v0.0.21 

func (x *File) GetPath() string

func (*File) ProtoMessage added in v0.0.21 

func (*File) ProtoMessage()

func (*File) ProtoReflect added in v0.0.21 

func (x *File) ProtoReflect() protoreflect.Message

func (*File) Reset added in v0.0.21 

func (x *File) Reset()

func (*File) String added in v0.0.21 

func (x *File) String() string

type MountRequest 

type MountRequest struct {

	// Attributes is the parameters field defined in the SecretProviderClass
	Attributes string `protobuf:"bytes,1,opt,name=attributes,proto3" json:"attributes,omitempty"`
	// Secrets is the secret content referenced in nodePublishSecretRef secret data
	Secrets string `protobuf:"bytes,2,opt,name=secrets,proto3" json:"secrets,omitempty"`
	// TargetPath is the path to which the volume will be published
	// TODO(tam7t): deprecate
	TargetPath string `protobuf:"bytes,3,opt,name=target_path,json=targetPath,proto3" json:"target_path,omitempty"`
	// Permission is the file permissions
	// TODO(tam7t): deprecate
	Permission string `protobuf:"bytes,4,opt,name=permission,proto3" json:"permission,omitempty"`
	// CurrentObjectVersion is the list of objects and their versions that's
	// currently mounted in the pod
	CurrentObjectVersion []*ObjectVersion `protobuf:"bytes,5,rep,name=current_object_version,json=currentObjectVersion,proto3" json:"current_object_version,omitempty"`
	// contains filtered or unexported fields
}

func (*MountRequest) Descriptor deprecated 

func (*MountRequest) Descriptor() ([]byte, []int)

Deprecated: Use MountRequest.ProtoReflect.Descriptor instead.

func (*MountRequest) GetAttributes 

func (x *MountRequest) GetAttributes() string

func (*MountRequest) GetCurrentObjectVersion added in v0.0.15 

func (x *MountRequest) GetCurrentObjectVersion() []*ObjectVersion

func (*MountRequest) GetPermission 

func (x *MountRequest) GetPermission() string

func (*MountRequest) GetSecrets 

func (x *MountRequest) GetSecrets() string

func (*MountRequest) GetTargetPath 

func (x *MountRequest) GetTargetPath() string

func (*MountRequest) ProtoMessage 

func (*MountRequest) ProtoMessage()

func (*MountRequest) ProtoReflect 

func (x *MountRequest) ProtoReflect() protoreflect.Message

func (*MountRequest) Reset 

func (x *MountRequest) Reset()

func (*MountRequest) String 

func (x *MountRequest) String() string

type MountResponse 

type MountResponse struct {
	ObjectVersion []*ObjectVersion `protobuf:"bytes,1,rep,name=object_version,json=objectVersion,proto3" json:"object_version,omitempty"`
	Error         *Error           `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`
	// files contains the entire mount volume filesystem.
	//
	// The total size of all files should not exceed 1MiB or syncing to
	// Kubernetes Secrets will fail. If the contents of all files exceeds
	// 4MiB then requests could fail unless MaxCallRecvMsgSize is increased.
	Files []*File `protobuf:"bytes,3,rep,name=files,proto3" json:"files,omitempty"`
	// contains filtered or unexported fields
}

func (*MountResponse) Descriptor deprecated 

func (*MountResponse) Descriptor() ([]byte, []int)

Deprecated: Use MountResponse.ProtoReflect.Descriptor instead.

func (*MountResponse) GetError 

func (x *MountResponse) GetError() *Error

func (*MountResponse) GetFiles added in v0.0.21 

func (x *MountResponse) GetFiles() []*File

func (*MountResponse) GetObjectVersion 

func (x *MountResponse) GetObjectVersion() []*ObjectVersion

func (*MountResponse) ProtoMessage 

func (*MountResponse) ProtoMessage()

func (*MountResponse) ProtoReflect 

func (x *MountResponse) ProtoReflect() protoreflect.Message

func (*MountResponse) Reset 

func (x *MountResponse) Reset()

func (*MountResponse) String 

func (x *MountResponse) String() string

type ObjectVersion 

type ObjectVersion struct {

	// Id is the object UID that is fetched from external secrets store
	// The Id should be unique. If multiple objects fetched from the secrets
	// store contain the same name, the provider should return a uid. This will
	// be populated in the SecretProviderClassPodStatus and sent back to the
	// provider as part of rotation reconcile
	// Example: secret/secret1, key/secret1, projects/$PROJECT_ID/secrets/secret1
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Version is the object version that is fetched from external secrets store
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

func (*ObjectVersion) Descriptor deprecated 

func (*ObjectVersion) Descriptor() ([]byte, []int)

Deprecated: Use ObjectVersion.ProtoReflect.Descriptor instead.

func (*ObjectVersion) GetId 

func (x *ObjectVersion) GetId() string

func (*ObjectVersion) GetVersion 

func (x *ObjectVersion) GetVersion() string

func (*ObjectVersion) ProtoMessage 

func (*ObjectVersion) ProtoMessage()

func (*ObjectVersion) ProtoReflect 

func (x *ObjectVersion) ProtoReflect() protoreflect.Message

func (*ObjectVersion) Reset 

func (x *ObjectVersion) Reset()

func (*ObjectVersion) String 

func (x *ObjectVersion) String() string

type UnimplementedCSIDriverProviderServer 

type UnimplementedCSIDriverProviderServer struct {
}

UnimplementedCSIDriverProviderServer should be embedded to have forward compatible implementations.

func (UnimplementedCSIDriverProviderServer) Mount 

func (UnimplementedCSIDriverProviderServer) Mount(context.Context, *MountRequest) (*MountResponse, error)

func (UnimplementedCSIDriverProviderServer) Version 

func (UnimplementedCSIDriverProviderServer) Version(context.Context, *VersionRequest) (*VersionResponse, error)

type UnsafeCSIDriverProviderServer added in v1.3.0 

type UnsafeCSIDriverProviderServer interface {
	// contains filtered or unexported methods
}

UnsafeCSIDriverProviderServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to CSIDriverProviderServer will result in compilation errors.

type VersionRequest 

type VersionRequest struct {

	// Version of the Secrets Store CSI Driver
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

func (*VersionRequest) Descriptor deprecated 

func (*VersionRequest) Descriptor() ([]byte, []int)

Deprecated: Use VersionRequest.ProtoReflect.Descriptor instead.

func (*VersionRequest) GetVersion 

func (x *VersionRequest) GetVersion() string

func (*VersionRequest) ProtoMessage 

func (*VersionRequest) ProtoMessage()

func (*VersionRequest) ProtoReflect 

func (x *VersionRequest) ProtoReflect() protoreflect.Message

func (*VersionRequest) Reset 

func (x *VersionRequest) Reset()

func (*VersionRequest) String 

func (x *VersionRequest) String() string

type VersionResponse 

type VersionResponse struct {

	// Version of the Secrets Store CSI Driver
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// Name of the Secrets Store CSI Driver Provider
	RuntimeName string `protobuf:"bytes,2,opt,name=runtime_name,json=runtimeName,proto3" json:"runtime_name,omitempty"`
	// Version of the Secrets Store CSI Driver Provider. The string must be semver-compatible.
	RuntimeVersion string `protobuf:"bytes,3,opt,name=runtime_version,json=runtimeVersion,proto3" json:"runtime_version,omitempty"`
	// contains filtered or unexported fields
}

func (*VersionResponse) Descriptor deprecated 

func (*VersionResponse) Descriptor() ([]byte, []int)

Deprecated: Use VersionResponse.ProtoReflect.Descriptor instead.

func (*VersionResponse) GetRuntimeName 

func (x *VersionResponse) GetRuntimeName() string

func (*VersionResponse) GetRuntimeVersion 

func (x *VersionResponse) GetRuntimeVersion() string

func (*VersionResponse) GetVersion 

func (x *VersionResponse) GetVersion() string

func (*VersionResponse) ProtoMessage 

func (*VersionResponse) ProtoMessage()

func (*VersionResponse) ProtoReflect 

func (x *VersionResponse) ProtoReflect() protoreflect.Message

func (*VersionResponse) Reset 

func (x *VersionResponse) Reset()

func (*VersionResponse) String 

func (x *VersionResponse) String() string

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.