Visual Studio Code plug-in for NGINX Instance Manager
How to use Visual Studio Code with the NGINX Instance Manager extension
You are not viewing the latest documentation for Instance Manager. Visit https://docs.nginx.com/nginx-management-suite/nim to read the latest content.
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 internal).
The plug-in for NGINX Instance Manager can be found in the Visual Studio Marketplace.
The VS Code plug-in is based on the F5 VS Code plug-in that enables AS3 language and pushes changes to F5 BIG-IP appliances through Visual Studio Code. This extension is based on 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.
- NGINX Instance Manager server already configured and running.
- NGINX Agent installed on any NGINX Instances you want to manage.
- Basic Authentication to connect to Instance Manager.
Assuming you already have Visual Studio Code installed and running. Simply navigate to the marketplace and install or search for F5 Instance Manager in the extensions search panel.
Select the gear icon, and you will see a configuration file that may have existing entries, or you may need to add these. You will need to use Basic auth for this current version and know the username and password.
You can leverage VS Code to explore NGINX Instance Manager and push configurations with lightning speed.
There are some limitations with the initial version of the extension:
- Analyzer best practice rulesets are not yet integrated.
- Visual Studio Code will not check for conflicts.