About this release
SovLabs 2018.1.x is a full quarterly release that includes enhancements and fixes to existing modules as well as new modules.
vRA 7.4 Notice
The minimum SovLabs Plug-in version required for VMware’s vRA 7.4 is 2018.1.4.
Please note that the vRO js-io-rights.conf file (at /etc/vco/app-server) is reset anytime the vRO Configurator service restarts. The proper configuration of the js-io-rights.conf file is a prerequisite to an Install/Upgrade. Prior to performing any subsequent upgrades on vRA 7.4, please validate that the js-io-right.conf is updated appropriately. Please reference our documentation.
To prevent the js-io-rights.conf file from reverting, please follow the steps below:
- SSH as root to vRO server
- Stop Control Center. Type in: service vco-configurator stop
- Make the changes. Follow steps via: docs.sovlabs.com
- Execute the CLI command to apply the changes to the latest configuration which is going to be replicated. Type in: /var/lib/vco/tools/configuration-cli/bin/vro-configure.sh sync-local
- Start Control Center. Type in: service vco-configurator start
vRA 7.3 Notice
There is a vRA 7.3 hotfix from VMware that fixes an issue with form field validations that affects all of SovLabs’ provided XaaS forms. This hotfix must be applied to your vRA 7.3 before upgrading to SovLabs 2018.1.x or earlier.
There is also a vRA 7.3 vRO CAFE plug-in patch that fixes a CAFE bug related to VMware vRA plug-in for vRO. This patch must be installed on vRO before upgrading to SovLabs 2017.3.2.3 or above.
- Apply the hotfix to vRA 7.3 before installing the SovLabs Plug-in.
- Verify that the vRA version shows as 7.3.0.537 after the update.
- Download the vRA hotfix: VMware-vRA-Appliance-7.3.0.537-6515242-updaterepo.iso. Alternative download location: VMware-vRA-Appliance-7.3.0.537-6515242-updaterepo.iso
- *The vRA hotfix is an ISO. Place the ISO on a datastore in vCenter and mount it as a CDROM drive to the vRA appliance. From there, install the update through the vRA VAMI.
- Please reboot the vRA instance after upgrading to this hotfix.
There is also a vRA 7.3 vRO CAFE plug-in patch that fixes a CAFE bug related to VMware vRA plug-in for vRO. *Affects SovLabs version 2017.3.2.3 and above.
- The updated vRO CAFE plug-in must be installed on your vRO(s) before installing the SovLabs Plug-in.
- The updated vRO CAFE plug-in and instructions can be found in VMware KB article 2150546. Alternative download location: 2150546_o11nplugin-vcaccafe.zip
**The vRA 7.3 hotfix and the vRO CAFE plug-in update are provided and supported by VMware. Please refer to VMware’s support channels for any questions about the installation or functionality of these updates.
What’s New?
Module |
Description |
ServiceNow Connector |
With the ServiceNow Connector by SovLabs, it’s now possible to import, consume and manage vRealize Automation catalog items natively within ServiceNow. ServiceNow administrators can customize the catalog and request process directly within the ServiceNow platform, without any need for custom coding or intimate knowledge of the vRealize Automation API. End-users can request and manage vRA catalog items and inventory directly within ServiceNow. Coupled with the SovLabs ServiceNow CMDB Module, organizations can now fully realize the full potential of both vRealize and ServiceNow platforms. |
Lifecycle Components Toolkit |
The SovLabs Lifecycle Components Toolkit was developed to:
SovLabs Lifecycle Components Toolkit (LCT) allows administrators to fine-tune provisioning for different types of builds and maintain those profiles independently without touching the default vRA Event Broker subscriptions for existing SovLabs integrations. |
SovLabs vRA EBS Priority Updates
EBS State |
Notes |
Machine Requested PRE |
Prior to this release:
For this release:
|
Features/Enhancements
Module |
Feature/Enhancement |
All |
Updated all Configuration label helpers in vRA forms text to:
No spaces, periods, nor special characters except underscore (_) and dash (-). |
DNS |
Added ability to skip PTR record validation in DNS Machine Building PRE and DNS Machine Disposing PRE lifecycle phases if vRA property SovLabs_SkipValidateDnsPtr is set. |
Infoblox DNS and/or IPAM |
Added support for Infoblox version 8.x |
ServiceNow CMDB |
Added support for Kingston Added support for configuring a non-authenticating Proxy to pass ServiceNow Calls out of vRO to the internet. Configured in the ServiceNow Endpoint. **Proxies which require authentication are not supported at this time. |
Backup as a Service for Rubrik |
Added support for Rubrik versions 3.2.x and 4.0.x |
Red Hat Satellite |
Added support for RH Satellite version 6.2 Added support for using Capsule Servers |
Puppet Enterprise |
Added support for Puppet Enterprise 2017.3 |
Puppet Open Source with Foreman |
Added support for Foreman 1.16/Puppet Open Source 5.3.4 |
Ansible Tower |
Added support for automated Dynamic Inventory Configuration
Added support for Ansible Tower CM Framework |
F5 |
Inventories all data from F5 endpoints (used to only inventory health monitors) Updated /reorganized F5 Virtual – SovLabs Modules form:
Updated SovLabs RESTipe to have versioning. During upgrades, user can now choose to replace the F5Config-default RESTipe with the latest during SovLabs Configuration > Update |
Backup as a Service for Veeam |
Improved performance of Recover Files and Folders and Recover VM forms
Added a Veeam FLR Cleanup scheduled task
|
Resolved Issues
Module |
Resolved Issue(s) |
DNS |
Fixed issue with MS DNS where if the Network field was left blank in the SovLabs DNS Configuration, the PTR Record was not created even if checked. |
Red Hat Satellite |
Fixed issue in Deprovisioning where Nodes were not removed from Content Hosts when name was an FQDN. |
VM Tagging |
Fixed issue where VMWare Tagging workflow was timing out after 5 minutes when processing large numbers of tags or categories.
Improved performance with tag and category processing. |
F5 |
Fixed issues with scale out for nested components in vRA blueprints
Fixed issue where provisioning of multiple VMs in a single request was failing during Provision Machine and Add VIP in vRA 7.3. Improved logic for looping through only the most recent requests to find the parent-child relations in multi-VM and Nested blueprints containing F5 VIPs. Fixed inconsistencies with rollback after errors. |
Known Issues
Module |
Known Issue(s) |
For vRA 7.4, js-io-rights.conf file reverts any time the vRO Configurator service is restarted. |
For vRA 7.4, js-io-rights.conf file reverts any time the vRO Configurator service is restarted.
Workaround:
|
All that generate a vRA Property Group |
Unable to rename a Property Group name in vRA 7.x programmatically
Workaround: Any forms that generate a vRA Property Group will no longer allow updating the “Configuration label” (e.g. Add Naming Standard/Update Naming Standard) |
Custom Naming |
Unable to rename deployments in vRA 7.x due to vRA Platform limitation.
The deployment name defaults to the blueprint name appended by a dash and an auto-generated 8-digit number (e.g. blueprintName-12345678) Workaround: The deployment name can be influced by adding a vRA Custom Property at the composite blueprint level (versus at the machine component in the blueprint) with:
*Note: Using the same property value will result in deployments with the same name |
Manage Credentials for Puppet Open Source with Foreman |
Unable to update a credential that is tied to Puppet Open Source with Foreman
Workaround: Update the Foreman Master or Foreman Agent and create a new credential directly inline and submit. |
F5 |
A nested vRA blueprint with the F5 virtual component in the child vRA blueprint that defines the value for Pool Health Monitors field fails with a: Status Code 400 ‘The value for the ‘poolHealthMonitors’ field should be among the permitted value’ for vRA 7.2. This issue does not occur for vRA 7.3 nor for a single (non-nested) blueprint.
Workaround: Do not define (pin) the value for Pool Health Monitors (or any field that is Array/String) on the F5 Virtual component in the child blueprint for a nested blueprint. vRA 7.4, 2018.1.4 |
vSphere Snapshot Management |
If using vSphere Snapshot Management with any of the Backup as a Service modules (Cohesity, Rubrik, Veeam) may result in an email notification of a Backup as a Service snapshot.
If the Backup as a Service snapshot lives beyond deletion time set in Snapshot Configuration, will get deleted. |
Lifecycle Component Toolkit |
Issue: For Add/Update Lifecycle Profiles, the vRA forms may timeout.
Workaround: Upgrade to 2018.1.4 Issue: machineRequested phase for Lifecycle Component Toolkit fails. Workaround: Upgrade to 2018.1.4 |
SovLabs vCenter Endpoint |
Version “6.7x” does not show in the dropdown list.
Workaround: Please select “6.5x” from the Version dropdown list. We have certified vCenter 6.7 in 2018.1.5. Resolved in 2019.6.0 |
Important Notes
Module |
Notes |
All that use VMWare tools connection type |
The version of VMWare tools on the VM must match the vCenter version. In other words, if your VM lives on a vCenter 6.5 and VMTools on the VM is from vCenter 5.5, there will be issues using the integrations with the vmware-tools connectivity type. |
IPAM (All) |
The option to skip in-use IP addresses will reserve the IP address first, then check to see if the IP is in use (responds to ping or DNS lookup). If that IP appears to be in use, the workflow will leave the first reservation in the IPAM, the hostname will be regenerated, the next IP will be reserved and checked for use. This will continue until an IP is found that does not appear to be in use. This will result in the in-use IP addresses being reserved in your IPAM under the hostnames generated during the workflow. It is recommended to turn on the notification option so operations staff can be aware of the discrepancy, and do appropriate clean up. |
vSphere 5.5 – End of Support |
The End of General Support (EOGS) for vSphere 5.5 is rapidly approaching. If you’re still on vSphere 5.5, time to start serious planning your upgrade
vSphere 5.5 will end general VMware support on September 19, 2018 |
Minor Release Notes
Version |
Notes |
2018.1.1.1 |
VM Tagging
|
2018.1.1.2 |
ServiceNow Connector
F5
SovLabs Template Engine
All
|
2018.1.1.3 |
Red Hat Satellite
|
2018.1.1.4 |
Red Hat Satellite
F5
Lifecycle Components Toolkit
|
2018.1.2 Released April 2, 2018 |
F5
Lifecycle Components Toolkit
ServiceNow Connector
|
2018.1.3 Released April 16, 2018 |
Ansible Tower
ServiceNow CMDB
All Backup as a ServiceFor Day2 actions that enables use of Notifications
|
2018.1.4 Released April 30, 2018 |
Certified for vRA 7.4 and vCenter 6.7
F5
Lifecycle Components Toolkit
Backup as a Service for Rubrik
ServiceNow CMDB
|
2018.1.5
Released May 14, 2018 |
SovLabs Configuration
Ansible Tower
All IPAM
Infoblox IPAM
Red Hat Satellite
SovLabs vCenter Endpoint
Backup as a Service for Veeam
|
2018.1.6
Released May 29, 2018 |
SovLabs Configuration
All
Ansible Tower
BlueCat DNS
F5
Red Hat Satellite
|
SovLabs Plugin New Install Instructions
- New SovLabs Plugin 2018.1.x Install (click the link to get directions)
SovLabs Plugin Upgrade Instructions
Prior to an upgrade
- Update the heap size in vRO Configurator to allow installation of the SovLabs Plugin. By default, the vRO Configurator heap size is set to 512m. We recommend setting it to 768m.
- Go to Instructions: Increase vRO Max Heap Size
- If upgrading from SovLabs Plugin 2017.X or earlier, Delete all license keys
- Login to the vRA tenant
- Click on the Items tab > SovLabs vRA Extensiblity Modules > SovLabs License
- For each SovLabs License item listed, perform the Delete License action
- If upgrading from SovLabs Plugin 2017.1.x or earlier, update the SovLabs DNS custom resource in vRA
- Login to the vRA tenant
- Click on Design > XaaS > Custom Resources
- Find and select SovLabs DNS
- Edit SovLabs DNS
- Update the Name field to be: SovLabs DNS configuration (is case sensitive)
- Click Finish
- Repeat for all vRA tenants
- Follow the remaining instructions: https://docs.sovlabs.com/vRA7x/2018.1.x/getting-started/sovlabs-plugin/upgrade/
Ansible Tower
*Only perform if SovLabs Ansible Tower module is licensed and is being upgraded from a previous SovLabs plugin
- SSH as root to your Ansible Tower server and add the deprov_workflow_id to the yaml file in your inventory directory:
- cd /
- ls -l | grep awx
- Find the directory that corresponds to to your SovLabs Ansible Tower Inventory Profile in vRA.
- cd /<your_vra_inventory_dir>
- Using a text editor (vi), edit the .yaml file and add the following line at the end of the yaml file: deprov_workflow_id: 03406239-dd1d-433a-ad69-90ebd680b07b
- chmod 644 <your yaml filename>.yaml
- chown awx:awx <your yaml filename>.yaml
- If you have more than one Ansible Tower Inventory Profile in vRA, repeat for each one.
- Replace the custom inventory script for your vRA inventory with the new one for SovLabs 4.x and above:
- Log into Ansible Tower as an admin user
- Click on Settings > Inventory Scripts
- Find the inventory script associated with your vRA inventory. If you’re not sure, go to Inventories and select your vRA inventory. Under Groups, click the Edit button, and you’ll see Source is “Custom Script”. Note the name in the Custom Inventory Script field. Then go back to Settings > Inventory scripts and edit the inventory script
- Edit the inventory script. thee first few lines should look like this below:#!/usr/bin/env python
# -*- coding: utf-8 -*-
”’
VMware VRealize Automation (vRA) Inventory Script
=======================
Retrieve information about virtual machines from a vRA, though a
vRO ( vRealize Orchestrator ) server.
- Replace the entire contents script of the script field with the contents of the new file referenced <here>.
- Click Save
- Test the new Inventory Script by syncing the Inventory in Ansible Tower.
- If the inventory sync fails, re-check all the steps above. If you re-check the steps and inventory sync still fails, please contact SovLabs support.
NOTE: Do not upgrade the vra.py prior to upgrading the plugin as the vra.py is NOT backwards compatible with prior versions of the SovLabs plugin. The vra.yaml however, is backwards compatible with prior versions of the plugin.
Perform a Rollback
*Only if necessary
- Download Instructions (same PDF as Creating a backup vRO Package in section Prior to an upgrade – Step 1)
For additional resources, please checkout: docs.sovlabs.com