client

README

Community Go Client for STACKIT

The client is community-supported and not an official STACKIT release, it is maintained by internal Schwarz IT teams integrating with STACKIT

Install

To install the latest stable release, run:

go get github.com/SchwarzIT/community-stackit-go-client@latest

Usage Example

In order to use the client, a STACKIT Service Account must be created and have relevant roles assigned to it.
For further assistance, please contact STACKIT support

package main

import (
	"context"
	"fmt"
	"os"

	client "github.com/SchwarzIT/community-stackit-go-client"
)

func main() {
	ctx := context.Background()
	c, err := client.New(ctx, client.Config{
		ServiceAccountEmail: os.Getenv("STACKIT_SERVICE_ACCOUNT_EMAIL"),
		ServiceAccountToken: os.Getenv("STACKIT_SERVICE_ACCOUNT_TOKEN"),
	})
	if err != nil {
		panic(err)
	}

	projectID := "1234"
	bucketName := "example"

	process, err := c.ObjectStorage.Buckets.Create(ctx, projectID, bucketName)
	if err != nil {
		panic(err)
	}

	// wait for bucket to be created
	if _, err := process.Wait(); err != nil {
		panic(err)
	}

	fmt.Printf("bucket '%s' created successfully", bucketName)
}

Further usage examples can be found in terraform-provider-stackit

Enabling auto-retry

The client can automatically retry failed calls using pkg/retry

To enable retry in the client, use SetRetry in the following way:

c, _ := client.New(context.Background(), client.Config{})
c.SetRetry(retry.New())

Documentation

Index

• type ArchivedServices
• type Client
  • func MockServer() (c *Client, mux *http.ServeMux, teardown func(), err error)
  • func New(ctx context.Context, cfg Config) (*Client, error)
  • func (c *Client) Clone() common.Client
  • func (c *Client) Do(req *http.Request, v interface{}, errorHandlers ...func(*http.Response) error) (*http.Response, error)
  • func (c *Client) GetBaseURL() string
  • func (c *Client) GetConfig() Config
  • func (c *Client) GetHTTPClient() *http.Client
  • func (c *Client) Request(ctx context.Context, method, path string, body []byte) (*http.Request, error)
  • func (c *Client) Retry() *retry.Retry
  • func (c *Client) SetBaseURL(url string) error
  • func (c *Client) SetRetry(r *retry.Retry)
  • func (c *Client) SetToken(token string)
• type Config
  • func (c *Config) SetURL(value string) error
  • func (c *Config) Validate() error
• type DataServices
• type IncubatorServices
• type ProductiveServices

Types

type ArchivedServices

type ArchivedServices struct {
	ResourceManagementV1 *resourceManagementV1.ResourceManagementV1Service
}

ArchivedServices is used for services that are being phased out

type Client

type Client struct {

	// Productive services - services that are ready to be used in production
	ProductiveServices

	// Incubator - services under development or currently being tested
	// not ready for production usage
	Incubator IncubatorServices

	// Archived - for services that are phased out
	Archived ArchivedServices
	// contains filtered or unexported fields
}

Client service for managing interactions with STACKIT API

func MockServer

func MockServer() (c *Client, mux *http.ServeMux, teardown func(), err error)

MockServer mocks STACKIT api server and returns a client pointing to it, mux, teardown function and an error indicator

func New

func New(ctx context.Context, cfg Config) (*Client, error)

New returns a new client

func (*Client) Clone

func (c *Client) Clone() common.Client

Clone creates a shallow clone of the client

func (*Client) Do

func (c *Client) Do(req *http.Request, v interface{}, errorHandlers ...func(*http.Response) error) (*http.Response, error)

Do performs the request, including retry if set To set retry, use WithRetry() which returns a shalow copy of the client

func (*Client) GetBaseURL

func (c *Client) GetBaseURL() string

GetBaseURL returns the base url string

func (*Client) GetConfig

func (c *Client) GetConfig() Config

GetConfig returns the client config

func (*Client) GetHTTPClient

func (c *Client) GetHTTPClient() *http.Client

GetHTTPClient returns the HTTP client

func (*Client) Request

func (c *Client) Request(ctx context.Context, method, path string, body []byte) (*http.Request, error)

Request creates a new API request

func (*Client) Retry

func (c *Client) Retry() *retry.Retry

Retry returns the defined retry

func (*Client) SetBaseURL

func (c *Client) SetBaseURL(url string) error

SetBaseURL sets the base url

func (*Client) SetRetry

func (c *Client) SetRetry(r *retry.Retry)

SetRetry overrides default retry setting

func (*Client) SetToken

func (c *Client) SetToken(token string)

type Config

type Config struct {
	BaseUrl             *url.URL
	ServiceAccountToken string
	ServiceAccountEmail string
}

Config is the STACKIT client configuration

func (*Config) SetURL

func (c *Config) SetURL(value string) error

SetURL sets a given url string as the base url in the config if the given value is empty, the default base URL will be used

func (*Config) Validate

func (c *Config) Validate() error

Validate verifies that the given config is valid

type DataServices

type DataServices struct {
	ElasticSearch *dataservices.DataServicesService
	LogMe         *dataservices.DataServicesService
	MariaDB       *dataservices.DataServicesService
	PostgresDB    *dataservices.DataServicesService
	RabbitMQ      *dataservices.DataServicesService
	Redis         *dataservices.DataServicesService
}

type IncubatorServices

type IncubatorServices struct {
	MongoDB  *mongodb.MongoDBService
	Postgres *postgres.PostgresService
}

IncubatorServices is the struct representing all services that are under development

type ProductiveServices

type ProductiveServices struct {
	Argus              *argus.ArgusService
	Costs              *costs.CostsService
	Kubernetes         *kubernetes.KubernetesService
	Membership         *membership.MembershipService
	ObjectStorage      *objectstorage.ObjectStorageService
	ResourceManagement *resourceManagement.ResourceManagementService
	DataServices       DataServices
}

ProductiveServices is the struct representing all productive services