Go API client for ranchersolutionapi

Simplify enterprise-grade Kubernetes cluster operations and management with Rancher on Bare Metal Cloud. Deploy Kubernetes clusters using a few API calls.

Knowledge base articles to help you can be found here

All URLs are relative to (https://api.phoenixnap.com/solutions/rancher/v1beta)

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

API version: 0.1 For more information, please visit https://phoenixnap.com/

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import ranchersolutionapi "github.com/phoenixnap/go-sdk-bmc/ranchersolutionapi"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value ranchersolutionapi.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), ranchersolutionapi.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value ranchersolutionapi.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), ranchersolutionapi.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using ranchersolutionapi.ContextOperationServerIndices and ranchersolutionapi.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), ranchersolutionapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), ranchersolutionapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://api.phoenixnap.com/solutions/rancher/v1beta

Class	Method	HTTP request	Description
ClustersAPI	ClustersGet	Get /clusters	Cluster list.
ClustersAPI	ClustersIdDelete	Delete /clusters/{id}	Delete a cluster.
ClustersAPI	ClustersIdGet	Get /clusters/{id}	Retrieve a Cluster
ClustersAPI	ClustersPost	Post /clusters	Create a Rancher Server Deployment.

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

OAuth2

Type: OAuth
Flow: application
Authorization URL:
Scopes:
bmc: Grants full access to bmc-api.
bmc.read: Grants read only access to bmc-api.

Example

auth := context.WithValue(context.Background(), ranchersolutionapi.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, ranchersolutionapi.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

PtrBool
PtrInt
PtrInt32
PtrInt64
PtrFloat
PtrFloat32
PtrFloat64
PtrString
PtrTime

Author

[email protected]

# README