-
Notifications
You must be signed in to change notification settings - Fork 124
feat(shim): add task wrapper and containerd access session #657
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
cmainas
merged 2 commits into
urunc-dev:main-pr657
from
sidneychang:feat/containerd-shim-access
May 13, 2026
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,171 @@ | ||
| // Copyright (c) 2023-2026, Nubificus LTD | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package containerd | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "time" | ||
|
|
||
| containersapi "github.com/containerd/containerd/api/services/containers/v1" | ||
| contentapi "github.com/containerd/containerd/api/services/content/v1" | ||
| imagesapi "github.com/containerd/containerd/api/services/images/v1" | ||
| leasesapi "github.com/containerd/containerd/api/services/leases/v1" | ||
| snapshotsapi "github.com/containerd/containerd/api/services/snapshots/v1" | ||
| "github.com/containerd/containerd/defaults" | ||
| "github.com/containerd/containerd/errdefs" | ||
| "github.com/containerd/containerd/namespaces" | ||
| "github.com/containerd/containerd/pkg/dialer" | ||
| "google.golang.org/grpc" | ||
| "google.golang.org/grpc/backoff" | ||
| "google.golang.org/grpc/credentials/insecure" | ||
| ) | ||
|
|
||
| const defaultConnectTimeout = 10 * time.Second | ||
|
|
||
| type Session struct { | ||
| conn *grpc.ClientConn | ||
|
|
||
| namespace string | ||
| containerID string | ||
| container *containersapi.Container | ||
| } | ||
|
|
||
| // OpenSession opens a containerd session and loads the task container metadata. | ||
| func OpenSession(ctx context.Context, address, containerID string) (*Session, error) { | ||
| if address == "" { | ||
| return nil, fmt.Errorf("containerd address is empty") | ||
| } | ||
| if containerID == "" { | ||
| return nil, fmt.Errorf("container id is empty") | ||
| } | ||
|
|
||
| namespace, err := namespaces.NamespaceRequired(ctx) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| backoffConfig := backoff.DefaultConfig | ||
| backoffConfig.MaxDelay = 3 * time.Second | ||
| dialOptions := []grpc.DialOption{ | ||
| grpc.WithBlock(), | ||
| grpc.WithTransportCredentials(insecure.NewCredentials()), | ||
| grpc.FailOnNonTempDialError(true), | ||
| grpc.WithConnectParams(grpc.ConnectParams{Backoff: backoffConfig}), | ||
| grpc.WithContextDialer(dialer.ContextDialer), | ||
| grpc.WithReturnConnectionError(), | ||
| grpc.WithDefaultCallOptions( | ||
| grpc.MaxCallRecvMsgSize(defaults.DefaultMaxRecvMsgSize), | ||
| grpc.MaxCallSendMsgSize(defaults.DefaultMaxSendMsgSize), | ||
| ), | ||
| } | ||
|
|
||
| dialCtx, cancel := context.WithTimeout(ctx, defaultConnectTimeout) | ||
| defer cancel() | ||
|
|
||
| conn, err := grpc.DialContext(dialCtx, dialer.DialAddress(address), dialOptions...) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("dial containerd at %q: %w", address, err) | ||
| } | ||
|
|
||
| session := &Session{ | ||
| conn: conn, | ||
| namespace: namespace, | ||
| containerID: containerID, | ||
| } | ||
|
|
||
| container, err := loadContainer(ctx, namespace, containerID, session.containersClient()) | ||
| if err != nil { | ||
| if closeErr := conn.Close(); closeErr != nil { | ||
| return nil, fmt.Errorf("loadContainer failed: %w; close containerd connection: %v", err, closeErr) | ||
| } | ||
| return nil, fmt.Errorf("loadContainer failed: %w", err) | ||
| } | ||
| session.container = container | ||
|
|
||
| return session, nil | ||
| } | ||
|
|
||
| func (s *Session) Close() error { | ||
| if s == nil || s.conn == nil { | ||
| return nil | ||
| } | ||
| return s.conn.Close() | ||
| } | ||
|
|
||
| func (s *Session) GetNamespace() string { | ||
| return s.namespace | ||
| } | ||
|
|
||
| func (s *Session) GetContainerID() string { | ||
| return s.containerID | ||
| } | ||
|
|
||
| func (s *Session) GetContainer() *containersapi.Container { | ||
| return s.container | ||
| } | ||
|
|
||
| func loadContainer(ctx context.Context, namespace, containerID string, client containersapi.ContainersClient) (*containersapi.Container, error) { | ||
| resp, err := client.Get(withNamespace(ctx, namespace), &containersapi.GetContainerRequest{ | ||
| ID: containerID, | ||
| }) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("get container %q: %w", containerID, containerdErr(err)) | ||
| } | ||
| container := resp.GetContainer() | ||
| if container == nil { | ||
| return nil, fmt.Errorf("get container %q: response missing container", containerID) | ||
| } | ||
|
|
||
| return container, nil | ||
| } | ||
|
|
||
| func withNamespace(ctx context.Context, namespace string) context.Context { | ||
| if ctx == nil { | ||
| ctx = context.Background() | ||
| } | ||
| return namespaces.WithNamespace(ctx, namespace) | ||
| } | ||
|
|
||
| func containerdErr(err error) error { | ||
| if err == nil { | ||
| return nil | ||
| } | ||
| return errdefs.FromGRPC(err) | ||
| } | ||
|
|
||
| func (s *Session) containersClient() containersapi.ContainersClient { | ||
| return containersapi.NewContainersClient(s.conn) | ||
| } | ||
|
|
||
| //nolint:unused // Used by follow-up feature-specific access constructors. | ||
| func (s *Session) imagesClient() imagesapi.ImagesClient { | ||
| return imagesapi.NewImagesClient(s.conn) | ||
| } | ||
|
|
||
| //nolint:unused // Used by follow-up feature-specific access constructors. | ||
| func (s *Session) contentClient() contentapi.ContentClient { | ||
| return contentapi.NewContentClient(s.conn) | ||
| } | ||
|
|
||
| //nolint:unused // Used by follow-up feature-specific access constructors. | ||
| func (s *Session) snapshotsClient() snapshotsapi.SnapshotsClient { | ||
| return snapshotsapi.NewSnapshotsClient(s.conn) | ||
| } | ||
|
|
||
| //nolint:unused // Used by follow-up feature-specific access constructors. | ||
| func (s *Session) leasesClient() leasesapi.LeasesClient { | ||
| return leasesapi.NewLeasesClient(s.conn) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| // Copyright (c) 2023-2026, Nubificus LTD | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package containerdshim | ||
|
|
||
| import ( | ||
| "github.com/containerd/containerd/pkg/shutdown" | ||
| "github.com/containerd/containerd/plugin" | ||
| runcTask "github.com/containerd/containerd/runtime/v2/runc/task" | ||
| "github.com/containerd/containerd/runtime/v2/shim" | ||
| ) | ||
|
|
||
| func init() { | ||
| plugin.Register(&plugin.Registration{ | ||
| Type: plugin.TTRPCPlugin, | ||
| ID: "task", | ||
| Requires: []plugin.Type{ | ||
| plugin.EventPlugin, | ||
| plugin.InternalPlugin, | ||
| }, | ||
| InitFn: func(ic *plugin.InitContext) (interface{}, error) { | ||
| pp, err := ic.GetByID(plugin.EventPlugin, "publisher") | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| ss, err := ic.GetByID(plugin.InternalPlugin, "shutdown") | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| inner, err := runcTask.NewTaskService(ic.Context, pp.(shim.Publisher), ss.(shutdown.Service)) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return &taskService{ | ||
| TaskService: inner, | ||
| containerdAddress: ic.Address, | ||
| }, nil | ||
| }, | ||
| }) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| // Copyright (c) 2023-2026, Nubificus LTD | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package containerdshim | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| taskAPI "github.com/containerd/containerd/api/runtime/task/v2" | ||
| "github.com/containerd/ttrpc" | ||
| ) | ||
|
|
||
| // taskService is urunc's shim-side wrapper around containerd's runc task | ||
| // service. It currently forwards calls to the wrapped service while keeping a | ||
| // urunc-owned place for task-level feature wiring. | ||
| type taskService struct { | ||
| taskAPI.TaskService | ||
|
|
||
| containerdAddress string | ||
| } | ||
|
|
||
| func (s *taskService) Create(ctx context.Context, r *taskAPI.CreateTaskRequest) (*taskAPI.CreateTaskResponse, error) { | ||
| return s.TaskService.Create(ctx, r) | ||
| } | ||
|
|
||
| func (s *taskService) Delete(ctx context.Context, r *taskAPI.DeleteRequest) (*taskAPI.DeleteResponse, error) { | ||
| return s.TaskService.Delete(ctx, r) | ||
| } | ||
|
|
||
| func (s *taskService) RegisterTTRPC(server *ttrpc.Server) error { | ||
| taskAPI.RegisterTaskService(server, s) | ||
| return nil | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.