# README
OpenStorage API usage
Any storage product that uses the openstorage API can be managed via this API. Below are some examples of using this API.
Enumerate nodes in a cluster
import (
...
"github.com/libopenstorage/gossip/types"
"github.com/libopenstorage/openstorage/api"
"github.com/libopenstorage/openstorage/api/client/cluster"
)
type myapp struct {
manager cluster.Cluster
}
func (c *myapp) init() {
// Choose the default version.
// Leave the host blank to use the local UNIX socket, or pass in an IP and a port at which the server is listening on.
clnt, err := cluster.NewClusterClient("", cluster.APIVersion)
if err != nil {
fmt.Printf("Failed to initialize client library: %v\n", err)
os.Exit(1)
}
c.manager = cluster.ClusterManager(clnt)
}
func (c *myapp) listNodes() {
cluster, err := c.manager.Enumerate()
if err != nil {
cmdError(context, fn, err)
return
}
// cluster is now a hashmap of nodes... do something useful with it:
for _, n := range cluster.Nodes {
}
}
Inspect a volume in a cluster
import (
...
"github.com/libopenstorage/openstorage/api"
volumeclient "github.com/libopenstorage/openstorage/api/client/volume"
"github.com/libopenstorage/openstorage/volume"
)
type myapp struct {
volDriver volume.VolumeDriver
}
func (c *myapp) init() {
// Choose the default version.
// Leave the host blank to use the local UNIX socket, or pass in an IP and a port at which the server is listening on.
clnt, err := volumeclient.NewDriverClient("", v.name, volume.APIVersion)
if err != nil {
fmt.Printf("Failed to initialize client library: %v\n", err)
os.Exit(1)
}
v.volDriver = volumeclient.VolumeDriver(clnt)
}
func (c *myapp) inspect(id string) {
stats, err := v.volDriver.Stats(id, true)
if err != nil {
return
}
// stats is an object that has various volume properties and statistics.
}
# Packages
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Functions
No description provided by the author
No description provided by the author
No description provided by the author
CosTypeSimpleValueOf returns the string format of CosType.
DriverTypeSimpleValueOf returns the string format of DriverType.
FSTypeSimpleValueOf returns the string format of FSType.
GraphDriverChangeTypeSimpleValueOf returns the string format of GraphDriverChangeType.
IoProfileSimpleValueOf returns the string format of IoProfile.
Functions.
IsAdminByUser returns true if the user is an ownership admin, meaning, that they belong to any group.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
OwnershipSetUsernameFromContext is used to create a new ownership object for a volume.
RegisterOpenStorageAlertsHandler registers the http handlers for service OpenStorageAlerts to "mux".
RegisterOpenStorageAlertsHandler registers the http handlers for service OpenStorageAlerts to "mux".
RegisterOpenStorageAlertsHandlerFromEndpoint is same as RegisterOpenStorageAlertsHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
No description provided by the author
RegisterOpenStorageCloudBackupHandler registers the http handlers for service OpenStorageCloudBackup to "mux".
RegisterOpenStorageCloudBackupHandler registers the http handlers for service OpenStorageCloudBackup to "mux".
RegisterOpenStorageCloudBackupHandlerFromEndpoint is same as RegisterOpenStorageCloudBackupHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
No description provided by the author
RegisterOpenStorageClusterDomainsHandler registers the http handlers for service OpenStorageClusterDomains to "mux".
RegisterOpenStorageClusterDomainsHandler registers the http handlers for service OpenStorageClusterDomains to "mux".
RegisterOpenStorageClusterDomainsHandlerFromEndpoint is same as RegisterOpenStorageClusterDomainsHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
No description provided by the author
RegisterOpenStorageClusterHandler registers the http handlers for service OpenStorageCluster to "mux".
RegisterOpenStorageClusterHandler registers the http handlers for service OpenStorageCluster to "mux".
RegisterOpenStorageClusterHandlerFromEndpoint is same as RegisterOpenStorageClusterHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterOpenStorageClusterPairHandler registers the http handlers for service OpenStorageClusterPair to "mux".
RegisterOpenStorageClusterPairHandler registers the http handlers for service OpenStorageClusterPair to "mux".
RegisterOpenStorageClusterPairHandlerFromEndpoint is same as RegisterOpenStorageClusterPairHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
No description provided by the author
No description provided by the author
RegisterOpenStorageCredentialsHandler registers the http handlers for service OpenStorageCredentials to "mux".
RegisterOpenStorageCredentialsHandler registers the http handlers for service OpenStorageCredentials to "mux".
RegisterOpenStorageCredentialsHandlerFromEndpoint is same as RegisterOpenStorageCredentialsHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
No description provided by the author
RegisterOpenStorageIdentityHandler registers the http handlers for service OpenStorageIdentity to "mux".
RegisterOpenStorageIdentityHandler registers the http handlers for service OpenStorageIdentity to "mux".
RegisterOpenStorageIdentityHandlerFromEndpoint is same as RegisterOpenStorageIdentityHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
No description provided by the author
RegisterOpenStorageMigrateHandler registers the http handlers for service OpenStorageMigrate to "mux".
RegisterOpenStorageMigrateHandler registers the http handlers for service OpenStorageMigrate to "mux".
RegisterOpenStorageMigrateHandlerFromEndpoint is same as RegisterOpenStorageMigrateHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
No description provided by the author
RegisterOpenStorageMountAttachHandler registers the http handlers for service OpenStorageMountAttach to "mux".
RegisterOpenStorageMountAttachHandler registers the http handlers for service OpenStorageMountAttach to "mux".
RegisterOpenStorageMountAttachHandlerFromEndpoint is same as RegisterOpenStorageMountAttachHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
No description provided by the author
RegisterOpenStorageNodeHandler registers the http handlers for service OpenStorageNode to "mux".
RegisterOpenStorageNodeHandler registers the http handlers for service OpenStorageNode to "mux".
RegisterOpenStorageNodeHandlerFromEndpoint is same as RegisterOpenStorageNodeHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
No description provided by the author
RegisterOpenStorageObjectstoreHandler registers the http handlers for service OpenStorageObjectstore to "mux".
RegisterOpenStorageObjectstoreHandler registers the http handlers for service OpenStorageObjectstore to "mux".
RegisterOpenStorageObjectstoreHandlerFromEndpoint is same as RegisterOpenStorageObjectstoreHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
No description provided by the author
RegisterOpenStoragePolicyHandler registers the http handlers for service OpenStoragePolicy to "mux".
RegisterOpenStoragePolicyHandler registers the http handlers for service OpenStoragePolicy to "mux".
RegisterOpenStoragePolicyHandlerFromEndpoint is same as RegisterOpenStoragePolicyHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
No description provided by the author
RegisterOpenStorageRoleHandler registers the http handlers for service OpenStorageRole to "mux".
RegisterOpenStorageRoleHandler registers the http handlers for service OpenStorageRole to "mux".
RegisterOpenStorageRoleHandlerFromEndpoint is same as RegisterOpenStorageRoleHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
No description provided by the author
RegisterOpenStorageSchedulePolicyHandler registers the http handlers for service OpenStorageSchedulePolicy to "mux".
RegisterOpenStorageSchedulePolicyHandler registers the http handlers for service OpenStorageSchedulePolicy to "mux".
RegisterOpenStorageSchedulePolicyHandlerFromEndpoint is same as RegisterOpenStorageSchedulePolicyHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
No description provided by the author
RegisterOpenStorageVolumeHandler registers the http handlers for service OpenStorageVolume to "mux".
RegisterOpenStorageVolumeHandler registers the http handlers for service OpenStorageVolume to "mux".
RegisterOpenStorageVolumeHandlerFromEndpoint is same as RegisterOpenStorageVolumeHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
No description provided by the author
No description provided by the author
No description provided by the author
StatusKindMapLength used only for unit testing.
StatusSimpleValueOf returns the string format of Status.
No description provided by the author
No description provided by the author
VolumeActionParamSimpleValueOf returns the string format of VolumeAction.
VolumeStateSimpleValueOf returns the string format of VolumeState.
VolumeStatusSimpleValueOf returns the string format of VolumeStatus.
# Constants
AdminGroup is the value that can be set in the token claims Group which gives the user access to any resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Attached and available externally.
Attached but only available internally.
Switching from External to Internal.
AutoAggregation value indicates driver to select aggregation level.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Migrate all volumes in the cluster.
Migrate a single volume.
Migrate a group of volumes.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Default pairing mode.
Paired for DisasterRecovery.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DoesNotExist means the 'key' should NOT exist.
Exists means the 'key' should just exist regardless of the value.
Gt means the 'key' should be greater than the value(s).
In means the value for 'key' should be in one of the given value(s).
Lt means the 'key' should be less than the value(s).
NotIn means the value for 'key' should NOT be in one of the given value(s).
Strings for VolumeSpec.
Perform a force_detach during detach operation.
No description provided by the author
No description provided by the author
OptBackupSchedUUID is the UUID of the backup-schedule.
OptBkupOpState is the desired operational state (stop/pause/resume) of backup/restore.
OptCatalogMaxDepth query parameter used to limit the depth we return.
OptVolumeSubFolder query parameter used to catalog a particular path inside a volume.
OptCloudBackupID is the backID in the cloud.
OptConfigLabel query parameter used to lookup volume by set of labels.
OptCredAccKey for s3.
OptOptCredAzureAccountKey is the accountkey for azure as the cloud provider.
OptCredAzureAccountName is the account name for azure as the cloud provider.
OptCredBucket is the optional bucket name.
OptCredDisableSSL indicated if SSL should be disabled.
OptCredEncrKey is the key used to encrypt data.
OptCredEndpoint indicate the cloud endpoint.
OptCredGoogleJsonKey for google cloud.
OptCredGoogleProjectID projectID for google cloud.
OptCredName indicates unique name of credential.
Credential ownership key in params.
OptCredRegion indicates the region for s3.
OptCredSecretKey for s3.
OptCredType indicates type of credential.
OptCredUUID is the UUID of the credential.
OptCumulative query parameter used to request cumulative stats.
OptLabel query parameter used to lookup volume by set of labels.
OptName query parameter used to lookup volume by name.
OptQuiesceID query parameter use for quiesce.
OptSnapID query parameter used to lookup snapshot by ID.
OptSrcVolID is the source volume ID of the backup.
OptTimeout query parameter used to indicate timeout seconds.
OptVolumeID query parameter used to lookup volume by ID.
Api clientserver Constants.
Api clientserver Constants.
Api clientserver Constants.
Api clientserver Constants.
Api clientserver Constants.
Api clientserver Constants.
Api clientserver Constants.
Api clientserver Constants.
Administrator access.
Read access only and cannot affect the resource.
Write access and can affect the resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Backup.
Restore.
Unknown.
Pause the backup or restore.
Resume the backup or restore.
Stop a backup or restore.
Unknown state.
Aborted.
Active.
Done.
Failed.
Not started.
Paused.
Queued.
Stopped.
Unkonwn.
Alert enumeration.
Cloud backup of volumes management.
Cluster management.
Cluster Pair service.
Credentials management.
Migrate service.
Mount/Attach Support.
Node management.
Object Storage management.
Role service.
Schedule policy management.
StoragePolicy Service.
Unknown service.
Volume management.
Friday.
Monday.
Saturday.
Sunday.
Thursday.
Tuesday.
Wednesday.
SDK version major value of this specification.
SDK version minor value of this specification.
Must be set in the proto file; ignore.
SDK version patch value of this specification.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
SpecBestEffortLocationProvisioning default is false.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
SpecForceUnsuppportedFsType is of type boolean and if true it sets the VolumeSpec.force_unsupported_fs_type.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
Strings for VolumeSpec.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Add statuses before MAX and update the number for MAX.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
StatusSeverityHigh indicates a BAD status.
StatusSeverityLow indicates an OK status.
StatusSeverityMedium indicates a status which is in transition from OK to BAD or vice versa.
Magnetic spinning disk.
NVME disk.
SSD disk.
Strings for VolumeSpec.
Api clientserver Constants.
Strings for VolumeSpec.
Strings for VolumeSpec.
No description provided by the author
Maps to the boolean value false.
Maps to the boolean value true.
Affinity means the rule specifies an affinity to objects that match the below label selector requirements.
AntiAffinity means the rule specifies an anti-affinity to objects that match the below label selector requirements.
This specifies that the rule is preferred and can be best effort.
This specifies that the rule is required and must be strictly enforced.
Policy will make sure the value must be equal.
Policy will make sure the requested value must be less than or equal.
Policy will make sure the requested value must be greater than or equal.
Volume is attached to container.
Volume is ready to be assigned to a container.
Volume is deleted, it will remain in this state while resources are asynchronously reclaimed.
Volume is detached but associated with a container.
Volume detach is in progress.
Volume is in error state.
No description provided by the author
Volume is transitioning to new state.
Volume is undergoing restore.
Volume is trying to be detached.
Volume is up but with degraded performance In a RAID group, this may indicate a problem with one or more drives.
Volume is in fail mode.
No description provided by the author
Volume is not present.
Volume is healthy.
# Variables
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
Active Request.
Active Requests.
Alert is a structure that represents an alert object.
Alerts is an array of Alert objects.
Provides details on exclusive and shared storage used by snapshot/volume specifically for copy-on-write(COW) snapshots.
Defines the response for CapacityUsage request.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Request to stop a cloud migration.
No description provided by the author
No description provided by the author
Request to start a cloud migration.
Response to start a cloud migration.
Request for cloud migration operation status.
Response with a status of the cloud migration operations.
Cluster represents the state of the cluster.
Used to send a request to create a cluster pair.
Response for a pair request.
Reponse to get a cluster pair.
Information about a cluster pair.
No description provided by the author
Used to process a pair request from a remote cluster.
Response after a pairing has been processed.
Response to enumerate all the cluster pairs.
Response to get the cluster token.
ClusterResponse specifies a response that gets returned when requesting the cluster.
CredCreateRequest is the input for CredCreate command.
CredCreateResponse is returned for CredCreate command.
FluentDConfig describes ip and port of a fluentdhost.
GraphDriverChanges represent a list of changes between the filesystem layers specified by the ID and Parent.
Group represents VolumeGroup / namespace All volumes in the same group share this object.
GroupSnapCreateRequest specifies a request to create a snapshot of given group.
GroupSnapCreateRequest specifies a response that get's returned when creating a group snapshot.
IoStrategy defines how I/O should be performed to backing storage media.
LabelSelectorRequirement is a selector that contains values, a key, and an operator that relates the key and values.
Locate response would be used to return a set of mounts and/or Container IDs and their mount paths.
Node describes the state of a node.
ObjectstoreInfo is a structure that has current objectstore info.
Ownership information for resource.
No description provided by the author
ReplicaSet set of machine IDs (nodes) to which part of this volume is erasure coded - for clustered storage arrays.
No description provided by the author
RuntimeStateMap is a list of name value mapping of driver specific runtime information.
SdkAlertsAlertTypeQuery queries for alerts using alert type and it requires that resource type be provided as well.
SdkAlertsCountSpan to store count range information.
SdkAlertsDeleteRequest is a request message to delete alerts.
SdkAlertsDeleteResponse is empty.
SdkAlertsEnumerateRequest is a request message to enumerate alerts.
SdkAlertsEnumerateResponse is a list of alerts.
SdkAlertsOption contains options for filtering alerts.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SdkAlertsQuery is one of the query types and a list of options.
No description provided by the author
No description provided by the author
No description provided by the author
SdkAlertsResourceIdQuery queries for alerts using resource id and it requires that both alert type and resource type be provided as well.
SdkAlertsResourceTypeQuery queries for alerts using only resource id.
SdkAlertsTimeSpan to store time window information.
Defines credentials for Aws/S3 endpoints.
Defines the response for AWS/S3 credentials.
Defines credentials for Azure.
Defines the response for Azure credentials.
Defines a request to get catalog of a backup stored by a cloud provider.
Defines a response containing the contents of a backup stored by a cloud provider.
Defines a request to create a backup of a volume to the cloud.
Empty response.
Defines a request to delete all the backups stored by a cloud provider for a specified volume.
Empty response.
Defines a request to delete a single backup stored by a cloud provider.
Empty response.
Defines a request to list the backups stored by a cloud provider.
Defines a response which lists all the backups stored by a cloud provider.
SdkCloudBackupHistoryItem contains information about a backup for a specific volume.
Defines a request to retreive the history of the backups for a specific volume to a cloud provider.
Defines a response containing a list of history of backups to a cloud provider.
SdkCloudBackupInfo has information about a backup stored by a cloud provider.
Defines a request to restore a volume from an existing backup stored by a cloud provider.
Defines a response when restoring a volume from a backup stored by a cloud provider.
Defines a request to create a schedule for volume backups to a cloud provider.
Defines a response containing the id of a schedule for a volume backup to a cloud provider.
Defines a request to delete a backup schedule.
Empty response.
Empty request.
Defines a response containing a map listing the schedules for volume backups to a cloud provider.
SdkCloudBackupScheduleInfo describes a schedule for volume backups to a cloud provider.
Defines a request to change the state of a backup or restore to or from a cloud provider.
Empty response.
SdkCloudBackupStatus defines the status of a backup stored by a cloud provider.
Defines a request to retreive the status of a backup or restore for a specified volume.
Defines a response containing the status of the backups for a specified volume.
Defines a request to stop a cloud migration.
Empty Response.
Defines a migration request.
No description provided by the author
Defines a migration request for all volumes in a cluster.
Defines a migration request for a volume.
Defines a migration request for a volume group.
No description provided by the author
No description provided by the author
Defines a response for the migration that was started.
Request for cloud migration operation status.
Defines a response for the status request.
Defines a request to activate a cluster domain.
Empty response.
Defines a request to deactivate a cluster domain.
Empty response.
Defines a request to inspect a cluster domain.
Defines a response to inspecting a cluster domain.
Empty request.
Defines a response when enumerating cluster domains.
Empty request.
Defines a response when inspecting the current cluster.
Defines a request for creating a cluster pair.
Defines a result of the cluster pair.
Defines a delete request for a cluster pair.
Empty response.
Empty Request.
Defines a list of cluster pair.
Empty request.
Defines a response for the token request.
Defines a cluster pair inspect request.
Defines a cluster pair inspect response.
Empty request.
Defines a response for the token request.
Defines a request to create credentials.
No description provided by the author
No description provided by the author
No description provided by the author
Defines a response from creating a credential.
Defines the request to delete credentials.
Empty response.
Empty request.
Defines response for a enumeration of credentials.
Defines the request to inspection for credentials.
Defines the response to an inspection of a credential.
No description provided by the author
No description provided by the author
No description provided by the author
Defines a request to validate credentials.
Empty response.
Defines credentials for Google.
Defines the response for Google credentials.
Empty request.
Defines a response containing the capabilites of the cluster.
Empty request.
Defines a response containing version information.
Empty request.
Defines a response with a list of nodes.
Empty request.
Defines a response when inspecting a node.
Defines a request when inspecting a node.
Defines a response when inspecting a node.
Defines a request to create an object store.
Defines a response when an object store has been created for a specified volume.
Defines a request to delete an object store service from a volume.
Empty response.
Defines a request to get information about an object store endpoint.
Defines a response when inspecting an object store endpoint.
Defines a request to update an object store.
Empty response.
Define a request to create storage policy.
Empty response.
Empty Request.
Define default storage policy response.
Define a request to delete storage policy.
Empty Response.
Empty request.
Define a storage policy enumerate response.
Define a request to inspect storage policy.
Define a storage policy inspect response.
Empty Request.
Empty Response.
Define a request to set default storage policy.
Empty Response.
Define a request to update storage policy.
Empty Response.
No description provided by the author
Defines a request for creating a role.
Response contains informaiton about the creation of the role.
Defines a request to delete a role.
Empty response.
Empty request.
Respose to enumerate all roles.
Defines a request to inspect a role.
Response to inspection request.
Defines a request to update an existing role.
Response contains information about the updated role.
SdkRule is the message used to construct custom roles in the OpenStorage SDK.
Defines a schedule policy.
Define a schedule policy request.
Empty response.
Define schedule policy deletion request.
Empty response.
Empty request.
Defines a schedule policy enumerate response.
Define a schedule policy inspection request.
Defines a schedule policy inspection response.
Defines a schedule policy interval.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Defines a daily schedule.
Defines a monthly schedule.
Defines a periodic schedule.
Defines a weekly schedule.
Define a request to update a schedule policy.
Empty response.
Defines a capability of he cluster.
No description provided by the author
No description provided by the author
A SdkStoragePolicy represents minimum set of volume specs to be follow while creating volumes.
SDK version in Major.Minor.Patch format.
Options to attach device.
Defines a request to attach a volume to the node receiving this request.
Defines a response from the node which received the request to attach.
Defines request to retrieve volume/snapshot capacity usage details.
Defines response containing volume/snapshot capacity usage details.
Defines a request to clone a volume or create a volume from a snapshot.
Defines the response when creating a clone from a volume or a snapshot.
Defines a request to create a volume.
Defines a response to the creation of a volume.
Defines the request to delete a volume.
Empty response.
No description provided by the author
Defines a request to detach a volume.
Empty response.
Defines a request to list volumes.
Defines the response when listing volumes.
Defines a request to list volumes.
Defines the response when listing volumes.
Defines the request to inspect a volume.
Defines the response when inspecting a volume.
Defines the request to inspect volumes using a filter.
Defines the response when inspecting volumes using a filter.
Defines a request to mount a volume to the node receiving this request.
Empty response.
Defines the request when creating a snapshot from a volume.
Defines a response after creating a snapshot of a volume.
Defines a request to list the snaphots.
Defines a response when listing snapshots.
Defines a request to list the snaphots.
Defines a response when listing snapshots.
Defines a request to restore a volume to a snapshot.
Empty response.
Defines a request to update the snapshot schedule of a volume.
Empty response.
Defines a request to retreive volume statistics.
Defines a response containing drive statistics.
Options to unmount device.
Defines a request to unmount a volume on the node receiving this request.
Empty response.
This request is used to adjust or set new values in the volume.
Empty response.
SnapCreateRequest specifies a request to create a snapshot of given volume.
SnapCreateRequest specifies a response that get's returned when creating a snapshot.
Source is a structure that can be given to a volume to seed the volume with data.
StatPoint represents the basic structure of a single Stat reported TODO: This is the first step to introduce stats in openstorage.
Stats is a structure that represents last collected stats for a volume.
StorageCluster represents the state and information about the cluster.
StorageNode describes the state of the node.
StoragePool groups different storage devices based on their CosType.
StorageResource groups properties of a storage device.
Version information about the storage system.
TunnelConfig describes key, cert and endpoint of a reverse proxy tunnel DEPRECATED
swagger:model.
Volume represents an abstract storage volume.
VolumeConsumer identifies a consumer for a Volume.
VolumeCreateRequest is a structure that has the locator, source and spec to create a volume.
VolumeCreateResponse.
VolumeInfo.
Options used for volume inspection.
VolumeLocator is a structure that is attached to a volume and is used to carry opaque metadata.
VolumePlacementRule defines a single placement rule.
VolumePlacementStrategy defines a strategy for placing volumes in the cluster which will be a series of rules.
VolumeResponse is a structure that wraps an error.
VolumeSet specifies a request to update a volume.
VolumeSetResponse.
VolumeSpec has the properties needed to create a volume.
VolumeSpecPolicy provides a method to set volume storage policy.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
VolumeSpecUpdate provides a method to set any of the VolumeSpec of an existing volume.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
VolumeStateAction specifies desired actions.
# Interfaces
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Type aliases
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
This defines operator types used in a label matching rule.
No description provided by the author
Access types can be set by owner to have different levels of access to a resource.
No description provided by the author
CloudBackup operations types.
SdkCloudBackupRequestedState defines states to set a specified backup or restore to or from a cloud provider.
CloudBackup status types.
No description provided by the author
Defines times of day.
These values are constants that can be used by the client and server applications.
No description provided by the author
No description provided by the author
StatusKind indicates the severity of a status.
No description provided by the author
No description provided by the author
This specifies the type an affinity rule can take.
Defines the types of enforcement on the given rules.
This defines an operator for the policy comparisons.
VolumeState represents the state of a volume.
VolumeStatus represents a health status for a volume.