describe

Documentation

Index

• func NewCommand(log *logger.FunLogger) *cli.Command
• type AWSResourcesInfo
• type ClusterInfo
• type ComponentsInfo
• type ConditionInfo
• type ContainerRuntimeInfo
• type ContainerToolkitInfo
• type ControlPlaneInfo
• type DescribeOutput
• type HAInfo
• type InstanceInfo
• type KernelInfo
• type KubernetesInfo
• type NVIDIADriverInfo
• type NodeInfo
• type ProviderInfo
• type StatusInfo
• type WorkersInfo

Functions

func NewCommand

func NewCommand(log *logger.FunLogger) *cli.Command

NewCommand constructs the describe command with the specified logger

Types

type AWSResourcesInfo

type AWSResourcesInfo struct {
	InstanceID    string `json:"instanceId,omitempty" yaml:"instanceId,omitempty"`
	InstanceType  string `json:"instanceType,omitempty" yaml:"instanceType,omitempty"`
	PublicDNS     string `json:"publicDNS,omitempty" yaml:"publicDNS,omitempty"`
	PublicIP      string `json:"publicIP,omitempty" yaml:"publicIP,omitempty"`
	PrivateIP     string `json:"privateIP,omitempty" yaml:"privateIP,omitempty"`
	VpcID         string `json:"vpcId,omitempty" yaml:"vpcId,omitempty"`
	SubnetID      string `json:"subnetId,omitempty" yaml:"subnetId,omitempty"`
	SecurityGroup string `json:"securityGroup,omitempty" yaml:"securityGroup,omitempty"`
	AMI           string `json:"ami,omitempty" yaml:"ami,omitempty"`
}

AWSResourcesInfo contains AWS-specific resource information

type ClusterInfo

type ClusterInfo struct {
	Region           string           `json:"region" yaml:"region"`
	ControlPlane     ControlPlaneInfo `json:"controlPlane" yaml:"controlPlane"`
	Workers          *WorkersInfo     `json:"workers,omitempty" yaml:"workers,omitempty"`
	HighAvailability *HAInfo          `json:"highAvailability,omitempty" yaml:"highAvailability,omitempty"`
	Phase            string           `json:"phase,omitempty" yaml:"phase,omitempty"`
	TotalNodes       int32            `json:"totalNodes,omitempty" yaml:"totalNodes,omitempty"`
	ReadyNodes       int32            `json:"readyNodes,omitempty" yaml:"readyNodes,omitempty"`
	Endpoint         string           `json:"endpoint,omitempty" yaml:"endpoint,omitempty"`
	LoadBalancerDNS  string           `json:"loadBalancerDNS,omitempty" yaml:"loadBalancerDNS,omitempty"`
	Nodes            []NodeInfo       `json:"nodes,omitempty" yaml:"nodes,omitempty"`
}

ClusterInfo contains cluster configuration

type ComponentsInfo

type ComponentsInfo struct {
	Kernel           *KernelInfo           `json:"kernel,omitempty" yaml:"kernel,omitempty"`
	NVIDIADriver     *NVIDIADriverInfo     `json:"nvidiaDriver,omitempty" yaml:"nvidiaDriver,omitempty"`
	ContainerRuntime *ContainerRuntimeInfo `json:"containerRuntime,omitempty" yaml:"containerRuntime,omitempty"`
	ContainerToolkit *ContainerToolkitInfo `json:"containerToolkit,omitempty" yaml:"containerToolkit,omitempty"`
	Kubernetes       *KubernetesInfo       `json:"kubernetes,omitempty" yaml:"kubernetes,omitempty"`
}

ComponentsInfo contains installed component information

type ConditionInfo

type ConditionInfo struct {
	Type    string `json:"type" yaml:"type"`
	Status  string `json:"status" yaml:"status"`
	Reason  string `json:"reason,omitempty" yaml:"reason,omitempty"`
	Message string `json:"message,omitempty" yaml:"message,omitempty"`
}

ConditionInfo represents a status condition

type ContainerRuntimeInfo

type ContainerRuntimeInfo struct {
	Install bool   `json:"install" yaml:"install"`
	Name    string `json:"name" yaml:"name"`
	Source  string `json:"source,omitempty" yaml:"source,omitempty"`
	Version string `json:"version,omitempty" yaml:"version,omitempty"`
	Repo    string `json:"repo,omitempty" yaml:"repo,omitempty"`
	Ref     string `json:"ref,omitempty" yaml:"ref,omitempty"`
	Commit  string `json:"commit,omitempty" yaml:"commit,omitempty"`
	Branch  string `json:"branch,omitempty" yaml:"branch,omitempty"`
}

ContainerRuntimeInfo contains container runtime configuration

type ContainerToolkitInfo

type ContainerToolkitInfo struct {
	Install   bool   `json:"install" yaml:"install"`
	Source    string `json:"source,omitempty" yaml:"source,omitempty"`
	Version   string `json:"version,omitempty" yaml:"version,omitempty"`
	EnableCDI bool   `json:"enableCDI" yaml:"enableCDI"`
	Repo      string `json:"repo,omitempty" yaml:"repo,omitempty"`
	Ref       string `json:"ref,omitempty" yaml:"ref,omitempty"`
	Commit    string `json:"commit,omitempty" yaml:"commit,omitempty"`
	Branch    string `json:"branch,omitempty" yaml:"branch,omitempty"`
}

