sdk

package
v10.1.1 Latest Latest
Warning

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

 Go to latest Published: Apr 12, 2022 License: Apache-2.0 Imports: 44 Imported by: 0

Documentation

Overview

Package sdk is the gRPC implementation of the SDK gRPC server Copyright 2018 Portworx

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 sdk is the gRPC implementation of the SDK gRPC server Copyright 2018 Portworx

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 sdk is the gRPC implementation of the SDK gRPC server Copyright 2019 Portworx

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 sdk is the gRPC implementation of the SDK gRPC server Copyright 2018 Portworx

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 sdk is the gRPC implementation of the SDK gRPC server Copyright 2018 Portworx

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.

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 sdk is the gRPC implementation of the SDK gRPC server Copyright 2019 Portworx

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 sdk is the gRPC implementation of the SDK gRPC server Copyright 2018 Portworx

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 sdk is the gRPC implementation of the SDK gRPC server Copyright 2018 Portworx

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 sdk is the gRPC implementation of the SDK gRPC server Copyright 2018 Portworx

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 sdk is the gRPC implementation of the SDK gRPC server Copyright 2018 Portworx

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 sdk is the gRPC implementation of the SDK gRPC server Copyright 2018 Portworx

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 sdk is the gRPC implementation of the SDK gRPC server Copyright 2018 Portworx

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 sdk is the gRPC implementation of the SDK gRPC server Copyright 2018 Portworx

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 sdk is the gRPC implementation of the SDK gRPC server Copyright 2018 Portworx

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 sdk is the gRPC implementation of the SDK gRPC server Copyright 2018 Portworx

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 sdk is the gRPC implementation of the SDK gRPC server Copyright 2018 Portworx

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 sdk is the gRPC implementation of the SDK gRPC server Copyright 2018 Portworx

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 sdk is the gRPC implementation of the SDK gRPC server Copyright 2018 Portworx

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.

Index

Constants

View Source 
const (

	// ContextDriverKey is the driver key passed in context's metadata
	ContextDriverKey = "driver"
	// DefaultDriverName is the default driver to be used
	DefaultDriverName = "default"
)
View Source 
const (
	// Metedata context key where the token is found.
	// This key must be used by the caller as the key for the token in
	// the metedata of the context. The generated Rest Gateway also uses this
	// key as the location of the raw token coming from the standard REST
	// header: Authorization: bearer <adaf0sdfsd...token>
	ContextMetadataTokenKey = "bearer"
)

Variables

This section is empty.

Functions

func FromError 

func FromError(err error) *status.Status

func GetDefaultVolSpecs 

func GetDefaultVolSpecs(
	ctx context.Context,
	spec *api.VolumeSpec,
	isUpdate bool,
) (*api.VolumeSpec, error)

GetDefaultVolSpecs returns volume spec merged with default storage policy applied if any

func HTTPStatusFromSdkError 

func HTTPStatusFromSdkError(err error) int

func IsErrorNotFound 

func IsErrorNotFound(err error) bool

IsErrorNotFound returns if the given error is due to not found

func NewAlertsServer 

func NewAlertsServer(filterDeleter alerts.FilterDeleter) api.OpenStorageAlertsServer

NewAlertsServer provides an instance of alerts server interface.

func ToSdkCloudBackupSchedEnumerateResponse 

func ToSdkCloudBackupSchedEnumerateResponse(r *api.CloudBackupSchedEnumerateResponse) *api.SdkCloudBackupSchedEnumerateResponse

func ToSdkCloudBackupdScheduleInfo 

func ToSdkCloudBackupdScheduleInfo(s api.CloudBackupScheduleInfo) *api.SdkCloudBackupScheduleInfo

Types

type CloudBackupServer 

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

CloudBackupServer is an implementation of the gRPC OpenStorageCloudBackup interface

func (*CloudBackupServer) Catalog 

func (s *CloudBackupServer) Catalog(
	ctx context.Context,
	req *api.SdkCloudBackupCatalogRequest,
) (*api.SdkCloudBackupCatalogResponse, error)

Catalog

func (*CloudBackupServer) Create 

func (s *CloudBackupServer) Create(
	ctx context.Context,
	req *api.SdkCloudBackupCreateRequest,
) (*api.SdkCloudBackupCreateResponse, error)

Create creates a backup for a volume

func (*CloudBackupServer) Delete 

