v1

Documentation

Index

• Variables
• type Info
  • func (*Info) Descriptor() ([]byte, []int)
  • func (x *Info) GetId() string
  • func (x *Info) GetVersion() string
  • func (*Info) ProtoMessage()
  • func (x *Info) ProtoReflect() protoreflect.Message
  • func (x *Info) Reset()
  • func (x *Info) String() string
• type Note
  • func (*Note) Descriptor() ([]byte, []int)
  • func (x *Note) GetAttr() map[string]string
  • func (x *Note) GetId() string
  • func (x *Note) GetLevel() NoteLevel
  • func (x *Note) GetMsg() string
  • func (x *Note) GetSummary() string
  • func (x *Note) GetType() string
  • func (*Note) ProtoMessage()
  • func (x *Note) ProtoReflect() protoreflect.Message
  • func (x *Note) Reset()
  • func (x *Note) String() string
• type NoteLevel
  • func (NoteLevel) Descriptor() protoreflect.EnumDescriptor
  • func (x NoteLevel) Enum() *NoteLevel
  • func (NoteLevel) EnumDescriptor() ([]byte, []int)
  • func (x NoteLevel) Number() protoreflect.EnumNumber
  • func (x NoteLevel) String() string
  • func (NoteLevel) Type() protoreflect.EnumType

Variables

var (
	NoteLevel_name = map[int32]string{
		0: "UNUSED",
		1: "INFO",
		2: "WARNING",
		3: "ERROR",
	}
	NoteLevel_value = map[string]int32{
		"UNUSED":  0,
		"INFO":    1,
		"WARNING": 2,
		"ERROR":   3,
	}
)

Enum value maps for NoteLevel.

var File_api_v1_note_proto protoreflect.FileDescriptor

Types

type Info

type Info struct {

	// Name of the vetter
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Semver string of the vetter
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

Vetters use Info to provide their information

func (*Info) Descriptor

func (*Info) Descriptor() ([]byte, []int)

Deprecated: Use Info.ProtoReflect.Descriptor instead.

func (*Info) GetId

func (x *Info) GetId() string

func (*Info) GetVersion

func (x *Info) GetVersion() string

func (*Info) ProtoMessage

func (*Info) ProtoMessage()

func (*Info) ProtoReflect

func (x *Info) ProtoReflect() protoreflect.Message

func (*Info) Reset

func (x *Info) Reset()

func (*Info) String

func (x *Info) String() string

type Note

type Note struct {

	// MD5 checksum of the generated note
	//
	// Used as UUID for notes
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Type of the note
	//
	// Example "istio-component-mismatch", "missing-service-port-prefix"
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// Short description of the note
	//
	// Summary may contain python template strings "${var}" which will be
	// substituted from values in Attr map described below. Summary
	// should only refer to template variables present in Attr map.
	Summary string `protobuf:"bytes,3,opt,name=summary,proto3" json:"summary,omitempty"`
	// Long description of the note
	//
	// Similar to Summary, Msg can contain python template strings "${var}" which
	// will be substituted from values in Attr map described below. Msg
	// should only refer to template variables present in Attr map.
	Msg string `protobuf:"bytes,4,opt,name=msg,proto3" json:"msg,omitempty"`
	// Severity of the note
	Level NoteLevel `protobuf:"varint,5,opt,name=level,proto3,enum=istio.vet.v1.NoteLevel" json:"level,omitempty"`
	// Map of template variables which can be used by Summary and Msg
	Attr map[string]string `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

Vetters generate Notes after inspecting the mesh configuration

func (*Note) Descriptor

func (*Note) Descriptor() ([]byte, []int)

Deprecated: Use Note.ProtoReflect.Descriptor instead.

func (*Note) GetAttr

func (x *Note) GetAttr() map[string]string

func (*Note) GetId

func (x *Note) GetId() string

func (*Note) GetLevel

func (x *Note) GetLevel() NoteLevel

func (*Note) GetMsg

func (x *Note) GetMsg() string

func (*Note) GetSummary

func (x *Note) GetSummary() string

func (*Note) GetType

func (x *Note) GetType() string

func (*Note) ProtoMessage

func (*Note) ProtoMessage()

func (*Note) ProtoReflect

func (x *Note) ProtoReflect() protoreflect.Message

func (*Note) Reset

func (x *Note) Reset()

func (*Note) String

func (x *Note) String() string

type NoteLevel

type NoteLevel int32

NoteLevel indicates the severity level of the note

const (
	NoteLevel_UNUSED  NoteLevel = 0 // useful for skipping empty (0) value
	NoteLevel_INFO    NoteLevel = 1
	NoteLevel_WARNING NoteLevel = 2
	NoteLevel_ERROR   NoteLevel = 3
)

func (NoteLevel) Descriptor

func (NoteLevel) Descriptor() protoreflect.EnumDescriptor

func (NoteLevel) Enum

func (x NoteLevel) Enum() *NoteLevel

func (NoteLevel) EnumDescriptor

func (NoteLevel) EnumDescriptor() ([]byte, []int)

Deprecated: Use NoteLevel.Descriptor instead.

func (NoteLevel) Number

func (x NoteLevel) Number() protoreflect.EnumNumber

func (NoteLevel) String

func (x NoteLevel) String() string

func (NoteLevel) Type

func (NoteLevel) Type() protoreflect.EnumType