README
¶
ids
Nominal UUID types for the resource identifiers the region API owns.
Purpose
Provides distinct named types over uuid.UUID for every resource category the
region service addresses through its public API:
| Type | Identifies |
|---|---|
RegionID |
regions |
IdentityID |
cloud identities |
NetworkID |
networks |
SecurityGroupID |
security groups |
LoadBalancerID |
load balancers |
VolumeID |
block storage volumes |
ServerID |
servers |
SSHCertificateAuthorityID |
SSH certificate authorities |
FileStorageID |
file storage |
FileStorageSnapshotID |
manual File Storage snapshot name slots |
ImageID |
images |
FlavorID |
flavors |
Each type is a distinct named type — not an alias — so the compiler prevents a
NetworkID from being passed where a ServerID is expected, and so on across
all types.
Each type implements encoding.TextUnmarshaler by delegating to uuid.UUID,
so the oapi-codegen parameter binder validates UUID format at path-parameter
binding time before any handler is reached. Non-UUID path values produce a
400 at the routing layer rather than propagating into business logic.
Scope
These types run from the router down to the provider layer — not the API layer
alone. The region service mints UUIDs for its own CRD-backed resources (Region,
Identity, Network, SecurityGroup, LoadBalancer, Volume, Server,
SSHCertificateAuthority, FileStorage, FileStorageSnapshot) and addresses provider-owned
Image/Flavor resources by their provider-assigned UUIDs. They appear on:
- the generated OpenAPI surface (path parameters and request/response body fields);
- CRD spec fields that hold region-owned UUIDs — currently the
ServerCRD'sFlavorID,Image.ID,SecurityGroups[].ID,Networks[].ID, andVolumeClassFlavorSelector.IDs, plusFileStorageSnapshot.Spec.FileStorageID. Because the types areuuid.UUID-backed ([16]byte), each declaration carries+kubebuilder:validation:Type=string(andFormat=uuid) so controller-gen emits a string schema rather than a byte array; the existingTextMarshalerhandles the etcd round-trip, so no data migration is needed; - the provider interface for image operations (
GetImage,DeleteImage, and theAvailableToOrganization/OwnedByOrganizationquery predicates). The other provider methods take whole CRD objects and so carry their typed IDs inside the object — no signature change needed.
Conversion back to a plain string happens only at genuine sinks: an external
provider SDK call (gophercloud/OpenStack), a by-name Kubernetes lookup
(GetRaw/ObjectKey), a label value, or a read-model/status field still
string-typed by design (e.g. v1 ServerNetwork.Id, ServerSecurityGroup.Id).
Resources recover their own and their owners' typed IDs fail-closed from names
and labels via accessor methods on the CRD types (Network.NetworkID(),
Server.RegionID(), *.OrganizationID()/OrganizationAndProjectID()).
Identifiers owned by other services — organizationId, projectId, userId —
use the identity service's pkg/ids
types, not these. Provider-internal identifiers exposed only through hidden APIs
(vlanId, subnetId, routerId, serverGroupId) remain plain strings — they
live in another system's namespace, not region's.
Conversion
Inward (string → typed ID): Use Parse* for untrusted or stored input
(Kubernetes labels, resource names, request body fields read back from storage);
it returns an error so a malformed value fails closed rather than panicking. The
panic-on-error MustParse* constructors live in the test-only
idstest package — not here — so they cannot be reached on a request
path; use them only with known-good literals in tests. Path parameters are
validated by the oapi-codegen binder via UnmarshalText before the handler runs.
Outward (typed ID → string): Call .String() to produce the canonical
hyphenated UUID string — only at the sinks above (external SDK calls, by-name
Kubernetes lookups, label values, string read-model fields, log messages).
VolumeID follows the same UUID v4 identity model as the other Region resource
IDs that do not have a concrete natural uniqueness key. Volume display names are
metadata, not part of the stored identity model.
Documentation
¶
Index ¶
- type FileStorageID
- func (v FileStorageID) DeepCopy() FileStorageID
- func (v FileStorageID) DeepCopyInto(out *FileStorageID)
- func (v FileStorageID) MarshalJSON() ([]byte, error)
- func (v FileStorageID) MarshalText() ([]byte, error)
- func (v FileStorageID) String() string
- func (v FileStorageID) ToUnstructured() any
- func (v *FileStorageID) UnmarshalText(b []byte) error
- type FileStorageSnapshotID
- type FlavorID
- func (v FlavorID) DeepCopy() FlavorID
- func (v FlavorID) DeepCopyInto(out *FlavorID)
- func (v FlavorID) MarshalJSON() ([]byte, error)
- func (v FlavorID) MarshalText() ([]byte, error)
- func (v FlavorID) String() string
- func (v FlavorID) ToUnstructured() any
- func (v *FlavorID) UnmarshalText(b []byte) error
- type IdentityID
- type ImageID
- type LoadBalancerID
- type NetworkID
- type RegionID
- type SSHCertificateAuthorityID
- func (v SSHCertificateAuthorityID) MarshalJSON() ([]byte, error)
- func (v SSHCertificateAuthorityID) MarshalText() ([]byte, error)
- func (v SSHCertificateAuthorityID) String() string
- func (v SSHCertificateAuthorityID) ToUnstructured() any
- func (v *SSHCertificateAuthorityID) UnmarshalText(b []byte) error
- type SecurityGroupID
- type ServerID
- type VolumeID
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type FileStorageID ¶
FileStorageID is a UUID-backed identifier for file storage. It is a distinct named type so the compiler prevents accidental interchange with any other ID type. UnmarshalText delegates to uuid.UUID, so the oapi-codegen runtime rejects non-UUID path parameter values before any handler is reached.
+kubebuilder:validation:Type=string +kubebuilder:validation:Format=uuid
func ParseFileStorageID ¶
func ParseFileStorageID(s string) (FileStorageID, error)
ParseFileStorageID parses s as a UUID into a FileStorageID, returning an error if s is not a valid UUID.
func (FileStorageID) DeepCopy ¶ added in v1.25.0
func (v FileStorageID) DeepCopy() FileStorageID
DeepCopy returns a value copy for generated CRD deep-copy code.
func (FileStorageID) DeepCopyInto ¶ added in v1.25.0
func (v FileStorageID) DeepCopyInto(out *FileStorageID)
DeepCopyInto copies the ID for generated CRD deep-copy code.
func (FileStorageID) MarshalJSON ¶ added in v1.21.1
func (v FileStorageID) MarshalJSON() ([]byte, error)
func (FileStorageID) MarshalText ¶
func (v FileStorageID) MarshalText() ([]byte, error)
func (FileStorageID) String ¶
func (v FileStorageID) String() string
func (FileStorageID) ToUnstructured ¶ added in v1.21.1
func (v FileStorageID) ToUnstructured() any
func (*FileStorageID) UnmarshalText ¶
func (v *FileStorageID) UnmarshalText(b []byte) error
type FileStorageSnapshotID ¶ added in v1.25.0
FileStorageSnapshotID identifies the immutable parent/name slot occupied by a manual File Storage snapshot.
+kubebuilder:validation:Type=string +kubebuilder:validation:Format=uuid
func ParseFileStorageSnapshotID ¶ added in v1.25.0
func ParseFileStorageSnapshotID(s string) (FileStorageSnapshotID, error)
ParseFileStorageSnapshotID parses s as a UUID into a FileStorageSnapshotID, returning an error if s is not a valid UUID.
func (FileStorageSnapshotID) MarshalJSON ¶ added in v1.25.0
func (v FileStorageSnapshotID) MarshalJSON() ([]byte, error)
func (FileStorageSnapshotID) MarshalText ¶ added in v1.25.0
func (v FileStorageSnapshotID) MarshalText() ([]byte, error)
func (FileStorageSnapshotID) String ¶ added in v1.25.0
func (v FileStorageSnapshotID) String() string
func (FileStorageSnapshotID) ToUnstructured ¶ added in v1.25.0
func (v FileStorageSnapshotID) ToUnstructured() any
func (*FileStorageSnapshotID) UnmarshalText ¶ added in v1.25.0
func (v *FileStorageSnapshotID) UnmarshalText(b []byte) error
type FlavorID ¶
FlavorID is a UUID-backed identifier for flavors. The platform addresses flavors by their provider-assigned UUID; it is a distinct named type so the compiler prevents accidental interchange with any other ID type. UnmarshalText delegates to uuid.UUID, so the oapi-codegen runtime rejects non-UUID path parameter values before any handler is reached.
+kubebuilder:validation:Type=string +kubebuilder:validation:Format=uuid
func ParseFlavorID ¶
ParseFlavorID parses s as a UUID into a FlavorID, returning an error if s is not a valid UUID.
func (FlavorID) DeepCopyInto ¶ added in v1.21.0
func (FlavorID) MarshalJSON ¶ added in v1.21.1
func (FlavorID) MarshalText ¶
func (FlavorID) ToUnstructured ¶ added in v1.21.1
func (*FlavorID) UnmarshalText ¶
type IdentityID ¶
IdentityID is a UUID-backed identifier for cloud identities. It is a distinct named type so the compiler prevents accidental interchange with any other ID type. UnmarshalText delegates to uuid.UUID, so the oapi-codegen runtime rejects non-UUID path parameter values before any handler is reached.
+kubebuilder:validation:Type=string +kubebuilder:validation:Format=uuid
func ParseIdentityID ¶
func ParseIdentityID(s string) (IdentityID, error)
ParseIdentityID parses s as a UUID into an IdentityID, returning an error if s is not a valid UUID.
func (IdentityID) MarshalJSON ¶ added in v1.21.1
func (v IdentityID) MarshalJSON() ([]byte, error)
func (IdentityID) MarshalText ¶
func (v IdentityID) MarshalText() ([]byte, error)
func (IdentityID) String ¶
func (v IdentityID) String() string
func (IdentityID) ToUnstructured ¶ added in v1.21.1
func (v IdentityID) ToUnstructured() any
func (*IdentityID) UnmarshalText ¶
func (v *IdentityID) UnmarshalText(b []byte) error
type ImageID ¶
ImageID is a UUID-backed identifier for images. The platform addresses images by their provider-assigned UUID; it is a distinct named type so the compiler prevents accidental interchange with any other ID type. UnmarshalText delegates to uuid.UUID, so the oapi-codegen runtime rejects non-UUID path parameter values before any handler is reached.
+kubebuilder:validation:Type=string +kubebuilder:validation:Format=uuid
func ParseImageID ¶
ParseImageID parses s as a UUID into an ImageID, returning an error if s is not a valid UUID.
func (*ImageID) DeepCopy ¶ added in v1.23.0
DeepCopy returns an independent copy of v, or nil if v is nil.
func (*ImageID) DeepCopyInto ¶ added in v1.23.0
DeepCopyInto exists because deepcopy-gen cannot synthesise a copy for a pointer to a named array type from another package, and fails the whole generation run when a CRD field is one. ImageID is the only ID type used as a CRD pointer field (Server's status.observed.image), so it carries pointer-copy hooks. The value is a byte array, so assignment copies it.
func (ImageID) MarshalJSON ¶ added in v1.21.1
func (ImageID) MarshalText ¶
func (ImageID) ToUnstructured ¶ added in v1.21.1
func (*ImageID) UnmarshalText ¶
type LoadBalancerID ¶
LoadBalancerID is a UUID-backed identifier for load balancers. It is a distinct named type so the compiler prevents accidental interchange with any other ID type. UnmarshalText delegates to uuid.UUID, so the oapi-codegen runtime rejects non-UUID path parameter values before any handler is reached.
+kubebuilder:validation:Type=string +kubebuilder:validation:Format=uuid
func ParseLoadBalancerID ¶
func ParseLoadBalancerID(s string) (LoadBalancerID, error)
ParseLoadBalancerID parses s as a UUID into a LoadBalancerID, returning an error if s is not a valid UUID.
func (LoadBalancerID) MarshalJSON ¶ added in v1.21.1
func (v LoadBalancerID) MarshalJSON() ([]byte, error)
func (LoadBalancerID) MarshalText ¶
func (v LoadBalancerID) MarshalText() ([]byte, error)
func (LoadBalancerID) String ¶
func (v LoadBalancerID) String() string
func (LoadBalancerID) ToUnstructured ¶ added in v1.21.1
func (v LoadBalancerID) ToUnstructured() any
func (*LoadBalancerID) UnmarshalText ¶
func (v *LoadBalancerID) UnmarshalText(b []byte) error
type NetworkID ¶
NetworkID is a UUID-backed identifier for networks. It is a distinct named type so the compiler prevents accidental interchange with any other ID type. UnmarshalText delegates to uuid.UUID, so the oapi-codegen runtime rejects non-UUID path parameter values before any handler is reached.
+kubebuilder:validation:Type=string +kubebuilder:validation:Format=uuid
func ParseNetworkID ¶
ParseNetworkID parses s as a UUID into a NetworkID, returning an error if s is not a valid UUID.
func (NetworkID) MarshalJSON ¶ added in v1.21.1
func (NetworkID) MarshalText ¶
func (NetworkID) ToUnstructured ¶ added in v1.21.1
func (*NetworkID) UnmarshalText ¶
type RegionID ¶
RegionID is a UUID-backed identifier for regions. It is a distinct named type so the compiler prevents accidental interchange with any other ID type. UnmarshalText delegates to uuid.UUID, so the oapi-codegen runtime rejects non-UUID path parameter values before any handler is reached.
+kubebuilder:validation:Type=string +kubebuilder:validation:Format=uuid
func ParseRegionID ¶
ParseRegionID parses s as a UUID into a RegionID, returning an error if s is not a valid UUID.
func (RegionID) MarshalJSON ¶ added in v1.21.1
func (RegionID) MarshalText ¶
func (RegionID) ToUnstructured ¶ added in v1.21.1
func (*RegionID) UnmarshalText ¶
type SSHCertificateAuthorityID ¶
SSHCertificateAuthorityID is a UUID-backed identifier for SSH certificate authorities. It is a distinct named type so the compiler prevents accidental interchange with any other ID type. UnmarshalText delegates to uuid.UUID, so the oapi-codegen runtime rejects non-UUID path parameter values before any handler is reached.
+kubebuilder:validation:Type=string +kubebuilder:validation:Format=uuid
func ParseSSHCertificateAuthorityID ¶
func ParseSSHCertificateAuthorityID(s string) (SSHCertificateAuthorityID, error)
ParseSSHCertificateAuthorityID parses s as a UUID into an SSHCertificateAuthorityID, returning an error if s is not a valid UUID.
func (SSHCertificateAuthorityID) MarshalJSON ¶ added in v1.21.1
func (v SSHCertificateAuthorityID) MarshalJSON() ([]byte, error)
func (SSHCertificateAuthorityID) MarshalText ¶
func (v SSHCertificateAuthorityID) MarshalText() ([]byte, error)
func (SSHCertificateAuthorityID) String ¶
func (v SSHCertificateAuthorityID) String() string
func (SSHCertificateAuthorityID) ToUnstructured ¶ added in v1.21.1
func (v SSHCertificateAuthorityID) ToUnstructured() any
func (*SSHCertificateAuthorityID) UnmarshalText ¶
func (v *SSHCertificateAuthorityID) UnmarshalText(b []byte) error
type SecurityGroupID ¶
SecurityGroupID is a UUID-backed identifier for security groups. It is a distinct named type so the compiler prevents accidental interchange with any other ID type. UnmarshalText delegates to uuid.UUID, so the oapi-codegen runtime rejects non-UUID path parameter values before any handler is reached.
+kubebuilder:validation:Type=string +kubebuilder:validation:Format=uuid
func ParseSecurityGroupID ¶
func ParseSecurityGroupID(s string) (SecurityGroupID, error)
ParseSecurityGroupID parses s as a UUID into a SecurityGroupID, returning an error if s is not a valid UUID.
func (SecurityGroupID) MarshalJSON ¶ added in v1.21.1
func (v SecurityGroupID) MarshalJSON() ([]byte, error)
func (SecurityGroupID) MarshalText ¶
func (v SecurityGroupID) MarshalText() ([]byte, error)
func (SecurityGroupID) String ¶
func (v SecurityGroupID) String() string
func (SecurityGroupID) ToUnstructured ¶ added in v1.21.1
func (v SecurityGroupID) ToUnstructured() any
func (*SecurityGroupID) UnmarshalText ¶
func (v *SecurityGroupID) UnmarshalText(b []byte) error
type ServerID ¶
ServerID is a UUID-backed identifier for servers. It is a distinct named type so the compiler prevents accidental interchange with any other ID type. UnmarshalText delegates to uuid.UUID, so the oapi-codegen runtime rejects non-UUID path parameter values before any handler is reached.
+kubebuilder:validation:Type=string +kubebuilder:validation:Format=uuid
func ParseServerID ¶
ParseServerID parses s as a UUID into a ServerID, returning an error if s is not a valid UUID.
func (ServerID) MarshalJSON ¶ added in v1.21.1
func (ServerID) MarshalText ¶
func (ServerID) ToUnstructured ¶ added in v1.21.1
func (*ServerID) UnmarshalText ¶
type VolumeID ¶ added in v1.19.0
VolumeID is a UUID-backed identifier for block storage volumes. It is a distinct named type so the compiler prevents accidental interchange with any other ID type. UnmarshalText delegates to uuid.UUID, so the oapi-codegen runtime rejects non-UUID path parameter values before any handler is reached.
+kubebuilder:validation:Type=string +kubebuilder:validation:Format=uuid
func ParseVolumeID ¶ added in v1.19.0
ParseVolumeID parses s as a UUID into a VolumeID, returning an error if s is not a valid UUID.
Source Files
Directories