config

Documentation

Overview

Package config is a common, top-level folder for aggregating Istio-wide config related libraries and utilities. More details can be found here: https://docs.google.com/document/d/1atY5vDHy5sXJP7qIaFQS3ixQZvOxUciPgULH5qTPX_8/

Index

• func ApplyJSON(s Spec, js string) error
• func ApplyJSONStrict(s Spec, js string) error
• func ApplyYAML(s Spec, yml string) error
• func CanonicalGroup(group string) string
• func DeepCopy(s any) any
• func Key(grp, ver, typ, name, namespace string) string
• func LabelsInRevision(lbls map[string]string, rev string) bool
• func NamespacedName[T Namer](o T) kubetypes.NamespacedName
• func ObjectInRevision(o *Config, rev string) bool
• func PilotConfigToResource(c *Config) (*mcp.Resource, error)
• func ToJSON(s Spec) ([]byte, error)
• func ToMap(s Spec) (map[string]any, error)
• func ToPrettyJSON(s Spec) ([]byte, error)
• func ToProto(s Spec) (*anypb.Any, error)
• func ToRaw(s Spec) (json.RawMessage, error)
• type Config
  • func (c Config) DeepCopy() Config
  • func (c Config) GetCreationTimestamp() time.Time
  • func (c Config) GetName() string
  • func (c Config) GetNamespace() string
  • func (c Config) NamespacedName() kubetypes.NamespacedName
• type GroupVersionKind
  • func FromKubernetesGVK(gvk schema.GroupVersionKind) GroupVersionKind
  • func (g GroupVersionKind) CanonicalGroup() string
  • func (g GroupVersionKind) GroupVersion() string
  • func (g GroupVersionKind) Kubernetes() schema.GroupVersionKind
  • func (g GroupVersionKind) String() string
• type Meta
  • func (meta *Meta) Key() string
  • func (meta *Meta) ToObjectMeta() metav1.ObjectMeta
• type Namer
• type PatchFunc
• type Spec
• type Status

Functions

func ApplyJSON

func ApplyJSON(s Spec, js string) error

func ApplyJSONStrict

func ApplyJSONStrict(s Spec, js string) error

func ApplyYAML

func ApplyYAML(s Spec, yml string) error

func CanonicalGroup

func CanonicalGroup(group string) string

func DeepCopy

func DeepCopy(s any) any

func Key

func Key(grp, ver, typ, name, namespace string) string

Key function for the configuration objects

func LabelsInRevision

func LabelsInRevision(lbls map[string]string, rev string) bool

func NamespacedName

func NamespacedName[T Namer](o T) kubetypes.NamespacedName

func ObjectInRevision

func ObjectInRevision(o *Config, rev string) bool

func PilotConfigToResource

func PilotConfigToResource(c *Config) (*mcp.Resource, error)

Convert from model.Config, which has no associated proto, to MCP Resource proto. TODO: define a proto matching Config - to avoid useless superficial conversions.

func ToJSON

func ToJSON(s Spec) ([]byte, error)

func ToMap

func ToMap(s Spec) (map[string]any, error)

func ToPrettyJSON

func ToPrettyJSON(s Spec) ([]byte, error)

func ToProto

func ToProto(s Spec) (*anypb.Any, error)

func ToRaw

func ToRaw(s Spec) (json.RawMessage, error)

Types

type Config

type Config struct {
	Meta

	// Spec holds the configuration object as a gogo protobuf message
	Spec Spec

	// Status holds long-running status.
	Status Status
}

Config is a configuration unit consisting of the type of configuration, the key identifier that is unique per type, and the content represented as a protobuf message.

func (Config) DeepCopy

func (c Config) DeepCopy() Config

func (Config) GetCreationTimestamp

func (c Config) GetCreationTimestamp() time.Time

func (Config) GetName

func (c Config) GetName() string

func (Config) GetNamespace

func (c Config) GetNamespace() string

