Visual Studio Code plugin for NGINX Instance Manager

How to use Visual Studio Code with the NGINX Instance Manager extension

This document is intended to help utilize Visual Studio Code (“vscode”) and NGINX Instance Manager.

TECH PREVIEW: This extension is in Tech Preview and is community supported currently.

Currently we are using basic authentication which is not a very secure way to protect your Instance Manager environment. It is highly recommended you block external access and only use this internally (your connection from visual studio code to nginx-manager should be interal).

The plugin for NIM can be found in the Visual Studio Marketplace.

Description

The vscode plugin is based off the F5 vscode plugin that enables AS3 language and pushing changes to F5 BIG-IP appliances through Visual Studio Code. This extension is based off that work but targets NGINX Instance Manager. The purpose of the extension is to enable a native experience with existing tools. The extension only communicates with nginx-manager and leverages the APIs from NGINX Instance Manager.

Prerequisites

  1. NGINX Instance Manager server already configured and running.
  2. NGINX Agent installed on any NGINX Instances you want to manage.
  3. Basic Authentication to connect to Instance Manager.

Install the vscode plugin

Assuming you already have Visual Studio Code installed and running. Simply navigate to the marketplace and install or search for F5 NIM in the extensions search panel.

Visual Studio Code Marketplace

Configure vscode plug

Click on the gear icon and you will see a configuration file which may have existing entries or you may need to add these. You will need to use Basic auth for this current version and will need to know the username and password.

What’s Next

You can leverage vscode to explore NGINX Instance Manager and push configurations with lightning speed. Go explore.

Known Issues

There are some limitations with the intial version of the extension:

  • Analyzer best practice rulsets are not yet integrated.
  • Visual Studio Code will not check for conflicts.