metadata

Documentation

Overview

Package metadata includes metadata variables for logging and reporting.

Index

• type BuildFlavor
• type Info
  • func Metadata() Info
  • func (inf Info) UserAgent() string

Types

type BuildFlavor

type BuildFlavor string

BuildFlavor is the flavor of the build.

const (
	// OSSFlavor is the open-source flavor.
	OSSFlavor BuildFlavor = "oss"
	// EEFlavor is the enterprise flavor.
	EEFlavor BuildFlavor = "enterprise"
)

type Info

type Info struct {
	// Release returns the release version, generally a semver like v1.0.0.
	Release string

	// Repo returns the git repository URL.
	Repo string

	// RepoURL returns the repository URL.
	RepoURL string

	// Commit returns the SHA from the current branch HEAD.
	Commit string

	// ProjectName is the name of the project.
	ProjectName string

	// Organization is the Kong organization
	Organization string

	// Flavor is the flavor of the build.
	Flavor BuildFlavor
}

Info is a struct type that holds the metadata for the controller manager.

func Metadata

func Metadata() Info

Metadata returns the metadata for the controller manager.

func (Info) UserAgent

func (inf Info) UserAgent() string

UserAgent returns the User-Agent string to use in all HTTP requests made by KGO.