func (s *CloudBackupServer) Delete(
	ctx context.Context,
	req *api.SdkCloudBackupDeleteRequest,
) (*api.SdkCloudBackupDeleteResponse, error)

Delete deletes a backup

func (*CloudBackupServer) DeleteAll 

func (s *CloudBackupServer) DeleteAll(
	ctx context.Context,
	req *api.SdkCloudBackupDeleteAllRequest,
) (*api.SdkCloudBackupDeleteAllResponse, error)

DeleteAll deletes all backups for a certain volume

func (*CloudBackupServer) EnumerateWithFilters 

func (s *CloudBackupServer) EnumerateWithFilters(
	ctx context.Context,
	req *api.SdkCloudBackupEnumerateWithFiltersRequest,
) (*api.SdkCloudBackupEnumerateWithFiltersResponse, error)

Enumerate returns information about the backups

func (*CloudBackupServer) GroupCreate 

func (s *CloudBackupServer) GroupCreate(
	ctx context.Context,
	req *api.SdkCloudBackupGroupCreateRequest,
) (*api.SdkCloudBackupGroupCreateResponse, error)

GroupCreate creates a backup for a list of volume or group

func (*CloudBackupServer) History 

func (s *CloudBackupServer) History(
	ctx context.Context,
	req *api.SdkCloudBackupHistoryRequest,
) (*api.SdkCloudBackupHistoryResponse, error)

History returns ??

func (*CloudBackupServer) Restore 

func (s *CloudBackupServer) Restore(
	ctx context.Context,
	req *api.SdkCloudBackupRestoreRequest,
) (*api.SdkCloudBackupRestoreResponse, error)

Restore a backup

func (*CloudBackupServer) SchedCreate 

func (s *CloudBackupServer) SchedCreate(
	ctx context.Context,
	req *api.SdkCloudBackupSchedCreateRequest,
) (*api.SdkCloudBackupSchedCreateResponse, error)

SchedCreate new schedule for cloud backup

func (*CloudBackupServer) SchedDelete 

func (s *CloudBackupServer) SchedDelete(
	ctx context.Context,
	req *api.SdkCloudBackupSchedDeleteRequest,
) (*api.SdkCloudBackupSchedDeleteResponse, error)

SchedDelete cloud backup schedule

func (*CloudBackupServer) SchedEnumerate 

func (s *CloudBackupServer) SchedEnumerate(
	ctx context.Context,
	req *api.SdkCloudBackupSchedEnumerateRequest,
) (*api.SdkCloudBackupSchedEnumerateResponse, error)

SchedEnumerate cloud backup schedule

func (*CloudBackupServer) SchedInspect 

func (s *CloudBackupServer) SchedInspect(
	ctx context.Context,
	schedUUID string,
) error

func (*CloudBackupServer) SchedUpdate 

func (s *CloudBackupServer) SchedUpdate(
	ctx context.Context,
	req *api.SdkCloudBackupSchedUpdateRequest,
) (*api.SdkCloudBackupSchedUpdateResponse, error)

Schedupdate updates the existing schedule for cloud backup. Callers must do read-modify-write op

func (*CloudBackupServer) Size 

func (s *CloudBackupServer) Size(
	ctx context.Context,
	req *api.SdkCloudBackupSizeRequest,
) (*api.SdkCloudBackupSizeResponse, error)

Size returns size of a cloud backup

func (*CloudBackupServer) StateChange 

func (s *CloudBackupServer) StateChange(
	ctx context.Context,
	req *api.SdkCloudBackupStateChangeRequest,
) (*api.SdkCloudBackupStateChangeResponse, error)

StateChange pauses and resumes backups

func (*CloudBackupServer) Status 

func (s *CloudBackupServer) Status(
	ctx context.Context,
	req *api.SdkCloudBackupStatusRequest,
) (*api.SdkCloudBackupStatusResponse, error)

Status provides status on a backup

type ClusterDomainsServer 

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

ClusterDomainsServer is an implementation of the gRPC OpenStorageClusterDomains interface

func (*ClusterDomainsServer) Activate 

func (m *ClusterDomainsServer) Activate(
	ctx context.Context,
	req *api.SdkClusterDomainActivateRequest,
) (*api.SdkClusterDomainActivateResponse, error)

func (*ClusterDomainsServer) Deactivate 

