stackpoint-sdk-go

stackpoint.io Go SDK

Version: stackpoint-sdk-go 1.0.0

The StackPointCloud software development kit for Go provides you with access to the StackPointCloud API. It is designed for developers who are building applications in Go.

In order to use the client from the StackPointCloud Go SDK, you must provide a StackPointCloud API token and endpoint url.

Installation

Install the Go language from from the official Go installation guide or using your Linux distribution package management system.

The GOPATH environment variable specifies the location of your Go workspace. It is likely the only environment variable you will need to set when developing Go code. This is an example of pointing to a workspace configured under your home directory:

mkdir -p ~/go/bin
export GOPATH=~/go
export GOBIN=$GOPATH/bin
export PATH=$PATH:$GOBIN

The following go command will download stackpoint-sdk-go to your configured GOPATH:

go get "github.com/StackPointCloud/stackpoint-sdk-go"

The source code of the package will be located here:

$GOPATH/src/github.com/StackPointCloud/stackpoint-sdk-go

Library

Include the StackPointCloud SDK for Go like any other Go library. For example, create main package file example.go:

package main

import (
	"fmt"
)

func main() {
}

Include the StackPointCloud SDK for Go under the list of imports.

import(
	"fmt"    
	spio "github.com/StackPointCloud/stackpoint-sdk-go"
)

Authentication

Add your StackPointCloud API token and endpoint URL to the client connection.

client := spio.NewClient("token", "endpoint")

It might be necessary to accept credentials through environment variables in a containerized environment.

Set your environment variables in your shell.

export SPC_API_TOKEN="YOUR TOKEN HERE"
export SPC_BASE_API_URL="YOUR ENDPOINT URL HERE"

Now you can use a helper function to get a client instance with environment variables.

import (
	"fmt"
	"os"
	spio "github.com/StackPointCloud/stackpoint-sdk-go"
)

func main() {
	client, err := spio.NewClientFromEnv()
...

Caution: You will want to ensure you follow security best practices when using credentials within your code or stored in a file.

Examples

The StackPointCloud SDK for Go comes with several example programs to demonstrate how most major operations can be performed, from listing organizations and nodes, to building clusters in various cloud ecosystems. The examples will be located in:

github.com/StackPointCloud/stackpoint-sdk-go/example