goisilon

package module
v1.7.1 Latest Latest
Warning

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

 Go to latest Published: Jun 16, 2023 License: Apache-2.0 Imports: 13 Imported by: 0

README

GoIsilon

Overview

GoIsilon is a Go package that provides a client for the EMC Isilon OneFS HTTP API. The package provides both direct implementations of the API bindings as well as abstract, helper functionality. In addition, services such as Docker, Mesos, and REX-Ray use the GoIsilon package to integrate with the NAS storage platform.

OneFS API Support Matrix

The GoIsilon package is tested with and supports OneFS 7.2+ with support for APIv2 and APIv3 (introduced in OneFS 8.0).

Examples

The tests provide working examples for how to use the package, but here are a few code snippets to further illustrate the basic ideas:

Initialize a new client

This example shows how to initialize a new client.

client, err := NewClient(context.Background())
if err != nil {
	panic(err)
}

Please note that there is no attempt to provide a host, credentials, or any other options. The NewClient() function relies on the following environment variables to configure the GoIsilon client:

Environment Variables
Name Description
GOISILON_ENDPOINT the API endpoint, ex. https://172.17.177.230:8080
GOISILON_USERNAME the username
GOISILON_GROUP the user's group
GOISILON_PASSWORD the password
GOISILON_INSECURE whether to skip SSL validation
GOISILON_VOLUMEPATH which base path to use when looking for volume directories
Initialize a new client with options

The following example demonstrates how to explicitly specify options when creating a client:

client, err := NewClientWithArgs(
	context.Background(),
	"https://172.17.177.230:8080",
	"groupName",
	"userName",
	"password",
	true,
	"/ifs/volumes")
if err != nil {
	panic(err)
}
Create a Volume

This snippet creates a new volume named "testing" at "/ifs/volumes/loremipsum". The volume path is generated by concatenating the client's volume path and the name of the volume.

volume, err := c.CreateVolume(context.Background(), "loremipsum")
Export a Volume

Enabling a volume for NFS access is fairly straight-forward.

if err := c.ExportVolume(context.Background(), "loremipsum"); err != nil {
	panic(err)
}
Delete a Volume

When a volume is no longer needed, this is how it may be removed.

if err := c.DeleteVolume(context.Background(), "loremipsum"); err != nil {
	panic(err)
}
More Examples

Several, very detailed examples of the GoIsilon package in use can be found in the package's *_test.go files as well as in the libStorage Isilon storage driver.

Contributions

Please contribute!

Licensing

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.

Support

If you have questions relating to the project, please either post Github Issues, join our Slack channel available by signup through community.emc.com and post questions into #projects, or reach out to the maintainers directly. The code and documentation are released with no warranties or SLAs and are intended to be supported through a community driven process.

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ConcurrentHTTPConnections = 2

ConcurrentHTTPConnections is the number of allowed concurrent HTTP connections for API functions that attempt to send multiple API calls at once.

Functions

This section is empty.

Types

type ACL 

type ACL *api.ACL

type Client 

type Client struct {

	// API is the underlying OneFS API client.
	API api.Client
}

Client is an Isilon client.

func NewClient 

func NewClient(ctx context.Context) (*Client, error)

func NewClientWithArgs 

func NewClientWithArgs(
	ctx context.Context,
	endpoint string,
	insecure bool,
	user, group, pass, volumesPath string) (*Client, error)

func (*Client) AddExportClients 

func (c *Client) AddExportClients(
	ctx context.Context, name string, clients ...string) error

AddExportClients adds to the Export's clients property.

func (*Client) AddExportClientsByID 

func (c *Client) AddExportClientsByID(
	ctx context.Context, id int, clients ...string) error

AddExportClientsByID adds to the Export's clients property.

func (*Client) AddExportRootClients 

func (c *Client) AddExportRootClients(
	ctx context.Context, name string, clients ...string) error

AddExportRootClients adds to the Export's root_clients property.

func (*Client) AddExportRootClientsByID 

func (c *Client) AddExportRootClientsByID(
	ctx context.Context, id int, clients ...string) error

