detect

Documentation

Index

• Constants
• func KubernetesVersion(ctx context.Context) (platform.Version, error)
• func KubernetesVersionFromDiscovery(_ context.Context, cli discovery.ServerVersionInterface) (platform.Version, error)
• func OpenshiftVersion(ctx context.Context) (platform.Version, error)
• func OpenshiftVersionFromGetter(ctx context.Context, coGetter ClusterOperatorsGetter) (platform.Version, error)
• func Platform(ctx context.Context) (platform.Platform, error)
• func PlatformFromClients(ctx context.Context, cvLister ClusterVersionsLister, ...) (platform.Platform, error)
• func PlatformFromLister(ctx context.Context, cvLister ClusterVersionsLister) (platform.Platform, error)
• func Version(ctx context.Context, plat platform.Platform) (platform.Version, error)
• type ClusterInfo
  • func (ci ClusterInfo) String() string
  • func (ci ClusterInfo) ToJSON() string
• type ClusterOperatorsGetter
• type ClusterVersionsLister
• type ControlPlaneInfo
  • func ControlPlane(ctx context.Context) (ControlPlaneInfo, error)
  • func ControlPlaneFromLister(ctx context.Context, cli client.Client) (ControlPlaneInfo, error)
  • func (cpi ControlPlaneInfo) String() string
  • func (cpi ControlPlaneInfo) ToJSON() string
• type InfrastructuresGetter
• type PlatformInfo
  • func FindPlatform(ctx context.Context, userSupplied platform.Platform) (PlatformInfo, string, error)
• type VersionInfo
  • func FindVersion(ctx context.Context, plat platform.Platform, userSupplied platform.Version) (VersionInfo, string, error)

Constants

const (
	DetectedFromUser    string = "user-supplied"
	DetectedFromCluster string = "autodetected from cluster"
	DetectedFailure     string = "autodetection failed"
)

Functions

func KubernetesVersion

func KubernetesVersion(ctx context.Context) (platform.Version, error)

TODO: we need to wait for the client-go to be fixed to accept a context

func KubernetesVersionFromDiscovery

func KubernetesVersionFromDiscovery(_ context.Context, cli discovery.ServerVersionInterface) (platform.Version, error)

func OpenshiftVersion

func OpenshiftVersion(ctx context.Context) (platform.Version, error)

func OpenshiftVersionFromGetter

func OpenshiftVersionFromGetter(ctx context.Context, coGetter ClusterOperatorsGetter) (platform.Version, error)

func Platform

func Platform(ctx context.Context) (platform.Platform, error)

func PlatformFromClients

func PlatformFromClients(ctx context.Context, cvLister ClusterVersionsLister, infraGetter InfrastructuresGetter) (platform.Platform, error)

func PlatformFromLister

func PlatformFromLister(ctx context.Context, cvLister ClusterVersionsLister) (platform.Platform, error)

PlatformFromLister is deprecated, use PlatformFromClients instead

func Version

func Version(ctx context.Context, plat platform.Platform) (platform.Version, error)

Types

type ClusterInfo

type ClusterInfo struct {
	Platform PlatformInfo `json:"platform"`
	Version  VersionInfo  `json:"version"`
}

func (ClusterInfo) String

func (ci ClusterInfo) String() string

func (ClusterInfo) ToJSON

func (ci ClusterInfo) ToJSON() string

type ClusterOperatorsGetter

type ClusterOperatorsGetter interface {
	Get(ctx context.Context, name string, opts metav1.GetOptions) (*ocpconfigv1.ClusterOperator, error)
}

type ClusterVersionsLister

type ClusterVersionsLister interface {
	List(ctx context.Context, opts metav1.ListOptions) (*ocpconfigv1.ClusterVersionList, error)
}

type ControlPlaneInfo

type ControlPlaneInfo struct {
	NodeCount int `json:"nodeCount"`
}

func ControlPlane

func ControlPlane(ctx context.Context) (ControlPlaneInfo, error)

func ControlPlaneFromLister

func ControlPlaneFromLister(ctx context.Context, cli client.Client) (ControlPlaneInfo, error)

func (ControlPlaneInfo) String

func (cpi ControlPlaneInfo) String() string

func (ControlPlaneInfo) ToJSON

func (cpi ControlPlaneInfo) ToJSON() string

type InfrastructuresGetter

type InfrastructuresGetter interface {
	Get(ctx context.Context, name string, options metav1.GetOptions) (*ocpconfigv1.Infrastructure, error)
}

type PlatformInfo

type PlatformInfo struct {
	AutoDetected platform.Platform `json:"autoDetected"`
	UserSupplied platform.Platform `json:"userSupplied"`
	Discovered   platform.Platform `json:"discovered"`
}

func FindPlatform

func FindPlatform(ctx context.Context, userSupplied platform.Platform) (PlatformInfo, string, error)

type VersionInfo

type VersionInfo struct {
	AutoDetected platform.Version `json:"autoDetected"`
	UserSupplied platform.Version `json:"userSupplied"`
	Discovered   platform.Version `json:"discovered"`
}

func FindVersion

func FindVersion(ctx context.Context, plat platform.Platform, userSupplied platform.Version) (VersionInfo, string, error)