pluginonboarding

package
v0.1.20 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 10, 2026 License: Apache-2.0 Imports: 24 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	PlaceholderImage   = "registry.example.invalid/drydock/plugin-placeholder@sha256:0000000000000000000000000000000000000000000000000000000000000000"
	PlaceholderCommand = "TODO_REPLACE_WITH_DIRECT_EXECUTABLE"
	// PlaceholderCommandToken is the command token required by the onboarding
	// generator contract. PlaceholderCommand is kept as a shorter alias for
	// existing callers in this package.
	PlaceholderCommandToken = PlaceholderCommand

	SchemaModeline = "# yaml-language-server: $schema=https://raw.githubusercontent.com/sholdee/drydock/main/schemas/plugin-policy.schema.json"

	StatusPass = "PASS"
	StatusWarn = "WARN"
	StatusFail = "FAIL"
	StatusInfo = "INFO"
)
View Source 
const (
	IssuePolicyMissing      = "policy.missing"
	IssuePolicyUntrusted    = "policy.untrusted"
	IssuePluginsDisabled    = "plugins.disabled"
	IssueImagePlaceholder   = "image.placeholder"
	IssueImageMutable       = "image.mutable"
	IssueImageAmbiguous     = "image.ambiguous"
	IssueCommandPlaceholder = "command.placeholder"
	IssueBootstrapMissing   = "bootstrap.missing"
	IssueParamsMissingAllow = "params.missing_allow"
	IssueEnvMissingAllow    = "env.missing_allow"
)

Variables

This section is empty.

Functions

func Generate 

func Generate(report Report, opts GenerateOptions) ([]byte, error)

Types

type AnalyzeOptions 

type AnalyzeOptions struct {
	IncludeUnused        bool
	BootstrapEntrypoints []BootstrapEntrypointHint
}

type ApplicationInput 

type ApplicationInput struct {
	Application argoappv1.Application
	Paths       []string
}

type ApplicationReadiness 

type ApplicationReadiness struct {
	Namespace string           `json:"namespace" yaml:"namespace"`
	Name      string           `json:"name" yaml:"name"`
	Status    string           `json:"status" yaml:"status"`
	Issues    []ReadinessIssue `json:"issues,omitempty" yaml:"issues,omitempty"`
}

type BootstrapEntrypointHint 

type BootstrapEntrypointHint struct {
	Plugin     string
	SourcePath string
}

type DoctorOptions 

type DoctorOptions struct {
	EnablePlugins bool
	TrustedPolicy bool
	Strict        bool
}

type GenerateOptions 

type GenerateOptions struct {
	Engine                pluginpolicy.Engine
	EngineExplicit        bool
	Comments              bool
	AllowMutableImageTags bool
}

type ParameterEvidence 

type ParameterEvidence struct {
	Name string
	Type pluginpolicy.ExecParameterType
}

type PluginReadiness 

type PluginReadiness struct {
	Name   string           `json:"name" yaml:"name"`
	Status string           `json:"status" yaml:"status"`
	Issues []ReadinessIssue `json:"issues,omitempty" yaml:"issues,omitempty"`
}

type PluginReport 

type PluginReport struct {
	Name            string
	Used            bool
	Uses            []PluginUse
	CMP             *config.ConfigManagementPlugin
	Discover        *pluginpolicy.PluginDiscoverMatch
	Generate        []string
	GenerateSafe    bool
	SuggestedEngine pluginpolicy.Engine
	Parameters      []ParameterEvidence
	Env             []string
	Sidecar         SidecarMatch
}

type PluginUse 

type PluginUse struct {
	AppNamespace string `json:"appNamespace" yaml:"appNamespace"`
	AppName      string `json:"appName" yaml:"appName"`
	SourceIndex  int    `json:"sourceIndex" yaml:"sourceIndex"`
	SourcePath   string `json:"sourcePath,omitempty" yaml:"sourcePath,omitempty"`
	Explicit     bool   `json:"explicit" yaml:"explicit"`
	StaticMatch  bool   `json:"staticMatch" yaml:"staticMatch"`
}

type ReadinessIssue 

type ReadinessIssue struct {
	Code    string `json:"code" yaml:"code"`
	Status  string `json:"status" yaml:"status"`
	Message string `json:"message" yaml:"message"`
	Plugin  string `json:"plugin,omitempty" yaml:"plugin,omitempty"`
}

type ReadinessReport 

type ReadinessReport struct {
	Status          string                 `json:"status" yaml:"status"`
	Applications    []ApplicationReadiness `json:"applications" yaml:"applications"`
	Plugins         []PluginReadiness      `json:"plugins" yaml:"plugins"`
	Recommendations []ReadinessIssue       `json:"recommendations,omitempty" yaml:"recommendations,omitempty"`
}

func Readiness 

func Readiness(report Report, policy *pluginpolicy.Policy, opts DoctorOptions) ReadinessReport

type Report 

type Report struct {
	Root                  string
	Plugins               []PluginReport
	Sidecars              []SidecarCandidate
	BootstrapEntrypoints  []BootstrapEntrypointHint
	ExistingPolicyPresent bool
}

func Analyze 

func Analyze(root string, inputs []ApplicationInput, settings config.ArgoSettings, existing *pluginpolicy.Policy, opts AnalyzeOptions) (Report, error)

type SidecarCandidate 

type SidecarCandidate struct {
	Name       string
	Image      string
	Source     string
	Provenance diagnostic.Provenance
	Signals    []string
}

type SidecarConfidence 

type SidecarConfidence string
const (
	SidecarConfidenceNone       SidecarConfidence = "none"
	SidecarConfidenceStructural SidecarConfidence = "structural"
	SidecarConfidenceSingle     SidecarConfidence = "single-candidate"
	SidecarConfidenceAmbiguous  SidecarConfidence = "ambiguous"
)

type SidecarMatch 

type SidecarMatch struct {
	Confidence SidecarConfidence
	Candidate  *SidecarCandidate
	Candidates []SidecarCandidate
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.