-
Notifications
You must be signed in to change notification settings - Fork 9
/
endpoints.go
244 lines (201 loc) · 7.41 KB
/
endpoints.go
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
// Copyright 2022 Namespace Labs Inc; All rights reserved.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
package planning
import (
"fmt"
"golang.org/x/exp/slices"
"google.golang.org/protobuf/types/descriptorpb"
anypb "google.golang.org/protobuf/types/known/anypb"
"namespacelabs.dev/foundation/internal/fnerrors"
"namespacelabs.dev/foundation/internal/planning/constants"
"namespacelabs.dev/foundation/internal/runtime"
"namespacelabs.dev/foundation/schema"
"namespacelabs.dev/foundation/std/pkggraph"
)
type EndpointProvider interface {
InternalEndpoints(*schema.Environment, *schema.Server, []*schema.Endpoint_Port) ([]*schema.InternalEndpoint, error)
}
var endpointProviderByFramework = map[string]EndpointProvider{}
// XXX this is not the right place for protocol handling.
func RegisterEndpointProvider(fmwk schema.Framework, f EndpointProvider) {
endpointProviderByFramework[fmwk.String()] = f
}
func ComputeEndpoints(planner runtime.Planner, srv Server, merged *schema.ServerFragment, allocatedPorts []*schema.Endpoint_Port) ([]*schema.Endpoint, []*schema.InternalEndpoint, error) {
sch := srv.StackEntry()
serverPorts := append([]*schema.Endpoint_Port{}, sch.Server.StaticPort...)
serverPorts = append(serverPorts, allocatedPorts...)
// XXX figure out a story to handle collisions within a server!
// XXX should this be by exported RPC service instead?
var endpoints []*schema.Endpoint
var serverPort *schema.Endpoint_Port
for _, port := range serverPorts {
if port.Name == "server-port" { // XXX this needs to be thought through, it's convention by naming.
serverPort = port
break
}
}
for _, service := range sch.Services() {
var pkg *pkggraph.Package
for _, p := range srv.Deps() {
if p.PackageName().Equals(service.PackageName) {
pkg = p
break
}
}
nd, err := computeServiceEndpoint(planner, sch.Server, pkg, service, service.GetIngress(), serverPort)
if err != nil {
return nil, nil, err
}
endpoints = append(endpoints, nd...)
}
// Handle statically defined services.
server := sch.Server
for _, s := range merged.GetService() {
t := schema.Endpoint_PRIVATE
if s.EndpointType != schema.Endpoint_INGRESS_UNSPECIFIED {
t = s.EndpointType
}
spec, err := ServiceSpecToEndpoint(planner, server, s, t)
if err != nil {
return nil, nil, err
}
endpoints = append(endpoints, spec)
}
for _, s := range merged.GetIngress() {
if s.EndpointType != schema.Endpoint_INGRESS_UNSPECIFIED && s.EndpointType != schema.Endpoint_INTERNET_FACING {
return nil, nil, fnerrors.InternalError("ingress endpoint type is incompatible, saw %v", s.EndpointType)
}
spec, err := ServiceSpecToEndpoint(planner, server, s, schema.Endpoint_INTERNET_FACING)
if err != nil {
return nil, nil, err
}
endpoints = append(endpoints, spec)
}
// Handle HTTP.
if needsHTTP := len(server.UrlMap) > 0; needsHTTP {
var httpPort *schema.Endpoint_Port
for _, port := range serverPorts {
if port.Name == "http-port" {
httpPort = port
break
}
}
short, fqdn := planner.MakeServiceName(server.Name)
// We need a http service to hit.
endpoints = append(endpoints, &schema.Endpoint{
Type: schema.Endpoint_PRIVATE,
ServiceName: constants.HttpServiceName,
Port: httpPort,
ExportedPort: httpPort.GetContainerPort(),
AllocatedName: short,
FullyQualifiedName: fqdn,
EndpointOwner: server.GetPackageName(),
ServerOwner: server.GetPackageName(),
ServiceMetadata: []*schema.ServiceMetadata{
{Protocol: "http"},
},
})
}
var internal []*schema.InternalEndpoint
if f, ok := endpointProviderByFramework[server.Framework.String()]; ok {
var err error
internal, err = f.InternalEndpoints(srv.SealedContext().Environment(), server, allocatedPorts)
if err != nil {
return nil, nil, err
}
}
return endpoints, internal, nil
}
// XXX this should be somewhere else.
func computeServiceEndpoint(planner runtime.Planner, server *schema.Server, pkg *pkggraph.Package, n *schema.Node, t schema.Endpoint_Type, serverPort *schema.Endpoint_Port) ([]*schema.Endpoint, error) {
if len(n.ExportService) == 0 {
return nil, nil
}
// XXX should we perhaps export an endpoint per service.
short, fqdn := planner.MakeServiceName(n.GetIngressServiceName() + "-grpc")
endpoint := &schema.Endpoint{
ServiceName: n.GetIngressServiceName(),
AllocatedName: short,
FullyQualifiedName: fqdn,
EndpointOwner: n.GetPackageName(),
ServerOwner: server.GetPackageName(),
Type: t,
Port: serverPort,
ExportedPort: serverPort.GetContainerPort(),
}
if slices.Contains(constants.ReservedServiceNames, endpoint.ServiceName) {
return nil, fnerrors.InternalError("%s: %q is a reserved service name", n.PackageName, endpoint.ServiceName)
}
for _, exported := range n.ExportService {
details, err := anypb.New(exported)
if err != nil {
return nil, err
}
endpoint.ServiceMetadata = append(endpoint.ServiceMetadata, &schema.ServiceMetadata{
Kind: exported.ProtoTypename,
Protocol: schema.ClearTextGrpcProtocol,
Details: details,
})
if n.ExportServicesAsHttp {
details, err := anypb.New(&schema.GrpcExportService{ProtoTypename: exported.ProtoTypename})
if err != nil {
return nil, err
}
endpoint.ServiceMetadata = append(endpoint.ServiceMetadata, &schema.ServiceMetadata{
Kind: constants.KindNeedsGrpcGateway,
Details: details,
})
if pkg != nil {
if def := pkg.Services[exported.ProtoTypename]; def != nil {
fds := &descriptorpb.FileDescriptorSet{}
fds.File = append(fds.File, def.GetFile()...)
fds.File = append(fds.File, def.GetDependency()...)
details, err := anypb.New(&schema.GrpcHttpTranscoding{
FileDescriptorSet: fds,
})
if err != nil {
return nil, err
}
endpoint.ServiceMetadata = append(endpoint.ServiceMetadata, &schema.ServiceMetadata{Details: details})
}
}
}
}
return []*schema.Endpoint{endpoint}, nil
}
func ServiceSpecToEndpoint(planner runtime.Planner, srv *schema.Server, spec *schema.Server_ServiceSpec, t schema.Endpoint_Type) (*schema.Endpoint, error) {
short, fqdn := planner.MakeServiceName(fmt.Sprintf("%s-%s", spec.GetName(), srv.Id))
endpoint := &schema.Endpoint{
ServiceName: spec.GetName(),
ServerOwner: srv.GetPackageName(),
EndpointOwner: srv.GetPackageName(),
Type: t,
Port: spec.GetPort(),
ExportedPort: spec.GetExportedPort(),
AllocatedName: short,
FullyQualifiedName: fqdn,
ServiceLabel: spec.GetLabel(),
ServiceMetadata: spec.Metadata,
IngressProvider: spec.IngressProvider,
}
ingressSpec := &schema.Endpoint_IngressSpec{}
if len(spec.IngressDomain) > 0 {
if t != schema.Endpoint_INTERNET_FACING {
return nil, fnerrors.InternalError("ingress domain is specified in non-ingress endpoint")
}
ingressSpec.Domain = spec.IngressDomain
}
ingressSpec.Annotations = spec.IngressAnnotations
endpoint.IngressSpec = ingressSpec
if endpoint.ExportedPort == 0 {
endpoint.ExportedPort = spec.GetPort().GetContainerPort()
}
// XXX Rethink this -- i.e. consolidate with InternalEndpoint.
if spec.Internal {
endpoint.ServiceMetadata = append(endpoint.ServiceMetadata, &schema.ServiceMetadata{
Kind: constants.ManualInternalService,
})
}
return endpoint, nil
}