kibana

Documentation

Index

• Constants
• func Create(params CreateParams) (*models.ClusterCrudResponse, error)
• func Delete(params DeploymentParams) error
• func Enable(params DeploymentParams) (*models.ClusterCrudResponse, error)
• func Get(params ClusterParams) (*models.KibanaClusterInfo, error)
• func List(params ListParams) (*models.KibanaClustersInfo, error)
• func NewKibanaBody(params NewKibanaBodyParams) *models.CreateKibanaRequest
• func Reallocate(params ReallocateParams) error
• func Restart(params DeploymentParams) error
• func Resync(params DeploymentParams) error
• func Stop(params StopParams) error
• func Upgrade(params DeploymentParams) (*models.ClusterUpgradeInfo, error)
• type ClusterParams
• type CreateParams
  • func (params CreateParams) Validate() error
• type DeploymentParams
  • func (params *DeploymentParams) Validate() error
• type ListParams
  • func (params ListParams) Validate() error
• type NewKibanaBodyParams
  • func (params *NewKibanaBodyParams) Fill()
• type ReallocateParams
  • func (params ReallocateParams) Validate() error
• type StopParams
  • func (params StopParams) Validate() error

Constants

const (
	// DefaultZoneCount is the number of zones that a Kibana has by default.
	DefaultZoneCount = 1
	// DefaultMemoryPerNode is the default memory per node.
	DefaultMemoryPerNode = 1024
	// DefaultNodeCountPerZone is the default node count per zone set.
	DefaultNodeCountPerZone = 1
)

Functions

func Create

func Create(params CreateParams) (*models.ClusterCrudResponse, error)

Create enables kibana in the specified elasticsearch cluster

func Delete

func Delete(params DeploymentParams) error

Delete deletes a Kibana deployment

func Enable

func Enable(params DeploymentParams) (*models.ClusterCrudResponse, error)

Enable creates a new kibana cluster in the specified deployment

func Get

func Get(params ClusterParams) (*models.KibanaClusterInfo, error)

Get returns the kibana cluster

func List

func List(params ListParams) (*models.KibanaClustersInfo, error)

List lists all the kibana clusters matching the filters

func NewKibanaBody

func NewKibanaBody(params NewKibanaBodyParams) *models.CreateKibanaRequest

NewKibanaBody constructs a kibana body for simple cases, abstracting the structure's complexity away from the user.

func Reallocate

func Reallocate(params ReallocateParams) error

Reallocate will reallocate the Kibana cluster instances, if no Instances are specified, all of the instances will be moved.

func Restart

func Restart(params DeploymentParams) error

Restart restarts a Kibana cluster

func Resync

func Resync(params DeploymentParams) error

Resync forces indexer to immediately resynchronize the search index and cache for a given Kibana cluster.

func Stop

func Stop(params StopParams) error

Stop stops the cluster.

func Upgrade

func Upgrade(params DeploymentParams) (*models.ClusterUpgradeInfo, error)

Upgrade upgrades the kibana instance to same version as the Elasticsearch cluster.

Types

type ClusterParams

type ClusterParams struct {
	DeploymentParams

	// Optional parameters
	deputil.QueryParams
}

ClusterParams contains parameters used to fetch cluster's data

type CreateParams

type CreateParams struct {
	*models.CreateKibanaRequest
	DeploymentParams
}

CreateParams is used by the Create function

func (CreateParams) Validate

func (params CreateParams) Validate() error

Validate ensures that the parameters are usable by the consuming function.

type DeploymentParams

type DeploymentParams struct {
	API *api.API
	// ID represents the deployment ID.
	ID string
	util.TrackParams
}

DeploymentParams is the base struct meant to be embedded in other kibana pkg params

func (*DeploymentParams) Validate

func (params *DeploymentParams) Validate() error

Validate ensures that the parameters are usable by the consuming function.

type ListParams

type ListParams struct {
	*api.API
	Version string

	// Optional parameters
	deputil.QueryParams
}

ListParams contains parameters used to fetch cluster's data

func (ListParams) Validate

func (params ListParams) Validate() error

Validate is the implementation for the ecctl.Validator interface

type NewKibanaBodyParams

type NewKibanaBodyParams struct {
	ID               string
	Name             string
	ZoneCount        int32
	MemoryPerNode    int32
	NodeCountPerZone int32
}

NewKibanaBodyParams is used by NewKibanaBody.

func (*NewKibanaBodyParams) Fill

func (params *NewKibanaBodyParams) Fill()

Fill sets any unset values to its default ones.

type ReallocateParams

type ReallocateParams struct {
	DeploymentParams
	Instances []string
	Output    *output.Device
}

ReallocateParams is used by Reallocate as a config struct

func (ReallocateParams) Validate

func (params ReallocateParams) Validate() error

Validate ensures that the parameters are usable by the consuming function.

type StopParams

type StopParams struct {
	Hide bool
	DeploymentParams
}

StopParams is used by the Stop function

func (StopParams) Validate

func (params StopParams) Validate() error

Validate ensures that the parameters are usable by the consuming function.