func (m *ClusterDomainsServer) Deactivate(
	ctx context.Context,
	req *api.SdkClusterDomainDeactivateRequest,
) (*api.SdkClusterDomainDeactivateResponse, error)

func (*ClusterDomainsServer) Enumerate 

func (m *ClusterDomainsServer) Enumerate(
	ctx context.Context,
	req *api.SdkClusterDomainsEnumerateRequest,
) (*api.SdkClusterDomainsEnumerateResponse, error)

func (*ClusterDomainsServer) Inspect 

func (m *ClusterDomainsServer) Inspect(
	ctx context.Context,
	req *api.SdkClusterDomainInspectRequest,
) (*api.SdkClusterDomainInspectResponse, error)

type ClusterPairServer 

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

ClusterPairServer is an implementation of the gRPC OpenStorageClusterServer interface

func (*ClusterPairServer) Create 

func (s *ClusterPairServer) Create(
	ctx context.Context,
	req *api.SdkClusterPairCreateRequest,
) (*api.SdkClusterPairCreateResponse, error)

Create a new cluster with remote pair

func (*ClusterPairServer) Delete 

func (s *ClusterPairServer) Delete(
	ctx context.Context,
	req *api.SdkClusterPairDeleteRequest,
) (*api.SdkClusterPairDeleteResponse, error)

Delete removes the cluster pairing

func (*ClusterPairServer) Enumerate 

func (s *ClusterPairServer) Enumerate(
	ctx context.Context,
	req *api.SdkClusterPairEnumerateRequest,
) (*api.SdkClusterPairEnumerateResponse, error)

Enumerate returns list of cluster pairs

func (*ClusterPairServer) GetToken 

func (s *ClusterPairServer) GetToken(
	ctx context.Context,
	req *api.SdkClusterPairGetTokenRequest,
) (*api.SdkClusterPairGetTokenResponse, error)

GetToken gets the authentication token for this cluster

func (*ClusterPairServer) Inspect 

func (s *ClusterPairServer) Inspect(
	ctx context.Context,
	req *api.SdkClusterPairInspectRequest,
) (*api.SdkClusterPairInspectResponse, error)

Inspect information about a cluster pair

func (*ClusterPairServer) ResetToken 

func (s *ClusterPairServer) ResetToken(
	ctx context.Context,
	req *api.SdkClusterPairResetTokenRequest,
) (*api.SdkClusterPairResetTokenResponse, error)

ResetToken gets the authentication token for this cluster

type ClusterServer 

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

ClusterServer is an implementation of the gRPC OpenStorageClusterServer interface

func (*ClusterServer) InspectCurrent 

func (s *ClusterServer) InspectCurrent(
	ctx context.Context,
	req *api.SdkClusterInspectCurrentRequest,
) (*api.SdkClusterInspectCurrentResponse, error)

InspectCurrent returns information about the current cluster

type CredentialServer 

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

CredentialServer is an implementation of the gRPC OpenStorageCredential interface

func (*CredentialServer) Create 

func (s *CredentialServer) Create(
	ctx context.Context,
	req *api.SdkCredentialCreateRequest,
) (*api.SdkCredentialCreateResponse, error)

Create method creates credentials

func (*CredentialServer) Delete 

func (s *CredentialServer) Delete(
	ctx context.Context,
	req *api.SdkCredentialDeleteRequest,
) (*api.SdkCredentialDeleteResponse, error)

Delete deletes a specified credential

func (*CredentialServer) DeleteReferences 

func (s *CredentialServer) DeleteReferences(
	ctx context.Context,
	req *api.SdkCredentialDeleteReferencesRequest,
) (*api.SdkCredentialDeleteReferencesResponse, error)

DeleteReferences removes all references to a specified Credential.

func (*CredentialServer) Enumerate 

func (s *CredentialServer) Enumerate(
	ctx context.Context,
	req *api.SdkCredentialEnumerateRequest,
) (*api.SdkCredentialEnumerateResponse, error)

Enumerate returns a list credentials ids

func (*CredentialServer) Inspect 

func (s *CredentialServer) Inspect(
	ctx context.Context,
	req *api.SdkCredentialInspectRequest,
) (*api.SdkCredentialInspectResponse, error)

Inspect returns information about credential id

func (*CredentialServer) Update 

