livelint

Documentation

Index

• type Apiv1EndpointsInterface
• type Apiv1EventInterface
• type Apiv1Interface
• type Apiv1NodeInterface
• type Apiv1PVCInterface
• type Apiv1PodInterface
• type Apiv1ServiceInterface
• type Appsv1Interface
• type BubbleteaUI
  • func NewBubbleTeaUI(program *tea.Program) *BubbleteaUI
  • func (s *BubbleteaUI) AddCheckResult(checkResult CheckResult)
  • func (ui *BubbleteaUI) AskYesNo(question string) bool
  • func (s *BubbleteaUI) CompleteCheck(outcome summaryMsg)
  • func (ui *BubbleteaUI) DisplayCheckCompletion(completionMsg string, kind SummaryType)
  • func (ui *BubbleteaUI) DisplayCheckResult(checkResult CheckResult)
  • func (ui *BubbleteaUI) DisplayCheckStart(checkMsg string)
  • func (ui *BubbleteaUI) DisplayContext(contextMsg string)
  • func (ui *BubbleteaUI) DisplayError(errorMsg error)
  • func (ui *BubbleteaUI) SetVerbose()
  • func (s *BubbleteaUI) StartCheck(title string)
  • func (ui *BubbleteaUI) StartSpinner()
  • func (ui *BubbleteaUI) StopSpinner()
• type CheckResult
• type DeploymentInterface
• type ForwardedPorts
• type IngressInterface
• type KubernetesInterface
• type Livelint
  • func New(k8s kubernetes.Interface, config *rest.Config, ui UserInteraction) *Livelint
  • func (n *Livelint) CheckAreResourceQuotasHit(namespace string, deploymentName string) CheckResult
  • func (n *Livelint) CheckAreThereRestartCyclingPods(pods []apiv1.Pod) CheckResult
  • func (n *Livelint) CheckCanSeeBackends(ingress netv1.Ingress, namespace string) CheckResult
  • func (n *Livelint) CheckCanSeeEndpoints(serviceName string, namespace string) CheckResult
  • func (n *Livelint) CheckCanVisitPublicApp(namespace string, services []apiv1.Service) CheckResult
  • func (n *Livelint) CheckContainerLogs(pod apiv1.Pod, containerName string) CheckResult
  • func (n *Livelint) CheckFailedMount(pod apiv1.Pod) CheckResult
  • func (n *Livelint) CheckForgottenCMDInDockerfile(c apiv1.Container) CheckResult
  • func (n *Livelint) CheckIsClusterFull(pods []apiv1.Pod) CheckResult
  • func (n *Livelint) CheckIsMountingPendingPVC(pods []apiv1.Pod, namespace string) CheckResult
  • func (n *Livelint) CheckIsNumberOfReplicasCorrect(namespace string, deploymentName string) CheckResult
  • func (n *Livelint) CheckReadinessProbe(pods []apiv1.Pod) CheckResult
  • func (n *Livelint) RunChecks(namespace, deploymentName string, verbose bool) error
• type Model
  • func InitialModel() Model
  • func (m Model) Init() tea.Cmd
  • func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m Model) View() string
• type NetworkingV1Interface
• type ReplicaSetInterface
• type SummaryType
• type UserInteraction

Types

type Apiv1EndpointsInterface

type Apiv1EndpointsInterface = apiv1.EndpointsInterface

type Apiv1EventInterface

type Apiv1EventInterface = apiv1.EventInterface

type Apiv1Interface

type Apiv1Interface = apiv1.CoreV1Interface

type Apiv1NodeInterface

type Apiv1NodeInterface = apiv1.NodeInterface

type Apiv1PVCInterface

type Apiv1PVCInterface = apiv1.PersistentVolumeClaimInterface

type Apiv1PodInterface

type Apiv1PodInterface = apiv1.PodInterface

type Apiv1ServiceInterface

type Apiv1ServiceInterface = apiv1.ServiceInterface

type Appsv1Interface

type Appsv1Interface = appsv1.AppsV1Interface

type BubbleteaUI

type BubbleteaUI struct {
	*tea.Program
	// contains filtered or unexported fields
}

func NewBubbleTeaUI

func NewBubbleTeaUI(program *tea.Program) *BubbleteaUI

func (*BubbleteaUI) AddCheckResult

func (s *BubbleteaUI) AddCheckResult(checkResult CheckResult)

func (*BubbleteaUI) AskYesNo

func (ui *BubbleteaUI) AskYesNo(question string) bool

func (*BubbleteaUI) CompleteCheck

func (s *BubbleteaUI) CompleteCheck(outcome summaryMsg)

func (*BubbleteaUI) DisplayCheckCompletion

func (ui *BubbleteaUI) DisplayCheckCompletion(completionMsg string, kind SummaryType)

