plugins

README

Plugins

Cluster

Cluster is the abstraction of a particular type of cluster, and it is responsible for probing and discovering the core components of the cluster and collecting cluster-related information

• custom

Coordinator

Coordinator is responsible for coordinating the work of the other plug-ins, executing the various diagnostics, and distributing the output to the exporters

• default
• cron

Diagnostic

Diagnostic is responsible for diagnosing an aspect of the cluster, outputting diagnostic results and repair recommendations

• example
• kube-apiserver-args
• kube-controller-manager-args
• etcd-args
• scheduler-args
• master-capacity
• master-components
• node-ha
• node-iptables
• node-status
• node-sys
• hpa-ip
• affinity
• batch-check
• workload-ha
• health-check
• pdb
• requests-limits
• workload-status
• node-ha

Exporter

Exporter is responsible for formatting the output or storage

• stdout
• store

Documentation

Overview

* Tencent is pleased to support the open source community by making TKEStack * available. * * Copyright (C) 2012-2019 Tencent. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the “License”); you may not use * this file except in compliance with the License. You may obtain a copy of the * License at * * https://opensource.org/licenses/Apache-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an “AS IS” BASIS, WITHOUT * WARRANTIES OF ANY KIND, either express or implied. See the License for the * specific language governing permissions and limitations under the License.

* Tencent is pleased to support the open source community by making TKEStack * available. * * Copyright (C) 2012-2019 Tencent. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the “License”); you may not use * this file except in compliance with the License. You may obtain a copy of the * License at * * https://opensource.org/licenses/Apache-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an “AS IS” BASIS, WITHOUT * WARRANTIES OF ANY KIND, either express or implied. See the License for the * specific language governing permissions and limitations under the License.

Index

• func IsSupportedCloud(supported []string, cloud string) bool
• type MetaData
• type Progress
  • func NewProgress() *Progress
  • func (p *Progress) AddProgressUpdatedWatcher(f func(p *Progress))
  • func (p *Progress) AddStepPercent(name string, n int)
  • func (p *Progress) Clone() *Progress
  • func (p *Progress) CreateStep(name string, title string, total int)
  • func (p *Progress) Done()
  • func (p *Progress) SetCurStep(name string)
• type ProgressStep

Functions

func IsSupportedCloud

func IsSupportedCloud(supported []string, cloud string) bool

IsSupportedCloud return true if cloud type is supported

Types

type MetaData

type MetaData struct {
	// Store is the global storage
	Store store.Store
	// Translator is a translator with plugins module context
	Translator translate.Translator
	// Logger is a logger with plugins module context
	Logger logger.Logger
	// Type is the type of plugins
	Type string
	// Title is the custom name of plugins
	Name string
	// Desc is the description of this plugin,
	// Desc should be set by plugin
	Desc translate.Message
}

MetaData is the common attributes of a plugins

type Progress

type Progress struct {
	sync.Mutex
	// IsDone if true if will Step done
	IsDone bool
	// Steps shows the sub progress of every step
	Steps map[string]*ProgressStep
	// CurStep is the name of current ProgressStep in Steps
	CurStep string
	// Total is the max step value of Progress
	Total int
	// Current is finished step value of Progress
	Current int
	// Percent is the percentage of overall progress
	Percent float64
	// contains filtered or unexported fields
}

Progress show the progress of cluster Initialization

func NewProgress

func NewProgress() *Progress

NewProgress return a new Progress

func (*Progress) AddProgressUpdatedWatcher

func (p *Progress) AddProgressUpdatedWatcher(f func(p *Progress))

AddProgressUpdatedWatcher add a watcher that will be called once progress updated

func (*Progress) AddStepPercent

func (p *Progress) AddStepPercent(name string, n int)

AddPercent add current progress percent

func (*Progress) Clone

func (p *Progress) Clone() *Progress

Clone return a new Progress with the same value of origin

func (*Progress) CreateStep

func (p *Progress) CreateStep(name string, title string, total int)

CreateStep create and return an new InitialProgressStep from a InitialProgress

func (*Progress) Done

func (p *Progress) Done()

Done

func (*Progress) SetCurStep

func (p *Progress) SetCurStep(name string)

SetCurStep change current step of Progress

type ProgressStep

type ProgressStep struct {
	// Title is the short describe of this step
	Title string
	// Total is the total value of this step
	Total int
	// Percent is the percentage of overall this step
	Percent float64
	// Current is current value of this step
	Current int
}

ProgressStep is one step of Initialization