version

Documentation

Index

• Constants
• Variables
• func GetServerVersion(clientConn *grpc.ClientConn) (*pb.Version, error)
• func NewAPIServer(version *pb.Version, options APIServerOptions) pb.APIServer
• func PrettyPrintVersion(version *pb.Version) string
• func PrettyPrintVersionNoAdditional(version *pb.Version) string
• func PrettyVersion() string
• func String(v *pb.Version) string
• type APIServerOptions

Constants

const (
	// MajorVersion is the current major version for pachyderm.
	MajorVersion = 1
	// MinorVersion is the current minor version for pachyderm.
	MinorVersion = 8
	// MicroVersion is the patch number for pachyderm.
	MicroVersion = 2
)

Variables

var (
	// AdditionalVersion is the string provided at release time
	// The value is passed to the linker at build time
	//
	// DO NOT set the value of this variable here. For some reason, if
	// AdditionalVersion is set here, the go linker will not overwrite it.
	AdditionalVersion string

	// Version is the current version for pachyderm.
	Version = &pb.Version{
		Major:      MajorVersion,
		Minor:      MinorVersion,
		Micro:      MicroVersion,
		Additional: AdditionalVersion,
	}
)

Functions

func GetServerVersion

func GetServerVersion(clientConn *grpc.ClientConn) (*pb.Version, error)

GetServerVersion gets the server *Version given the *grpc.ClientConn.

func NewAPIServer

func NewAPIServer(version *pb.Version, options APIServerOptions) pb.APIServer

NewAPIServer creates a new APIServer for the given Version.

func PrettyPrintVersion

func PrettyPrintVersion(version *pb.Version) string

PrettyPrintVersion returns a version string optionally tagged with metadata. For example: "1.2.3", or "1.2.3rc1" if version.Additional is "rc1".

func PrettyPrintVersionNoAdditional

func PrettyPrintVersionNoAdditional(version *pb.Version) string

PrettyPrintVersionNoAdditional returns a version string without version.Additional.

func PrettyVersion

func PrettyVersion() string

PrettyVersion calls PrettyPrintVersion on Version and returns the result.

func String

func String(v *pb.Version) string

String returns a string representation of the Version.

Types

type APIServerOptions

type APIServerOptions struct {
	DisableLogging bool
}

APIServerOptions are options when creating a new APIServer.