Categorygithub.com/kcp-dev/logicalcluster/v3
modulepackage
3.0.5
Repository: https://github.com/kcp-dev/logicalcluster.git
Documentation: pkg.go.dev

# README

logicalcluster

A library for logical-cluster-aware code.

For contributions, issues, or general discussion, please see the kcp-dev/kcp repository.

# Functions

From returns the logical cluster name from the given object.
NewPath returns a new Path.
NewValidatedPath returns a Path and whether it is valid.

# Constants

AnnotationKey is the name of the annotation key used to denote an object's logical cluster.

# Variables

None represents an unset path.
TODO is a value created by automated refactoring tools that should be replaced by a real path.
Wildcard is the path indicating a requests that spans many logical clusters.

# Structs

Path represents a colon separated list of words describing a path in a logical cluster hierarchy, like a file path in a file-system.

# Interfaces

Object is a local interface representation of the Kubernetes metav1.Object, to avoid dependencies on k8s.io/apimachinery.

# Type aliases

Name holds a value that uniquely identifies a logical cluster.