yc

package module

v0.12.3 Latest Latest Go to latest Published: Aug 21, 2024 License: Apache-2.0 Imports: 9 Imported by: 12

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ydb-platform/ydb-go-yc

Links

Open Source Insights

README ¶

ydb-go-yc

Code lines

Helpers to connect to YDB inside yandex-cloud.

Overview

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

About semantic versioning

We follow the SemVer 2.0.0. In particular, we provide backward compatibility in the MAJOR releases. New features without loss of backward compatibility appear on the MINOR release. In the minor version, the patch number starts from 0. Bug fixes and internal changes are released with the third digit (PATCH) in the version.

There are, however, some changes with the loss of backward compatibility that we consider to be MINOR:

extension or modification of internal ydb-go-yc interfaces. We understand that this will break the compatibility of custom implementations of the ydb-go-yc internal interfaces. But we believe that the internal interfaces of ydb-go-yc are implemented well enough that they do not require custom implementation. We are working to ensure that all internal interfaces have limited access only inside ydb-go-yc.
major changes to (including removal of) the public interfaces and types that have been previously exported by ydb-go-yc. We understand that these changes will break the backward compatibility of early adopters of these interfaces. However, these changes are generally coordinated with early adopters and have the concise interfacing with ydb-go-yc as a goal.

Internal interfaces outside from internal directory are marked with comment such as

// Warning: only for internal usage inside ydb-go-yc

We publish the planned breaking MAJOR changes:

via the comment Deprecated in the code indicating what should be used instead
through the file NEXT_MAJOR_RELEASE.md

Prerequisites

Requires Go 1.13 or later.

Installation

go get -u github.com/ydb-platform/ydb-go-yc

Usage

import (
    yc "github.com/ydb-platform/ydb-go-yc"
)
...
    db, err := ydb.Open(ctx, os.Getenv("YDB_CONNECTION_STRING"),
        yc.WithInternalCA(),
        yc.WithServiceAccountKeyFileCredentials("~/.ydb/sa.json"), // auth from service account key file
        // yc.WithMetadataCredentials(), // auth inside cloud (virual machine or yandex function)
    )

Documentation ¶

Overview ¶

Example (WithMetadataCredentials) ¶

package main

