Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

style

...

none

Navigation
Anchor
Navigation-Steps
Navigation-Steps

1. Log in to

...

Cloudaware account Admin.

...

Select Admin under your username in the upper right corner.

...

2. Find Breeze in the list of DevOps

...

integrations. Click 1Configured.

...

3. Select the installer file based on OS version.

...

Manual Installation

Check the Navigation section to get the Breeze agent installer file.

...


Linux Installation Verification:

1) . Check the cronjob or the systemd timer status:

Code Block
cat /etc/cron.d/breeze-agent

2) OR

Code Block
systemctl status breeze-agent.timer
  1. Run the agent manually as root-user or using sudo:

Code Block
cd /opt/breeze-agent
./app.sh

3) Check the log file var/log/breeze-agent.log. It should be used only by the cronjob. When the agent is run manually, the log data will be printed to STDOUT.

Windows
Anchor
breeze-manual-windows
breeze-manual-windows

1. Download the agent installer (select Windows Agent version)

...

Windows Installation Verification:

1) . Open the Task Scheduler (Start : Start → Control Panel → Administrative tools → Task Scheduler).

2) . Ensure that the scheduled task Breeze Agent has been created.

3) . Run the job manually. Check the log file C:\Program Files\Breeze\agent.log.

...

Check the Navigation section to get the Breeze agent installer file.

AWS Elastic Beanstalk

You can install Install Breeze agent on AWS Elastic Beanstalk using .ebextension configuration files. In this example, we will use EB CLI to deploy a new configuration.

...

Code Block
eb deploy

AWS EC2 User Data Script

You can install Install Breeze agent on AWS EC2 instances using 'EC2 instance user data' during the initial launch of an instance. The script involves the following steps:

...

2. Unpack the installer (for Linux OSs)

3. Run the installer

Since the installer file is customer-related and may contain vulnerable data, it may be challenging to define a secure location where it will be placed and accessible for EC2 instance. Upload the installer file into the location where it will be publicly available for short duration. In our the use case below, we will generate a presigned pre-signed AWS S3 object URL for the S3 bucket storing the installer file. 

...

Prepare the user data script and launch the instance
Once agent installers are ready, add the script to EC2 instance user data to install Breeze agent.

Replace the presigned pre-signed URL in the script samples below by the one you generated and insert it into the User data section when launching the instance.

...

Code Block
#!/bin/bash

URL='<presigned URL to agent installer in your S3 bucket>'

# download agent installer
curl $URL -o /tmp/breeze-agent.tgz

# unpack agent installer
sudo tar -xf /tmp/breeze-agent.tgz -C /tmp

# install agent
sudo /tmp/breeze-agent/install.sh


Windows:

Code Block
<powershell>
function New-TemporaryDirectory {
  $parent = [System.IO.Path]::GetTempPath()
  [string]$name = [System.Guid]::NewGuid()
  New-Item -ItemType Directory -Path (Join-Path $parent $name)
}

$url = "<presigned URL to agent installer in your S3 bucket>"
$tmp_dir = New-TemporaryDirectory
$agent_sfx = "$tmp_dir\breeze-agent.exe"

# download agent installer
(New-Object System.Net.WebClient).DownloadFile($url, $agent_sfx)

# install agent
Start-Process $agent_sfx -ArgumentList '-gm2' -NoNewWindow -Wait

# clean up
Remove-Item "$tmp_dir" -recurse
</powershell>

Windows must have PowerShell preinstalled. This script will work for all Windows Server versions starting 2012 R2 and newer.

...

AWS Systems Manager Distributor

You can install Install Breeze agent on AWS EC2 instances using AWS Systems Manager Distributor.

...

Note

Ensure that the script files have correct lines line breaks, namely LF (\n == 0x0A) on Linux and CRLF (\r\n == 0x0D 0x0A) on Windows.

...

To install Breeze agent via SCCM, we recommend using use a PowerShell script that will download the agent installer to a target machine and install it.

...

Code Block
- hosts: linux
  vars:
    linux_agent: linux-breeze-agent.tgzagent: linux-breeze-agent.tgz

Installation via Azure VM extension (Run Command)

Check Navigation to get the agent installer file. Right click the file to select 'Save Link As'. Save the link*.

*The saved link should be in the following format: breeze-agent.XXXXXXXXXXXXXXXXXXXXXXX.cloudaware.20200922.0.x86_64.linux.tgz (for Linux) or breeze-agent.XXXXXXXXXXXXXXXXXXXXXXX.cloudaware.20210707.0.windows.signed.exe (for Windows).Please note that the copied installer link is valid for one hour only.

