Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/selectel/mks-go
Go SDK for Managed Kubernetes Service
https://github.com/selectel/mks-go
go go-sdk kubernetes mks selectel-k8s
Last synced: 8 days ago
JSON representation
Go SDK for Managed Kubernetes Service
- Host: GitHub
- URL: https://github.com/selectel/mks-go
- Owner: selectel
- License: apache-2.0
- Created: 2020-02-10T11:17:45.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-12-04T09:48:22.000Z (about 1 month ago)
- Last Synced: 2024-12-04T10:36:36.150Z (about 1 month ago)
- Topics: go, go-sdk, kubernetes, mks, selectel-k8s
- Language: Go
- Size: 159 KB
- Stars: 7
- Watchers: 8
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# mks-go: Go SDK for Managed Kubernetes Service
[](https://pkg.go.dev/github.com/selectel/mks-go/)
[](https://goreportcard.com/report/github.com/selectel/mks-go)
[](https://coveralls.io/github/selectel/mks-go?branch=master)
Package mks-go provides Go SDK to work with the Selectel Managed Kubernetes Service.
## Documentation
The Go library documentation is available at [go.dev](https://pkg.go.dev/github.com/selectel/mks-go/).
## What this library is capable of
You can use this library to work with the following objects of the Selectel Managed Kubernetes Service:
* [cluster](https://pkg.go.dev/github.com/selectel/mks-go/pkg/v1/cluster)
* [nodegroup](https://pkg.go.dev/github.com/selectel/mks-go/pkg/v1/nodegroup)
* [node](https://pkg.go.dev/github.com/selectel/mks-go/pkg/v1/node)
* [task](https://pkg.go.dev/github.com/selectel/mks-go/pkg/v1/task)
* [kubeversion](https://pkg.go.dev/github.com/selectel/mks-go/pkg/v1/kubeversion)
* [kubeoptions](https://pkg.go.dev/github.com/selectel/mks-go/pkg/v1/kubeoptions)
## Getting started
### Installation
You can install needed `mks-go` packages via `go get` command:
```bash
go get github.com/selectel/mks-go/pkg/v1/cluster github.com/selectel/mks-go/pkg/v1/task
```
### Authentication
To work with the Selectel Managed Kubernetes Service API you first need to:
* Create a Selectel account: [registration page](https://my.selectel.ru/registration).
* Create a project in Selectel Cloud Platform [projects](https://my.selectel.ru/vpc/projects).
* Retrieve a token for your project via API or [go-selvpcclient](https://github.com/selectel/go-selvpcclient).
### Endpoints
Selectel Managed Kubernetes Service currently has the following API endpoints:
| URL | Region |
|---------------------------------|--------|
| https://ru-1.mks.selcloud.ru/v1 | ru-1 |
| https://ru-2.mks.selcloud.ru/v1 | ru-2 |
| https://ru-3.mks.selcloud.ru/v1 | ru-3 |
| https://ru-7.mks.selcloud.ru/v1 | ru-7 |
| https://ru-8.mks.selcloud.ru/v1 | ru-8 |
| https://ru-9.mks.selcloud.ru/v1 | ru-9 |
| https://uz-1.mks.selcloud.ru/v1 | uz-1 |
You can also retrieve all available API endpoints from the Identity catalog.
### Usage example
```go
package main
import (
"context"
"fmt"
"log"
v1 "github.com/selectel/mks-go/pkg/v1"
"github.com/selectel/mks-go/pkg/v1/cluster"
"github.com/selectel/mks-go/pkg/v1/kubeversion"
"github.com/selectel/mks-go/pkg/v1/nodegroup"
"github.com/selectel/mks-go/pkg/v1/task"
)
func main() {
// Token to work with Selectel Cloud project.
token := "gAAAAABeVNzu-..."
// MKS endpoint to work with.
endpoint := "https://ru-3.mks.selcloud.ru/v1"
// Initialize the MKS V1 client.
mksClient := v1.NewMKSClientV1(token, endpoint)
// Prepare empty context.
ctx := context.Background()
// Get supported Kubernetes versions.
kubeVersions, _, err := kubeversion.List(ctx, mksClient)
if err != nil {
log.Fatal(err)
}
if len(kubeVersions) == 0 {
log.Fatal("There are no available Kubernetes versions")
}
// Use the first version in list.
kubeVersion := kubeVersions[0]
// Nodegroup with nodes based on network volumes for root partition.
firstNodegroup := &nodegroup.CreateOpts{
Count: 3,
CPUs: 1,
RAMMB: 2048,
VolumeGB: 50,
VolumeType: "fast.ru-3a",
AvailabilityZone: "ru-3a",
}
// Nodegroup with nodes based on local volumes for root partition.
secondNodegroup := &nodegroup.CreateOpts{
Count: 2,
CPUs: 2,
RAMMB: 4096,
VolumeGB: 20,
LocalVolume: true,
AvailabilityZone: "ru-3a",
}
// Build final options for a new cluster.
createOpts := &cluster.CreateOpts{
Name: "test-cluster",
KubeVersion: kubeVersion.Version,
Region: "ru-3",
Nodegroups: []*nodegroup.CreateOpts{
firstNodegroup,
secondNodegroup,
},
}
// Create a cluster.
newCluster, _, err := cluster.Create(ctx, mksClient, createOpts)
if err != nil {
log.Fatal(err)
}
// Print cluster fields.
fmt.Printf("Created cluster: %+v\n", newCluster)
// Get cluster tasks.
tasks, _, err := task.List(ctx, mksClient, newCluster.ID)
if err != nil {
log.Fatal(err)
}
// Print cluster tasks.
for _, t := range tasks {
fmt.Printf("Cluster task: %+v\n", t)
}
}
```