import (
	"context"

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

func main() {
	db, err := ydb.Open(context.TODO(), "grpc://localhost:2136/local",
		yc.WithMetadataCredentials(),
		yc.WithInternalCA(),
	)
	if err != nil {
		panic(err)
	}
	_ = db.Close(context.TODO())
}

Output:

Example (WithServiceAccountKeyFileCredentials) ¶

package main

import (
	"context"

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

func main() {
	db, err := ydb.Open(context.TODO(), "grpc://localhost:2136/local",
		yc.WithServiceAccountKeyFileCredentials("~/.ydb/sa.json"),
		yc.WithInternalCA(),
	)
	if err != nil {
		panic(err)
	}
	_ = db.Close(context.TODO())
}

Output:

Index ¶

func NewClient(opts ...ClientOption) (credentials.Credentials, error)
func NewInstanceServiceAccount(opts ...yc.InstanceServiceAccountCredentialsOption) *yc.InstanceServiceAccountCredentials
func NewInstanceServiceAccountURL(url string) *yc.InstanceServiceAccountCredentials
func WithAuthClientCredentials(opts ...ClientOption) ydb.Option
func WithInternalCA() ydb.Option
func WithMetadataCredentials(opts ...yc.InstanceServiceAccountCredentialsOption) ydb.Option
func WithMetadataCredentialsURL(url string) ydb.Option
func WithServiceAccountKeyCredentials(serviceAccountKey string, opts ...ClientOption) ydb.Option
func WithServiceAccountKeyFileCredentials(serviceAccountKeyFile string, opts ...ClientOption) ydb.Option
type ClientOption

Examples ¶

Package (WithMetadataCredentials)
Package (WithServiceAccountKeyFileCredentials)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewClient ¶ added in v0.3.0

func NewClient(opts ...ClientOption) (credentials.Credentials, error)

func NewInstanceServiceAccount ¶ added in v0.4.0

func NewInstanceServiceAccount(
	opts ...yc.InstanceServiceAccountCredentialsOption,
) *yc.InstanceServiceAccountCredentials

func NewInstanceServiceAccountURL ¶ added in v0.8.0

func NewInstanceServiceAccountURL(url string) *yc.InstanceServiceAccountCredentials

func WithAuthClientCredentials ¶ added in v0.1.1

func WithAuthClientCredentials(opts ...ClientOption) ydb.Option

func WithInternalCA ¶

func WithInternalCA() ydb.Option

WithInternalCA append internal yandex-cloud certs

func WithMetadataCredentials ¶

func WithMetadataCredentials(opts ...yc.InstanceServiceAccountCredentialsOption) ydb.Option

func WithMetadataCredentialsURL ¶ added in v0.1.0

func WithMetadataCredentialsURL(url string) ydb.Option

func WithServiceAccountKeyCredentials ¶ added in v0.10.0

func WithServiceAccountKeyCredentials(serviceAccountKey string, opts ...ClientOption) ydb.Option

func WithServiceAccountKeyFileCredentials ¶

func WithServiceAccountKeyFileCredentials(serviceAccountKeyFile string, opts ...ClientOption) ydb.Option

Types ¶

type ClientOption ¶ added in v0.2.0

type ClientOption = auth.ClientOption

func WithAudience ¶ added in v0.1.0

func WithAudience(audience string) ClientOption

WithAudience set provided audience.

func WithCertPool ¶ added in v0.1.0

func WithCertPool(certPool *x509.CertPool) ClientOption

WithCertPool set provided certPool.

func WithCertPoolFile ¶ added in v0.1.0

func WithCertPoolFile(caFile string) ClientOption

WithCertPoolFile try set root certPool from provided cert file path.

func WithDefaultEndpoint ¶ added in v0.1.0

func WithDefaultEndpoint() ClientOption

WithDefaultEndpoint set endpoint with default value.

func WithEndpoint ¶ added in v0.1.0

func WithEndpoint(endpoint string) ClientOption

WithEndpoint set provided endpoint.

func WithFallbackCredentials ¶ added in v0.7.0

func WithFallbackCredentials(fallback credentials.Credentials) ClientOption

WithFallbackCredentials makes fallback credentials if primary credentials are failed

func WithInsecureSkipVerify ¶ added in v0.1.0

func WithInsecureSkipVerify(insecure bool) ClientOption

WithInsecureSkipVerify set insecureSkipVerify to true which force client accepts any TLS certificate presented by the iam server and any host name in that certificate.

If insecureSkipVerify is set, then certPool field is not used.

This should be used only for testing purposes.

func WithIssuer ¶ added in v0.1.0

func WithIssuer(issuer string) ClientOption

WithIssuer set provided issuer.

func WithKeyID ¶ added in v0.1.0

func WithKeyID(keyID string) ClientOption

WithKeyID set provided keyID.

func WithPrivateKey ¶ added in v0.1.0

func WithPrivateKey(key *rsa.PrivateKey) ClientOption

WithPrivateKey set provided private key.

func WithPrivateKeyFile ¶ added in v0.1.0

func WithPrivateKeyFile(path string) ClientOption

WithPrivateKeyFile try set key from provided private key file path

func WithServiceFile ¶ added in v0.1.0

func WithServiceFile(path string) ClientOption

WithServiceFile try set key, keyID, issuer from provided service account file path.

Do not mix this option with WithKeyID, WithIssuer and key options (WithPrivateKey, WithPrivateKeyFile, etc).

func WithServiceKey ¶ added in v0.12.0

func WithServiceKey(json string) ClientOption

WithServiceKey try set key, keyID, issuer from provided service account key.