func (*BubbleteaUI) DisplayCheckResult

func (ui *BubbleteaUI) DisplayCheckResult(checkResult CheckResult)

func (*BubbleteaUI) DisplayCheckStart

func (ui *BubbleteaUI) DisplayCheckStart(checkMsg string)

func (*BubbleteaUI) DisplayContext

func (ui *BubbleteaUI) DisplayContext(contextMsg string)

func (*BubbleteaUI) DisplayError

func (ui *BubbleteaUI) DisplayError(errorMsg error)

func (*BubbleteaUI) SetVerbose

func (ui *BubbleteaUI) SetVerbose()

func (*BubbleteaUI) StartCheck

func (s *BubbleteaUI) StartCheck(title string)

func (*BubbleteaUI) StartSpinner

func (ui *BubbleteaUI) StartSpinner()

func (*BubbleteaUI) StopSpinner

func (ui *BubbleteaUI) StopSpinner()

type CheckResult

type CheckResult struct {
	HasFailed    bool
	Message      string
	Details      []string
	Instructions string
}

type DeploymentInterface

type DeploymentInterface = appsv1.DeploymentInterface

type ForwardedPorts

type ForwardedPorts struct {
	HTTP       int32
	HTTPFound  bool
	HTTPS      int32
	HTTPSFound bool
}

type IngressInterface

type IngressInterface = netv1.IngressInterface

type KubernetesInterface

type KubernetesInterface = kubernetes.Interface

type Livelint

type Livelint struct {
	K8s kubernetes.Interface

	HTTP *http.Client
	// contains filtered or unexported fields
}

func New

func New(k8s kubernetes.Interface, config *rest.Config, ui UserInteraction) *Livelint

New creates a livelint application.

func (*Livelint) CheckAreResourceQuotasHit

func (n *Livelint) CheckAreResourceQuotasHit(namespace string, deploymentName string) CheckResult

func (*Livelint) CheckAreThereRestartCyclingPods

func (n *Livelint) CheckAreThereRestartCyclingPods(pods []apiv1.Pod) CheckResult

func (*Livelint) CheckCanSeeBackends

func (n *Livelint) CheckCanSeeBackends(ingress netv1.Ingress, namespace string) CheckResult

func (*Livelint) CheckCanSeeEndpoints

func (n *Livelint) CheckCanSeeEndpoints(serviceName string, namespace string) CheckResult

func (*Livelint) CheckCanVisitPublicApp

func (n *Livelint) CheckCanVisitPublicApp(namespace string, services []apiv1.Service) CheckResult

func (*Livelint) CheckContainerLogs

func (n *Livelint) CheckContainerLogs(pod apiv1.Pod, containerName string) CheckResult

func (*Livelint) CheckFailedMount

func (n *Livelint) CheckFailedMount(pod apiv1.Pod) CheckResult

func (*Livelint) CheckForgottenCMDInDockerfile

func (n *Livelint) CheckForgottenCMDInDockerfile(c apiv1.Container) CheckResult

func (*Livelint) CheckIsClusterFull

func (n *Livelint) CheckIsClusterFull(pods []apiv1.Pod) CheckResult

func (*Livelint) CheckIsMountingPendingPVC

func (n *Livelint) CheckIsMountingPendingPVC(pods []apiv1.Pod, namespace string) CheckResult

func (*Livelint) CheckIsNumberOfReplicasCorrect

func (n *Livelint) CheckIsNumberOfReplicasCorrect(namespace string, deploymentName string) CheckResult

func (*Livelint) CheckReadinessProbe

func (n *Livelint) CheckReadinessProbe(pods []apiv1.Pod) CheckResult

func (*Livelint) RunChecks

func (n *Livelint) RunChecks(namespace, deploymentName string, verbose bool) error

RunChecks checks for potential issues with a deployment.

type Model

type Model struct {
	YesNoResponse chan int
	// contains filtered or unexported fields
}

func InitialModel

func InitialModel() Model

func (Model) Init

func (m Model) Init() tea.Cmd

func (Model) Update

func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (Model) View

func (m Model) View() string

type NetworkingV1Interface

type NetworkingV1Interface = netv1.NetworkingV1Interface

type ReplicaSetInterface

type ReplicaSetInterface = appsv1.ReplicaSetInterface

type SummaryType

type SummaryType int

type UserInteraction

type UserInteraction interface {
	DisplayContext(contextMsg string)
	DisplayCheckStart(checkMsg string)
	DisplayCheckResult(checkResult CheckResult)
	DisplayCheckCompletion(completionMsg string, kind SummaryType)
	DisplayError(errorMsg error)
	AskYesNo(question string) bool
	SetVerbose()
	StartSpinner()
	StopSpinner()
}