sgcloudendpoints

Documentation

Index

• func BuildImage(ctx context.Context, project, region, repo, service, configID string) (string, error)
• func BuildProtoDescriptor(ctx context.Context, inputDir, outputFile string) error
• func Deploy(ctx context.Context, opts DeployOptions) (err error)
• func DeployConfig(ctx context.Context, project string, configFiles ...string) (string, error)
• func GetServiceConfig(ctx context.Context, service, configID string) (string, error)
• func Validate(ctx context.Context, opts ValidateOptions) (err error)
• func ValidateConfig(ctx context.Context, project string, configFiles ...string) error
• type DeployOptions
• type ValidateOptions

Functions

func BuildImage

func BuildImage(ctx context.Context, project, region, repo, service, configID string) (string, error)

BuildImage builds a container image with a baked-in Cloud Endpoints service configuration.

func BuildProtoDescriptor

func BuildProtoDescriptor(ctx context.Context, inputDir, outputFile string) error

BuildProtoDescriptor builds a Cloud Endpoints-compatible proto descriptor from the provided Buf module input dir.

func Deploy

func Deploy(ctx context.Context, opts DeployOptions) (err error)

func DeployConfig

func DeployConfig(ctx context.Context, project string, configFiles ...string) (string, error)

DeployConfig deploys the provided config files to Cloud Endpoints and returns the resulting config revision.

func GetServiceConfig

func GetServiceConfig(ctx context.Context, service, configID string) (string, error)

GetServiceConfig fetches a full service config from Cloud Endpoints.

func Validate

func Validate(ctx context.Context, opts ValidateOptions) (err error)

Validate a Cloud Endpoints deployment from a Buf proto module and an endpoints config.

func ValidateConfig

func ValidateConfig(ctx context.Context, project string, configFiles ...string) error

ValidateConfig validates the provided config files with Cloud Endpoints.

Types

type DeployOptions

type DeployOptions struct {
	// ProjectID is the ID of the GCP project to deploy to.
	ProjectID string
	// Region is the GCP region to deploy to.
	Region string
	// ArtifactRegistry is the name of the artifact registry to push the deployed image to.
	ArtifactRegistry string
	// BufModulePath is the path to the Buf module to deploy.
	BufModulePath string
	// EndpointsConfigPath is the path to the endpoints config to deploy.
	EndpointsConfigPath string
	// ServiceConfigPath is the path to the Knative YAML service config to deploy.
	//
	// The service config will be executed as a Go template, where the following variables are available:
	//
	//  - Image: The container image to deploy
	ServiceConfigPath string
}

type ValidateOptions

type ValidateOptions struct {
	// ProjectID is the ID of the GCP project to validate in.
	ProjectID string
	// BufModulePath is the path to the Buf module to validate.
	BufModulePath string
	// EndpointsConfigPath is the path to the endpoints config to validate.
	EndpointsConfigPath string
}