solidfire-go

README

solidfire-go

The solidfire-go library is a Go language SDK for interacting with a SolidFire Cluster.

This particular repository is a fork of a downstream derivative of the auto-generated Go SDK package from NetApp's Ngage BitBucket repository.

What the derivative did was strip out the auto-generated code and just provided the resultant SDK itself. In addition this library also provides a "methods" package with some wrappers around the basic and most common volume operations a user might be interested in. The methods package wraps soem of the basics into very easy to consume functions and also can serve as a good example on how to use the SDK.

This package refreshes and improves that fork for SolidFire 12.5.

Build

go build ./sdk/... ./methods/...

Use Go 1.26.5 or newer. The following dependencies exist.

github.com/sirupsen/logrus
gopkg.in/yaml.v2

Build examples:

go build -o create-volumes ./example/create-volumes/main.go
go build -o s3-backup ./example/s3-backup/main.go
go build -o account-redact ./example/account-redact/main.go
go build -o secure-api-proxy ./example/secure-api-proxy
# or build everything at once
# go build ./sdk/... ./methods/... && go build -o create-volumes example/create-volumes.go && go build -o s3-backup example/s3-backup.go

The terraform-provider-solidfire and solidfire-csi repositories contain additional examples of using this SDK.

Use (pick appropriate version):

go get github.com/scaleoutsean/solidfire-go@v1.0.6

Compatibility with SolidFire (ElementOS)

solidfire-go is developed and tested with SolidFire 12.5 using SolidFire Demo VM v12.5.0.897.

Older versions are expected to work, but not tested or "supported".

Newer versions are supported (using 12.5 or newer JSON-RPC API path), but may not support all parameters available in those versions. One notable exception is the authentication field in iSCSI sessions, enabling access to chapAlgorithm in newer SolidFire versions (>=12.7) while maintaining compatibility with 12.5 (and older) that are limited to MD5.

Contributing

Support for the API methods and parameters from newer versions (12.5+) is a goal that depends on contributors.

What's New from the official documentation mentions new features added to API methods in v12.

Community contributions and bug reports are welcome. Please include complete, working request/response examples as the maintainer has no access to SolidFire versions above 12.5.

Acknowledgements

This repository is an updated fork of John Griffith's repository https://github.com/j-griffith/solidfire-go. Thank you, John!

An earlier, auto-generated SDK version from an Ngage Bitbucket repository (which I can't find on the Internet) is copyrighted by NetApp, Inc.