Overview
This guide provides step-by-step instructions on installing and using Composer, an automation platform by Orchestral.ai. Learn about system prerequisites, installation, key features, and how to verify your Composer setup. For additional help, visit Orchestral.ai and contact the Client Development Team.
Prerequisites
System Requirements
Component | Minimum Requirements | Recommended EC2 |
---|---|---|
CPU | Dual Core | Quad Core |
RAM | >2GB | >16GB |
Storage | >10GB | >40GB |
Instance | - | m5.xlarge |
Supported Operating Systems
- Ubuntu 18.04 Bionic (64-bit)
- RHEL 8 and CentOS 8
- RHEL 7 and CentOS 7
- Amazon AWS
- Red Hat Enterprise Linux (RHEL) 8 (HVM)
Pre-Installation Requirements
- Internet access for downloading software packages
- Composer license from Orchestral.ai (30-day trial available for new users)
- sudo access on the server
- curl installed
- Open ports 80 and 443 for the Web UI
Commands to Open Ports
For Ubuntu:
sudo ufw enable
sudo ufw allow ssh
sudo ufw allow 80,443/tcp
sudo ufw status
For CentOS/RHEL:
sudo firewall-cmd --zone=public --permanent --add-port=80/tcp
sudo firewall-cmd --zone=public --permanent --add-port=443/tcp
sudo firewall-cmd --reload
sudo firewall-cmd --zone=public --list-ports
Installing Composer
Step 1: Enable License
Create a directory and place your license file:
mkdir -p /etc/st2
mv license /etc/st2/license
Step 2: Install Composer
Run the installation script with your credentials:
curl -sSL https://pkg.orchestral.ai/public/installers/raw/versions/latest/orch-st2-install.sh | bash -s -- --user=<USER> --password=<PASSWORD> --license=/etc/st2/license
Example:
curl -sSL https://pkg.orchestral.ai/public/installers/raw/versions/latest/orch-st2-install.sh | bash -s -- --user=myUser --password=myPassword --license=/etc/st2/license
Note: If using special characters in passwords, escape them with a backslash.
Verifying Composer Installation
Once installation is complete, verify the setup:
Login to Composer:
st2 login <username>
Check Installed Packs:
st2 pack list
- Access the Web UI:
- Find your server IP using
ifconfig
- Login using the credentials you set during installation
- Navigate to Actions to view installed packs
- Find your server IP using
Understanding Composer Components
1. Sensors
- Detect changes in monitored environments (e.g., API monitoring, webhook triggers).
- Emit triggers when conditions are met.
2. Triggers
- Define events that initiate automation workflows.
- Example: If a server is low on storage, a trigger notifies Composer.
3. Rules
- Connect triggers to actions.
- Example: A rule can detect low disk space and trigger an automated response.
4. Actions
- Individual automation tasks executed based on rules.
- Example: Running a script to restart a failed service.
5. Workflows
- Series of actions executed sequentially or in parallel.
- Example: A workflow could scale up cloud resources when CPU usage is high.
6. Packs
- Collections of sensors, triggers, rules, and workflows.
- Open-source packs can be installed from StackStorm Exchange.
Contact Us
For assistance with installation, demos, or feature inquiries, reach out to:
- Email: info@orchestral.ai
- Website: Orchestral.ai
We look forward to helping you automate your workflows with Composer!
Please check the document below for additional information.