ContainerToolkitInfo contains NVIDIA Container Toolkit configuration

type ControlPlaneInfo

type ControlPlaneInfo struct {
	Count        int32  `json:"count" yaml:"count"`
	InstanceType string `json:"instanceType" yaml:"instanceType"`
	Dedicated    bool   `json:"dedicated" yaml:"dedicated"`
}

ControlPlaneInfo contains control plane configuration

type DescribeOutput

type DescribeOutput struct {
	Instance     InstanceInfo      `json:"instance" yaml:"instance"`
	Provider     ProviderInfo      `json:"provider" yaml:"provider"`
	Cluster      *ClusterInfo      `json:"cluster,omitempty" yaml:"cluster,omitempty"`
	Components   ComponentsInfo    `json:"components" yaml:"components"`
	Status       StatusInfo        `json:"status" yaml:"status"`
	AWSResources *AWSResourcesInfo `json:"awsResources,omitempty" yaml:"awsResources,omitempty"`
}

DescribeOutput represents the full instance description for JSON/YAML output

type HAInfo

type HAInfo struct {
	Enabled          bool   `json:"enabled" yaml:"enabled"`
	EtcdTopology     string `json:"etcdTopology,omitempty" yaml:"etcdTopology,omitempty"`
	LoadBalancerType string `json:"loadBalancerType,omitempty" yaml:"loadBalancerType,omitempty"`
}

HAInfo contains high availability configuration

type InstanceInfo

type InstanceInfo struct {
	ID          string    `json:"id" yaml:"id"`
	Name        string    `json:"name" yaml:"name"`
	CreatedAt   time.Time `json:"createdAt" yaml:"createdAt"`
	Age         string    `json:"age" yaml:"age"`
	CacheFile   string    `json:"cacheFile" yaml:"cacheFile"`
	Provisioned bool      `json:"provisioned" yaml:"provisioned"`
}

InstanceInfo contains basic instance metadata

type KernelInfo

type KernelInfo struct {
	Version string `json:"version" yaml:"version"`
}

KernelInfo contains kernel configuration

type KubernetesInfo

type KubernetesInfo struct {
	Install   bool   `json:"install" yaml:"install"`
	Installer string `json:"installer,omitempty" yaml:"installer,omitempty"`
	Version   string `json:"version,omitempty" yaml:"version,omitempty"`
	Source    string `json:"source,omitempty" yaml:"source,omitempty"`
	Repo      string `json:"repo,omitempty" yaml:"repo,omitempty"`
	Ref       string `json:"ref,omitempty" yaml:"ref,omitempty"`
	Commit    string `json:"commit,omitempty" yaml:"commit,omitempty"`
	Branch    string `json:"branch,omitempty" yaml:"branch,omitempty"`
}

KubernetesInfo contains Kubernetes configuration

type NVIDIADriverInfo

type NVIDIADriverInfo struct {
	Install bool   `json:"install" yaml:"install"`
	Source  string `json:"source,omitempty" yaml:"source,omitempty"`
	Branch  string `json:"branch,omitempty" yaml:"branch,omitempty"`
	Version string `json:"version,omitempty" yaml:"version,omitempty"`
	Repo    string `json:"repo,omitempty" yaml:"repo,omitempty"`
	Ref     string `json:"ref,omitempty" yaml:"ref,omitempty"`
	Commit  string `json:"commit,omitempty" yaml:"commit,omitempty"`
}

NVIDIADriverInfo contains NVIDIA driver configuration

type NodeInfo

type NodeInfo struct {
	Name       string `json:"name" yaml:"name"`
	Role       string `json:"role" yaml:"role"`
	InstanceID string `json:"instanceId,omitempty" yaml:"instanceId,omitempty"`
	PublicIP   string `json:"publicIP,omitempty" yaml:"publicIP,omitempty"`
	PrivateIP  string `json:"privateIP,omitempty" yaml:"privateIP,omitempty"`
	Phase      string `json:"phase" yaml:"phase"`
}

NodeInfo contains individual node information

type ProviderInfo

type ProviderInfo struct {
	Type     string `json:"type" yaml:"type"`
	Region   string `json:"region,omitempty" yaml:"region,omitempty"`
	Username string `json:"username" yaml:"username"`
	KeyName  string `json:"keyName" yaml:"keyName"`
}

ProviderInfo contains provider configuration

type StatusInfo

type StatusInfo struct {
	State      string          `json:"state" yaml:"state"`
	Conditions []ConditionInfo `json:"conditions,omitempty" yaml:"conditions,omitempty"`
}

StatusInfo contains status and conditions

type WorkersInfo

type WorkersInfo struct {
	Count        int32  `json:"count" yaml:"count"`
	InstanceType string `json:"instanceType" yaml:"instanceType"`
}

WorkersInfo contains worker pool configuration