func (s *CredentialServer) Update(
	ctx context.Context,
	req *api.SdkCredentialUpdateRequest,
) (*api.SdkCredentialUpdateResponse, error)

Update method modifies previously created credentials

func (*CredentialServer) Validate 

func (s *CredentialServer) Validate(
	ctx context.Context,
	req *api.SdkCredentialValidateRequest,
) (*api.SdkCredentialValidateResponse, error)

Validate validates a specified Credential.

type DiagsServer 

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

DiagsServer is an implementation of the OpenStorageDiags SDK

func (*DiagsServer) Collect 

func (s *DiagsServer) Collect(ctx context.Context, in *api.SdkDiagsCollectRequest) (*api.SdkDiagsCollectResponse, error)

type FilesystemCheckServer 

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

FilesystemCheckServer is an implementation of the gRPC OpenStorageFilesystemCheck interface

func (*FilesystemCheckServer) Start 

func (s *FilesystemCheckServer) Start(
	ctx context.Context,
	req *api.SdkFilesystemCheckStartRequest,
) (*api.SdkFilesystemCheckStartResponse, error)

Start a filesystem check operation on a unmounted volume

func (*FilesystemCheckServer) Status 

func (s *FilesystemCheckServer) Status(
	ctx context.Context,
	req *api.SdkFilesystemCheckStatusRequest,
) (*api.SdkFilesystemCheckStatusResponse, error)

GetStatus of a filesystem check operation

func (*FilesystemCheckServer) Stop 

func (s *FilesystemCheckServer) Stop(
	ctx context.Context,
	req *api.SdkFilesystemCheckStopRequest,
) (*api.SdkFilesystemCheckStopResponse, error)

Stop the background filesystem check (CheckHealth or FixSafe or Fixall) operation on a volume, if any

type FilesystemTrimServer 

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

FilesystemTrimServer is an implementation of the gRPC OpenStorageFilesystemTrim interface

func (*FilesystemTrimServer) AutoFSTrimStatus 

func (s *FilesystemTrimServer) AutoFSTrimStatus(
	ctx context.Context,
	req *api.SdkAutoFSTrimStatusRequest,
) (*api.SdkAutoFSTrimStatusResponse, error)

Status of auto fs trim operation

func (*FilesystemTrimServer) AutoFSTrimUsage 

func (s *FilesystemTrimServer) AutoFSTrimUsage(
	ctx context.Context,
	req *api.SdkAutoFSTrimUsageRequest,
) (*api.SdkAutoFSTrimUsageResponse, error)

Usage of auto fs trim

func (*FilesystemTrimServer) Start 

func (s *FilesystemTrimServer) Start(
	ctx context.Context,
	req *api.SdkFilesystemTrimStartRequest,
) (*api.SdkFilesystemTrimStartResponse, error)

Start a filesystem trim operation on a mounted volume

func (*FilesystemTrimServer) Status 

func (s *FilesystemTrimServer) Status(
	ctx context.Context,
	req *api.SdkFilesystemTrimStatusRequest,
) (*api.SdkFilesystemTrimStatusResponse, error)

Status of a filesystem trim operation

func (*FilesystemTrimServer) Stop 

func (s *FilesystemTrimServer) Stop(
	ctx context.Context,
	req *api.SdkFilesystemTrimStopRequest,
) (*api.SdkFilesystemTrimStopResponse, error)

Stop the background filesystem trim operation on a volume, if any

type IdentityServer 

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

IdentityServer is an implementation of the gRPC OpenStorageIdentityServer interface

func (*IdentityServer) Capabilities 

func (s *IdentityServer) Capabilities(
	ctx context.Context,
	req *api.SdkIdentityCapabilitiesRequest,
) (*api.SdkIdentityCapabilitiesResponse, error)

Capabilities returns the capabilities of the SDK server

func (*IdentityServer) Version 

func (s *IdentityServer) Version(
	ctx context.Context,
	req *api.SdkIdentityVersionRequest,
) (*api.SdkIdentityVersionResponse, error)

Version returns version of the storage system

type JobServer 

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

func (*JobServer) Enumerate 

func (j *JobServer) Enumerate(
	ctx context.Context,
	req *api.SdkEnumerateJobsRequest,
) (*api.SdkEnumerateJobsResponse, error)

func (*JobServer) GetStatus 

