Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thecodeteam/goisilon
Isilon package that provides API bindings for Go
https://github.com/thecodeteam/goisilon
Last synced: about 2 months ago
JSON representation
Isilon package that provides API bindings for Go
- Host: GitHub
- URL: https://github.com/thecodeteam/goisilon
- Owner: thecodeteam
- License: apache-2.0
- Created: 2015-12-04T22:02:54.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2020-12-23T14:13:24.000Z (about 4 years ago)
- Last Synced: 2024-06-18T21:42:39.332Z (7 months ago)
- Language: Go
- Homepage:
- Size: 2.43 MB
- Stars: 13
- Watchers: 16
- Forks: 14
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
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](http://rexray.readthedocs.io/) 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.
```go
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:
```go
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.
```go
volume, err := c.CreateVolume(context.Background(), "loremipsum")
```
### Export a Volume
Enabling a volume for NFS access is fairly straight-forward.
```go
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.
```go
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](https://github.com/thecodeteam/rexray/blob/master/libstorage/drivers/storage/isilon/storage/isilon_storage.go).
## 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
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](https://github.com/codedellemc/mesos-module-dvdi/issues), join our
Slack channel available by signup through
[community.emc.com](https://community.emccode.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.