profiles

Documentation

Overview

Package profiles manages collections of environment profiles and their relationships. It handles profile resolution, validation, and environment generation with inheritance support.

Index

• Variables
• type Profiles
  • func (p Profiles) Default() string
  • func (p Profiles) Defaults() (defaults []string)
  • func (p Profiles) Environment(name string, steps step.Steps) (environment.Environment, error)
  • func (p Profiles) Environments() (environments []environment.Environment, err error)
  • func (p Profiles) Exists(name string) bool
  • func (p Profiles) Get(name string) (profile.Profile, error)
  • func (p Profiles) Names() []string
  • func (p Profiles) Plan(root string, overlays ...string) (step.Steps, error)
  • func (p Profiles) Validate() error

Variables

var ErrValidation = errors.New("validation error")

ErrValidation is returned when profiles validation fails.

Types

type Profiles

type Profiles map[string]profile.Profile

Profiles is a map of profile names to their metadata.

func (Profiles) Default

func (p Profiles) Default() string

Default returns the name of the first default profile found.

func (Profiles) Defaults

func (p Profiles) Defaults() (defaults []string)

Defaults returns the names of the default profiles.

func (Profiles) Environment

func (p Profiles) Environment(name string, steps step.Steps) (environment.Environment, error)

Environment returns a fully resolved environment for a specific profile.

func (Profiles) Environments

func (p Profiles) Environments() (environments []environment.Environment, err error)

Environments returns a fully resolved list of environments for all profiles.

func (Profiles) Exists

func (p Profiles) Exists(name string) bool

Exists checks if a profile exists in the profiles.

func (Profiles) Get

func (p Profiles) Get(name string) (profile.Profile, error)

Get retrieves a profile by name. Returns an error for empty or non-existing profile names.

func (Profiles) Names

func (p Profiles) Names() []string

Names returns the names of the profiles in sorted order.

func (Profiles) Plan

func (p Profiles) Plan(root string, overlays ...string) (step.Steps, error)

Plan creates an execution plan for a profile with optional overlays.

func (Profiles) Validate

func (p Profiles) Validate() error

Validate checks that the profiles are valid.