oneviewgolang

README

HPE OneView SDK for GoLang

Build Status

OV Version	6.20	6.10	6.00	5.60	5.50	5.40
SDK Version/Tag	v6.2.0	v6.1.0	v6.0.0	v1.8.0	v1.7.0	v1.6.0
Build Status

Introduction

HPE OneView makes it simple to deploy and manage today’s complex hybrid cloud infrastructure. HPE OneView can help you transform your data center to software-defined, and it supports HPE’s broad portfolio of servers, storage, and networking solutions, ensuring the simple and automated management of your hybrid infrastructure. Software-defined intelligence enables a template-driven approach for deploying, provisioning, updating, and integrating compute, storage, and networking infrastructure.

The HPE OneView Go SDK provides library to easily interact with HPE OneView and HPE Image Streamer REST APIs. The HPE OneView Go SDK enables developers to easily build integrations and scalable solutions with HPE OneView and HPE Image Streamer.

You can find the latest supported HPE OneView Go SDK here

What's New

HPE OneView Go library extends support of the SDK to OneView REST API version 2800 (OneView v6.20)

Please refer to notes for more information on the changes , features supported and issues fixed in this version

Getting Started

Installation and Configuration

Installation

HPE OneView SDK for Go can be installed from Source or Docker container installation methods. You can either use a docker container which will have the HPE OneView SDK for Go installed or perform local installation.

Docker Setup

The light weight containerized version of the HPE OneView SDK for Go is available in the Docker Store. The Docker Store image tag consist of two sections: <sdk_version-OV_version>

# Download and store a local copy of oneview-golang and use it as a Docker Image.
$ docker pull hewlettpackardenterprise/hpe-oneview-sdk-for-golang:v6.2.0-OV6.2
# Run docker commands below given, which  will in turn create a sh session 
# where you can create files, issue commands and execute the examples.
$ docker run -it hewlettpackardenterprise/hpe-oneview-sdk-for-golang:v6.2.0-OV6.2 /bin/sh

Local Setup

• Local installation requires Installing Go

# Install the dependent packages
$ apt-get install build-essential git wget
$ wget https://dl.google.com/go/go1.11.3.linux-amd64.tar.gz

# untar with "tar -zxvf go1.11.3.linux-amd64.tar.gz"
# move go/ to /usr/local/ 
# mv go1.11.3.linux-amd64.tar.gz /usr/local/ 
# mkdir ~/go

# Setting GO Environment Variable and adding the GO installed directory to PATH 
$ export GOROOT=/usr/local/go
$ export GOPATH=$HOME/go 
$ export PATH=$PATH:$GOROOT/bin:$GOPATH/bin

# Install Oneview Go SDK
$ go get -u github.com/HewlettPackard/oneview-golang 

Configuration

Environment Variables

# Required
$ export ONEVIEW_OV_ENDPOINT=<ov_endpoint>
$ export ONEVIEW_OV_USER=<ov_username>
$ export ONEVIEW_OV_PASSWORD=<ov_password>
$ export ONEVIEW_OV_DOMAIN=LOCAL
$ export ONEVIEW_SSLVERIFY=false
$ export ONEVIEW_APIVERSION=<ov_apiversion>

Note: Currently this SDK supports OneView API 2600 minimally, where we can test OneView API 2600 version with this SDK. If API version is not provided then appliance's API version will be used. If API version used is not supported then error will be thrown.

OneView Client Configuration

The OneView Client configuration options that can be passed during OneView Client object creation:

# Create a OneView client object:
import "github.com/HewlettPackard/oneview-golang/ov"

var ClientOV    *ov.OVClient
apiversion, _ := strconv.Atoi(os.Getenv("ONEVIEW_APIVERSION"))

ovc := ClientOV.NewOVClient(
  os.Getenv("ONEVIEW_OV_USER"),      # This is to set the Oneview UserName
  os.Getenv("ONEVIEW_OV_PASSWORD"),  # This is to set the Oneview Password
  os.Getenv("ONEVIEW_OV_DOMAIN"),    # This is to set the Domain, default is LOCAL
  os.Getenv("ONEVIEW_OV_ENDPOINT"),  # This is to set the IP Address of the Oneview Appliance
  false,                             # This is to set the SSL, default is false
  apiversion,                        # This is to set OV REST API Version. Defaults to OneView Max supported REST API Version.
    "*")                              

🔒 Tip: Check the file permissions because the password is stored in clear-text.

Image Streamer Client Configuration

The Image Streamer (I3S) client is very much similar to the OneView client, but has one key difference: it cannot generate it's own token. However, it uses the same token given to or generated by the OneView client, so if you need to generate a token, create a OneView client using a user & password, then pass the generated token into the Image Streamer client.

# Additional environment variable for I3S END POINT should be set.
$ export ONEVIEW_I3S_ENDPOINT=<i3s_endpoint>

# Create a OneView client object
import (
  "github.com/HewlettPackard/oneview-golang/ov"
  "github.com/HewlettPackard/oneview-golang/i3s" 
)

