connections

Documentation

Overview

Package connections manages connections between VCS repositories and OTF resources, e.g. workspaces, modules.

Index

• type ConnectOptions
• type Connection
• type ConnectionType
• type DisconnectOptions
• type Options
• type Service
  • func NewService(ctx context.Context, opts Options) *Service
  • func (s *Service) Connect(ctx context.Context, opts ConnectOptions) (*Connection, error)
  • func (s *Service) Disconnect(ctx context.Context, opts DisconnectOptions) error
• type SynchroniseOptions

Types

type ConnectOptions

type ConnectOptions struct {
	ConnectionType // OTF resource type

	VCSProviderID string // vcs provider of repo
	ResourceID    string // ID of OTF resource
	RepoPath      string
}

type Connection

type Connection struct {
	VCSProviderID string
	Repo          string
}

Connection is a connection between a VCS repo and an OTF resource.

type ConnectionType

type ConnectionType int

ConnectionType identifies the OTF resource type in a VCS connection.

const (
	WorkspaceConnection ConnectionType = iota
	ModuleConnection
)

type DisconnectOptions

type DisconnectOptions struct {
	ConnectionType // OTF resource type

	ResourceID string // ID of OTF resource
}

type Options

type Options struct {
	logr.Logger
	*sql.DB

	VCSProviderService *vcsprovider.Service
	RepoHooksService   *repohooks.Service
}

type Service

type Service struct {
	logr.Logger
	// contains filtered or unexported fields
}

func NewService

func NewService(ctx context.Context, opts Options) *Service

func (*Service) Connect

func (s *Service) Connect(ctx context.Context, opts ConnectOptions) (*Connection, error)

Connect an OTF resource to a VCS repo.

func (*Service) Disconnect

func (s *Service) Disconnect(ctx context.Context, opts DisconnectOptions) error

Disconnect resource from repo

type SynchroniseOptions

type SynchroniseOptions struct {
	VCSProviderID string // vcs provider of repo
	RepoPath      string
}