serviceportprefix

README

Service Port Prefix

The serviceportprefix vetter inspects the port names defined in the services in mesh and generates notes if they are missing Istio recognized port protocol prefixes.

Service port names need to be prefixed with the recognized names for Istio routing features to work correctly. If a port name doesn't begin with a recognized prefix or is unnamed, traffic on the port is treated as plain TCP or UDP depending on the port protocol.

Port names of the form <protocol>-<suffix> or <protocol> are allowed for the following protocols as of Istio 1.1.0:

• http
• http2
• https
• grpc
• mongo
• redis
• tcp
• tls
• udp

Note that tcp protocol prefix can be used to indicate that the port is for TCP protocol. Service ports with protocol type UDP are also excluded from this prefix requirement.

It is recommended to add one of the above mentioned protocol prefixes to the services mentioned in the generated notes.

Notes Generated

• Missing service port prefix

Documentation

Overview

Package serviceportprefix vets the port names of the services in the mesh and generates notes if they are missing Istio recognized port protocol prefixes.

Index

• type SvcPortPrefix
  • func NewVetter(factory vetter.ResourceListGetter) *SvcPortPrefix
  • func NewVetterFromListers(nsLister v1.NamespaceLister, svcLister v1.ServiceLister) *SvcPortPrefix
  • func (m *SvcPortPrefix) Info() *apiv1.Info
  • func (m *SvcPortPrefix) Vet() ([]*apiv1.Note, error)

Types

type SvcPortPrefix

type SvcPortPrefix struct {
	// contains filtered or unexported fields
}

SvcPortPrefix implements Vetter interface

func NewVetter

func NewVetter(factory vetter.ResourceListGetter) *SvcPortPrefix

NewVetter returns "svcPortPrefix" which implements Vetter Interface

func NewVetterFromListers

func NewVetterFromListers(nsLister v1.NamespaceLister, svcLister v1.ServiceLister) *SvcPortPrefix

func (*SvcPortPrefix) Info

func (m *SvcPortPrefix) Info() *apiv1.Info

Info returns information about the vetter

func (*SvcPortPrefix) Vet

func (m *SvcPortPrefix) Vet() ([]*apiv1.Note, error)

Vet returns the list of generated notes