easy-portforward

Easy port-forward connections manager

Description

Package is not longer supported

This is a tiny tool installed via npm that allows you to manage and connect kubernetes services using port forward in an easy way.

Requirement

• Kubectl
• Previous authorization and rancher configurations
• VPN

Install

Install globally from one of the following sources npm i -g easy-portforward

Configuration

1. Download the configuration file from rancher.
2. Save the configuration file in ~/.easy-portforward/store
3. Create the database with port forward connections. ~/.easy-portforward/store

{
  "environment": {
    "config": "sandbox.yml",
    "name": "Development environment",
    "acronym": "DEV",
    "portRange": 21
  },
  "services": [
    {
      "description": "API Rest service",
      "owner": "Team number 1",
      "namespace": "< Rancher namespace >",
      "label": "< pod label name >",
      "labelValue": "< pod label value >",
      "type": "Https api rest service",
      "ports": "X001:80", //👈 ports mapping separated by the colon symbol ':' first and second port should be a valid port number
      // You can use optionally an X to represent the port range X will be replaced by the value in `environment.portRange`
      "verified": false
    }
  ]
}

Running the scripts

Before running the script is important to check you are connected to the VPN using the official software Open VPN

# Start using user interface
$ epf

Useful commands

# Start using shell
$ epf --shell

# Help
$ epf --help

# Help
$ epf --config

# List ports
epf --ports

# Show verbose mode
epf --verbose

# Use a gauzy script with variables
epf --verbose --gauzy

To send params when you run in develop

Add the symbol '--' between the script call npm run start:dev and the params like this

## Run UI mode
npm run start:dev

## Run Shell mode
npm run start:dev -- --shell
npm run start:dev -- --verbose

Developer

• Author - Luis Arias 2021 <[e-mail]> GitHub profile

License

This software is licensed under MIT License

May 2021