support kubectl attach in KubeEdge #4734

wenchajun · 2023-04-15T15:09:02Z

What type of PR is this?

/kind feature

What this PR does / why we need it:

Currently, in a native kubernetes cluster, kubectl exec command can execute a command in a container. kubectl logs command can print the logs for a container in a pod. kubectl attach command can attach to a running container.
Users can execute these commands in the cloud and do not need to operate on the nodes.
we plan to implement kubectl exec, kubectl logs and kubectl attach feature based on edge computing scenarios.
These two commands(kubectl exec, kubectl logs) are currently integrated, and this PR is to integrate the kubectl attach command.

Which issue(s) this PR fixes:

Fixes #4424

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

The user can use the `kubectl attach` command to access the pod of the edge node.

Signed-off-by: Shelley-BaoYue <baoyue2@huawei.com> (cherry picked from commit 7cee5b0) Signed-off-by: dehaocheng <dehaocheng@kubesphere.io>

kubeedge-bot · 2023-04-15T15:09:07Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign qizha after the PR has been reviewed.
You can assign the PR to them by writing /assign @qizha in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

wenchajun · 2023-04-15T16:53:51Z

@Shelley-BaoYue Can you give us some advice?

Shelley-BaoYue · 2023-04-17T13:10:08Z

cloud/pkg/cloudstream/containerattach_connection.go

