version

package

v0.0.0-...-7635388 Latest Latest Go to latest Published: Dec 21, 2023 License: Apache-2.0 Imports: 13 Imported by: 16

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/istio/pkg

Links

Open Source Insights

Documentation ¶

Rendered for

Overview ¶

Package version provides build version information.

Index ¶

Variables
func CobraCommand() *cobra.Command
func CobraCommandWithOptions(options CobraOptions) *cobra.Command
type BuildInfo
- func NewBuildInfoFromOldString(oldOutput string) (BuildInfo, error)
type CobraOptions
type DockerBuildInfo
type GetProxyVersionFunc
type GetRemoteVersionFunc
type MeshInfo
type NodeType
type ProxyInfo
type ServerInfo
type Version

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// Info exports the build version information.
	Info       BuildInfo
	DockerInfo DockerBuildInfo
)

Functions ¶

func CobraCommand ¶

func CobraCommand() *cobra.Command

CobraCommand returns a command used to print version information.

func CobraCommandWithOptions ¶

func CobraCommandWithOptions(options CobraOptions) *cobra.Command

CobraCommandWithOptions returns a command used to print version information. It accepts an CobraOptions argument that might modify its behavior

Types ¶

type BuildInfo ¶

type BuildInfo struct {
	Version       string `json:"version"`
	GitRevision   string `json:"revision"`
	GolangVersion string `json:"golang_version"`
	BuildStatus   string `json:"status"`
	GitTag        string `json:"tag"`
}

BuildInfo describes version information about the binary build.

func NewBuildInfoFromOldString ¶

func NewBuildInfoFromOldString(oldOutput string) (BuildInfo, error)

NewBuildInfoFromOldString creates a BuildInfo struct based on the output of previous Istio components '-- version' output

func (BuildInfo) LongForm ¶

func (b BuildInfo) LongForm() string

LongForm returns a dump of the Info struct This looks like:

func (BuildInfo) RecordComponentBuildTag ¶

func (b BuildInfo) RecordComponentBuildTag(component string)

RecordComponentBuildTag sets the value for a metric that will be used to track component build tags for tracking rollouts, etc.

func (BuildInfo) String ¶

func (b BuildInfo) String() string

String produces a single-line version info

This looks like:

``` u<version>-<git revision>-<build status> ```

type CobraOptions ¶

type CobraOptions struct {
	// GetRemoteVersion is the function to be invoked to retrieve remote versions for
	// Istio components. Optional. If not set, the 'version' subcommand will not attempt
	// to connect to a remote side, and CLI flags such as '--remote' will be hidden.
	GetRemoteVersion GetRemoteVersionFunc
	GetProxyVersions GetProxyVersionFunc
}

CobraOptions holds options to be passed to `CobraCommandWithOptions`

type DockerBuildInfo ¶

type DockerBuildInfo struct {
	Hub  string
	Tag  string
	OS   string
	Arch string
}

DockerBuildInfo contains and exposes Hub: buildHub, Tag: buildVersion, OS: buildOS, and Arch: buildArch

type GetProxyVersionFunc ¶

type GetProxyVersionFunc func() (*[]ProxyInfo, error)

GetRemoteVersionFunc is the function protoype to be passed to CobraOptions so that it is called when invoking `cmd version`

type GetRemoteVersionFunc ¶

type GetRemoteVersionFunc func() (*MeshInfo, error)

GetRemoteVersionFunc is the function protoype to be passed to CobraOptions so that it is called when invoking `cmd version`

type MeshInfo ¶

type MeshInfo []ServerInfo

MeshInfo contains the versions for all Istio control plane components

type NodeType ¶

type NodeType string

NodeType decides the responsibility of the proxy serves in the mesh

const (
	// SidecarProxy type is used for sidecar proxies in the application containers
	SidecarProxy NodeType = "sidecar"

	// Gateway type is used for gateway proxies that enable ingress and egress traffic
	Gateway NodeType = "gateway"

	// Waypoint type is used for waypoint proxies
	Waypoint NodeType = "waypoint"

	// Ztunnel type is used for node proxies (ztunnel)
	Ztunnel NodeType = "ztunnel"
)

type ProxyInfo ¶

type ProxyInfo struct {
	ID           string
	IstioVersion string
	Type         NodeType
}

ProxyInfo contains the version for a single data plane component

type ServerInfo ¶

type ServerInfo struct {
	Component string
	Info      BuildInfo
}

ServerInfo contains the version for a single control plane component

type Version ¶

type Version struct {
	ClientVersion    *BuildInfo   `json:"clientVersion,omitempty" yaml:"clientVersion,omitempty"`
	MeshVersion      *MeshInfo    `json:"meshVersion,omitempty" yaml:"meshVersion,omitempty"`
	DataPlaneVersion *[]ProxyInfo `json:"dataPlaneVersion,omitempty" yaml:"dataPlaneVersion,omitempty"`
}

Version holds info for client and control plane versions

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL