cu-lab

This is not done yet.

Summary

This repository leverages AutomatedLab to easily configure a ControlUp environment on Hyper-V. The lab structure is defined via a JSON configuration file.

For quick setup, please refer to the Quick Start section.

Requirements

To set up a full CU Lab, you will need the following:

• ControlUp Organization - See Create Your ControlUp Organization
• Hyper-V
• DEX API Key - See Create and Manage API Keys
• Depending on the lab configuration, you will need:
  • Windows Server
  • Windows 11
• A valid lab configuration JSON file.
• ControlUp Console
• EdgeDX Agent Manager MSI
• Scoutbees Custom Hive

JSON Configuration

New-CULab.ps1 dynamically adds machines to your lab based on the provided JSON configuration file. This is an example configuration file for a lab with 1 DC, 1 monitor, 1 Hive, 1 EdgeDX device on the same server

{
    "Description": "This is an example configuration file for a lab with 1 VM hosting all CU services using 4.5 GB of RAM",
    "LabName": "MacroCULab",
    "DriveLetter": "C",
    "OrgName": "",
    "DEXKey": "",
    "DEVREGCODE": "",
    "TENANT": "",
    "ScoutBeesKey": "",
    "Domains": [
        {
            "Name": "macro.local",
            "Username": "Administrator",
            "Password": "MySecurePassword123!",
            "NetworkBase": "192.168.103",
            "Subnet": "192.168.103.0/24",
            "NatSubnet": "192.168.104.0/24",
            "NatAddressBase": "192.168.104",
            "NatIPAddress": "192.168.104.10"
        }
    ],
    "VirtualMachines": [
        {
            "Name": "monitor",
            "OS": "Windows Server 2022 Standard Evaluation (Desktop Experience)",
            "RAM": "4831838208",
            "CPU": "2",
            "DomainName": "macro.local",
            "IpAddress": "192.168.103.10",
            "Roles": [ "RootDC", "Routing" ],
            "RTDX": true,
            "EdgeDX": true,
            "Hive": true,
            "Monitor": true
        }
    ]
}

Root Properties:

• Description: Optional but provides a brief description of the lab.
• LabName: Identifies the lab, creates separate network adapters, etc.
• OrgName: Your RTDX Organization name (case-sensitive).
• DriveLetter: Specifies the drive for storing VMs and LabSources folder.
• DEXKey: See Create and Manage API Keys.
• DEVREGCODE: See EdgeDX Agent.
• ScoutbeesKey: See Silent Install for Synthetic Monitoring Custom Hives.
• TENANT: See EdgeDX Agent.
• Domains: Array of domains in the lab.
• VirtualMachines: Array of virtual machines to be created.

Virtual Machines Properties:

• Name: Hostname of the VM.
• OS: Retrieved from AutomatedLab - Get-LabAvailableOperatingSystem.
• RAM: RAM assigned to the VM (in bytes).
• CPU: CPU count assigned to the VM.
• DomainName: New domain name.
• Roles: Read more about roles here.
• RTDX: If true, installs the RTDX Agent via self-registration.
• EdgeDX: If true, installs the EdgeDX Agent with configuration properties.
• Hive: If true, installs the Scoutbees Custom Hive software.
• Monitor: If true, installs ControlUp Monitor using ControlUp.Automation.
• IpAddress: Static IP address assigned to the VM.

Domain Properties:

• Name: Name of the new domain
• Username: Specifies the username of the domain admin
• Password: Specifies the password of the domain admin
• NetworkBase: Base IP for your domain network.
• Subnet: Main subnet for domain traffic.
• NatSubnet: NAT-based subnet used for domain routing.
• NatAddressBase: Base NAT address for domain traffic.
• NatIPAddress: IP address used for NAT translation.

Note: The script assumes a routing role is included in the configuration. Note: The RootDC VM has to be at the start of the VM array

More examples can be found in ConfigExamples

Quick Start

To quickly set up a lab with Windows Server 2022, Windows 11 agent, RTDX, EdgeDX, Scoutbees, and Active Directory, follow these steps:

1. Download the repository.
2. Copy ./ConfigExamples/MacroPlusCULab.json to the root of the repo.
3. Update the JSON file:
   • Set values for DEXKey, DEVREGCODE, TENANT.
   • Replace the DomainName for each VM with your desired domain name.
4. If you don't have Hyper-V installed, run the following command in an elevated PowerShell window:
   Enable-WindowsOptionalFeature -FeatureName 'Microsoft-Hyper-V' -Online -All and reboot.
5. Download Windows 11 from Microsoft.
6. Download Windows Server 2022 from Microsoft.
7. Download the ControlUp Console from ControlUp.
8. Download the EdgeDX Agent Manager MSI from your tenant.
9. Download the Scoutbees Custom Hive from your ControlUp dashboard.
10. Open an elevated PowerShell window, navigate to the repository folder, and run:
    . ./Publish-CULab.ps1 -ConfigPath ./MacroPlusCULab.json

Note: The setup may take up to an hour depending on your device. It will be faster for new labs since the OS images are built.

Once the script is done, you should have entries in your host file for the new VMs. So you can RDP into them or open Hyper-V Manager and connect to them that way.

To add the host and hyperv connection:

1. Add the lab domain adapter ip and name to the hostfile on the monitor, example: 192.168.12.1 ISAIAHD-WIN-US
2. Manually install the CUAgent and set the inbound registry key Set-ItemProperty -Path "HKLM:\SOFTWARE\Smart-X\ControlUp\Agent\Communication" -Name "Outbound" -Value 0
3. Restart the Agent
4. Launch the console on the monitor
5. Add the host by name to the org tree
6. Check the monitor data sources for the connection. Should be available in DEX

For more information, see the AutomatedLab documentation.

Scoutbees: This only installs Scoutbees, you will need to add the hive key manually.

References

• Learn about Controlup
• AutomatedLab Documentation
• ControlUp Console Download
• EdgeDX Agent Installation
• Scoutbees Custom Hive Installation
• Hyper-V Requirements