Skip to content

Latest commit

 

History

History
131 lines (87 loc) · 5.87 KB

README.md

File metadata and controls

131 lines (87 loc) · 5.87 KB
Raw

vRealize Developer Tools

A Visual Studio Code extension that provides code intelligence features and enables a more developer-friendly experience when creating vRealize Orchestrator and vRealize Automation content.

Visual Studio Marketplace Version Build Status Dependencies Status Coverage Status

Prerequisites

To use most of the vRealize Developer Tools's functionality, you will need a development vRealize Orchestrator instance and to set up vRealize Build Tools.

Features

Multiple environments

Connect to different vRO environments by configuring maven profiles in ~/.m2/settings.xml.

<profile>
    <id>my-env</id>
    <properties>
        <!-- vRO Connection -->
        <vro.host>10.27.120.27</vro.host>
        <vro.port>443</vro.port>
        <vro.username>[email protected]</vro.username>
        <vro.password>myPlainTextPass</vro.password>
        <vro.auth>basic</vro.auth> <!-- or 'vra' for sso auth -->
        <vro.tenant>vsphere.local</vro.tenant> <!-- required for 'vra' auth -->

        <!-- vRA Connection -->
        <vra.host>10.27.120.27</vra.host>
        <vra.port>443</vra.port>
        <vra.username>[email protected]</vra.username>
        <vra.password>myPlainTextPass</vra.password>
        <vra.tenant>vsphere.local</vra.tenant>
    </properties>
</profile>

Once vRealize Developer Tools extension is activated in VS Code, on the bottom left corner of the status bar, an idicator is shown if there is no currently active profile.

Missing profile

Click on it to see list of all available profiles and select one to activate.

Environment profiles

Active profile name and the IP address of the vRealize Orchestrator instance is shown in the status bar.

Active profile

Project on-boarding

The vRealize: New Project command from the VS Code comand palette (Cmd+Shift+P / Ctrl+Shift+P) can be used to on-board a new vRealize project.

Project on-boarding

vRO-aware IntelliSense

Visual Studio Code's IntelliSense feature for JavaScript files is enhanced with with symbols and information from the vRO’s core scripting API, plug-in objects and actions.

vRO-aware IntelliSense

Run action

The vRealize: Run Action command from the VS Code comand palette (Cmd+Shift+P / Ctrl+Shift+P) allows running an action JavaScript file in live vRO instance while seeing the logs in the OUTPUT panel.

Run action

Explore the inventory

A vRO explorer view is available in the activity bar that allows browsing the whole vRO inventory (actions, workflows, resources, configurations, packages and plugin objects).

  • Browse, search by name, fetch source (read-only) of all elements
  • Fetch schema (read-only) of workflows
  • 3 different layouts for the actions hierarchy (controlled by vrdev.views.explorer.actions.layout setting)
    • tree - Displays action packages as a tree
    • compact - Displays action packages as a tree, but flattens any folders that have no children
    • flat - Displays action packages as a list
  • Delete packages
  • Browse the inventory and see properties of each plugin object

vRO Explorer

Push and Pull content

The VS Code build tasks palette (Cmd+Shift+B / Ctrl+Shift+B) contains commands for pushing content to a live vRO/vRA instance and for pulling workflows, configurations, resources and vRA content back to your local machine – in a form suitable for committing into source control.

Push and Pull content

The vrdev.tasks.exclude setting can be used to exclude certain projects from the list of build tasks (Cmd+Shift+B) by using glob patterns

"vrdev.tasks.exclude" : [
    "my.example.library*", // Exclude all libraries
    "!my.example.library*", // Exclude everything, except libraries
    "my.example!(library*)", // Exclude everything from 'my.example', except libraries
    "my.example.library:{nsx,vra,vc}", // Exclude nsx, vra and vc libraries
    "my.example.library:util" // Exclude util library (<groupId>:<artifactId>)
]

Upgrade steps

If you have installed any versions prior 2.0.0, do the following to upgrade.

  1. Remove the old version from the VS Code Extensions panel (Cmd+Shift+X)
  2. Reload VS Code by executing the Reload Window command (Cmd+Shift+P)
  3. Install the latest version of vRealize Developer Tools.

Contributing

If you're interested in contributing, see our contributing guide.

Open Source Licenses

Please see the file open_source_licenses.txt.

License

Copyright 2018-2020 VMware, Inc.

Licensed under the MIT License.