search

TritonDataCenter / node-triton

Triton client tool and node.js library
57 stars 39 forks source link

`instance ssh --help` is missing docs about tag `tritoncli.ssh.port` #343

Closed teutat3s closed 10 months ago

teutat3s commented 10 months ago

tritoncli.ssh.port is currently undocumented in triton instance ssh --help

triton instance ssh --help
SSH to the primary IP of an instance

Usage:

    triton instance ssh [-h] [USER@]INST [SSH-ARGUMENTS]

Options:
    -h, --help          Show this help.
    --no-proxy          Disable SSH proxy support (ignore "tritoncli.ssh.proxy"
                        tag).

Where INST is the name, id, or short id of an instance. Note that
the INST argument must come before any `ssh` options or arguments.
Where USER is the username to use on the instance. If not specified,
the instance's image is inspected for the default_user tag.
If USER is not specified and the default_user tag is not set, the user
is assumed to be "root".

The "tritoncli.ssh.proxy" tag on the target instance may be set to
the name or the UUID of another instance through which to proxy this
SSH connection.  If set, the primary IP of the proxy instance will be
loaded and passed to SSH via the ProxyJump option.  The --no-proxy
flag can be used to ignore the tag and force a direct connection.

For example, to proxy connections to zone "narnia" through "wardrobe":
    triton instance tag set narnia tritoncli.ssh.proxy=wardrobe

The "tritoncli.ssh.ip" tag on the target instance may be set to the
IP address to use for SSH connections.  This may be useful if the
primary IP address is not available for SSH connections.  This address
must be set to one of the IP addresses attached to the instance.

The "tritoncli.ssh.proxyuser" tag on the proxy instance may be set to
the user account that should be used for the proxy connection (i.e., via
the SSH ProxyJump option).  This is useful when all users of the proxy
instance should use a special common account, and will override the USER
value (if one is provided) for the SSH connection to the target instance.

There is a known issue with SSH connection multiplexing (a.k.a.
ControlMaster, mux) where stdout/stderr is lost. As a workaround, `ssh`
is spawned with options disabling ControlMaster. See
<https://github.com/TritonDataCenter/node-triton/issues/52> for details. If you
want to use ControlMaster, an alternative is:
    ssh root@$(triton ip INST)