AddExportRootClientsByID adds to the Export's root_clients property.

func (*Client) ClearExportClients 

func (c *Client) ClearExportClients(
	ctx context.Context, name string) error

ClearExportClients sets the Export's clients property to nil.

func (*Client) ClearExportClientsByID 

func (c *Client) ClearExportClientsByID(
	ctx context.Context, id int) error

ClearExportClientsByID sets the Export's clients property to nil.

func (*Client) ClearExportRootClients 

func (c *Client) ClearExportRootClients(
	ctx context.Context, name string) error

ClearExportRootClients sets the Export's root_clients property to nil.

func (*Client) ClearExportRootClientsByID 

func (c *Client) ClearExportRootClientsByID(
	ctx context.Context, id int) error

ClearExportRootClientsByID sets the Export's clients property to nil.

func (*Client) ClearQuota 

func (c *Client) ClearQuota(ctx context.Context, name string) error

ClearQuota removes the quota from a volume

func (*Client) CopySnapshot 

func (c *Client) CopySnapshot(
	ctx context.Context,
	sourceId int64, sourceName, destinationName string) (Volume, error)

func (*Client) CopyVolume 

func (c *Client) CopyVolume(
	ctx context.Context, src, dest string) (Volume, error)

CopyVolume creates a volume based on an existing volume

func (*Client) CreateSnapshot 

func (c *Client) CreateSnapshot(
	ctx context.Context, path, name string) (Snapshot, error)

func (*Client) CreateVolume 

func (c *Client) CreateVolume(
	ctx context.Context, name string) (Volume, error)

CreateVolume creates a volume

func (*Client) CreateVolumeDir 

func (c *Client) CreateVolumeDir(
	ctx context.Context,
	volumeName, dirPath string,
	fileMode os.FileMode,
	overwrite, recursive bool) error

CreateVolumeDir creates a directory inside a volume.

func (*Client) DeleteVolume 

func (c *Client) DeleteVolume(
	ctx context.Context, name string) error

DeleteVolume deletes a volume

func (*Client) DisableFailureMapping 

func (c *Client) DisableFailureMapping(
	ctx context.Context, name string) error

DisableFailureMapping disables the map_failure mapping for an Export.

func (*Client) DisableFailureMappingByID 

func (c *Client) DisableFailureMappingByID(
	ctx context.Context, id int) error

DisableFailureMappingByID disables the map_failure mapping for an Export.

func (*Client) DisableNonRootMapping 

func (c *Client) DisableNonRootMapping(
	ctx context.Context, name string) error

DisableNonRootMapping disables the map_non_root mapping for an Export.

func (*Client) DisableNonRootMappingByID 

func (c *Client) DisableNonRootMappingByID(
	ctx context.Context, id int) error

DisableNonRootMappingByID disables the map_non_root mapping for an Export.

func (*Client) DisableRootMapping 

func (c *Client) DisableRootMapping(
	ctx context.Context, name string) error

DisableRootMapping disables the root mapping for an Export.

func (*Client) DisableRootMappingByID 

func (c *Client) DisableRootMappingByID(
	ctx context.Context, id int) error

DisableRootMappingbyID disables the root mapping for an Export.

func (*Client) EnableFailureMapping 

func (c *Client) EnableFailureMapping(
	ctx context.Context, name, user string) error

EnableFailureMapping enables the map_failure mapping for an Export.

func (*Client) EnableFailureMappingByID 

func (c *Client) EnableFailureMappingByID(
	ctx context.Context, id int, user string) error

EnableFailureMappingByID enables the map_failure mapping for an Export.

func (*Client) EnableNonRootMapping 

func (c *Client) EnableNonRootMapping(
	ctx context.Context, name, user string) error

EnableNonRootMapping enables the map_non_root mapping for an Export.

func (*Client) EnableNonRootMappingByID 

func (c *Client) EnableNonRootMappingByID(
	ctx context.Context, id int, user string) error

EnableNonRootMappingByID enables the map_non_root mapping for an Export.

func (*Client) EnableRootMapping 

func (c *Client) EnableRootMapping(
	ctx context.Context, name, user string) error

EnableRootMapping enables the root mapping for an Export.

func (*Client) EnableRootMappingByID 

func (c *Client) EnableRootMappingByID(
	ctx context.Context, id int, user string) error

EnableRootMappingByID enables the root mapping for an Export.

func (*Client) Export 

func (c *Client) Export(ctx context.Context, name string) (int, error)

Export the volume with a given name on the cluster

func (*Client) ExportVolume 

func (c *Client) ExportVolume(
	ctx context.Context, name string) (int, error)

ExportVolume exports a volume

func (*Client) ForceDeleteVolume 

func (c *Client) ForceDeleteVolume(ctx context.Context, name string) error

ForceDeleteVolume force deletes a volume by resetting the ownership of all descendent directories to the current user prior to issuing a delete call.

func (*Client) GetExportByID 

func (c *Client) GetExportByID(ctx context.Context, id int) (Export, error)

GetExportByID returns an export with the provided ID.

func (*Client) GetExportByName 

func (c *Client) GetExportByName(
	ctx context.Context, name string) (Export, error)

GetExportByName returns the first export with a path for the provided volume name.

func (*Client) GetExportClients 

func (c *Client) GetExportClients(
	ctx context.Context, name string) ([]string, error)

GetExportClients returns an Export's clients property.

func (*Client) GetExportClientsByID 

func (c *Client) GetExportClientsByID(
	ctx context.Context, id int) ([]string, error)

GetExportClientsByID returns an Export's clients property.

func (*Client) GetExportRootClients 

func (c *Client) GetExportRootClients(
	ctx context.Context, name string) ([]string, error)

GetExportRootClients returns an Export's root_clients property.

func (*Client) GetExportRootClientsByID 

func (c *Client) GetExportRootClientsByID(
	ctx context.Context, id int) ([]string, error)

GetExportRootClientsByID returns an Export's clients property.

func (*Client) GetExports 

func (c *Client) GetExports(ctx context.Context) (ExportList, error)

GetExports returns a list of all exports on the cluster

func (*Client) GetFailureMapping 

func (c *Client) GetFailureMapping(
	ctx context.Context, name string) (UserMapping, error)

GetFailureMapping returns the map_failure mapping for an Export.

func (*Client) GetFailureMappingByID 

func (c *Client) GetFailureMappingByID(
	ctx context.Context, id int) (UserMapping, error)

GetFailureMappingByID returns the map_failure mapping for an Export.

func (*Client) GetNonRootMapping 

func (c *Client) GetNonRootMapping(
	ctx context.Context, name string) (UserMapping, error)

GetNonRootMapping returns the map_non_root mapping for an Export.

func (*Client) GetNonRootMappingByID 

func (c *Client) GetNonRootMappingByID(
	ctx context.Context, id int) (UserMapping, error)

GetNonRootMappingByID returns the map_non_root mapping for an Export.

func (*Client) GetQuota 

func (c *Client) GetQuota(ctx context.Context, name string) (Quota, error)

GetQuota returns a specific quota by path

func (*Client) GetRootMapping 

func (c *Client) GetRootMapping(
	ctx context.Context, name string) (UserMapping, error)

GetRootMapping returns the root mapping for an Export.

func (*Client) GetRootMappingByID 

func (c *Client) GetRootMappingByID(
	ctx context.Context, id int) (UserMapping, error)

GetRootMappingByID returns the root mapping for an Export.

func (*Client) GetSnapshot 

func (c *Client) GetSnapshot(
	ctx context.Context, id int64, name string) (Snapshot, error)

func (*Client) GetSnapshots 

func (c *Client) GetSnapshots(ctx context.Context) (SnapshotList, error)

func (*Client) GetSnapshotsByPath 

func (c *Client) GetSnapshotsByPath(
	ctx context.Context, path string) (SnapshotList, error)

func (*Client) GetVolume 

func (c *Client) GetVolume(
	ctx context.Context, id, name string) (Volume, error)

GetVolume returns a specific volume by name or ID

func (*Client) GetVolumeACL 

func (c *Client) GetVolumeACL(
	ctx context.Context,
	volumeName string) (ACL, error)

