The highest tagged major version is
README
¶
logicalcluster
A library for logical-cluster-aware code.
For contributions, issues, or general discussion, please see the kcp repository.
Documentation
¶
Index ¶
- Variables
- type Name
- func (n Name) Base() string
- func (n Name) Empty() bool
- func (n Name) HasPrefix(other Name) bool
- func (n Name) Join(name string) Name
- func (n Name) MarshalJSON() ([]byte, error)
- func (n Name) Parent() (Name, bool)
- func (n Name) Path() string
- func (n Name) Split() (parent Name, name string)
- func (n Name) String() string
- func (n *Name) UnmarshalJSON(data []byte) error
- type Object
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // Wildcard is the name indicating cross-workspace requests. Wildcard = New("*") )
Functions ¶
This section is empty.
Types ¶
type Name ¶
type Name struct {
// contains filtered or unexported fields
}
Name is the name of a logical cluster. A logical cluster is
- a (part of) etcd prefix to store objects in that cluster
- a (part of) a http path which serves a Kubernetes-cluster-like API with discovery, OpenAPI and the actual API groups.
- a value in metadata.clusterName in objects from cross-workspace list/watches, which is used to identify the logical cluster.
A logical cluster is a colon separated list of words. In other words, it is like a path, but with colons instead of slashes.
func (Name) MarshalJSON ¶
func (Name) Parent ¶
Parent returns the parent logical cluster name of the given logical cluster name.
func (Name) Split ¶
Split splits logical cluster immediately following the final colon, separating it into a parent logical cluster and name component. If there is no colon in path, Split returns an empty logical cluster name and name set to path.
func (*Name) UnmarshalJSON ¶
Source Files
Click to show internal directories.
Click to hide internal directories.