func (j *JobServer) GetStatus(
	ctx context.Context,
	req *api.SdkGetJobStatusRequest,
) (*api.SdkGetJobStatusResponse, error)

func (*JobServer) Update 

func (j *JobServer) Update(
	ctx context.Context,
	req *api.SdkUpdateJobRequest,
) (*api.SdkUpdateJobResponse, error)

type NodeServer 

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

NodeServer is an implementation of the gRPC OpenStorageNodeServer interface

func (*NodeServer) CordonAttachments 

func (s *NodeServer) CordonAttachments(
	ctx context.Context,
	req *api.SdkNodeCordonAttachmentsRequest,
) (*api.SdkNodeCordonAttachmentsResponse, error)

func (*NodeServer) DrainAttachments 

func (s *NodeServer) DrainAttachments(
	ctx context.Context,
	req *api.SdkNodeDrainAttachmentsRequest,
) (*api.SdkJobResponse, error)

func (*NodeServer) Enumerate 

func (s *NodeServer) Enumerate(
	ctx context.Context,
	req *api.SdkNodeEnumerateRequest,
) (*api.SdkNodeEnumerateResponse, error)

Enumerate returns the ids of all the nodes in the cluster

func (*NodeServer) EnumerateWithFilters 

func (s *NodeServer) EnumerateWithFilters(
	ctx context.Context,
	req *api.SdkNodeEnumerateWithFiltersRequest,
) (*api.SdkNodeEnumerateWithFiltersResponse, error)

EnumerateWithFilters returns all the nodes in the cluster

func (*NodeServer) Inspect 

func (s *NodeServer) Inspect(
	ctx context.Context,
	req *api.SdkNodeInspectRequest,
) (*api.SdkNodeInspectResponse, error)

Inspect returns information about a specific node

func (*NodeServer) InspectCurrent 

func (s *NodeServer) InspectCurrent(
	ctx context.Context,
	req *api.SdkNodeInspectCurrentRequest,
) (*api.SdkNodeInspectCurrentResponse, error)

func (*NodeServer) RelaxedReclaimPurge 

func (s *NodeServer) RelaxedReclaimPurge(
	ctx context.Context,
	req *api.SdkNodeRelaxedReclaimPurgeRequest,
) (*api.SdkNodeRelaxedReclaimPurgeResponse, error)

func (*NodeServer) UncordonAttachments 

func (s *NodeServer) UncordonAttachments(
	ctx context.Context,
	req *api.SdkNodeUncordonAttachmentsRequest,
) (*api.SdkNodeUncordonAttachmentsResponse, error)

func (*NodeServer) VolumeUsageByNode 

func (s *NodeServer) VolumeUsageByNode(
	ctx context.Context,
	req *api.SdkNodeVolumeUsageByNodeRequest,
) (*api.SdkNodeVolumeUsageByNodeResponse, error)

type ObjectstoreServer 

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

Objectstoreserver is an implementation of the gRPC OpenStorageObjectstore interface

func (*ObjectstoreServer) Create 

func (s *ObjectstoreServer) Create(
	ctx context.Context,
	req *api.SdkObjectstoreCreateRequest,
) (*api.SdkObjectstoreCreateResponse, error)

CreateObjectstore creates objectstore for given volume

func (*ObjectstoreServer) Delete 

func (s *ObjectstoreServer) Delete(
	ctx context.Context,
	req *api.SdkObjectstoreDeleteRequest,
) (*api.SdkObjectstoreDeleteResponse, error)

DeleteObjectstore delete objectstore from cluster

func (*ObjectstoreServer) Inspect 

func (s *ObjectstoreServer) Inspect(
	ctx context.Context,
	req *api.SdkObjectstoreInspectRequest,
) (*api.SdkObjectstoreInspectResponse, error)

Inspect Objectstore return status of provided objectstore

func (*ObjectstoreServer) Update 

func (s *ObjectstoreServer) Update(
	ctx context.Context,
	req *api.SdkObjectstoreUpdateRequest,
) (*api.SdkObjectstoreUpdateResponse, error)

UpdateObjectstore updates given objectstore state

type SchedulePolicyServer 

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

SchedulePolicyServer is an implementation of the gRPC OpenStorageSchedulePolicy interface

func (*SchedulePolicyServer) Create 

func (s *SchedulePolicyServer) Create(
	ctx context.Context,
	req *api.SdkSchedulePolicyCreateRequest,
) (*api.SdkSchedulePolicyCreateResponse, error)

