repo

Documentation

Overview

Package repo handles configuration of VCS repositories.

Index

• Constants
• func NewService(ctx context.Context, opts Options) *service
• type Callback
• type ConnectOptions
• type Connection
• type ConnectionType
• type DisconnectOptions
• type Options
• type Purger
  • func (p *Purger) Start(ctx context.Context) error
• type RepoService
• type Service
• type Subscriber
• type SynchroniseOptions

Constants

const PurgerLockID int64 = 179366396344335598

PurgerLockID is a unique ID guaranteeing only one purger on a cluster is running at any time.

Functions

func NewService

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

Types

type Callback

type Callback func(event cloud.VCSEvent)

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

	CloudService cloud.Service

	*sql.DB
	*pubsub.Broker
	internal.HostnameService
	VCSProviderService vcsprovider.Service
	organization.OrganizationService
}

type Purger

type Purger struct {
	DB purgerDB

	logr.Logger
	pubsub.Subscriber
	Service
}

Purge purges webhooks that are no longer in use.

func (*Purger) Start

func (p *Purger) Start(ctx context.Context) error

Start starts the purger daemon. Should be invoked in a go routine.

type RepoService

type RepoService = Service

type Service

type Service interface {
	// Connect adds a connection between a VCS repo and an OTF resource. A
	// webhook is created if one doesn't exist already.
	Connect(ctx context.Context, opts ConnectOptions) (*Connection, error)

	// Disconnect removes a connection between a VCS repo and an OTF
	// resource. If there are no more connections then its
	// webhook is removed.
	Disconnect(ctx context.Context, opts DisconnectOptions) error

	// Subscribe to incoming VCS events
	Subscribe(cb Callback)
	// contains filtered or unexported methods
}

Service manages VCS repositories

type Subscriber

type Subscriber interface {
	Subscribe(cb Callback)
}

type SynchroniseOptions

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