module

Documentation

Overview

Package module is reponsible for registry modules

Index

• Constants
• Variables
• type CreateModuleVersionOptions
• type CreateOptions
• type GetModuleOptions
• type ListModulesOptions
• type Module
  • func (m *Module) AvailableVersions() (avail []ModuleVersion)
  • func (m *Module) Latest() *ModuleVersion
  • func (m *Module) LogValue() slog.Value
  • func (m *Module) Version(v string) *ModuleVersion
• type ModuleList
• type ModuleStatus
• type ModuleVersion
  • func (v *ModuleVersion) LogValue() slog.Value
• type ModuleVersionStatus
• type Options
• type PublishOptions
• type PublishVersionOptions
• type Repo
  • func (r Repo) Split() (name, provider string, err error)
• type Service
  • func NewService(opts Options) *Service
  • func (s *Service) AddHandlers(r *mux.Router)
  • func (s *Service) CreateModule(ctx context.Context, opts CreateOptions) (*Module, error)
  • func (s *Service) CreateVersion(ctx context.Context, opts CreateModuleVersionOptions) (*ModuleVersion, error)
  • func (s *Service) DeleteModule(ctx context.Context, id resource.ID) (*Module, error)
  • func (s *Service) GetModule(ctx context.Context, opts GetModuleOptions) (*Module, error)
  • func (s *Service) GetModuleByConnection(ctx context.Context, vcsProviderID resource.ID, repoPath string) (*Module, error)
  • func (s *Service) GetModuleByID(ctx context.Context, id resource.ID) (*Module, error)
  • func (s *Service) GetModuleInfo(ctx context.Context, versionID resource.ID) (*TerraformModule, error)
  • func (s *Service) ListModules(ctx context.Context, opts ListModulesOptions) ([]*Module, error)
  • func (s *Service) PublishModule(ctx context.Context, opts PublishOptions) (*Module, error)
  • func (s *Service) PublishVersion(ctx context.Context, opts PublishVersionOptions) error
• type TerraformModule
• type UpdateModuleVersionStatusOptions

Constants

const (
	ModuleStatusPending       ModuleStatus = "pending"
	ModuleStatusNoVersionTags ModuleStatus = "no_version_tags"
	ModuleStatusSetupFailed   ModuleStatus = "setup_failed"
	ModuleStatusSetupComplete ModuleStatus = "setup_complete"

	ModuleVersionStatusPending             ModuleVersionStatus = "pending"
	ModuleVersionStatusCloning             ModuleVersionStatus = "cloning"
	ModuleVersionStatusCloneFailed         ModuleVersionStatus = "clone_failed"
	ModuleVersionStatusRegIngressReqFailed ModuleVersionStatus = "reg_ingress_req_failed"
	ModuleVersionStatusRegIngressing       ModuleVersionStatus = "reg_ingressing"
	ModuleVersionStatusRegIngressFailed    ModuleVersionStatus = "reg_ingress_failed"
	ModuleVersionStatusOK                  ModuleVersionStatus = "ok"
)

Variables

var ErrInvalidModuleRepo = errors.New("invalid repository name for module")

Types

type CreateModuleVersionOptions

type CreateModuleVersionOptions struct {
	ModuleID resource.ID
	Version  string
}

type CreateOptions

type CreateOptions struct {
	Name         string
	Provider     string
	Organization string
}

type GetModuleOptions

type GetModuleOptions struct {
	Name         string `schema:"name,required"`
	Provider     string `schema:"provider,required"`
	Organization string `schema:"organization,required"`
}

type ListModulesOptions

type ListModulesOptions struct {
	Organization string `schema:"organization_name,required"` // filter by organization name
}

type Module

type Module struct {
	ID           resource.ID
	CreatedAt    time.Time
	UpdatedAt    time.Time
	Name         string
	Provider     string
	Organization string // Module belongs to an organization
	Status       ModuleStatus
	Versions     []ModuleVersion         // versions sorted in descending order
	Connection   *connections.Connection // optional vcs repo connection
}

func (*Module) AvailableVersions