Create method creates schedule policy

func (*SchedulePolicyServer) Delete 

func (s *SchedulePolicyServer) Delete(
	ctx context.Context,
	req *api.SdkSchedulePolicyDeleteRequest,
) (*api.SdkSchedulePolicyDeleteResponse, error)

Delete method deletes schedule policy

func (*SchedulePolicyServer) Enumerate 

func (s *SchedulePolicyServer) Enumerate(
	ctx context.Context,
	req *api.SdkSchedulePolicyEnumerateRequest,
) (*api.SdkSchedulePolicyEnumerateResponse, error)

Enumerate method enumerates schedule policies

func (*SchedulePolicyServer) Inspect 

func (s *SchedulePolicyServer) Inspect(
	ctx context.Context,
	req *api.SdkSchedulePolicyInspectRequest,
) (*api.SdkSchedulePolicyInspectResponse, error)

Inspect method inspects schedule policy

func (*SchedulePolicyServer) Update 

func (s *SchedulePolicyServer) Update(
	ctx context.Context,
	req *api.SdkSchedulePolicyUpdateRequest,
) (*api.SdkSchedulePolicyUpdateResponse, error)

Update method updates schedule policy

type SecurityConfig 

type SecurityConfig struct {
	// Role implementation
	Role role.RoleManager
	// Tls configuration
	Tls *TLSConfig
	// Authenticators per issuer. You can register multple authenticators
	// based on the "iss" string in the string. For example:
	// map[string]auth.Authenticator {
	//     "https://accounts.google.com": googleOidc,
	//     "openstorage-sdk-auth: selfSigned,
	// }
	Authenticators map[string]auth.Authenticator
}

SecurityConfig provides configuration for SDK auth

type Server 

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

Server is an implementation of the gRPC SDK interface

func New 

func New(config *ServerConfig) (*Server, error)

New creates a new SDK server

func (*Server) Address 

func (s *Server) Address() string

func (*Server) Start 

func (s *Server) Start() error

Start all servers

func (*Server) Stop 

func (s *Server) Stop()

func (*Server) UdsAddress 

func (s *Server) UdsAddress() string

func (*Server) UseAlert 

func (s *Server) UseAlert(a alerts.FilterDeleter)

UseAlert will setup a new alert object for the gRPC handlers

func (*Server) UseCluster 

func (s *Server) UseCluster(c cluster.Cluster)

UseCluster will setup a new cluster object for the gRPC handlers

func (*Server) UseVolumeDrivers 

func (s *Server) UseVolumeDrivers(d map[string]volume.VolumeDriver)

UseVolumeDrivers will setup a new driver object for the gRPC handlers

type ServerConfig 

type ServerConfig struct {
	// Net is the transport for gRPC: unix, tcp, etc.
	// For the gRPC Server. This value goes together with `Address`.
	Net string
	// Address is the port number or the unix domain socket path.
	// For the gRPC Server. This value goes together with `Net`.
	Address string

	// RestAdress is the port number. Example: 9110
	// For the gRPC REST Gateway.
	RestPort string
	// Unix domain socket for local communication. This socket
	// will be used by the REST Gateway to communicate with the gRPC server.
	// Only set for testing. Having a '%s' can be supported to use the
	// name of the driver as the driver name.
	Socket string
	// (optional) Location for audit log.
	// If not provided, it will go to /var/log/openstorage-audit.log
	AuditOutput io.Writer
	// (optional) Location of access log.
	// This is useful when authorization is not running.
	// If not provided, it will go to /var/log/openstorage-access.log
	AccessOutput io.Writer
	// (optional) The OpenStorage driver to use
	DriverName string
	// (optional) Cluster interface
	Cluster cluster.Cluster
	// AlertsFilterDeleter
	AlertsFilterDeleter alerts.FilterDeleter
	// StoragePolicy Manager
	StoragePolicy policy.PolicyManager
	// Security configuration
	Security *SecurityConfig
	// ServerExtensions allows you to extend the SDK gRPC server
	// with callback functions that are sequentially executed
	// at the end of Server.Start()
	//
	// To add your own service to the SDK gRPC server,
	// just append a function callback that registers it:
	//
	// s.config.ServerExtensions = append(s.config.ServerExtensions,
	// 		func(gs *grpc.Server) {
	//			api.RegisterCustomService(gs, customHandler)
	//		})
	GrpcServerExtensions []func(grpcServer *grpc.Server)

	// RestServerExtensions allows for extensions to be added
	// to the SDK Rest Gateway server.
	//
	// To add your own service to the SDK REST Server, simply add your handlers
	// to the RestSererExtensions slice. These handlers will be registered on the
	// REST Gateway http server.
	RestServerExtensions []func(context.Context, *runtime.ServeMux, *grpc.ClientConn) error
	// contains filtered or unexported fields
}