var (
  clientOV             *ov.OVClient
  i3sClient            *i3s.I3SClient
  endpoint             = os.Getenv("ONEVIEW_OV_ENDPOINT")
  i3sc_endpoint        = os.Getenv("ONEVIEW_I3S_ENDPOINT")
  username             = os.Getenv("ONEVIEW_OV_USER")
  password             = os.Getenv("ONEVIEW_OV_PASSWORD")
  domain               = os.Getenv("ONEVIEW_OV_DOMAIN")
)

apiversion, _ := strconv.Atoi(os.Getenv("ONEVIEW_APIVERSION"))
i3s_apiversion, _ := strconv.Atoi(os.Getenv("ONEVIEW_APIVERSION"))

# Creates OV Client
ovc := clientOV.NewOVClient( username, password, domain, endpoint, false, api_version, "*")

# Gets Session ID
ovc.RefreshLogin()

# Create I3s Client using Session ID
i3sc := i3sClient.NewI3SClient(i3sc_endpoint, false, i3s_apiversion, ovc.APIKey)

🔒 Tip: Check the file permissions because the password is stored in clear-text as Environment Variable.

Configuration Files

Configuration files can also be used to define client configuration (json or yaml formats). Here's an example json file:

# oneview_config.json
{
  "username":     "<ov_username>",  
  "password":     "<ov_password>",
  "endpoint":     "<ov_ip>",
  "domain":       "LOCAL",
  "apiversion":   "<ov_apiversion>",
  "sslverify":    false,
  "ifmatch":      "*"
}

and load via:

# Create a OneView client object:
import 	"github.com/HewlettPackard/oneview-golang/ov"

var	ClientOV    *ov.OVClient
config, _ := ov.LoadConfigFile("oneview_config.json")

ovc := ClientOV.NewOVClient(
  config.UserName,       # This is to set the Oneview UserName
  config.Password,       # This is to set the Oneview Password
  config.Domain,         # This is to set the Domain, default is LOCAL
  config.Endpoint,       # This is to set the IP Address of the 
  config.SslVerify,      # This is to set the SSL, default is false
  config.ApiVersion,     # This is to set OV REST API Version. Defaults to OneView Max supported REST API Version.
  config.IfMatch)

🔒 Tip: Check the file permissions if the password or token is stored in clear-text.

API Implementation

A detailed list of the HPE OneView REST interfaces that have been implemented in this SDK can be found in the endpoints-support.md file.

Getting Help

Are you running into a road block? Have an issue with unexpected behavior? Feel free to open a new issue on the issue tracker

License

This project is licensed under the Apache 2.0 license. Please see LICENSE for more info.

Contributing and feature requests

We welcome your contributions to the HPE OneView for Go SDK library.

Contributing: You know the drill. Fork it, branch it, change it, commit it, and pull-request it. We are passionate about improving this project, and glad to accept help to make it better. For more information refer CONTRIBUTING.md file.

NOTE: We reserve the right to reject changes that we feel do not fit the scope of this project, so for feature additions, please open an issue to discuss your ideas before doing the work.

Feature Requests: If you have a need that is not met by the current implementation, please let us know opening an new enhancement request/issue. This feedback is important for us to deliver a useful product.

Testing your changes

We use docker to build and test, run this project on a system that has docker. If you don't use docker, you will need to install and setup go-lang locally as well as any other make requirements.

You can use USE_CONTAINER=false environment setting for make to avoid using docker. Otherwise make sure to have these tools:

• docker client and daemon
• gnu make tools

The Tests in GoLang are divided into two segments one is doing the acceptance test and another drives the Unit Tests.

With Docker

$ make test

Without docker

• Install golang 1.5 or higher(We recommend using Go 1.11)
• Install go packages listed in .travis.yml

The Test Data for these Tests are supplied through JSON file stored at test/data for example config_EGSL_tb200.json

These Tests can be run locally, you must install the below dependencies as mention in .travis.yml and do export USE_CONTAINER=false

$ go get github.com/mattn/goveralls
$ go get -u golang.org/x/lint/golint

These Tests are using make files to save the compile time. Below are the commands to run the tests.

$ sudo make vet
$ sudo make test-short
$ sudo make test-long
$ sudo make coverage-send

Note: $ make test runs all the above mentioned tests.

Additional Resources

HPE OneView Documentation

HPE OneView Release Notes

HPE OneView Support Matrix

HPE OneView Installation Guide

HPE OneView User Guide

HPE OneView Online Help

HPE OneView REST API Reference

HPE OneView Firmware Management White Paper

HPE OneView Deployment and Management White Paper

HPE OneView Community

HPE OneView Community Forums

Learn more about HPE OneView at hpe.com/info/oneview

Documentation

Overview

Package oneviewgolang This package should be used when working with api's for HP OneView and HP ICsp Stub package for version

Index

• Variables

Variables

var (
	// ConfigVersion dictates which version of the config.json format is
	// used. It needs to be bumped if there is a breaking change, and
	// therefore migration, introduced to the config file format.
	ConfigVersion = 1

	// Version should be updated by hand at each release
	Version = "1.0.0"

	// GitCommit will be overwritten automatically by the build system
	GitCommit = "HEAD"
)