GetVolumeACL returns the ACL for a volume.

func (*Client) GetVolumeExportMap 

func (c *Client) GetVolumeExportMap(
	ctx context.Context,
	includeRootClients bool) (map[Volume]Export, error)

GetVolumeExportMap returns a map that relates Volumes to their corresponding Exports. This function uses an Export's "clients" property to define the relationship. The flag "includeRootClients" can be set to "true" in order to also inspect the "root_clients" property of an Export when determining the Volume-to-Export relationship.

func (*Client) GetVolumes 

func (c *Client) GetVolumes(ctx context.Context) ([]Volume, error)

GetVolumes returns a list of volumes

func (*Client) IsExported 

func (c *Client) IsExported(
	ctx context.Context, name string) (bool, int, error)

IsExported returns a flag and export ID if the provided volume name is already exported.

func (*Client) QueryVolumeChildren 

func (c *Client) QueryVolumeChildren(
	ctx context.Context, name string) (VolumeChildrenMap, error)

QueryVolumeChildren retrieves a list of all of a volume's descendent files and directories.

func (*Client) RemoveSnapshot 

func (c *Client) RemoveSnapshot(
	ctx context.Context, id int64, name string) error

func (*Client) SetExportClients 

func (c *Client) SetExportClients(
	ctx context.Context, name string, clients ...string) error

SetExportClients sets the Export's clients property.

func (*Client) SetExportClientsByID 

func (c *Client) SetExportClientsByID(
	ctx context.Context, id int, clients ...string) error

SetExportClientsByID sets the Export's clients property.

func (*Client) SetExportRootClients 

func (c *Client) SetExportRootClients(
	ctx context.Context, name string, clients ...string) error

SetExportRootClients sets the Export's root_clients property.

func (*Client) SetExportRootClientsByID 

func (c *Client) SetExportRootClientsByID(
	ctx context.Context, id int, clients ...string) error

SetExportRootClientsByID sets the Export's clients property.

func (*Client) SetQuotaSize 

func (c *Client) SetQuotaSize(
	ctx context.Context, name string, size int64) error

SetQuota sets the max size (hard threshold) of a quota for a volume

func (*Client) SetVolumeOwner 

func (c *Client) SetVolumeOwner(
	ctx context.Context,
	volumeName, userName string) error

SetVolumeOwner sets the owner for a volume.

func (*Client) SetVolumeOwnerToCurrentUser 

func (c *Client) SetVolumeOwnerToCurrentUser(
	ctx context.Context,
	volumeName string) error

SetVolumeOwnerToCurrentUser sets the owner for a volume to the user that was used to connect to the API.

func (*Client) Unexport 

func (c *Client) Unexport(
	ctx context.Context, name string) error

Stop exporting a given volume from the cluster

func (*Client) UnexportByID 

func (c *Client) UnexportByID(
	ctx context.Context, id int) error

UnexportByID unexports an Export by its ID.

func (*Client) UnexportVolume 

func (c *Client) UnexportVolume(
	ctx context.Context, name string) error

UnexportVolume stops exporting a volume

func (*Client) UpdateQuotaSize 

func (c *Client) UpdateQuotaSize(
	ctx context.Context, name string, size int64) error

UpdateQuota modifies the max size (hard threshold) of a quota for a volume

type Export 

type Export *api.Export

type ExportList 

type ExportList []*api.Export

type Quota 

type Quota *api.IsiQuota

type Snapshot 

type Snapshot *api.IsiSnapshot

type SnapshotList 

type SnapshotList []*api.IsiSnapshot

type UserMapping 

type UserMapping *api.UserMapping

type Volume 

type Volume *apiv1.IsiVolume

type VolumeChildren 

type VolumeChildren apiv2.ContainerChildList

type VolumeChildrenMap 

type VolumeChildrenMap map[string]*apiv2.ContainerChild

Source Files

View all Source files

Directories

Path Synopsis
api
json
Package json implements encoding and decoding of JSON as defined in RFC 4627.
 Package json implements encoding and decoding of JSON as defined in RFC 4627.
v1
v2

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.