Install and Configure AGILITY
Install AGILITY
The AGILITY application is compatible with most public cloud providers, as well as on-premises self-managed Kubernetes clusters. AGILITY can be installed:
as a single self-contained virtual machine (VM)
as a workload running on a Kubernetes cluster
For both options, it is possible to use either public clouds such as AWS, GCP, Azure, Oracle or rely on your own premises where you have either:
at least one server with hypervisor (VM case)
a pre-deployed Kubernetes cluster where you have administrative access
To install AGILITY as a VM, follow this path: Install AGILITY VM Cloud Image
To install AGILITY as a Kubernetes workload, follow this path: Install AGILITY on Kubernetes
Deployment is from a cloud manager (OpenStack, VmWare ESXi/vSphere or virt-manager for KVM).
Configure AGILITY
After installation of AGILITY, go through the configuration steps. Configuration tasks are from VM OS (after ssh).
Follow the list of configuration tasks if you have decided to install AGILITY as a stand-alone VM:
1. Set up ingress
AGILITY is typically provisioned with a fully qualified domain name (FQDN) of your choice. An FQDN is easier to remember and share. The A-record for the selected FQDN must be provisioned in a DNS that will be used by the AGILITY users. You can assign an IP address for AGILITY before deployment and generate the A-record. Alternatively (if you use dynamic IP addressing for VM instantiation), you can record the assigned IP address and create the A-record.
The other parameter of ingress is the certificate assigned for the FQDN. A certificate ensures that a website is legitimate and allows you to have the confidence of creating and inputting your credentials. AGILITY can support both a self-signed and a public certificate authority (CA)-signed certificate. For both options, you will first need to generate a certificate signing request (CSR) and then follow the CA’s process to obtain the certificate and the key. You can refer to Red Hat documentation on how to create a CSR and obtain the certificate along with its key. (https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html/securing_networks/creating-and-managing-tls-keys-and-certificates_securing-networks )
Once you have the FQDN, certificate, and its key, execute the following command to set up ingress for AGILITY.
agility ingress tls set --host example.com --cert tls.crt --key tls.key
If you need to re-apply the command, change parameters; you can reset the ingress settings with the following command:
agility ingress tls reset
For more information, see ingress on the CLI reference page.
2. Set up internet access using a Proxy
AGILITY communicates with three destinations outside your domain:
iad.ocir.io:443 (Oracle cloud image repository) for continuous upgrades
central-monitoring.b-yond.com:4317 for remote monitoring by B-Yond
AWS S3 us-west-2 for model quality monitoring (over port 443)
These can be enabled via an HTTPS proxy or via a firewall rule that allows traffic originating from AGILITY to the destination.
If the firewall option is chosen, this step is skipped. B-Yond provides you with a list of IPv4 subnets to be provisioned in your firewall.
If your preference is an explicit proxy, it will be set up during this step. Please make sure that AGILITY is able to communicate with the proxy server and will allow traffic originating from AGILITY’s IP address with the hosts listed above.
In order to provision the proxy, you need to obtain its IP address and port number. Once you have this information, it can be configured with the following command.
agility proxy set --http-proxy http://proxy.example.com --https-proxy http://proxy.example.com --no-proxy localhost,127.0.0.1
If you need to reset the configuration, use the following command.
For more information, see proxy on the CLI reference page.
3. Setup AGILITY License
Backup the current B-Yond License
Store the new B-Yond License on a temporary directory
Create the new B-Yond license kubernetes secret locally:
Replace the B-Yond license kubernetes secret:
Restart AGILITY Operator instance
4. Install AGILITY-Monitoring
AGILITY comes with a set of tools that are used for collecting performance metrics, logs, and traces which can be displayed in dashboards and can generate alarms and notifications. AGILITY-Monitoring is based on Grafana software stack, specifically Grafana, Prometheus, Loki, and Tempo. If the AGILITY is installed as a VM, you can enable AGILITY-Monitoring with a single command.
To uninstall monitoring, use the following command.
For more information, see monitoring on the CLI reference page.
5. Enable telemetry remote
This is enabled by default on new deployments. AGILITY forwards the metrics, logs, and traces to B-Yond’s central monitoring server (central-monitoring.b-yond.com:4317). This is essential for B-Yond to fulfill its SLA commitments to its customers. To interact with remote monitoring, use the following command.
The status of remote telemetry can be queried using the following command.
To disable remote telemetry (in an unlikely troubleshooting scenario), use the following command.
For more information, see telemetry on the CLI reference page.
6. Enable telemetry local
AGILITY forwards the metrics, logs, and traces to the local AGILITY-Monitoring that was activated in step 6. This is activated by a command similar to the one we used for enabling remote telemetry.
The status of local telemetry can be queried by the following command.
To disable local telemetry needs to be disabled (in an unlikely troubleshooting scenario), use the following command.
For more information, see telemetry on the CLI reference page.
Basic installation is now complete. You can now add your users and manage AGILITY settings.
You can also set up an ingestion pipeline and the AGILITY API (optional).
For information about the AGILITY Toolbox and Backup, go here.
Optional OS-related tasks are from VM OS (after ssh); these are DNS and NTP-related tasks.
Set up AGILITY export to customer OpenTelemetry Collector (optional)
AGILITY provides the capability to route telemetry data (logs, metrics, traces) to OpenTelemetry collectors. At this time, we support the export of AGILITY data using AWS ADOT collectors. Please review the AWS documentation on how to set up the collector. Once you have the collector listening and reachable from the AGILITY server(s), you may use the following commands to interact with this feature.
To enable telemetry customer:
To query the status of remote telemetry:
To disable remote telemetry (in an unlikely troubleshooting scenario):
For more information, see telemetry on the CLI reference page.
Set up pipeline (optional)
Use the settings in the AGILITY UI to set up and manage your ingestion pipelines..
Add AGILITY API (optional)
Use the AGILITY API to analyze network traces