version

Documentation

Overview

Package version provides version information for the compiled binary, and an HTTP handler to serve the version information via an HTTP request.

Index

• Variables
• func GetVersionHandler() http.Handler
• func SetMetric()
• type Info
  • func GetInfo() Info

Variables

var BuildDate string

BuildDate is the date when the binary was built

var GitCommit string

GitCommit is the commit hash when the binary was built

var Version string

Version is the version of the compiled software

Functions

func GetVersionHandler

func GetVersionHandler() http.Handler

GetVersionHandler returns an HTTP handler that returns the version info

func SetMetric

func SetMetric()

SetMetric is a one time call to expose the version info via prometheus metrics.

Types

type Info

type Info struct {
	// Version is the version of the OSM Controller.
	Version string `json:"version,omitempty"`

	// GitCommit is the git commit hash of the OSM Controller.
	GitCommit string `json:"git_commit,omitempty"`

	// BuildDate is the build date of the OSM Controller.
	BuildDate string `json:"build_date,omitempty"`
}

Info is a struct helpful for JSON serialization of the OSM Controller version information.

func GetInfo

func GetInfo() Info

GetInfo returns the version info