connections

Documentation

Index

• Variables
• type Connection
• type ConnectionPage
• type ConnectionRegisterPayload
• type ConnectionStatus
• type ConnectionStatusInfo
• type ConnectionsStatusPage
• type GrafanaConn
• type GrafanaCred
• type PromConn
• type PromCred

Variables

var PossibleTransitionnsMap = map[string]map[ConnectionStatus][]ConnectionStatus{
	"kubernetes": {
		DISCOVERED: {},
		REGISTERED: {
			CONNECTED, IGNORED,
		},
		CONNECTED: {
			DISCONNECTED, MAINTENANCE, DELETED, NOTFOUND,
		},
		IGNORED: {
			DELETED, NOTFOUND,
		},
		MAINTENANCE: {
			REGISTERED, CONNECTED, IGNORED, NOTFOUND,
		},
		DISCONNECTED: {
			CONNECTED, DELETED,
		},
		DELETED: {},
		NOTFOUND: {
			DISCOVERED,
		},
	},
	"meshery": {
		CONNECTED: {
			DELETED,
		},
	},
}

Types

type Connection

type Connection struct {
	ID           uuid.UUID              `json:"id,omitempty" db:"id"`
	Name         string                 `json:"name,omitempty" db:"name"`
	CredentialID uuid.UUID              `json:"credential_id,omitempty" db:"credential_id"`
	Type         string                 `json:"type,omitempty" db:"type"`
	SubType      string                 `json:"sub_type,omitempty" db:"sub_type"`
	Kind         string                 `json:"kind,omitempty" db:"kind"`
	Metadata     map[string]interface{} `json:"metadata,omitempty" db:"metadata"`
	Status       ConnectionStatus       `json:"status,omitempty" db:"status"`
	UserID       *uuid.UUID             `json:"user_id,omitempty" db:"user_id"`
	CreatedAt    time.Time              `json:"created_at,omitempty" db:"created_at"`
	UpdatedAt    time.Time              `json:"updated_at,omitempty" db:"updated_at"`
	DeletedAt    sql.NullTime           `json:"deleted_at,omitempty" db:"deleted_at"`
}

swagger:response Connection

type ConnectionPage

type ConnectionPage struct {
	Connections []*Connection `json:"connections"`
	TotalCount  int           `json:"total_count"`
	Page        int           `json:"page"`
	PageSize    int           `json:"page_size"`
}

swagger:response ConnectionPage

type ConnectionRegisterPayload

type ConnectionRegisterPayload struct {
	EventType string
	// It is different from connection id, this is used to track the registration process for the connection.
	// Connection ID is generated after the registration process is completed.
	ID    uuid.UUID
	Model string
	// The concrete type depends on the type of connection and the corresponding connection definition.
	Connection struct {
		ConnMetadata interface{}
		CredMetadata interface{}
	}
}

type ConnectionStatus

type ConnectionStatus string

swagger:response ConnectionStatus

const (
	DISCOVERED   ConnectionStatus = "discovered"
	REGISTERED   ConnectionStatus = "registered"
	CONNECTED    ConnectionStatus = "connected"
	IGNORED      ConnectionStatus = "ignored"
	MAINTENANCE  ConnectionStatus = "maintenance"
	DISCONNECTED ConnectionStatus = "disconnected"
	DELETED      ConnectionStatus = "deleted"
	NOTFOUND     ConnectionStatus = "not found"
)

type ConnectionStatusInfo

type ConnectionStatusInfo struct {
	Status string `json:"status" db:"status"`
	Count  int    `json:"count" db:"count"`
}

type ConnectionsStatusPage

type ConnectionsStatusPage struct {
	ConnectionsStatus []*ConnectionStatusInfo `json:"connections_status"`
}

swagger:response ConnectionsStatusPage

type GrafanaConn

type GrafanaConn struct {
	URL  string `json:"url,omitempty"`
	Name string `json:"name,omitempty"`
}

type GrafanaCred

type GrafanaCred struct {
	Name string `json:"name,omitempty"`
	// If Basic then it should be formatted as username:password
	APIKeyOrBasicAuth string `json:"credential,omitempty"`
}

type PromConn

type PromConn struct {
	URL  string `json:"url,omitempty"`
	Name string `json:"name,omitempty"`
}

type PromCred

type PromCred struct {
	Name string `json:"name,omitempty"`
	// If Basic then it should be formatted as username:password
	APIKeyOrBasicAuth string `json:"credential,omitempty"`
}