func (m *Module) AvailableVersions() (avail []ModuleVersion)

func (*Module) Latest

func (m *Module) Latest() *ModuleVersion

Latest retrieves the latest version, which is the greatest version with an ok status. If there is no such version, nil is returned.

func (*Module) LogValue

func (m *Module) LogValue() slog.Value

func (*Module) Version

func (m *Module) Version(v string) *ModuleVersion

type ModuleList

type ModuleList struct {
	*resource.Pagination
	Items []*Module
}

type ModuleStatus

type ModuleStatus string

type ModuleVersion

type ModuleVersion struct {
	ID          resource.ID
	ModuleID    resource.ID
	Version     string
	CreatedAt   time.Time
	UpdatedAt   time.Time
	Status      ModuleVersionStatus
	StatusError string
}

func (*ModuleVersion) LogValue

func (v *ModuleVersion) LogValue() slog.Value

type ModuleVersionStatus

type ModuleVersionStatus string

type Options

type Options struct {
	logr.Logger

	*sql.DB
	*internal.HostnameService
	*surl.Signer
	html.Renderer

	Authorizer         *authz.Authorizer
	RepohookService    *repohooks.Service
	VCSProviderService *vcsprovider.Service
	ConnectionsService *connections.Service
	VCSEventSubscriber vcs.Subscriber
}

type PublishOptions

type PublishOptions struct {
	Repo          Repo
	VCSProviderID resource.ID
}

type PublishVersionOptions

type PublishVersionOptions struct {
	ModuleID resource.ID
	Version  string
	Ref      string
	Repo     Repo
	Client   vcs.Client
}

type Repo

type Repo string

Repo is the path of repository for a module. It is expected to follow a certain format, which varies according to the cloud providing the Repo, but it should always end with '/<identifier>-<name>-<provider>', with name and provider being used to set the name and provider of the module.

func (Repo) Split

func (r Repo) Split() (name, provider string, err error)

type Service

type Service struct {
	logr.Logger

	*authz.Authorizer
	// contains filtered or unexported fields
}

func NewService

func NewService(opts Options) *Service

func (*Service) AddHandlers

func (s *Service) AddHandlers(r *mux.Router)

func (*Service) CreateModule

func (s *Service) CreateModule(ctx context.Context, opts CreateOptions) (*Module, error)

func (*Service) CreateVersion

func (s *Service) CreateVersion(ctx context.Context, opts CreateModuleVersionOptions) (*ModuleVersion, error)

func (*Service) DeleteModule

func (s *Service) DeleteModule(ctx context.Context, id resource.ID) (*Module, error)

func (*Service) GetModule

func (s *Service) GetModule(ctx context.Context, opts GetModuleOptions) (*Module, error)

func (*Service) GetModuleByConnection

func (s *Service) GetModuleByConnection(ctx context.Context, vcsProviderID resource.ID, repoPath string) (*Module, error)

func (*Service) GetModuleByID

func (s *Service) GetModuleByID(ctx context.Context, id resource.ID) (*Module, error)

func (*Service) GetModuleInfo

func (s *Service) GetModuleInfo(ctx context.Context, versionID resource.ID) (*TerraformModule, error)

func (*Service) ListModules

func (s *Service) ListModules(ctx context.Context, opts ListModulesOptions) ([]*Module, error)

func (*Service) PublishModule

func (s *Service) PublishModule(ctx context.Context, opts PublishOptions) (*Module, error)

PublishModule publishes a new module from a VCS repository, enumerating through its git tags and releasing a module version for each tag.

func (*Service) PublishVersion

func (s *Service) PublishVersion(ctx context.Context, opts PublishVersionOptions) error

PublishVersion publishes a module version, retrieving its contents from a repository and uploading it to the module store.

type TerraformModule

type TerraformModule struct {
	*tfconfig.Module
	// contains filtered or unexported fields
}

TerraformModule is a module of terraform configuration

type UpdateModuleVersionStatusOptions

type UpdateModuleVersionStatusOptions struct {
	ID     resource.ID
	Status ModuleVersionStatus
	Error  string
}