ServerConfig provides the configuration to the SDK server

type StoragePoolServer 

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

func (*StoragePoolServer) EnumerateRebalanceJobs 

func (sp *StoragePoolServer) EnumerateRebalanceJobs(
	c context.Context, req *api.SdkEnumerateRebalanceJobsRequest) (*api.SdkEnumerateRebalanceJobsResponse, error)

func (*StoragePoolServer) GetRebalanceJobStatus 

func (sp *StoragePoolServer) GetRebalanceJobStatus(
	c context.Context, req *api.SdkGetRebalanceJobStatusRequest) (*api.SdkGetRebalanceJobStatusResponse, error)

func (*StoragePoolServer) Rebalance 

func (sp *StoragePoolServer) Rebalance(
	c context.Context, req *api.SdkStorageRebalanceRequest) (*api.SdkStorageRebalanceResponse, error)

func (*StoragePoolServer) Resize 

func (sp *StoragePoolServer) Resize(
	c context.Context, req *api.SdkStoragePoolResizeRequest) (*api.SdkStoragePoolResizeResponse, error)

func (*StoragePoolServer) UpdateRebalanceJobState 

func (sp *StoragePoolServer) UpdateRebalanceJobState(
	c context.Context, req *api.SdkUpdateRebalanceJobRequest) (*api.SdkUpdateRebalanceJobResponse, error)

type TLSConfig 

type TLSConfig struct {
	// CertFile is the path to the cert file
	CertFile string
	// KeyFile is the path to the key file
	KeyFile string
}

TLSConfig points to the cert files needed for HTTPS

type VolumeServer 

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

VolumeServer is an implementation of the gRPC OpenStorageVolume interface

func (*VolumeServer) Attach 

func (s *VolumeServer) Attach(
	ctx context.Context,
	req *api.SdkVolumeAttachRequest,
) (*api.SdkVolumeAttachResponse, error)

Attach volume to given node

func (*VolumeServer) Cancel 

func (s *VolumeServer) Cancel(
	ctx context.Context,
	req *api.SdkCloudMigrateCancelRequest,
) (*api.SdkCloudMigrateCancelResponse, error)

Cancel or stop a ongoing migration

func (*VolumeServer) CapacityUsage 

func (s *VolumeServer) CapacityUsage(
	ctx context.Context,
	req *api.SdkVolumeCapacityUsageRequest,
) (*api.SdkVolumeCapacityUsageResponse, error)

func (*VolumeServer) Clone 

func (s *VolumeServer) Clone(
	ctx context.Context,
	req *api.SdkVolumeCloneRequest,
) (*api.SdkVolumeCloneResponse, error)

Clone creates a new volume from an existing volume

func (*VolumeServer) Create 

func (s *VolumeServer) Create(
	ctx context.Context,
	req *api.SdkVolumeCreateRequest,
) (*api.SdkVolumeCreateResponse, error)

Create creates a new volume

func (*VolumeServer) Delete 

func (s *VolumeServer) Delete(
	ctx context.Context,
	req *api.SdkVolumeDeleteRequest,
) (*api.SdkVolumeDeleteResponse, error)

Delete deletes a volume

func (*VolumeServer) Detach 

func (s *VolumeServer) Detach(
	ctx context.Context,
	req *api.SdkVolumeDetachRequest,
) (*api.SdkVolumeDetachResponse, error)

Detach function for volume node detach

func (*VolumeServer) Enumerate 

func (s *VolumeServer) Enumerate(
	ctx context.Context,
	req *api.SdkVolumeEnumerateRequest,
) (*api.SdkVolumeEnumerateResponse, error)

Enumerate returns a list of volumes

func (*VolumeServer) EnumerateWithFilters 

