Documentation
¶
Index ¶
- type ParseOption
- type Reader
- func (r *Reader) FilterResources(filter func(rd *ResourceDefinition) bool) []*ResourceDefinition
- func (r *Reader) GetResources(apiVersion, kind string) ([]*ResourceDefinition, error)
- func (r *Reader) Len() int
- func (r *Reader) Parse(input io.Reader, opts ...ParseOption) error
- func (r *Reader) ParseBytes(input []byte, opts ...ParseOption) error
- func (r *Reader) ParseBytesWithOrigin(input []byte, origin string) error
- func (r *Reader) ParseString(input string, opts ...ParseOption) error
- func (r *Reader) Resources() []*ResourceDefinition
- type ResourceDefinition
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ParseOption ¶ added in v0.27.1
type ParseOption func(*parseOptions)
ParseOption configures optional behavior for Parse.
func WithOrigin ¶ added in v0.27.1
func WithOrigin(origin string) ParseOption
WithOrigin overrides the origin name for resources parsed from the reader.
type Reader ¶
type Reader struct {
IgnoreErrors bool
// contains filtered or unexported fields
}
Reader reads Kubernetes resource definitions from input streams.
func (*Reader) FilterResources ¶
func (r *Reader) FilterResources(filter func(rd *ResourceDefinition) bool) []*ResourceDefinition
FilterResources returns all parsed Kubernetes resource definitions that match the provided filter function.
func (*Reader) GetResources ¶
func (r *Reader) GetResources(apiVersion, kind string) ([]*ResourceDefinition, error)
GetResources returns all parsed Kubernetes resource definitions that match the provided apiVersion and kind. The matching is case-insensitive.
func (*Reader) Parse ¶
func (r *Reader) Parse(input io.Reader, opts ...ParseOption) error
Parse parses Kubernetes resource definitions from the provided input stream. They are then available via the Resources() or GetResources(apiVersion, kind) methods.
func (*Reader) ParseBytes ¶
func (r *Reader) ParseBytes(input []byte, opts ...ParseOption) error
ParseBytes parses Kubernetes resource definitions from the provided byte slice.
func (*Reader) ParseBytesWithOrigin ¶ added in v0.27.1
ParseBytesWithOrigin parses raw bytes and attributes them to the provided origin.
func (*Reader) ParseString ¶
func (r *Reader) ParseString(input string, opts ...ParseOption) error
ParseString parses Kubernetes resource definitions from the provided string.
func (*Reader) Resources ¶
func (r *Reader) Resources() []*ResourceDefinition
Resources returns all parsed Kubernetes resource definitions.
type ResourceDefinition ¶
type ResourceDefinition struct {
APIVersion string `yaml:"apiVersion"`
Kind string `yaml:"kind"`
Metadata struct {
Name string `yaml:"name"`
} `yaml:"metadata"`
Origin string `yaml:"-"`
Raw []byte `yaml:"-"`
}
ResourceDefinition represents a single Kubernetes resource definition.
func (*ResourceDefinition) Bytes ¶
func (rd *ResourceDefinition) Bytes() []byte
Bytes returns the raw resource definition.
func (*ResourceDefinition) Filename ¶
func (rd *ResourceDefinition) Filename() string
Filename returns a filename compatible name of the resource definition.
func (*ResourceDefinition) Reader ¶
func (rd *ResourceDefinition) Reader() *bytes.Reader
returns a Reader that reads the raw resource definition
func (*ResourceDefinition) Unmarshal ¶
func (rd *ResourceDefinition) Unmarshal(obj any) error
Unmarshal unmarshals the raw resource definition into the provided object.
Source Files