npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

opensearch_ssm_connect

v1.0.3

Published

A script to connect to AWS OpenSearch via secure session management.

Downloads

7

Readme

AWS Environment Selector and Command Executor

This Node.js application allows you to select an AWS environment and execute various AWS commands within that environment. The environments are read from your AWS configuration file, and the application uses the aws-vault tool to manage your AWS credentials securely.

Prerequisites

Before running this application, make sure you have the following installed:

Also, ensure that your AWS configuration file (~/.aws/config) is appropriately set up with the environments you want to use.

Installation

You can install this application globally using npm:

npm install -g opensearch_ssm_connect
  1. Select the environment you want to use. The application will then execute a series of AWS commands within that environment.

Given your provided code, here's how to connect to the database:

Connecting to the OpenSearch

  1. Invoke opensearch_ssm_connect in your terminal:

    opensearch_ssm_connect

    The application will read your AWS configuration file and prompt you to select an environment.

  2. Select the environment you want to connect to. The application will then execute a series of AWS commands within that environment. It will do the following:

    • Extract the environments from the AWS configuration file
    • Display the connection credentials and the connection url
    • Get the ID of the bastion instance
    • Get the endpoint of the OpenSearch domain
    • Start a port forwarding session to the OpenSearch domain
  3. After you've selected an environment and the AWS commands have been executed, you will receive the connection information. Here is an example of the output:

    You can access Kibana Dashboards by the link https://localhost:<port>/_dashboards/
    Login: <login>
    Password: <password>
  4. Use the provided connection string and password to connect to your Kibana dashboards via browser of your choice.

Please note: Make sure you accept certificate on the first connection.

Requirements

This application requires the following Node.js modules:

  • child_process: For spawning child processes to execute AWS commands.
  • inquirer: For prompting the user to select an environment.
  • fs: For reading the AWS configuration file.
  • os: For getting the user's home directory.
  • path: For working with file paths.

These modules will be installed automatically when you install the application with npm.

How It Works

The application first reads the AWS configuration file and extracts the environments from it. It then prompts the user to select an environment.

After the user selects an environment, the application executes a series of AWS commands within that environment using aws-vault. These commands include:

  • Describing EC2 instances to get the ID of the bastion instance.
  • Describing OpenSearch domain to get the endpoint.
  • Starting an AWS SSM session to forward a local port to the OpenSearch domain.

The application logs the output of each command and any errors that occur.