+	// first send connect message
+	connector, err := ah.SendConnection()
+	if err != nil {
+		klog.Errorf("%s send %s info error %v", ah.String(), stream.MessageTypeExecConnect, err)


Try changing it to MessageTypeAttachConnect.

Shelley-BaoYue · 2023-04-17T13:12:31Z

@Shelley-BaoYue Can you give us some advice?

I will debug it in my local environment, it may take some time to give you feedback.

Shelley-BaoYue · 2023-04-23T09:27:42Z

edge/pkg/edgestream/tunnel.go

@@ -104,6 +119,10 @@ func (s *TunnelSession) ServeConnection(m *stream.Message) {
 		if err := s.serveMetricsConnection(m); err != nil {
 			klog.Errorf("Serve Metrics connection error %s", m.String())
 		}
+	case stream.MessageTypeAttachConnect:
+		if err := s.serveContainerAttachConnection(m); err != nil {
+			klog.Errorf("Serve Metrics connection error %s", m.String())


log info error, need to be Serve Attach

Shelley-BaoYue · 2023-04-23T09:31:02Z

pkg/stream/edgedattachconnection.go

+	if err != nil {
+		return nil, err
+	}
+	return NewMessage(ah.MessID, MessageTypeExecConnect, data), nil


MessageTypeExecConnect --> MessageTypeAttachConnect

Shelley-BaoYue · 2023-04-23T09:34:34Z

cloud/pkg/cloudstream/containerattach_connection.go

+	"context"
+	"errors"
+	"fmt"
+	"github.com/kubeedge/kubeedge/common/constants"


The import sequence needs to be adjusted. Generally, the import sequence is the standard lib, third-party lib, and local
lib.

Shelley-BaoYue · 2023-04-23T09:35:36Z

pkg/stream/edgedattachconnection.go

+	"errors"
+	"fmt"
+	"io"
+	"k8s.io/apimachinery/pkg/util/httpstream/spdy"


Adjusting the import sequence

Shelley-BaoYue · 2023-04-23T09:35:57Z

pkg/stream/edgedattachconnection.go

+}
+
+func (ah *EdgedAttachConnection) receiveFromCloudStream(con net.Conn, stop chan struct{}) {
+	// todo: read msg from cloudstream


todo flag can be removed now

Shelley-BaoYue · 2023-04-23T09:36:13Z

pkg/stream/edgedattachconnection.go

+}
+
+func (ah *EdgedAttachConnection) write2CloudStream(tunnel SafeWriteTunneler, con net.Conn, stop chan struct{}) {
+	// todo: write response to tunnel


Shelley-BaoYue · 2023-04-23T09:36:22Z

pkg/stream/edgedattachconnection.go

+}
+
+func (ah *EdgedAttachConnection) Serve(tunnel SafeWriteTunneler) error {
+	// todo: serve msg from clousstream, send req to edged and write response to tunnel


Shelley-BaoYue · 2023-04-23T09:37:46Z

@wenchajun I have successfully debugged locally. You can adjust it according to my modification suggestions and try again.

wenchajun · 2023-04-24T02:03:54Z

@wenchajun I have successfully debugged locally. You can adjust it according to my modification suggestions and try again.

Thanks for your reply, I have fixed the problems.

wenchajun · 2023-04-24T03:45:06Z

In the CI just now, I see that the error is reported as an extra blank line added. I modified it, can you help me rerun this CI? @Shelley-BaoYue

Shelley-BaoYue · 2023-04-24T06:26:54Z

In the CI just now, I see that the error is reported as an extra blank line added. I modified it, can you help me rerun this CI? @Shelley-BaoYue

OK. And the description of this pr could be added, including associated issues #4424 , proposal: #4690 .

Shelley-BaoYue · 2023-04-24T09:41:28Z

pkg/stream/constants.go

@@ -8,6 +8,7 @@ const (
 const (
 	MessageTypeLogsConnect MessageType = iota
 	MessageTypeExecConnect
+	MessageTypeAttachConnect


Here is a compatibility problem. We hope CloudCore can be compatible with EdgeCore of earlier versions generally. If MessageTypeAttachConnect is inserted here, when CloudCore send MessageTypeData，EdgeCore will identify it as MessageTypeRemoveConnect. I suggest adding MessageTypeAttachConnect at the end, and the judgment at line 195 of edge/pkg/edgestream/tunnel needs to be changed accordingly.

Shelley-BaoYue · 2023-04-25T09:27:08Z

edge/pkg/edgestream/tunnel.go

@@ -172,7 +191,7 @@ func (s *TunnelSession) Serve() error {
 			return fmt.Errorf("close tunnel stream connection, error:%s", string(mess.Data))
 		}

-		if mess.MessageType < stream.MessageTypeData {
+		if (mess.MessageType < stream.MessageTypeData) || (mess.MessageType == stream.MessageTypeAttachConnect) {


mess.MessageType >= stream.MessageTypeAttachConnect maybe better for expansion

const ( MessageTypeLogsConnect MessageType = iota MessageTypeExecConnect MessageTypeMetricConnect MessageTypeData MessageTypeRemoveConnect MessageTypeCloseConnect MessageTypeAttachConnect

What should this field be adjusted to be greater than or equal to if it is increased by 1 each time here?

(mess.MessageType < stream.MessageTypeData) || (mess.MessageType >= stream.MessageTypeAttachConnect)?

const ( MessageTypeLogsConnect MessageType = iota MessageTypeExecConnect MessageTypeMetricConnect MessageTypeData MessageTypeRemoveConnect MessageTypeCloseConnect MessageTypeAttachConnect

What should this field be adjusted to be greater than or equal to if it is increased by 1 each time here?

I guess that in order to ensure compatibility, new message type will be added at the end. If we add more capabilities of kubectl in the future, we don't need to change that judgment, just using mess.MessageType >= stream.MessageTypeAttachConnect is OK. It's just my suggestion.

I get it .thanks

Signed-off-by: dehaocheng <dehaocheng@kubesphere.io>

wenchajun · 2023-05-06T01:58:00Z

All changes have been made, are there any questions so far? @Shelley-BaoYue

wenchajun · 2023-05-09T01:09:16Z

It looks like there is a slight error in action, please check codecov/codecov-action#598

Shelley-BaoYue · 2023-06-14T11:24:58Z

PTAL @fisherxu @wackxu

support kubectl attach

ddcb948

Signed-off-by: Shelley-BaoYue <baoyue2@huawei.com> (cherry picked from commit 7cee5b0) Signed-off-by: dehaocheng <dehaocheng@kubesphere.io>

kubeedge-bot requested review from subpathdev and zc2638 April 15, 2023 15:09

kubeedge-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Apr 15, 2023

Shelley-BaoYue reviewed Apr 17, 2023

View reviewed changes

Shelley-BaoYue added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Apr 18, 2023

wenchajun force-pushed the kubectl-attach branch from a69e642 to 1f30e7c Compare April 18, 2023 02:14

Shelley-BaoYue reviewed Apr 23, 2023

View reviewed changes

wenchajun force-pushed the kubectl-attach branch from 1f30e7c to 9771ed7 Compare April 24, 2023 02:00

Shelley-BaoYue removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Apr 24, 2023

Shelley-BaoYue closed this Apr 24, 2023

Shelley-BaoYue reopened this Apr 24, 2023

wenchajun force-pushed the kubectl-attach branch from 9771ed7 to e338a94 Compare April 24, 2023 03:32

wenchajun closed this Apr 24, 2023

wenchajun reopened this Apr 24, 2023

Shelley-BaoYue closed this Apr 24, 2023

Shelley-BaoYue reopened this Apr 24, 2023

Shelley-BaoYue reviewed Apr 24, 2023

View reviewed changes

wenchajun force-pushed the kubectl-attach branch from e338a94 to 32dce2e Compare April 25, 2023 08:13

wenchajun changed the title ~~Kubectl attach~~ support kubectl attach in KubeEdge Apr 25, 2023

Shelley-BaoYue reviewed Apr 25, 2023

View reviewed changes

add kubectl attach code

8bc26fc

Signed-off-by: dehaocheng <dehaocheng@kubesphere.io>

wenchajun force-pushed the kubectl-attach branch from 32dce2e to 8bc26fc Compare April 25, 2023 09:44

Shelley-BaoYue closed this Jun 14, 2023

Shelley-BaoYue reopened this Jun 14, 2023

kubeedge-bot merged commit 01ce58b into kubeedge:master Jun 30, 2023
22 of 24 checks passed

fisherxu added this to the v1.14 milestone Aug 24, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

support kubectl attach in KubeEdge #4734

support kubectl attach in KubeEdge #4734

wenchajun commented Apr 15, 2023 •

edited

kubeedge-bot commented Apr 15, 2023

wenchajun commented Apr 15, 2023

Shelley-BaoYue Apr 17, 2023

Shelley-BaoYue commented Apr 17, 2023

Shelley-BaoYue Apr 23, 2023

Shelley-BaoYue Apr 23, 2023

Shelley-BaoYue Apr 23, 2023

Shelley-BaoYue Apr 23, 2023

Shelley-BaoYue Apr 23, 2023

Shelley-BaoYue Apr 23, 2023

Shelley-BaoYue Apr 23, 2023

Shelley-BaoYue commented Apr 23, 2023

wenchajun commented Apr 24, 2023

wenchajun commented Apr 24, 2023

Shelley-BaoYue commented Apr 24, 2023

Shelley-BaoYue Apr 24, 2023

wenchajun Apr 25, 2023

Shelley-BaoYue Apr 25, 2023

wenchajun Apr 25, 2023 •

edited

Shelley-BaoYue Apr 25, 2023

wenchajun Apr 25, 2023

wenchajun commented May 6, 2023

wenchajun commented May 9, 2023

Shelley-BaoYue commented Jun 14, 2023

support kubectl attach in KubeEdge #4734

support kubectl attach in KubeEdge #4734

Conversation

wenchajun commented Apr 15, 2023 • edited

kubeedge-bot commented Apr 15, 2023

wenchajun commented Apr 15, 2023

Choose a reason for hiding this comment

Shelley-BaoYue commented Apr 17, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Shelley-BaoYue commented Apr 23, 2023

wenchajun commented Apr 24, 2023

wenchajun commented Apr 24, 2023

Shelley-BaoYue commented Apr 24, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wenchajun Apr 25, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wenchajun commented May 6, 2023

wenchajun commented May 9, 2023

Shelley-BaoYue commented Jun 14, 2023

wenchajun commented Apr 15, 2023 •

edited

wenchajun Apr 25, 2023 •

edited