Save the installer file in a secure location. Ensure the VM can route to that endpoint via HTTP protocol (for example, Azure Storage or an internal file server).

Linux:

1. Create URL for accessing the agent (in case of Azure Storage, the URL has the following format: https://breezedeploy.blob.core.windows.net/agent/breeze-agent.XXXXXXXXXXXXXXXXXXXXXXX.cloudaware.20200922.0.x86_64.linux.tgz)

2. Replace AGENT_DISTRO_URL placeholder in AGENT_URL= in the script below with the resulting URL:

Code Block
#!/bin/bash
AGENT_URL="AGENT_DISTRO_URL"
function echo_error {
  echo $@
  exit 1
}
BIN_CURL=$(which curl 2>/dev/null | grep -v 'not found')
BIN_WGET=$(which wget 2>/dev/null | grep -v 'not found')
if [ -n "${BIN_CURL}" ]; then
  CMD_DL="$BIN_CURL -o agent.tgz $AGENT_URL 2>/dev/null || echo_error \"download failed (curl)\""
elif [ -n "${BIN_WGET}" ]; then
  CMD_DL="$BIN_WGET -O agent.tgz $AGENT_URL 2>/dev/null || echo_error \"download failed (wget)\""
else
  echo_error "neither curl nor wget was found"
fi
echo "Downloading..."
DIR_TMP=`mktemp -d`
cd $DIR_TMP
eval "$CMD_DL"
echo "Installing..."
tar xf agent.tgz
cd breeze-agent
sudo ./install.sh > /dev/null
rm -fR $DIR_TMP
echo "Done"

3. Log in to Microsoft Azure Portal and select the VM in question. Select Operations → 'Run command' on the left.

4. Select RunShellScript, paste the resulting script from p.2 in the pop-up window on the right. Click Run.

5. Ensure the response has the following format:

Code Block
Enable succeeded: 
[stdout]
Downloading...
Installing...
Done

[stderr]

Windows:

1. Create URL for accessing the agent (in case of Azure Storage, the URL has the following format: https://breezedeploy.blob.core.windows.net/agent/breeze-agent.XXXXXXXXXXXXXXXXXXXXXXX.cloudaware.20210707.0.windows.signed.exe)

2. Replace AGENT_DISTRO_URL placeholder in $url = in the script below with the resulting URL:

Code Block
$url = "AGENT_DISTRO_URL"
[Net.ServicePointManager]::SecurityProtocol += [System.Net.SecurityProtocolType]::Tls12
function Exit-WithError($e, $c) { Write-Host "Error:" $(If ($e.Exception.InnerException) {$e.Exception.InnerException.Message} Else {$e.Exception.Message}); Exit $c }
Write-Host "Downloading..."
$dir_tmp = New-Item -ItemType Directory -Path ([IO.Path]::Combine([System.IO.Path]::GetTempPath(), [System.Guid]::NewGuid()))
$agent_distro = "$dir_tmp\agent.exe"
try { (New-Object System.Net.WebClient).DownloadFile($url, $agent_distro) } catch [System.Net.WebException] { Exit-WithError $_ 1 }
Write-Host "Installing..."
try { Start-Process $agent_distro -ArgumentList '-gm2' -NoNewWindow -Wait } catch { Exit-WithError $_ 2 }
Remove-Item $dir_tmp -Recurse -Force
Write-Host "Done"

More about running scripts on Azure VM here.

Installation to Microsoft Intune

1. Install a Breeze agent on a Windows device (as described here).

2. In the file C:\Program Files\Breeze\etc\tags write preferred.descriptor=intune
This step is also applicable if the Breeze agent has already been installed on the device.

3. When creating a new web interface deployment, Intune requires an uninstall script. The Breeze uninstall script is shipped as a part of Windows Breeze Installer. When prompted for a path to the uninstall script, specify C:\Program Files\Breeze\uninstall.bat

Installation on VM managed by vCenter

...

(deprecated)

Since VM ID cannot be used as a unique identifier across multiple vCenter Servers, you should perform additional configuration when installing Breeze on vCenter VMs. Once the agent is installed:

...

Code Block
vmware.vmid=vm-123456
vmware.service.uuid=1111-22-33-44-555555

WHERE

vmware.vmid - moRef ID (vm-123456 is a placeholder)

...

Add the next line before the string ruby  ruby ./app.rb:

Code Block
export http_proxy="http://1.2.3.4:3128"

ruby ./app.rb # this line already exist in file

...

Add the next line before the string ruby app.rb:

Code Block
app.rb >> agent.log 2>&1:
set http_proxy=http://1.2.3.4:3128

ruby app.rb >> agent.log 2>&1