Wondering what‚Äôs next for npm?Check out our public roadmap! ¬Ľ

    gcloud-ssh-tunnel

    2.0.0¬†‚Äʬ†Public¬†‚Äʬ†Published

    gcloud-ssh-tunnel

    Create secure IAM-controlled connections between Google Cloud resources and VM instances!

    Why?

    • Become free from VPC firewall rules and start using IAM roles to control access in the Google Cloud.
    • Allow yourself to use App Engine Standard environment that doesn't allow custom network configuration, instead of the slow-ass Flexible environment.
    • Stop wasting your time trying to connect Cloud Functions to the VPC network.

    How it works with IAM?

    Simply give the allowed resource's service account the Service Account User role, as well as either Compute OS Login or (the less recommended) Compute OS Admin Login (which can be given on a specific VM instance), and start connecting!

    Usage

    Install with:

    npm install --save gcloud-ssh-tunnel

    Then use it:

    const gcloudSshTunnel = require('gcloud-ssh-tunnel');
     
    let tunnel = gcloudSshTunnel({
      // either instance or host must be supplied
      instance: {
        zone: "gcp-region-with-zone", // e.g. us-east1-d
        name: "instance-name",
      },
      host: "host-or-ip",
     
      remotePort: 1234,
      localPort: 1234, // optional, will find a free port if not supplied
     
      projectId, // optional, project of the instance
      keyFilename: "path/to/service-account-keyfile.json", // optional, path to service account's keyfile
    });
     
    // the return value is a promise (that can also be awaited)
    tunnel.then(({ port, client, server, close }) => {
      // port: local port you can connect to
      // client: the SSH client (see ssh2)
      // server: the local listener that forwards connections to the SSH (see Net::Server)
      // close: same as tunnel.close(), closes the client, server, and all connections
    });
    // 
    tunnel.close(); // closes the tunnel and ends all client connections

    Install

    npm i gcloud-ssh-tunnel

    DownloadsWeekly Downloads

    3

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    4.86 kB

    Total Files

    3

    Last publish

    Collaborators

    • avatar