Template name
ACS-ECS-BulkyInstallLogAgent - Batch installs the Simple Log Service plugin
Template description
Installs Logtail on multiple Elastic Compute Service (ECS) instances at a time.
Template type
Automated
Owner
Alibaba Cloud
Input parameters
Parameter | Description | Type | Required | Default value | Limit |
targets | Target instance | Json | Yes | ||
regionId | The region ID. | String | No | {{ ACS::RegionId }} | |
action | Operation Type | String | No | install | |
overwrite | Overwriting LogAgent | Boolean | No | False | |
rateControl | Concurrent Task Execution Rate | Json | No | {'Mode': 'Concurrency', 'MaxErrors': 0, 'Concurrency': 10} | |
OOSAssumeRole | The Resource Access Management (RAM) role that is assumed by CloudOps Orchestration Service (OOS). | String | No | "" |
Output parameters
Parameter | Description | Type |
commandOutput | String |
Permission policy that is required to execute the template
{
"Version": "1",
"Statement": [
{
"Action": [
"ecs:DescribeInstances",
"ecs:DescribeInvocationResults",
"ecs:DescribeInvocations",
"ecs:RunCommand"
],
"Resource": "*",
"Effect": "Allow"
},
{
"Action": [
"oos:GetApplicationGroup"
],
"Resource": "*",
"Effect": "Allow"
}
]
}
Details
For more information, see ACS-ECS-BulkyInstallLogAgent.yml at GitHub.
Template content
FormatVersion: OOS-2019-06-01
Description:
en: Use this template to install the Simple Log Service agent on ECS instances in batches.
zh-cn: Use this template to install the Simple Log Service agent on ECS instances in batches.
name-en: ACS-ECS-BulkyInstallLogAgent
name-zh-cn: Batch Install Simple Log Service Agent
categories:
- run_command
Parameters:
regionId:
Type: String
Label:
en: Region ID
zh-cn: Region ID
AssociationProperty: RegionId
Default: '{{ ACS::RegionId }}'
action:
Type: String
Label:
en: Action Type
zh-cn: Action Type
AllowedValues:
- install
- upgrade
- uninstall
Default: install
overwrite:
Description:
en: 'Specifies whether to overwrite the existing LogAgent on an instance. By default, the existing LogAgent is not overwritten.'
zh-cn: 'Specifies whether to overwrite the existing LogAgent on an instance. By default, the existing LogAgent is not overwritten.'
Label:
en: Overwrite LogAgent
zh-cn: Overwrite LogAgent
Type: Boolean
Default: false
targets:
Type: Json
Label:
en: Target Instances
zh-cn: Target Instances
AssociationProperty: Targets
AssociationPropertyMetadata:
ResourceType: 'ALIYUN::ECS::Instance'
RegionId: regionId
rateControl:
Label:
en: Concurrency Rate
zh-cn: Concurrency Rate
Type: Json
AssociationProperty: RateControl
Default:
Mode: Concurrency
MaxErrors: 0
Concurrency: 10
OOSAssumeRole:
Label:
en: RAM Role for OOS to Assume
zh-cn: RAM Role for OOS to Assume
Type: String
Default: ''
RamRole: '{{ OOSAssumeRole }}'
Tasks:
- Name: getInstance
Description:
en: Retrieves the specified ECS instances.
zh-cn: Retrieves the specified ECS instances.
Action: 'ACS::SelectTargets'
Properties:
ResourceType: 'ALIYUN::ECS::Instance'
RegionId: '{{ regionId }}'
Filters:
- '{{ targets }}'
Outputs:
instanceIds:
Type: List
ValueSelector: 'Instances.Instance[].InstanceId'
instanceInfos:
Type: List
ValueSelector: '.Instances.Instance[] | {"osType":.OSType, "instanceId":.InstanceId}'
- Name: runCommand
Action: 'ACS::ECS::RunCommand'
Properties:
commandContent:
'Fn::If':
- 'Fn::Equals':
- 'Fn::Jq':
- First
- '.|map(select(.instanceId == "{{ ACS::TaskLoopItem }}").osType)[]'
- '{{ getInstance.instanceInfos }}'
- linux
- |-
set -e
installLogAgent(){
message=`./logtail.sh install {{ regionId }} 2>/dev/null`
if [ $? = 0 ]; then
cat /usr/local/ilogtail/app_info.json
else
echo "$message"
exit 1
fi
}
wget http://logtail-release-{{ regionId }}.oss-{{ regionId }}-internal.aliyuncs.com/linux64/logtail.sh -q -O logtail.sh;
if [ $? != 0 ]; then
echo "Failed to download logtail_installer, Please check your network service."
exit 1
fi
chmod 755 logtail.sh;
if [ "{{action}}" = "install" ]; then
wetherOverwriteAgent="{{overwrite}}"
if [ $wetherOverwriteAgent = "true" ]; then
installLogAgent
else
logVersionPath="/usr/local/ilogtail/app_info.json"
if [ -f "$logVersionPath" ]; then
echo 'LogAgent already exists.'
exit 0
else
installLogAgent
fi
fi
elif [ "{{action}}" = "upgrade" ]; then
message=`./logtail.sh upgrade 2>/dev/null`
if [ $? = 0 ]; then
cat /usr/local/ilogtail/app_info.json
else
echo "$message"
exit 1
fi
else
./logtail.sh uninstall
fi
- |-
function installLogAgent
{
.\logtail_installer.exe install {{ regionId }}
if (! $?)
{
echo "Failed to install Logtail or start the service. Please try again."
exit 1
}
echo 'Install complete.'
}
$action="{{ action }}"
$pathExistOrNot = Test-Path -Path "C:\Users\Administrator\OOSPackages"
if ($pathExistOrNot)
{
cd C:\Users\Administrator\OOSPackages
} else
{
mkdir C:\Users\Administrator\OOSPackages
cd C:\Users\Administrator\OOSPackages
echo 'File created.'
}
$client = new-object System.Net.WebClient
$client.DownloadFile('http://logtail-release-{{ regionId }}.oss-{{ regionId }}-internal.aliyuncs.com/win/logtail_installer.zip', 'C:\Users\Administrator\OOSPackages\logtail_installer.zip')
if (! $?)
{
echo "Failed to download logtail_installer. Please check your network service."
exit 1
}
Expand-Archive -Force -Path C:\Users\Administrator\OOSPackages\logtail_installer.zip -DestinationPath C:\Users\Administrator\OOSPackages
switch($action)
{
"install" {
$wetherOverwriteAgent = "{{overwrite}}"
if ($wetherOverwriteAgent -eq "true")
{
installLogAgent
} else
{
if ([Environment]::Is64BitOperatingSystem)
{
$logAgentPath = Test-Path -Path "C:\Program Files (x86)\Alibaba\Logtail"
if ($logAgentPath)
{
echo 'LogAgent already exists.'
exit 0
} else
{
installLogAgent
}
} else
{
$logAgentPath = Test-Path -Path "C:\Program Files\Alibaba\Logtail"
if ($logAgentPath)
{
echo 'LogAgent already exists.'
} else
{
installLogAgent
}
}
}
}
"upgrade" {
.\logtail_installer.exe uninstall
.\logtail_installer.exe install {{ regionId }}
echo 'Upgrade complete.'
}
"uninstall" {
.\logtail_installer.exe uninstall
echo 'Uninstall complete.'
}
}
$allFile = Get-ChildItem -Path "C:\Users\Administrator\OOSPackages"
foreach($file in $allFile)
{
Remove-Item $file.FullName -Recurse -Force
}
cd ..
del C:\Users\Administrator\OOSPackages
instanceId: '{{ ACS::TaskLoopItem }}'
regionId: '{{ regionId }}'
commandType:
'Fn::If':
- 'Fn::Equals':
- 'Fn::Jq':
- First
- '.|map(select(.instanceId == "{{ ACS::TaskLoopItem }}").osType)[]'
- '{{ getInstance.instanceInfos }}'
- linux
- RunShellScript
- RunPowerShellScript
Loop:
Items: '{{ getInstance.instanceIds }}'
RateControl: '{{ rateControl }}'
Outputs:
commandOutputs:
AggregateType: 'Fn::ListJoin'
AggregateField: commandOutput
Outputs:
commandOutput:
Type: String
ValueSelector: invocationOutput
Outputs:
commandOutput:
Type: String
Value: '{{ runCommand.commandOutputs }}'
Metadata:
ALIYUN::OOS::Interface:
ParameterGroups:
- Parameters:
- action
- overwrite
Label:
default:
zh-cn: Configure Parameters
en: Configure Parameters
- Parameters:
- regionId
- targets
Label:
default:
zh-cn: Select Instances
en: Select Instances
- Parameters:
- rateControl
- OOSAssumeRole
Label:
default:
zh-cn: Advanced Options
en: Advanced Options