func (Config) NamespacedName

func (c Config) NamespacedName() kubetypes.NamespacedName

type GroupVersionKind

type GroupVersionKind struct {
	Group   string `json:"group"`
	Version string `json:"version"`
	Kind    string `json:"kind"`
}

func FromKubernetesGVK

func FromKubernetesGVK(gvk schema.GroupVersionKind) GroupVersionKind

func (GroupVersionKind) CanonicalGroup

func (g GroupVersionKind) CanonicalGroup() string

CanonicalGroup returns the group with defaulting applied. This means an empty group will be treated as "core", following Kubernetes API standards

func (GroupVersionKind) GroupVersion

func (g GroupVersionKind) GroupVersion() string

GroupVersion returns the group/version similar to what would be found in the apiVersion field of a Kubernetes resource.

func (GroupVersionKind) Kubernetes

func (g GroupVersionKind) Kubernetes() schema.GroupVersionKind

Kubernetes returns the same GVK, using the Kubernetes object type

func (GroupVersionKind) String

func (g GroupVersionKind) String() string

type Meta

type Meta struct {
	// GroupVersionKind is a short configuration name that matches the content message type
	// (e.g. "route-rule")
	GroupVersionKind GroupVersionKind `json:"type,omitempty"`

	// UID
	UID string `json:"uid,omitempty"`

	// Name is a unique immutable identifier in a namespace
	Name string `json:"name,omitempty"`

	// Namespace defines the space for names (optional for some types),
	// applications may choose to use namespaces for a variety of purposes
	// (security domains, fault domains, organizational domains)
	Namespace string `json:"namespace,omitempty"`

	// Domain defines the suffix of the fully qualified name past the namespace.
	// Domain is not a part of the unique key unlike name and namespace.
	Domain string `json:"domain,omitempty"`

	// Map of string keys and values that can be used to organize and categorize
	// (scope and select) objects.
	Labels map[string]string `json:"labels,omitempty"`

	// Annotations is an unstructured key value map stored with a resource that may be
	// set by external tools to store and retrieve arbitrary metadata. They are not
	// queryable and should be preserved when modifying objects.
	Annotations map[string]string `json:"annotations,omitempty"`

	// ResourceVersion is an opaque identifier for tracking updates to the config registry.
	// The implementation may use a change index or a commit log for the revision.
	// The config client should not make any assumptions about revisions and rely only on
	// exact equality to implement optimistic concurrency of read-write operations.
	//
	// The lifetime of an object of a particular revision depends on the underlying data store.
	// The data store may compactify old revisions in the interest of storage optimization.
	//
	// An empty revision carries a special meaning that the associated object has
	// not been stored and assigned a revision.
	ResourceVersion string `json:"resourceVersion,omitempty"`

	// CreationTimestamp records the creation time
	CreationTimestamp time.Time `json:"creationTimestamp,omitempty"`

	// OwnerReferences allows specifying in-namespace owning objects.
	OwnerReferences []metav1.OwnerReference `json:"ownerReferences,omitempty"`

	// A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
	Generation int64 `json:"generation,omitempty"`
}

Meta is metadata attached to each configuration unit. The revision is optional, and if provided, identifies the last update operation on the object.

func (*Meta) Key

func (meta *Meta) Key() string

Key is the unique identifier for a configuration object

func (*Meta) ToObjectMeta

func (meta *Meta) ToObjectMeta() metav1.ObjectMeta

type Namer

type Namer interface {
	GetName() string
	GetNamespace() string
}

type PatchFunc

type PatchFunc func(cfg Config) (Config, kubetypes.PatchType)

PatchFunc provides the cached config as a base for modification. Only diff the between the cfg parameter and the returned Config will be applied.

type Spec

type Spec any

Spec defines the spec for the config. In order to use below helper methods, this must be one of: * golang/protobuf Message * gogo/protobuf Message * Able to marshal/unmarshal using json

type Status

type Status any