kubedump

package

v0.10.0 Latest Latest Go to latest Published: Oct 30, 2023 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/joshmeranda/kubedump

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func Discover(config *rest.Config) ([]schema.GroupVersionResource, error)
func ForEachKind(base string, fn ForEachFunc) error
func ForEachNamespace(base string, fn ForEachFunc) error
func ForEachResource(base string, fn ForEachFunc) error
type ForEachFunc
type Resource
- func NewResourceFromFile(path string) (Resource, error)
type ResourceBuilder
- func NewResourceBuilder() *ResourceBuilder
type ResourcePathBuilder

Constants ¶

This section is empty.

Variables ¶

View Source

var HelmReleaseName = "kubedump-server"

View Source

var Namespace = "kubedump"

View Source

var Port int32 = 9000

View Source

var ServiceName = HelmReleaseName

Functions ¶

func Discover ¶ added in v0.9.1

func Discover(config *rest.Config) ([]schema.GroupVersionResource, error)

func ForEachKind ¶ added in v0.10.0

func ForEachKind(base string, fn ForEachFunc) error

func ForEachNamespace ¶ added in v0.10.0

func ForEachNamespace(base string, fn ForEachFunc) error

ForEachNamespace iterates over each namespace directory and passes the ResourcePathBuilder to fn.

func ForEachResource ¶ added in v0.10.0

func ForEachResource(base string, fn ForEachFunc) error

Types ¶

type ForEachFunc ¶ added in v0.10.0

type ForEachFunc = func(ResourcePathBuilder) error

type Resource ¶ added in v0.9.1

type Resource interface {
	fmt.Stringer

	GetName() string

	GetNamespace() string

	GetLabels() map[string]string

	GetOwnershipReferences() []apimetav1.OwnerReference

	GetKind() string

	GetUID() types.UID
}

Resource is a collection of methods that can be used to describe a resource being handled by the kubedump controller.

func NewResourceFromFile ¶ added in v0.9.1

func NewResourceFromFile(path string) (Resource, error)

type ResourceBuilder ¶ added in v0.9.1

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

func NewResourceBuilder ¶ added in v0.9.1

func NewResourceBuilder() *ResourceBuilder

func (*ResourceBuilder) Build ¶ added in v0.9.1

func (builder *ResourceBuilder) Build() Resource

func (*ResourceBuilder) FromObject ¶ added in v0.9.1

func (builder *ResourceBuilder) FromObject(obj apimetav1.ObjectMeta) *ResourceBuilder

func (*ResourceBuilder) FromType ¶ added in v0.9.1

func (builder *ResourceBuilder) FromType(t apimetav1.TypeMeta) *ResourceBuilder

func (*ResourceBuilder) FromUnstructured ¶ added in v0.9.1

func (builder *ResourceBuilder) FromUnstructured(u *unstructured.Unstructured) *ResourceBuilder

func (*ResourceBuilder) WithId ¶ added in v0.9.1

func (builder *ResourceBuilder) WithId(id types.UID) *ResourceBuilder

func (*ResourceBuilder) WithKind ¶ added in v0.9.1

func (builder *ResourceBuilder) WithKind(kind string) *ResourceBuilder

func (*ResourceBuilder) WithLabels ¶ added in v0.9.1

func (builder *ResourceBuilder) WithLabels(labels map[string]string) *ResourceBuilder

func (*ResourceBuilder) WithName ¶ added in v0.9.1

func (builder *ResourceBuilder) WithName(name string) *ResourceBuilder

func (*ResourceBuilder) WithNamespace ¶ added in v0.9.1

func (builder *ResourceBuilder) WithNamespace(namespace string) *ResourceBuilder

func (*ResourceBuilder) WithOwnershipReferences ¶ added in v0.9.1

func (builder *ResourceBuilder) WithOwnershipReferences(ownerReferences []apimetav1.OwnerReference) *ResourceBuilder

type ResourcePathBuilder ¶

type ResourcePathBuilder struct {
	BasePath  string
	Namespace string

	ParentName string
	ParentKind string

	Name string
	Kind string
}

ResourcePathBuilder can be used to build the directory paths to a resource. You must build the paths to any resource files or subdirectories yourself.

func (ResourcePathBuilder) Build ¶

func (builder ResourcePathBuilder) Build() string

func (ResourcePathBuilder) BuildKind ¶ added in v0.10.0

func (builder ResourcePathBuilder) BuildKind() string

func (ResourcePathBuilder) BuildNamespace ¶ added in v0.10.0

func (builder ResourcePathBuilder) BuildNamespace() string

func (ResourcePathBuilder) BuildWithParent ¶ added in v0.10.0

func (builder ResourcePathBuilder) BuildWithParent() string

func (ResourcePathBuilder) WithBase ¶

func (builder ResourcePathBuilder) WithBase(basePath string) ResourcePathBuilder

func (ResourcePathBuilder) WithKind ¶

func (builder ResourcePathBuilder) WithKind(kind string) ResourcePathBuilder

func (ResourcePathBuilder) WithName ¶

func (builder ResourcePathBuilder) WithName(name string) ResourcePathBuilder

func (ResourcePathBuilder) WithNamespace ¶

func (builder ResourcePathBuilder) WithNamespace(namespace string) ResourcePathBuilder

func (ResourcePathBuilder) WithParentKind ¶ added in v0.10.0

func (builder ResourcePathBuilder) WithParentKind(kind string) ResourcePathBuilder

func (ResourcePathBuilder) WithParentName ¶ added in v0.10.0

func (builder ResourcePathBuilder) WithParentName(name string) ResourcePathBuilder

func (ResourcePathBuilder) WithResource ¶

func (builder ResourcePathBuilder) WithResource(resource Resource) ResourcePathBuilder

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
kubedump
codegen
controller
filter

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL