plugin

Documentation

Index

• Constants
• func ValidatePluginConfig(config PluginConfig) error
• type CMPServerInitConstants
• type CmdError
  • func (ce *CmdError) Error() string
• type Command
• type Discover
• type Find
• type PluginConfig
  • func ReadPluginConfig(filePath string) (*PluginConfig, error)
  • func (cfg *PluginConfig) Address() string
• type PluginConfigSpec
• type Service
  • func NewService(initConstants CMPServerInitConstants) *Service
  • func (s *Service) GenerateManifest(ctx context.Context, q *apiclient.ManifestRequest) (*apiclient.ManifestResponse, error)
  • func (s *Service) GetPluginConfig(ctx context.Context, q *apiclient.ConfigRequest) (*apiclient.ConfigResponse, error)
  • func (s *Service) MatchRepository(ctx context.Context, q *apiclient.RepositoryRequest) (*apiclient.RepositoryResponse, error)

Constants

const (
	ConfigManagementPluginKind string = "ConfigManagementPlugin"
)

Functions

func ValidatePluginConfig

func ValidatePluginConfig(config PluginConfig) error

Types

type CMPServerInitConstants

type CMPServerInitConstants struct {
	PluginConfig PluginConfig
}

type CmdError

type CmdError struct {
	Args   string
	Stderr string
	Cause  error
}

func (*CmdError) Error

func (ce *CmdError) Error() string

type Command

type Command struct {
	Command []string `json:"command,omitempty"`
	Args    []string `json:"args,omitempty"`
}

Command holds binary path and arguments list

type Discover

type Discover struct {
	Find     Find   `json:"find"`
	FileName string `json:"fileName"`
}

Discover holds find and fileName

type Find

type Find struct {
	Command
	Glob string `json:"glob"`
}

Find holds find command or glob pattern

type PluginConfig

type PluginConfig struct {
	metav1.TypeMeta `json:",inline"`
	Metadata        metav1.ObjectMeta `json:"metadata"`
	Spec            PluginConfigSpec  `json:"spec"`
}

func ReadPluginConfig

func ReadPluginConfig(filePath string) (*PluginConfig, error)

func (*PluginConfig) Address

func (cfg *PluginConfig) Address() string

type PluginConfigSpec

type PluginConfigSpec struct {
	Version          string   `json:"version"`
	Init             Command  `json:"init,omitempty"`
	Generate         Command  `json:"generate"`
	Discover         Discover `json:"discover"`
	AllowConcurrency bool     `json:"allowConcurrency"`
	LockRepo         bool     `json:"lockRepo"`
}

type Service

type Service struct {
	// contains filtered or unexported fields
}

Service implements ConfigManagementPluginService interface

func NewService

func NewService(initConstants CMPServerInitConstants) *Service

NewService returns a new instance of the ConfigManagementPluginService

func (*Service) GenerateManifest

func (s *Service) GenerateManifest(ctx context.Context, q *apiclient.ManifestRequest) (*apiclient.ManifestResponse, error)

GenerateManifest runs generate command from plugin config file and returns generated manifest files

func (*Service) GetPluginConfig

func (s *Service) GetPluginConfig(ctx context.Context, q *apiclient.ConfigRequest) (*apiclient.ConfigResponse, error)

GetPluginConfig returns plugin config

func (*Service) MatchRepository

func (s *Service) MatchRepository(ctx context.Context, q *apiclient.RepositoryRequest) (*apiclient.RepositoryResponse, error)

MatchRepository checks whether the application repository type is supported by config management plugin server