README
¶
Go SDK for Astronetes
This module contains a collection of Go utilities that could be mainly used by Astronetes developments. The main goal of this module is to provide a set of handful and reusable API's to be used when building Kubernetes operators.
History and project status
This module is still in active development and the API is still subject to breaking changes.
Most of the provided functionalities are used by the operators that belongs to the Astronetes ecosystem.
Installation
Use go get to retrieve the SDK to add it to your GOPATH workspace, or project's Go module dependencies.
go get -u github.com/astronetes/sdk-go
To update the SDK use go get -u to retrieve the latest version of the SDK.
go get -u github.com/astronetes/sdk-go
You could specify a concrete version of this module as It's shown on the below. Replace x.y.z by the desired version.
module github.com/<org>/<repository>
require (
github.com/astronetes/sdk-go vX.Y.Z
)
Overview of SDK's Packages
The SDK is composed of @TODO components,
astronetes: SDK Core, provides common shared types such as Config, Logger, and utilities to make working with API parameters easier.cloud: SDK cloud, provides API to interact with Cloud service providersk8s: Set of interfaces to interact with k8 and other belonging tools to it.
Getting started
###Pre-requisites
- Go 1.19+
- Helm command (required exclusively for testing purpose)
Examples
A rich and growing set of examples of usage of this module can be found in folder examples.
Contributing
See the contributing documentation.
Directories