models

Documentation

Index

• type Health
• type Kubeconfig
• type Package
• type PackageManager
• type Request
• type Response
• type SmiResult
• type Specification
• type Stats
• type Validator

Types

type Health

type Health struct {
	Version string `json:"version"`
	Status  string `json:"status"`
	Error   string `json:"error"`
}

type Kubeconfig

type Kubeconfig struct {
	APIVersion string `yaml:"apiVersion,omitempty" json:"apiVersion,omitempty"`
	Clusters   []struct {
		Cluster struct {
			CertificateAuthorityData string `yaml:"certificate-authority-data,omitempty" json:"certificate-authority-data,omitempty"`
			Server                   string `yaml:"server,omitempty" json:"server,omitempty"`
			InsecureSkipTLSVerify    *bool  `yaml:"insecure-skip-tls-verify,omitempty" json:"insecure-skip-tls-verify,omitempty"`
		} `yaml:"cluster,omitempty" json:"cluster,omitempty"`
		Name string `yaml:"name,omitempty" json:"name,omitempty"`
	} `yaml:"clusters,omitempty" json:"clusters,omitempty"`
	Contexts []struct {
		Context struct {
			Cluster   string `yaml:"cluster,omitempty" json:"cluster,omitempty"`
			Namespace string `yaml:"namespace,omitempty" json:"namespace,omitempty"`
			User      string `yaml:"user,omitempty" json:"user,omitempty"`
		} `yaml:"context,omitempty" json:"context,omitempty"`
		Name string `yaml:"name,omitempty" json:"name,omitempty"`
	} `yaml:"contexts,omitempty" json:"contexts,omitempty"`
	CurrentContext string `yaml:"current-context,omitempty" json:"current-context,omitempty"`
	Kind           string `yaml:"kind,omitempty" json:"kind,omitempty"`
	Preferences    struct {
	} `yaml:"preferences,omitempty" json:"preferences,omitempty"`
	Users []struct {
		Name string `yaml:"name,omitempty" json:"name,omitempty"`
		User struct {
			Exec struct {
				APIVersion string   `yaml:"apiVersion,omitempty" json:"apiVersion,omitempty"`
				Args       []string `yaml:"args,omitempty" json:"args,omitempty"`
				Command    string   `yaml:"command,omitempty" json:"command,omitempty"`
				Env        []struct {
					Name  string `yaml:"name,omitempty" json:"name,omitempty"`
					Value string `yaml:"value,omitempty" json:"value,omitempty"`
				} `yaml:"env,omitempty" json:"env,omitempty"`
			} `yaml:"exec,omitempty" json:"exec,omitempty"`
			AuthProvider struct {
				Config struct {
					AccessToken string    `yaml:"access-token,omitempty" json:"access-token,omitempty"`
					CmdArgs     string    `yaml:"cmd-args,omitempty" json:"cmd-args,omitempty"`
					CmdPath     string    `yaml:"cmd-path,omitempty" json:"cmd-path,omitempty"`
					Expiry      time.Time `yaml:"expiry,omitempty" json:"expiry,omitempty"`
					ExpiryKey   string    `yaml:"expiry-key,omitempty" json:"expiry-key,omitempty"`
					TokenKey    string    `yaml:"token-key,omitempty" json:"token-key,omitempty"`
				} `yaml:"config,omitempty" json:"config,omitempty"`
				Name string `yaml:"name,omitempty" json:"name,omitempty"`
			} `yaml:"auth-provider,omitempty" json:"auth-provider,omitempty"`
			ClientCertificateData string `yaml:"client-certificate-data,omitempty" json:"client-certificate-data,omitempty"`
			ClientKeyData         string `yaml:"client-key-data,omitempty" json:"client-key-data,omitempty"`
			Token                 string `yaml:"token,omitempty" json:"token,omitempty"`
		} `yaml:"user,omitempty" json:"user,omitempty"`
	} `yaml:"users,omitempty" json:"users,omitempty"`
}

type Package

type Package interface {
	GenerateComponents() ([]v1alpha1.ComponentDefinition, error)
}

An entity that is used to expose a particular system's capabilities in Meshery A Package should have all the information that we need to generate the components

type PackageManager

type PackageManager interface {
	GetPackage() (Package, error)
}

Supports pulling packages from Artifact Hub and other sources like Docker Hub. Should envelope Meshery Application importer - to be implemented

type Request

type Request struct {
	Meta string      `json:"meta,omitempty"`
	Body interface{} `json:"body,omitempty"`
}

type Response

type Response struct {
	Code string      `json:"code,omitempty"`
	Body interface{} `json:"body,omitempty"`
}

type SmiResult

type SmiResult struct {
	ID                 uuid.UUID       `json:"meshery_id,omitempty" db:"id"`
	Date               string          `json:"datetime,omitempty" dc:"datetime"`
	ServiceMesh        string          `json:"servicemesh,omitempty" db:"servicemesh"`
	ServiceMeshVersion string          `json:"servicemeshversion,omitempty" db:"servicemeshversion"`
	Capability         string          `json:"capability,omitempty" db:"capability"`
	Status             string          `json:"status,omitempty" db:"status"`
	Specifications     []Specification `json:"specifications,omitempty" db:"specifications"`
}

SmiResult - represents the results from Meshery smi conformance test run

type Specification

type Specification struct {
	Name       string `json:"name,omitempty" db:"name"`
	Version    string `json:"version,omitempty" db:"version"`
	Assertions string `json:"assertions,omitempty" db:"assertion"`
	Duration   string `json:"duration,omitempty" db:"duration"`
	Result     string `json:"result,omitempty" db:"result"`
	Reason     string `json:"reason,omitempty" db:"reason"`
}

type Stats

type Stats struct {
	Name      string    `json:"name"`
	Port      string    `json:"port"`
	Proxy     string    `json:"proxy"`
	Version   string    `json:"version"`
	StartedAt time.Time `json:"startedat"`
}

type Validator

type Validator interface {
	Validate([]byte) error
}

anything that can be validated is a Validator