Need Help With Emacs Tramp Mode For 'gcloud compute ssh'

Need Help With Emacs Tramp Mode For 'gcloud compute ssh'

[Samuel Banya]

Hello there,

I have looked high and low on the internet, and can't find a decent answer on how to utilize Tramp Mode for 'gcloud compute ssh'.

This is the command I need to run for work, since I remote into gcloud (GCP) based jump boxes, so I need to use the '--project' parameter accordingly:
gcloud compute ssh --project ops-dist-(client's environment name) (client's environment name)-cli

I have the following present in my Emacs config so far, but am completely stuck as all there's to go off is the source code itself, and I really only use Org Mode and Emacs for notes, and super light programming:

** WORK-SPECIFIC Add 'tramp' to easily ssh into gcp jumpbox and ssh into 'aa-master'
#+BEGIN_SRC emacs-lisp
  (use-package tramp
    :ensure t
    :config
    (add-to-list 'tramp-methods
'("gcssh"
   (tramp-login-program "gcloud compute ssh")
   (tramp-login-args (("%h --project example-project example-project-cli")))
   (tramp-async-args (("-q")))
   (tramp-remote-shell "/bin/bash")
   (tramp-remote-shell-args ("-c"))
   (tramp-gw-args (("-o" "GlobalKnownHostsFile=/dev/null")
   ("-o" "UserKnownHostsFile=/dev/null")
   ("-o" "StrictHostKeyChecking=no")))
   (tramp-default-port 22))))

  (defun gcp-box-connect ()
    (interactive)
    (find-file "/gcssh:compute-instance:/path/to/filename.clj"))

  ;; NOTE: Uncommenting when I figure out the full path to what I need to add and will most likely add it to a 'secrets' file:
  ;; Suggested format:
  ;; C-x C-f /gcssh:compute-instance:/path/to/filename.clj
  (global-set-key (kbd "C-M-g") 'gcp-box-connect)
#+END_SRC

Re: Need Help With Emacs Tramp Mode For 'gcloud compute ssh'

[Michael Albinus]

"Samuel Banya" <sbanya@fastmail.com> writes:

> Hello there,

Hi Samuel,

> I have looked high and low on the internet, and can't find a decent answer on how to utilize Tramp Mode for 'gcloud compute ssh'.

Which Emacs/Tramp version are you using?

>     (add-to-list 'tramp-methods
> '("gcssh"
>    (tramp-login-program "gcloud compute ssh")

This must be exactly the program name. "gcloud" I guess. "compute" and
"ssh" must be part of tramp-login-args.

>    (tramp-login-args (("%h --project example-project example-project-cli")))

"%h" must be an element of its own. Somethging like

    (tramp-login-args (("compute ssh") ("%h") ("--project example-project example-project-cli")))

>    (tramp-gw-args (("-o" "GlobalKnownHostsFile=/dev/null")
>    ("-o" "UserKnownHostsFile=/dev/null")
>    ("-o" "StrictHostKeyChecking=no")))

tramp-gw-args do not exists for years. Likely, you don't need them.

When you have adapted your config, set also tramp-verbose to 6. Run the
test. If it fails, there will be a Tramp debug buffer, which tells
more. In case you need help to analyze, show it here.

Best regards, Michael.

Re: Need Help With Emacs Tramp Mode For 'gcloud compute ssh'

[Samuel Banya]

Hello Michael,

I am currently using the latest Emacs Version 27.2.

This is specifically for my work Macbook running MacOSX Big Sur (latest).

On Mon, Aug 9, 2021, at 11:41 AM, Michael Albinus wrote:
> "Samuel Banya" <sbanya@fastmail.com> writes:
> 
> > Hello there,
> 
> Hi Samuel,
> 
> > I have looked high and low on the internet, and can't find a decent answer on how to utilize Tramp Mode for 'gcloud compute ssh'.
> 
> Which Emacs/Tramp version are you using?
> 
> >     (add-to-list 'tramp-methods
> > '("gcssh"
> >    (tramp-login-program "gcloud compute ssh")
> 
> This must be exactly the program name. "gcloud" I guess. "compute" and
> "ssh" must be part of tramp-login-args.
> 
> >    (tramp-login-args (("%h --project example-project example-project-cli")))
> 
> "%h" must be an element of its own. Somethging like
> 
>     (tramp-login-args (("compute ssh") ("%h") ("--project example-project example-project-cli")))
> 
> >    (tramp-gw-args (("-o" "GlobalKnownHostsFile=/dev/null")
> >    ("-o" "UserKnownHostsFile=/dev/null")
> >    ("-o" "StrictHostKeyChecking=no")))
> 
> tramp-gw-args do not exists for years. Likely, you don't need them.
> 
> When you have adapted your config, set also tramp-verbose to 6. Run the
> test. If it fails, there will be a Tramp debug buffer, which tells
> more. In case you need help to analyze, show it here.
> 
> Best regards, Michael.
> 

Re: Need Help With Emacs Tramp Mode For 'gcloud compute ssh'

[Michael Albinus]

"Samuel Banya" <sbanya@fastmail.com> writes:

> Hello Michael,

Hi Samuel,

> I am currently using the latest Emacs Version 27.2.

Good. Could you apply the proposed changes, and see how it works for you?

Best regards, Michael.