Skip to content

Commit 8cf3fad

Browse files
dmcgowandmcgowan
committed
Add leases manager interface
Add leases manager to the leases package and use the interface on the client and service. Signed-off-by: Derek McGowan <[email protected]>
1 parent c77c89b commit 8cf3fad

12 files changed

Lines changed: 304 additions & 205 deletions

File tree

‎client.go‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ import (
4343
"github.com/containerd/containerd/errdefs"
4444
"github.com/containerd/containerd/events"
4545
"github.com/containerd/containerd/images"
46+
"github.com/containerd/containerd/leases"
47+
leasesproxy "github.com/containerd/containerd/leases/proxy"
4648
"github.com/containerd/containerd/namespaces"
4749
"github.com/containerd/containerd/pkg/dialer"
4850
"github.com/containerd/containerd/plugin"
@@ -508,11 +510,11 @@ func (c *Client) IntrospectionService() introspectionapi.IntrospectionClient {
508510
}
509511

510512
// LeasesService returns the underlying Leases Client
511-
func (c *Client) LeasesService() leasesapi.LeasesClient {
513+
func (c *Client) LeasesService() leases.Manager {
512514
if c.leasesService != nil {
513515
return c.leasesService
514516
}
515-
return leasesapi.NewLeasesClient(c.conn)
517+
return leasesproxy.NewLeaseManager(leasesapi.NewLeasesClient(c.conn))
516518
}
517519

518520
// HealthService returns the underlying GRPC HealthClient

‎lease.go‎

Lines changed: 6 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -20,96 +20,27 @@ import (
2020
"context"
2121
"time"
2222

23-
leasesapi "github.com/containerd/containerd/api/services/leases/v1"
2423
"github.com/containerd/containerd/leases"
2524
)
2625

27-
// Lease is used to hold a reference to active resources which have not been
28-
// referenced by a root resource. This is useful for preventing garbage
29-
// collection of resources while they are actively being updated.
30-
type Lease struct {
31-
id string
32-
createdAt time.Time
33-
34-
client *Client
35-
}
36-
37-
// CreateLease creates a new lease
38-
// TODO: Add variadic lease opt
39-
func (c *Client) CreateLease(ctx context.Context) (Lease, error) {
40-
lapi := c.LeasesService()
41-
labels := map[string]string{
42-
"containerd.io/gc.expire": time.Now().Add(24 * 3600 * time.Second).Format(time.RFC3339),
43-
}
44-
resp, err := lapi.Create(ctx, &leasesapi.CreateRequest{labels})
45-
if err != nil {
46-
return Lease{}, err
47-
}
48-
49-
return Lease{
50-
id: resp.Lease.ID,
51-
createdAt: resp.Lease.CreatedAt,
52-
labels: labels,
53-
client: c,
54-
}, nil
55-
}
56-
57-
// ListLeases lists active leases
58-
func (c *Client) ListLeases(ctx context.Context) ([]Lease, error) {
59-
lapi := c.LeasesService()
60-
resp, err := lapi.List(ctx, &leasesapi.ListRequest{})
61-
if err != nil {
62-
return nil, err
63-
}
64-
leases := make([]Lease, len(resp.Leases))
65-
for i := range resp.Leases {
66-
leases[i] = Lease{
67-
id: resp.Leases[i].ID,
68-
createdAt: resp.Leases[i].CreatedAt,
69-
labels: resp.Leases[i].Labels,
70-
client: c,
71-
}
72-
}
73-
74-
return leases, nil
75-
}
76-
7726
// WithLease attaches a lease on the context
7827
func (c *Client) WithLease(ctx context.Context) (context.Context, func(context.Context) error, error) {
79-
_, ok := leases.Lease(ctx)
28+
_, ok := leases.FromContext(ctx)
8029
if ok {
8130
return ctx, func(context.Context) error {
8231
return nil
8332
}, nil
8433
}
8534

86-
l, err := c.CreateLease(ctx)
35+
ls := c.LeasesService()
36+
37+
l, err := ls.Create(ctx, leases.WithRandomID(), leases.WithExpiration(24*3600*time.Second))
8738
if err != nil {
8839
return nil, nil, err
8940
}
9041

91-
ctx = leases.WithLease(ctx, l.ID())
42+
ctx = leases.WithLease(ctx, l.ID)
9243
return ctx, func(ctx context.Context) error {
93-
return l.Delete(ctx)
44+
return ls.Delete(ctx, l)
9445
}, nil
9546
}
96-
97-
// ID returns the lease ID
98-
func (l Lease) ID() string {
99-
return l.id
100-
}
101-
102-
// CreatedAt returns the time at which the lease was created
103-
func (l Lease) CreatedAt() time.Time {
104-
return l.createdAt
105-
}
106-
107-
// Delete deletes the lease, removing the reference to all resources created
108-
// during the lease.
109-
func (l Lease) Delete(ctx context.Context) error {
110-
lapi := l.client.LeasesService()
111-
_, err := lapi.Delete(ctx, &leasesapi.DeleteRequest{
112-
ID: l.id,
113-
})
114-
return err
115-
}

‎leases/context.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ func WithLease(ctx context.Context, lid string) context.Context {
2929
return withGRPCLeaseHeader(ctx, lid)
3030
}
3131

32-
// Lease returns the lease from the context.
33-
func Lease(ctx context.Context) (string, bool) {
32+
// FromContext returns the lease from the context.
33+
func FromContext(ctx context.Context) (string, bool) {
3434
lid, ok := ctx.Value(leaseKey{}).(string)
3535
if !ok {
3636
return fromGRPCHeader(ctx)

‎leases/id.go‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
/*
2+
Copyright The containerd Authors.
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
*/
16+
17+
package leases
18+
19+
import (
20+
"encoding/base64"
21+
"fmt"
22+
"math/rand"
23+
"time"
24+
)
25+
26+
// WithRandomID sets the lease ID to a random unique value
27+
func WithRandomID() Opt {
28+
return func(l *Lease) error {
29+
t := time.Now()
30+
var b [3]byte
31+
rand.Read(b[:])
32+
l.ID = fmt.Sprintf("%d-%s", t.Nanosecond(), base64.URLEncoding.EncodeToString(b[:]))
33+
return nil
34+
}
35+
}
36+
37+
// WithID sets the ID for the lease
38+
func WithID(id string) Opt {
39+
return func(l *Lease) error {
40+
l.ID = id
41+
return nil
42+
}
43+
}

‎leases/lease.go‎

Lines changed: 49 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,60 @@
1+
/*
2+
Copyright The containerd Authors.
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
*/
16+
117
package leases
218

3-
import "time"
19+
import (
20+
"context"
21+
"time"
22+
)
423

5-
type LeaseOpt func(*Lease)
24+
// Opt is used to set options on a lease
25+
type Opt func(*Lease) error
626

7-
type LeaseManager interface {
8-
Create(...LeaseOpt) (Lease, error)
9-
Delete(Lease) error
10-
List(...string) ([]Lease, error)
27+
// Manager is used to create, list, and remove leases
28+
type Manager interface {
29+
Create(context.Context, ...Opt) (Lease, error)
30+
Delete(context.Context, Lease) error
31+
List(context.Context, ...string) ([]Lease, error)
1132
}
1233

34+
// Lease retains resources to prevent cleanup before
35+
// the resources can be fully referenced.
1336
type Lease struct {
1437
ID string
1538
CreatedAt time.Time
1639
Labels map[string]string
1740
}
41+
42+
// WithLabels sets labels on a lease
43+
func WithLabels(labels map[string]string) Opt {
44+
return func(l *Lease) error {
45+
l.Labels = labels
46+
return nil
47+
}
48+
}
49+
50+
// WithExpiration sets an expiration on the lease
51+
func WithExpiration(d time.Duration) Opt {
52+
return func(l *Lease) error {
53+
if l.Labels == nil {
54+
l.Labels = map[string]string{}
55+
}
56+
l.Labels["containerd.io/gc.expire"] = time.Now().Add(d).Format(time.RFC3339)
57+
58+
return nil
59+
}
60+
}

‎leases/proxy/manager.go‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
/*
2+
Copyright The containerd Authors.
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
*/
16+
17+
package proxy
18+
19+
import (
20+
"context"
21+
22+
leasesapi "github.com/containerd/containerd/api/services/leases/v1"
23+
"github.com/containerd/containerd/leases"
24+
)
25+
26+
type proxyManager struct {
27+
client leasesapi.LeasesClient
28+
}
29+
30+
// NewLeaseManager returns a lease manager which communicates
31+
// through a grpc lease service.
32+
func NewLeaseManager(client leasesapi.LeasesClient) leases.Manager {
33+
return &proxyManager{
34+
client: client,
35+
}
36+
}
37+
38+
func (pm *proxyManager) Create(ctx context.Context, opts ...leases.Opt) (leases.Lease, error) {
39+
l := leases.Lease{}
40+
for _, opt := range opts {
41+
if err := opt(&l); err != nil {
42+
return leases.Lease{}, err
43+
}
44+
}
45+
resp, err := pm.client.Create(ctx, &leasesapi.CreateRequest{
46+
ID: l.ID,
47+
Labels: l.Labels,
48+
})
49+
if err != nil {
50+
return leases.Lease{}, err
51+
}
52+
53+
return leases.Lease{
54+
ID: resp.Lease.ID,
55+
CreatedAt: resp.Lease.CreatedAt,
56+
Labels: resp.Lease.Labels,
57+
}, nil
58+
}
59+
60+
func (pm *proxyManager) Delete(ctx context.Context, l leases.Lease) error {
61+
_, err := pm.client.Delete(ctx, &leasesapi.DeleteRequest{
62+
ID: l.ID,
63+
})
64+
return err
65+
}
66+
67+
func (pm *proxyManager) List(ctx context.Context, filters ...string) ([]leases.Lease, error) {
68+
resp, err := pm.client.List(ctx, &leasesapi.ListRequest{
69+
Filters: filters,
70+
})
71+
if err != nil {
72+
return nil, err
73+
}
74+
l := make([]leases.Lease, len(resp.Leases))
75+
for i := range resp.Leases {
76+
l[i] = leases.Lease{
77+
ID: resp.Leases[i].ID,
78+
CreatedAt: resp.Leases[i].CreatedAt,
79+
Labels: resp.Leases[i].Labels,
80+
}
81+
}
82+
83+
return l, nil
84+
}

0 commit comments

Comments
 (0)