opensearchdashboards

Documentation

Index

• Constants
• func NewComponent() spi.Component
• type Attributes
• type IndexPatterns
• type OSDashboardsClient
  • func NewOSDashboardsClient(pas string) *OSDashboardsClient
  • func (od *OSDashboardsClient) CreateDefaultIndexPatterns(log vzlog.VerrazzanoLogger, openSearchDashboardsEndpoint string) error
• type SavedObject
• type SavedObjectType

Constants

const (
	VZSystemIndexPattern = "verrazzano-system"
	VZAppIndexPattern    = "verrazzano-application*"
	IndexPattern         = "index-pattern"

	// TimeStamp used to add timestamp as TimeFieldName in the index pattern
	TimeStampField = "@timestamp"
)

VZSystemIndexPattern for Verrazzano System default index pattern

const (
	// ComponentName is the name of the component
	ComponentName = "opensearch-dashboards"

	// ComponentNamespace is the namespace of the component
	ComponentNamespace = constants.VerrazzanoSystemNamespace
)

const ComponentJSONName = "opensearchDashboards"

ComponentJSONName is the JSON name of the OpenSearch-Dashboards component in CRD

Functions

func NewComponent

func NewComponent() spi.Component

NewComponent OpenSearch-Dashboards component function

Types

type Attributes

type Attributes struct {
	Title         string `json:"title"`
	TimeFieldName string `json:"timeFieldName,omitempty"`
}

type IndexPatterns

type IndexPatterns struct {
	Total        int           `json:"total"`
	Page         int           `json:"page"`
	SavedObjects []SavedObject `json:"saved_objects,omitempty"`
}

type OSDashboardsClient

type OSDashboardsClient struct {
	DoHTTP func(request *http.Request) (*http.Response, error)
	// contains filtered or unexported fields
}

func NewOSDashboardsClient

func NewOSDashboardsClient(pas string) *OSDashboardsClient

func (*OSDashboardsClient) CreateDefaultIndexPatterns

func (od *OSDashboardsClient) CreateDefaultIndexPatterns(log vzlog.VerrazzanoLogger, openSearchDashboardsEndpoint string) error

CreateDefaultIndexPatterns creates the defaultIndexPatterns in the OpenSearchDashboards if not existed

type SavedObject

type SavedObject struct {
	ID         string `json:"id"`
	Attributes `json:"attributes"`
}

type SavedObjectType

type SavedObjectType struct {
	Type       string `json:"type"`
	Attributes `json:"attributes"`
}

SavedObjectType specifies the OpenSearch SavedObject including index-patterns.