configs

Documentation

Index

• Variables
• func AcrImageReferences(imageName, loginServer string) (localSource, remoteImage string, err error)
• func ExportEnvironmentVariables(vars map[string]string) error
• func NormalizeAcrLocalImage(imageRef string) (localImage, repository, tag string, err error)
• func ParseBuildArgs(args []string) (map[string]string, error)
• func ParseCLIBuildArgs(args []string) (map[string]string, error)
• func ParseEcrImageRef(imageRef string) (string, string, string, string, error)
• func ParseGhcrImageRef(imageRef string) (namespace, repository, tag string, err error)
• func ParseImage(image string) (string, string, error)
• func SplitKeyValue(arg string) (key, value string, ok bool)
• func StripAcrRegistryHost(repository string) string
• type Config
  • func LoadConfig(filePath string) (*Config, error)
• type InitOptions
• type SdkrConfig
• type SelmConfig

Variables

var (
	DockerfilePath   string
	NoCache          bool
	BuildArgs        []string
	Target           string
	Platform         string
	ContextDir       string
	BuildTimeout     int
	SubscriptionID   string
	ResourceGroup    string
	RegistryName     string
	ConfirmAfterPush bool
	DeleteAfterPush  bool
	ProjectID        string
	Region           string
	Repository       string
	UseGCR           bool
)

types for SDKR

var (
	Directory       string
	File            []string
	Namespace       string
	Timeout         int // in seconds
	Atomic          bool
	Debug           bool
	Set             []string
	SetLiteral      []string
	Force           bool
	Wait            bool
	CaFile          string // --ca-file
	CertFile        string // --cert-file
	KeyFile         string // --key-file
	Password        string // --password
	RepoURL         string // --repo
	Username        string // --username
	Verify          bool   // --verify
	Version         string // --version
	HelmConfigDir   string
	Destination     string
	Untar           bool
	UntarDir        string
	Keyring         string
	Insecure        bool
	PlainHttp       bool
	PassCredentials bool
	Devel           bool
	Prov            bool
)

types for SELM

var BuildKit bool

var FileName = "smurf.yaml"

Config struct to hold the configuration for the SDKR and SELM

Functions

func AcrImageReferences

func AcrImageReferences(imageName, loginServer string) (localSource, remoteImage string, err error)

AcrImageReferences returns the local Docker source and remote ACR target for tagging.

func ExportEnvironmentVariables

func ExportEnvironmentVariables(vars map[string]string) error

ExportEnvironmentVariables sets the environment variables for the given map

func NormalizeAcrLocalImage

func NormalizeAcrLocalImage(imageRef string) (localImage, repository, tag string, err error)

NormalizeAcrLocalImage converts an image reference to the local Docker image name. Full ACR references such as "registry.azurecr.io/my-app:v1" are normalized to "my-app:v1".

func ParseBuildArgs

func ParseBuildArgs(args []string) (map[string]string, error)

ParseBuildArgs converts CLI --build-arg values into a key/value map. Each flag value can be a single key=value pair or comma-separated pairs: --build-arg NODE_ENV=production,API_URL=https://example.com Repeated flags are also supported and later values override earlier ones.

func ParseCLIBuildArgs

func ParseCLIBuildArgs(args []string) (map[string]string, error)

ParseCLIBuildArgs parses SDKR --build-arg flags and returns a user-facing error on failure.

func ParseEcrImageRef

func ParseEcrImageRef(imageRef string) (string, string, string, string, error)

ParseEcrImageRef parses an ECR image reference into its account ID, region, repository, and tag components. It returns accountID, region, repository, tag, error

func ParseGhcrImageRef

func ParseGhcrImageRef(imageRef string) (namespace, repository, tag string, err error)

ParseGhcrImageRef parses a GHCR image reference into its components

func ParseImage

func ParseImage(image string) (string, string, error)

ParseImage splits an image name into its name and tag components. If no tag is provided, "latest" is returned. used in sdkr package to parse image name and tag

func SplitKeyValue

func SplitKeyValue(arg string) (key, value string, ok bool)

SplitKeyValue splits a string into a key and value at the first occurrence of the "=" character. The second return value reports whether an "=" was found; when it is false, key holds the original string and value is empty. used in selm package to split key value pairs

func StripAcrRegistryHost

func StripAcrRegistryHost(repository string) string

StripAcrRegistryHost removes an optional ACR hostname from a repository path. For example, "myregistry.azurecr.io/my-app" becomes "my-app".

Types

type Config

type Config struct {
	Sdkr SdkrConfig `yaml:"sdkr"`
	Selm SelmConfig `yaml:"selm"`
}

Config struct to hold the configuration for the SDKR and SELM

func LoadConfig

func LoadConfig(filePath string) (*Config, error)

Config represents the structure of the configuration file

type InitOptions

type InitOptions struct {
	Dir           string
	Upgrade       bool
	UseAI         bool
	Reconfigure   bool
	MigrateState  bool
	BackendConfig []string
	Backend       bool
	ForceCopy     bool
	Get           bool
	FromModule    string
}

InitOptions represents all options for Terraform init

type SdkrConfig

type SdkrConfig struct {
	DockerPassword               string `yaml:"docker_password"`
	DockerUsername               string `yaml:"docker_username"`
	GithubUsername               string `yaml:"github_username"`
	GithubToken                  string `yaml:"github_token"`
	ProvisionAcrRegistryName     string `yaml:"provisionAcrRegistryName"`
	ProvisionAcrResourceGroup    string `yaml:"provisionAcrResourceGroup"`
	ProvisionAcrSubscriptionID   string `yaml:"provisionAcrSubscriptionID"`
	ProvisionGcrProjectID        string `yaml:"provisionGcrProjectID"`
	GoogleApplicationCredentials string `yaml:"google_application_credentials"`
	ImageName                    string `yaml:"imageName"`
	TargetImageTag               string `yaml:"targetImageTag"`
	AwsAccessKey                 string `yaml:"awsAccessKey"`
	AwsSecretKey                 string `yaml:"awsSecretKey"`
	AwsRegion                    string `yaml:"awsRegion"`
	Dockerfile                   string `yaml:"dockerfile"`
	AwsECR                       bool   `yaml:"awsECR"`
	DockerHub                    bool   `yaml:"dockerHub"`
	GHCRRepo                     bool   `yaml:"ghcrRepo"`
	GCPRepo                      bool   `yaml:"gcpRepo"`
}

types for SDKR in the config file

type SelmConfig

type SelmConfig struct {
	HelmDeploy  bool   `yaml:"deployHelm"`
	ReleaseName string `yaml:"releaseName"`
	Namespace   string `yaml:"namespace"`
	ChartName   string `yaml:"chartName"`
	FileName    string `yaml:"fileName"`
	Revision    int    `yaml:"revision"`
}

types for SELM in the config file