Repository navigation
Expand file tree
/
Copy pathendpoint_search.go
More file actions
141 lines (125 loc) · 5.62 KB
/
Copy pathendpoint_search.go
File metadata and controls
141 lines (125 loc) · 5.62 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
package gophercloud
import (
"context"
"slices"
)
// Availability indicates to whom a specific service endpoint is accessible:
// the internet at large, internal networks only, or only to administrators.
// Different identity services use different terminology for these. Identity v2
// lists them as different kinds of URLs within the service catalog ("adminURL",
// "internalURL", and "publicURL"), while v3 lists them as "Interfaces" in an
// endpoint's response.
type Availability string
const (
// AvailabilityAdmin indicates that an endpoint is only available to
// administrators.
AvailabilityAdmin Availability = "admin"
// AvailabilityPublic indicates that an endpoint is available to everyone on
// the internet.
AvailabilityPublic Availability = "public"
// AvailabilityInternal indicates that an endpoint is only available within
// the cluster's internal network.
AvailabilityInternal Availability = "internal"
)
// ServiceTypeAliases contains a mapping of service types to any aliases, as
// defined by the OpenStack Service Types Authority. Only service types that
// we support are included.
var ServiceTypeAliases = map[string][]string{
"application-container": {"container"},
"baremetal": {"bare-metal"},
"baremetal-introspection": {},
"block-storage": {"block-store", "volume", "volumev2", "volumev3"},
"compute": {},
"container-infrastructure-management": {"container-infrastructure", "container-infra"},
"database": {},
"dns": {},
"identity": {},
"image": {},
"key-manager": {},
"load-balancer": {},
"message": {"messaging"},
"networking": {},
"object-store": {},
"orchestration": {},
"placement": {},
"shared-file-system": {"sharev2", "share"},
"workflow": {"workflowv2"},
}
// EndpointOpts specifies search criteria used by queries against an
// OpenStack service catalog. The options must contain enough information to
// unambiguously identify one, and only one, endpoint within the catalog.
//
// Usually, these are passed to service client factory functions in a provider
// package, like "openstack.NewComputeV2()".
type EndpointOpts struct {
// Type [required] is the service type for the client (e.g., "compute",
// "object-store"), as defined by the OpenStack Service Types Authority.
// This will generally be supplied by the service client function, but a
// user-given value will be honored if provided.
Type string
// Name [optional] is the service name for the client (e.g., "nova") as it
// appears in the service catalog. Services can have the same Type but a
// different Name, which is why both Type and Name are sometimes needed.
Name string
// Aliases [optional] is the set of aliases of the service type (e.g.
// "volumev2"/"volumev3", "volume" and "block-store" for the
// "block-storage" service type), as defined by the OpenStack Service Types
// Authority. As with Type, this will generally be supplied by the service
// client function, but a user-given value will be honored if provided.
Aliases []string
// Region [required] is the geographic region in which the endpoint resides,
// generally specifying which datacenter should house your resources.
// Required only for services that span multiple regions.
Region string
// Version [optional] is the major version of the service required. It it not
// a microversion. Use this to ensure the correct endpoint is selected when
// multiple API versions are available.
Version int
// Availability [optional] is the visibility of the endpoint to be returned.
// Valid types include the constants AvailabilityPublic, AvailabilityInternal,
// or AvailabilityAdmin from this package.
//
// Availability is not required, and defaults to AvailabilityPublic. Not all
// providers or services offer all Availability options.
Availability Availability
}
/*
EndpointLocator is an internal function to be used by provider implementations.
It provides an implementation that locates a single endpoint from a service
catalog for a specific ProviderClient based on user-provided EndpointOpts. The
provider then uses it to discover related ServiceClients.
*/
type EndpointLocator func(context.Context, EndpointOpts) (string, error)
// ApplyDefaults is an internal method to be used by provider implementations.
//
// It sets EndpointOpts fields if not already set, including a default type.
// Currently, EndpointOpts.Availability defaults to the public endpoint.
func (eo *EndpointOpts) ApplyDefaults(t string) {
if eo.Type == "" {
eo.Type = t
}
if eo.Availability == "" {
eo.Availability = AvailabilityPublic
}
if len(eo.Aliases) == 0 {
if aliases, ok := ServiceTypeAliases[eo.Type]; ok {
// happy path: user requested a service type by its official name
eo.Aliases = slices.Clone(aliases)
} else {
// unhappy path: user requested a service type by its alias or an
// invalid/unsupported service type
// TODO(stephenfin): This should probably be an error in v3
for t, aliases := range ServiceTypeAliases {
if slices.Contains(aliases, eo.Type) {
// we intentionally override the service type, even if it
// was explicitly requested by the user
eo.Type = t
eo.Aliases = slices.Clone(aliases)
}
}
}
}
}
func (eo *EndpointOpts) Types() []string {
return append([]string{eo.Type}, eo.Aliases...)
}