This repository has been archived by the owner on Jan 19, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 480
/
service.go
532 lines (449 loc) · 13.4 KB
/
service.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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
/*
Copyright (c) 2019 the Octant contributors. All Rights Reserved.
SPDX-License-Identifier: Apache-2.0
*/
package portforward
import (
"context"
"fmt"
"sort"
"sync"
"time"
"github.com/google/uuid"
"github.com/pkg/errors"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/client-go/rest"
restclient "k8s.io/client-go/rest"
"github.com/vmware/octant/internal/log"
"github.com/vmware/octant/pkg/store"
)
//go:generate mockgen -source=service.go -destination=./fake/mock_interface.go -package=fake github.com/vmware/octant/internal/portforward PortForwarder
var (
emptyPortForwardResponse = CreateResponse{}
)
// PortForwarder allows querying active port-forwards
type PortForwarder interface {
List(ctx context.Context) []State
Get(id string) (State, bool)
Create(ctx context.Context, gvk schema.GroupVersionKind, name string, namespace string, remotePort uint16) (CreateResponse, error)
Find(namespace string, gvk schema.GroupVersionKind, name string) (State, error)
Stop()
StopForwarder(id string)
}
// PortForwardPortSpec describes a forwarded port.
type PortForwardPortSpec struct {
Remote uint16 `json:"remote"`
Local uint16 `json:"local,omitempty"`
}
// PortForwardSpec describes a port forward.
// TODO Merge with PortForwardState
type PortForwardSpec struct {
ID string `json:"id"`
Status string `json:"status"`
Message string `json:"message"`
Ports []PortForwardPortSpec `json:"ports"`
CreatedAt time.Time `json:"createdAt"`
}
type CreateRequest struct {
Namespace string `json:"namespace"`
APIVersion string `json:"apiVersion"`
Kind string `json:"kind"`
Name string `json:"name"`
Ports []PortForwardPortSpec `json:"ports"`
}
type CreateResponse PortForwardSpec
// Target references a kubernetes object
type Target struct {
GVK schema.GroupVersionKind
Namespace string
Name string
}
// State describes a single port-forward's runtime state
type State struct {
ID string
CreatedAt time.Time
Ports []ForwardedPort
Target Target
Pod Target
cancel context.CancelFunc
}
// Clone clones a port forward state.
func (pf *State) Clone() State {
pfCpy := State{
ID: pf.ID,
CreatedAt: pf.CreatedAt,
Ports: make([]ForwardedPort, len(pf.Ports)),
Target: pf.Target,
Pod: pf.Pod,
cancel: pf.cancel,
}
copy(pfCpy.Ports, pf.Ports)
return pfCpy
}
// States describes all active port-forwards' runtime state
type States struct {
sync.Mutex
portForwards map[string]State
}
// PortForwardSvcOptions contains all the options for running a port-forward service
type ServiceOptions struct {
RESTClient rest.Interface
Config *restclient.Config
ObjectStore store.Store
PortForwarder portForwarder
}
type forwarderEvent struct {
ID string
err error
}
// Service is a port forwarding service.
type Service struct {
logger log.Logger
opts ServiceOptions
ctx context.Context
cancel context.CancelFunc
notifyCh chan forwarderEvent
state States
}
var _ PortForwarder = (*Service)(nil)
// New creates an instance of Service.
func New(ctx context.Context, opts ServiceOptions, logger log.Logger) *Service {
ctx, cancel := context.WithCancel(ctx)
return &Service{
logger: logger,
opts: opts,
notifyCh: make(chan forwarderEvent, 32),
ctx: ctx,
cancel: cancel,
state: States{
portForwards: make(map[string]State),
},
}
}
// Stop stops all forwarders. The portForwardService is invalid after calling stop.
func (s *Service) Stop() {
// TODO wait on goroutines to complete after calling cancel.
if s.cancel != nil {
s.cancel()
}
}
func (s *Service) validateCreateRequest(r CreateRequest) error {
if r.Namespace == "" {
return errors.New("namespace field required")
}
if r.Name == "" {
return errors.New("name field required")
}
if r.APIVersion != "v1" || r.Kind != "Pod" {
return errors.Errorf("port forwards only work with pods")
}
for _, p := range r.Ports {
if p.Remote < 1 || p.Remote > 65535 {
return errors.Errorf("remote port out of range: %v", p.Remote)
}
}
return nil
}
// resolvePod attempts to resolve a port forward request into an active pod we can
// forward to. Service/deployments selectors will be resolved into pods and a random
// one will be chosen. A pod has to be active.
// Returns: pod name or error.
func (s *Service) resolvePod(ctx context.Context, r CreateRequest) (string, error) {
o := s.opts.ObjectStore
if o == nil {
return "", errors.New("nil objectstore")
}
switch {
case r.APIVersion == "v1" && r.Kind == "Pod":
// Verify pod exists and status is running
if ok, err := s.verifyPod(ctx, r.Namespace, r.Name); !ok || err != nil {
return "", errors.Errorf("verifying pod %q: %v", r.Name, err)
}
return r.Name, nil
default:
return "", errors.New("not implemented")
}
}
// verifyPod returns true if the specified pod can be found and is in the running phase.
// Otherwise returns false and an error describing the cause.
func (s *Service) verifyPod(ctx context.Context, namespace, name string) (bool, error) {
o := s.opts.ObjectStore
if o == nil {
return false, errors.New("nil objectstore")
}
key := store.Key{
APIVersion: "v1",
Kind: "Pod",
Namespace: namespace,
Name: name,
}
var pod corev1.Pod
found, err := store.GetAs(ctx, o, key, &pod)
if err != nil {
return false, err
}
if !found {
return false, nil
}
if pod.Name == "" {
return false, errors.New("pod not found")
}
if pod.Status.Phase != corev1.PodRunning {
return false, errors.Errorf("pod not running, phase=%v", pod.Status.Phase)
}
return true, nil
}
// createForwarder creates a port forwarder, forwards traffic, and blocks until
// port state information is populated.
// Returns forwarder id.
func (s *Service) createForwarder(r CreateRequest) (string, error) {
logger := s.logger.With("context", "PortForwardService.createForwarder")
if s.opts.PortForwarder == nil {
return "", errors.New("portforwarder is nil")
}
randomUUID, err := uuid.NewRandom()
if err != nil {
return "", errors.Wrap(err, "generating uuid")
}
forwarderID := randomUUID.String()
logger = logger.With("id", forwarderID)
var ports []string
for _, p := range r.Ports {
ports = append(ports, fmt.Sprintf("%d:%d", p.Local, p.Remote))
}
// Target coordinates to preserve in state
gv, err := schema.ParseGroupVersion(r.APIVersion)
if err != nil {
return "", errors.Wrap(err, "parsing APIVersion")
}
gvk := gv.WithKind(r.Kind)
// This child context will be cancelled if our parent context is cancelled
ctx, cancel := context.WithCancel(s.ctx)
// Spawns goroutine to update state as ports become available
portsChannel, portsReady := s.localPortsHandler(ctx, forwarderID)
// TODO resolve request gvk/name to pod name
o := &s.opts
opts := Options{
Config: o.Config,
RESTClient: o.RESTClient,
Address: []string{"localhost"},
Ports: ports,
PortForwarder: o.PortForwarder,
StopChannel: ctx.Done(),
ReadyChannel: make(chan struct{}),
PortsChannel: portsChannel,
}
// NOTE: ports will be updated in the state struct by
// localPortsHandler when they become available.
forwardState := State{
ID: forwarderID,
CreatedAt: time.Now(),
Target: Target{
GVK: gvk,
Namespace: r.Namespace,
Name: r.Name,
},
// TODO Target and Pod may be different
Pod: Target{
GVK: gvk,
Namespace: r.Namespace,
Name: r.Name,
},
cancel: cancel,
}
s.state.Lock()
s.state.portForwards[forwarderID] = forwardState
s.state.Unlock()
req := o.RESTClient.Post().
Resource("pods").
Namespace(r.Namespace).
Name(r.Name).
SubResource("portforward")
go func() {
// Blocks until forwarder completes
logger.With("url", req.URL()).Debugf("starting port-forward")
err := s.opts.PortForwarder.ForwardPorts("POST", req.URL(), opts)
logger.Debugf("forwarding terminated: %v", err)
// Notify the main forwarder of the termination
event := forwarderEvent{
ID: forwarderID,
err: err,
}
select {
case s.notifyCh <- event:
default:
}
// Cleanup state for terminated port-forward
s.StopForwarder(forwarderID)
}()
// Block until ports state is ready
select {
case <-ctx.Done():
return "", errors.Errorf("portforward terminated due to parent context: %v", forwarderID)
case <-portsReady:
}
return forwarderID, nil
}
// responseForCreate creates a create response based on the state for the specified forward (by id)
func (s *Service) responseForCreate(id string) (CreateResponse, error) {
var response CreateResponse
s.state.Lock()
defer s.state.Unlock()
state, ok := s.state.portForwards[id]
if !ok {
return response, errors.Errorf("retrieving state for terminated port-forward: %v", id)
}
response.ID = id
response.CreatedAt = state.CreatedAt
rp := make([]PortForwardPortSpec, len(state.Ports))
for i := range state.Ports {
rp[i].Local = state.Ports[i].Local
rp[i].Remote = state.Ports[i].Remote
}
response.Ports = rp
response.Status = "ok"
return response, nil
}
func (s *Service) localPortsHandler(ctx context.Context, id string) (portsChan chan []ForwardedPort, portsReady <-chan struct{}) {
logger := s.logger.With("context", "PortForwardService.localPortsHandler", "id", id)
portsChan = make(chan []ForwardedPort, 1)
readyChan := make(chan struct{})
portsReady = readyChan
go func() {
select {
case p := <-portsChan:
logger.With("ports", p).Debugf("received ports for port-forward")
if err := s.updatePorts(id, p); err != nil {
logger.Warnf("%s", err.Error())
}
close(readyChan)
case <-ctx.Done():
logger.Debugf("terminated")
}
}()
return
}
// updatePorts updates the ports list for an existing port forward, specified by id
func (s *Service) updatePorts(id string, ports []ForwardedPort) error {
s.state.Lock()
defer s.state.Unlock()
state, ok := s.state.portForwards[id]
if !ok {
return errors.New("updating ports for terminated port-forward")
}
state.Ports = ports
s.state.portForwards[id] = state
return nil
}
// List lists port forwards
func (s *Service) List(ctx context.Context) []State {
s.state.Lock()
defer s.state.Unlock()
result := make([]State, 0, len(s.state.portForwards))
for i, pf := range s.state.portForwards {
targetPod := &pf.Pod
if verified, err := s.verifyPod(ctx, targetPod.Namespace, targetPod.Name); !verified || err != nil {
delete(s.state.portForwards, i)
continue
}
result = append(result, pf.Clone())
}
// Sort by creation time
sort.Slice(result, func(i, j int) bool {
return result[i].CreatedAt.Before(result[j].CreatedAt)
})
return result
}
// Get gets a single port forward state
func (s *Service) Get(id string) (State, bool) {
s.state.Lock()
defer s.state.Unlock()
pf, ok := s.state.portForwards[id]
cpy := pf.Clone()
return cpy, ok
}
// Create creates a new port forward for the specified object and remote port.
// Implements PortForwardInterface.
func (s *Service) Create(ctx context.Context, gvk schema.GroupVersionKind, name string, namespace string, remotePort uint16) (CreateResponse, error) {
logger := s.logger.With("context", "PortForwardService.Create")
req := newForwardRequest(gvk, name, namespace, remotePort)
if err := s.validateCreateRequest(req); err != nil {
return emptyPortForwardResponse, errors.Wrap(err, "invalid request")
}
// Resolve the request into a pod, update the request
logger.With(
"apiVersion", req.APIVersion,
"kind", req.Kind,
"name", req.Name,
"namespace", req.Namespace,
).Debugf("resolving pod from object")
podName, err := s.resolvePod(ctx, req)
if err != nil {
return emptyPortForwardResponse, errors.Wrap(err, "resolving pod")
}
logger.Debugf("resolved to pod %q", podName)
podReq := req
podReq.Name = podName
id, err := s.createForwarder(req)
if err != nil {
return emptyPortForwardResponse, errors.Wrap(err, "creating forwarder")
}
// Compose response based on forwarder state
response, err := s.responseForCreate(id)
if err != nil {
return emptyPortForwardResponse, errors.Wrapf(err, "fetching state for forwarder: %v", id)
}
return response, nil
}
// StopForwarder stops an individual port forward specified by id.
// Implements PortForwardInterface.
func (s *Service) StopForwarder(id string) {
s.state.Lock()
defer s.state.Unlock()
pf, ok := s.state.portForwards[id]
if !ok {
return
}
if pf.cancel != nil {
// TODO wait for goroutine to exit
pf.cancel()
}
delete(s.state.portForwards, id)
}
type notFound struct{}
var _ error = (*notFound)(nil)
func (e *notFound) Error() string {
return "port forward not found"
}
func (e *notFound) NotFound() bool {
return true
}
func (s *Service) Find(namespace string, gvk schema.GroupVersionKind, name string) (State, error) {
s.state.Lock()
defer s.state.Unlock()
for _, state := range s.state.portForwards {
target := state.Target
if target.GVK.String() == gvk.String() &&
namespace == target.Namespace &&
name == target.Name {
return state, nil
}
}
return State{}, ¬Found{}
}
// newForwardRequest constructs a port forwarding request based on the provided parameters
func newForwardRequest(gvk schema.GroupVersionKind, name string, namespace string, remotePort uint16) CreateRequest {
APIVersion, kind := gvk.ToAPIVersionAndKind()
return CreateRequest{
APIVersion: APIVersion,
Kind: kind,
Namespace: namespace,
Name: name,
Ports: []PortForwardPortSpec{
{
Remote: remotePort,
},
},
}
}