README
¶
pkg/util
Intention
pkg/util is a legacy miscellaneous bucket. It does not represent one coherent abstraction. It contains a small set of cross-cutting helpers and tiny shared types that historically did not get better homes.
The main things still living here are:
GenerateResourceID()for generating Kubernetes-safe random resource IDsGenerateDeterministicResourceID()for generating Kubernetes-safe deterministic resource IDs from a UUID v5 hash of a caller-supplied namespace and invariant stringServiceDescriptorfor passing common service/controller identity metadata such as name, version, and revisionGetNATPrefix()for discovering the process's internet-facing address and expressing it as a/32so managed cluster firewall rules can allow control-plane accessK8SAPITesterandDefaultK8SAPITesterfor a narrow kubeconfig connectivity check seam used by CD-layer codeKeys()as a small map-key helper that is now effectively obsolete
Invariants And Guard Rails
- This package should stay small. New code should not treat
pkg/utilas the default home for unrelated helper functions just because they feel broadly reusable. GenerateResourceID()is the shared helper for generating random Kubernetes resource IDs that satisfy the repository's naming expectations.GenerateDeterministicResourceID()is the shared helper for deriving a stable Kubernetes resource ID from caller-supplied invariant data. The same namespace UUID and invariant string always produce the same name, enabling Kubernetes 409 conflict detection as a deduplication mechanism. Each resource type should use its own fixed namespace UUID constant to prevent cross-type collisions, and the invariant must be composed of stable, immutable fields.ServiceDescriptoris the shared identity payload used where services, controllers, or cross-service clients need a commonname/version/revisiondescription.GetNATPrefix()is a pragmatic helper for the managed-cluster access model. Its job is to discover the control plane's egress address so firewall rules can allow access back into managed clusters.K8SAPITesteris a very limited integration seam for testing whether a kubeconfig can actually reach a Kubernetes API. It is not a broad connectivity abstraction and is mainly relevant to the CD-layer reachability check path.
Caveats
- The package boundary is weak. These helpers live together mostly because of history, not because they belong to one design.
Keys()is effectively superseded bymaps.Keysand should be treated as a cleanup candidate rather than something new code should continue to spread. It can be removed once the remaining live call sites are migrated.GetNATPrefix()depends on an external internet service, memoizes the result globally, and assumes one observed egress address is the right process-wide answer. That is pragmatic operational baggage, not a cleanly modeled networking contract.K8SAPITesterand its default implementation are specific enough that they would make more architectural sense closer to the code that owns kubeconfig validation.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var (
ErrK8SConnectionError = errors.New("unable to connection the kubernetes API")
)
Functions ¶
func GenerateDeterministicResourceID ¶ added in v1.17.0
GenerateDeterministicResourceID derives a valid Kubernetes name from a UUID v5 (SHA-1) hash of idNamespace and invariant. On the first attempt the standard uuid5(idNamespace, invariant) is returned if it starts with a letter; otherwise uuid5(idNamespace, previousUUID[:]) is iteratively applied until the constraint is met. Fallbacks hash binary UUID bytes rather than strings, keeping the fallback inputs out of the invariant string space and ensuring no two distinct invariants can ever produce the same name.
func GenerateResourceID ¶ added in v0.1.71
func GenerateResourceID() string
GenerateResourceID creates a valid Kubernetes name from a UUID.
func GetNATPrefix ¶
GetNATPrefix returns the IP address of the SNAT that the control plane and by extension we, sit behind.
Types ¶
type DefaultK8SAPITester ¶
type DefaultK8SAPITester struct{}
func (*DefaultK8SAPITester) Connect ¶
func (t *DefaultK8SAPITester) Connect(ctx context.Context, config *clientcmdapi.Config) error
type K8SAPITester ¶
type K8SAPITester interface {
Connect(ctx context.Context, config *clientcmdapi.Config) error
}
type ServiceDescriptor ¶ added in v1.9.0
type ServiceDescriptor struct {
// Name is the name of the service.
Name string
// Version is the version of the service.
Version string
// Revision is the revision of the service (typically a Git SHA).
Revision string
}
ServiceDescriptor is used to define a common format for application information. This is typically used to initialize logging and IPC so we can see who instigated a request.
Source Files
Directories