yc

README

ydb-go-yc-metadata

helpers to connect to YDB inside yandex-cloud using metadata service

godoc

Overview

Currently package provides helpers to connect to YDB inside yandex-cloud.

Usage

import (
	yc "github.com/ydb-platform/ydb-go-yc-metadata"
)
...
    db, err := ydb.Open(
        ctx,
	os.Getenv("YDB_CONNECTION_STRING"),
        yc.WithInternalCA(),
        yc.WithCredentials(ctx), // auth inside cloud (virtual machine or yandex function)
    )
    

Documentation

Index

• func WithCredentials(opts ...InstanceServiceAccountCredentialsOption) ydb.Option
• func WithInternalCA() ydb.Option
• type InstanceServiceAccountCredentials
  • func NewInstanceServiceAccount(opts ...InstanceServiceAccountCredentialsOption) *InstanceServiceAccountCredentials
  • func (m *InstanceServiceAccountCredentials) Stop()
  • func (m *InstanceServiceAccountCredentials) String() string
  • func (m *InstanceServiceAccountCredentials) Token(ctx context.Context) (token string, err error)
• type InstanceServiceAccountCredentialsOption
  • func WithInstanceServiceAccountCredentialsSourceInfo(sourceInfo string) InstanceServiceAccountCredentialsOption
  • func WithInstanceServiceAccountURL(url string) InstanceServiceAccountCredentialsOption
  • func WithRetryNotFound() InstanceServiceAccountCredentialsOption
  • func WithTrace(t trace.Trace) InstanceServiceAccountCredentialsOption
  • func WithURL(url string) InstanceServiceAccountCredentialsOption

Examples

• NewInstanceServiceAccount

Functions

func WithCredentials

func WithCredentials(opts ...InstanceServiceAccountCredentialsOption) ydb.Option

func WithInternalCA

func WithInternalCA() ydb.Option

Types

type InstanceServiceAccountCredentials

type InstanceServiceAccountCredentials struct {
	// contains filtered or unexported fields
}

func NewInstanceServiceAccount

func NewInstanceServiceAccount(opts ...InstanceServiceAccountCredentialsOption) *InstanceServiceAccountCredentials

NewInstanceServiceAccount makes credentials provider that uses instance metadata url to obtain token for service account attached to instance. Cancelling context will lead to credentials refresh halt. It should be used during application stop or credentials recreation.

Example

package main

import (
	"context"

	ydb "github.com/ydb-platform/ydb-go-sdk/v3"
	yc "github.com/ydb-platform/ydb-go-yc-metadata"
)

func main() {
	db, err := ydb.Open(context.TODO(), "grpc://localhost:2136/local",
		ydb.WithCredentials(
			yc.NewInstanceServiceAccount(
				yc.WithURL("http://localhost:6770/meatadata/v1/instance/service-accounts/default/token"),
			),
		),
	)
	if err != nil {
		panic(err)
	}
	_ = db.Close(context.TODO())
}

func (*InstanceServiceAccountCredentials) Stop

func (m *InstanceServiceAccountCredentials) Stop()

func (*InstanceServiceAccountCredentials) String

func (m *InstanceServiceAccountCredentials) String() string

func (*InstanceServiceAccountCredentials) Token

func (m *InstanceServiceAccountCredentials) Token(ctx context.Context) (token string, err error)

Token returns cached token if it is valid. Otherwise, will try to renew.

type InstanceServiceAccountCredentialsOption

type InstanceServiceAccountCredentialsOption interface {
	ApplyInstanceServiceAccountCredentialsOption(c *InstanceServiceAccountCredentials)
}

func WithInstanceServiceAccountCredentialsSourceInfo

func WithInstanceServiceAccountCredentialsSourceInfo(sourceInfo string) InstanceServiceAccountCredentialsOption

func WithInstanceServiceAccountURL

func WithInstanceServiceAccountURL(url string) InstanceServiceAccountCredentialsOption

func WithRetryNotFound

func WithRetryNotFound() InstanceServiceAccountCredentialsOption

func WithTrace

func WithTrace(t trace.Trace) InstanceServiceAccountCredentialsOption

func WithURL

func WithURL(url string) InstanceServiceAccountCredentialsOption