Skip to content

Chef 11169 optimize k8s container connection v2 #22

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 17 commits into
base: main
Choose a base branch
from
Open

Chef 11169 optimize k8s container connection v2 #22

wants to merge 17 commits into from

Conversation

sathish-progress
Copy link
Contributor

Optimise the Persistent connection to K8s container

Description

  • Uses PTY to open a pseudo terminal with persistent connection to a K8s Container
  • User Kubectl exec with shell to login to pod for an interactive session
  • Keeps the session for the whole process and ability to reconnect

Related Issue

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New content (non-breaking change)
  • Breaking change (a content change which would break existing functionality or processes)

Checklist:

  • I have read the CONTRIBUTING document.

@sathish-progress
modify exec command to open shell
c4847e9 
Signed-off-by: Sathish Babu <[email protected]>
@sathish-progress
setup session and stream pipe for command streaming to kubectl exec s…
b3d5b64 
…hell

Signed-off-by: Sathish Babu <[email protected]>
@sathish-progress
call streaming pipe from execute
a0e37b0 
Signed-off-by: Sathish Babu <[email protected]>
@sathish-progress
set session at class level
a62e7dd 
This allows to use only single session

Signed-off-by: Sathish Babu <[email protected]>
@sathish-progress
build shell command
5d26715 
Signed-off-by: Sathish Babu <[email protected]>
@sathish-progress
build instruction suitable for k8s exec client
6791413 
Signed-off-by: Sathish Babu <[email protected]>
@sathish-progress
require open3, pty and expect
ea850fc 
Signed-off-by: Sathish Babu <[email protected]>
@sathish-progress
disconnect logic
a82433b 
Signed-off-by: Sathish Babu <[email protected]>
@sathish-progress
strip the ansi sequence
de2315b 
Signed-off-by: Sathish Babu <[email protected]>
@sathish-progress
execute and close logic
5c7b077 
Signed-off-by: Sathish Babu <[email protected]>
@sathish-progress
send command
d2d0914 
Signed-off-by: Sathish Babu <[email protected]>
@sathish-progress
Train extras
c408d6b 
Signed-off-by: Sathish Babu <[email protected]>
@sathish-progress
set session from PTY
cd6cd20 
- set reader, writer and PID
- define reconnect logic
- load session at class level

Signed-off-by: Sathish Babu <[email protected]>
@sathish-progress
write cmd string
ae20888 
Signed-off-by: Sathish Babu <[email protected]>
@sathish-progress
catch standardError
559956c 
Signed-off-by: Sathish Babu <[email protected]>
@sathish-progress
fix connections for session
8635230 
Signed-off-by: Sathish Babu <[email protected]>
@sathish-progress
catch syntax error
4cb1485 
Signed-off-by: Sathish Babu <[email protected]>
github-advanced-security[bot]
github-advanced-security bot found potential problems May 29, 2024
View reviewed changes
lib/train/k8s/container/kubectl_exec_client.rb
Train::Extras::CommandResult.new("", "", 1)
end

private
def strip_ansi_sequences(text)
text.gsub(/\e\[.*?m/, "").gsub(/\e\]0;.*?\a/, "").gsub(/\e\[A/, "").gsub(/\e\[C/, "").gsub(/\e\[K/, "")

Check failure

Code scanning / CodeQL

Polynomial regular expression used on uncontrolled data

This [regular expression](1) that depends on a [library input](2) may run slow on strings starting with 'e\]0;' and with many repetitions of 'e\]0;'.
lib/train/k8s/container/kubectl_exec_client.rb
Train::Extras::CommandResult.new("", "", 1)
end

private
def strip_ansi_sequences(text)
text.gsub(/\e\[.*?m/, "").gsub(/\e\]0;.*?\a/, "").gsub(/\e\[A/, "").gsub(/\e\[C/, "").gsub(/\e\[K/, "")

Check failure

Code scanning / CodeQL

Polynomial regular expression used on uncontrolled data

This [regular expression](1) that depends on a [library input](2) may run slow on strings starting with 'e\[' and with many repetitions of 'e\['.
lib/train/k8s/container/kubectl_exec_client.rb
Train::Extras::CommandResult.new(res.stdout, res.stderr, res.exitstatus)
rescue Errno::ENOENT => _e
def connect
@reader, @writer, @pid = PTY.spawn("kubectl exec --stdin --tty #{@pod} -n #{@namespace} -c #{@container_name} -- /bin/bash")

Check warning

Code scanning / CodeQL

Unsafe shell command constructed from library input

This string construction which depends on [library input](1) is later used in a [shell command](2). This string construction which depends on [library input](1) is later used in a [shell command](2). This string construction which depends on [library input](1) is later used in a [shell command](2). This string construction which depends on [library input](3) is later used in a [shell command](2). This string construction which depends on [library input](4) is later used in a [shell command](2). This string construction which depends on [library input](5) is later used in a [shell command](2).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@sathish-progress