func (s *VolumeServer) EnumerateWithFilters(
	ctx context.Context,
	req *api.SdkVolumeEnumerateWithFiltersRequest,
) (*api.SdkVolumeEnumerateWithFiltersResponse, error)

EnumerateWithFilters returns a list of volumes for the provided filters

func (*VolumeServer) Inspect 

func (s *VolumeServer) Inspect(
	ctx context.Context,
	req *api.SdkVolumeInspectRequest,
) (*api.SdkVolumeInspectResponse, error)

Inspect returns information about a volume

func (*VolumeServer) InspectWithFilters 

func (s *VolumeServer) InspectWithFilters(
	ctx context.Context,
	req *api.SdkVolumeInspectWithFiltersRequest,
) (*api.SdkVolumeInspectWithFiltersResponse, error)

InspectWithFilters is a helper function returning information about volumes which match a filter

func (*VolumeServer) Mount 

func (s *VolumeServer) Mount(
	ctx context.Context,
	req *api.SdkVolumeMountRequest,
) (*api.SdkVolumeMountResponse, error)

Mount function for volume node detach

func (*VolumeServer) SnapshotCreate 

func (s *VolumeServer) SnapshotCreate(
	ctx context.Context,
	req *api.SdkVolumeSnapshotCreateRequest,
) (*api.SdkVolumeSnapshotCreateResponse, error)

SnapshotCreate creates a read-only snapshot of a volume

func (*VolumeServer) SnapshotEnumerate 

func (s *VolumeServer) SnapshotEnumerate(
	ctx context.Context,
	req *api.SdkVolumeSnapshotEnumerateRequest,
) (*api.SdkVolumeSnapshotEnumerateResponse, error)

SnapshotEnumerate returns a list of snapshots for the specified volume

func (*VolumeServer) SnapshotEnumerateWithFilters 

func (s *VolumeServer) SnapshotEnumerateWithFilters(
	ctx context.Context,
	req *api.SdkVolumeSnapshotEnumerateWithFiltersRequest,
) (*api.SdkVolumeSnapshotEnumerateWithFiltersResponse, error)

SnapshotEnumerateWithFilters returns a list of snapshots for the specified volume and labels

func (*VolumeServer) SnapshotRestore 

func (s *VolumeServer) SnapshotRestore(
	ctx context.Context,
	req *api.SdkVolumeSnapshotRestoreRequest,
) (*api.SdkVolumeSnapshotRestoreResponse, error)

SnapshotRestore restores a volume to the specified snapshot id

func (*VolumeServer) SnapshotScheduleUpdate 

func (s *VolumeServer) SnapshotScheduleUpdate(
	ctx context.Context,
	req *api.SdkVolumeSnapshotScheduleUpdateRequest,
) (*api.SdkVolumeSnapshotScheduleUpdateResponse, error)

SnapshotScheduleUpdate updates the snapshot schedule in the volume. It only manages the PolicyTags

func (*VolumeServer) Start 

func (s *VolumeServer) Start(
	ctx context.Context,
	req *api.SdkCloudMigrateStartRequest,
) (*api.SdkCloudMigrateStartResponse, error)

Start a volume migration

func (*VolumeServer) Stats 

func (s *VolumeServer) Stats(
	ctx context.Context,
	req *api.SdkVolumeStatsRequest,
) (*api.SdkVolumeStatsResponse, error)

Stats returns volume statistics

func (*VolumeServer) Status 

func (s *VolumeServer) Status(
	ctx context.Context,
	req *api.SdkCloudMigrateStatusRequest,
) (*api.SdkCloudMigrateStatusResponse, error)

Status of ongoing migration

func (*VolumeServer) Unmount 

func (s *VolumeServer) Unmount(
	ctx context.Context,
	req *api.SdkVolumeUnmountRequest,
) (*api.SdkVolumeUnmountResponse, error)

Unmount volume from given node

func (*VolumeServer) Update 

func (s *VolumeServer) Update(
	ctx context.Context,
	req *api.SdkVolumeUpdateRequest,
) (*api.SdkVolumeUpdateResponse, error)

Update allows the caller to change values in the volume specification

func (*VolumeServer) VolumeCatalog 

func (s *VolumeServer) VolumeCatalog(
	ctx context.Context,
	req *api.SdkVolumeCatalogRequest,
) (*api.SdkVolumeCatalogResponse, error)

VolumeCatalog returns a list of volumes for the provided filters

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.