Basic

What is Federator.ai for OpenShift?

Federator.ai for OpenShift (Federator.ai for short) is ProphetStor’s Artificial Intelligence for IT Operations (AIOps) platform, helps enterprises optimize cloud resources, maximize application performance, save significant cost, without excessive over-provisioning or under-provisioning of resources, while meeting service-level requirements of their applications.

What are the main features of Federator.ai?

The main features include:

  • Recommendation​

Utilize resource usage prediction based on workload patterns to recommend the just-in-time fitted pod sizes for performance and cost optimization​

  • Automation​

Automate Kubernetes POD scaling with intelligence​

  • Performance​

Improve performance by more than 60% comparing to Kubernetes Native​

  • Planning​

Continuous recommendations for optimal resource planning​

  • Cost Analysis​

Explore resource cost and recommend fitted cloud configuration in Multicloud environments​

What is Federator.ai Operator?
Federator.ai consists of multiple components and services. Federator.ai Operator is created as an Operator for easier configuring, deploying, managing, and monitoring Federatot.ai components and services. It is certified as a level 5 Operator on OperatorHub.io.
What is “AlamedaService” CRD?
「AlamedaService」 is a Custom Resource Definition (CRD) defined by Federator.ai Operator. It is for users to specify, store and retrieve the configuration and settings of Federator.ai components by creating an 「AlamedaService」 CR.
What is “AlamedaScaler” CRD?
“AlamedaScaler” is a Custom Resource Definition (CRD) defined by Federator.ai. It is for users to specify the applications to be managed by Federator.ai by creating “AlamedaScaler” CRs. Auto-scaling tool and other parameters for the applications can also be defined in the “AlamedaScaler” CR.
What types of pod scaling are supported by Federator.ai?
Federator.ai supports vertical pod autoscaling (resizing resource requests and limits of pods) and horizontal pod autoscaling (scaling the number of pods) based on intelligent workload predictions and recommendations.
What OpenShift versions are supported by Federator.ai?
Federator.ai supports OpenShift 3.9, 3.11, and 4.x.
Does Federator.ai offer a free trial?
Federator.ai offers a 30-day free trial by default. Customers require to get a regular subscription keycode from ProphetStor to continue using Federator.ai after the 30-day trial period.

Installation

How to install Federator.ai for OpenShift?
For OpenShift 3.9 and 3.11, Federator.ai provides an installation script to help customers install Federator.ai by command line:
  1. Log in OpenShift as cluster admin
  2. Download the installation script from Github and run the script
    https://raw.githubusercontent.com/containers-ai/federatorai-operator/<version>/deploy/install.sh
  3. The script will take a few minutes to complete the installation
  4. Confirm Federator.ai pods are running properly by “oc get pods” command or by Federator.ai GUI
For OpenShift 4.x, Federator.ai can be installed from OperatorHub.io:
  1. Log on OpenShift 4.x administration console (GUI)
  2. Go to main menu, 「Home -> Projects」, and create a new project for installing Federator.ai
  3. Go to main menu, 「Operators -> OperatorHub」, and select 「Federator.ai」 Operator
  4. Click 「Install」 and click 「Subscribe」 when OpenShift prompts 「Create Operator Subscription」
  5. It will take a few minutes to complete the installation
  6. ai Operator will show up on 「Operators -> Installed Operators」 page
What is the minimum requirement of using Federator.ai?
Federator.ai requires to run in the OpenShift cluster which has at least 4 CPU cores and 16GB memory.
What Prometheus versions are required by Federator.ai?
Federator.ai leverages Prometheus to collect resource metrics. It can work with the default Prometheus deployment without additional configuration in OpenShift clusters. For non-OpenShift clusters, the minimum Prometheus version required by Federator.ai is 6.4.4.

Troubleshooting

Why do some Federator.ai pods stay in “Pending” status?
Federator.ai gets workload metrics from Prometheus and stores processed result in InfluxDB databases. If Federator.ai fails to connect to Prometheus or InfluxDB, Federator.ai pods will wait for the availability of Prometheus and InfluxDB, and stay in “Pending” status. You will need to check the health and connectivity of Prometheus and “alameda-influxdb” pod. Federator.ai pods may also fail to start due to the shortage of CPU or memory resource. You can use “oc describe pod <pod_name> -n <namespace>” to get some detailed runtime information of the pod.
Why cannot I see my application shows up in Federator.ai GUI?
Applications to be managed by Federator.ai are defined in 「AlamedaScaler」 CRs. Federator.ai discovers and identifies the application pods by using “namespace” and “label” specified in 「AlamedaScaler」 CR, 「metadata.namespace」 and 「spec.selector.matchLabels」 field. You can use 「oc get <deploy|dc|statefulset> -n <namespace> –show-labels」 to confirm the labels on application pods match the labels defined in 「AlamedaScaler」 CRs.
Why cannot I see any CPU and memory metrics in Federator.ai GUI?
Federator.ai gets CPU and memory metrics from Prometheus. If Federator.ai GUI displays none of CPU and memory metrics, the cause would be Federator.ai is unable to connect to Prometheus. In OpenShift environment, you can check the health status of Prometheus in “openshift-monitoring” namespace by “oc get pods -n openshift-monitoring”, or by OpenShift administration console, “Application Console -> openshift-monitoring -> Overview -> prometheus-k8s”.
Why cannot I see the predictions and recommendations for my applications in Federator.ai GUI?
Federator.ai may take from a few seconds to a few minutes to make the predictions depending on the number of workloads to predict and the computation resources Federator.ai can have. You may first check the License Status in Federator.ai GUI, “Home -> Dashboard” page. If the License Status is “No Keycode”, “Expired” or “Invalid”, Federator.ai cannot provide the predictions and recommendations without a valid license. You will need to contact ProphetStor to get a subscription keycode and apply to Federator.ai. The second is to check the health status of Federat.ai AI engine pods, “alameda-ai-xxxx”. If they are ready and running normally, the predictions and recommendations should show up in Federator.ai GUI later.
What should I do if License Status is “Expired”?
Federator.ai offers a 30-day trial. Once the trial period expired, you will need to contact ProphetStor to get a subscription keycode. ProphetStor Support will provide the instructions of applying the subscription keycode to your Federator.ai.
What is the disadvantage of using ephemeral storage for Federator.ai?
In addition to persistent storage, pods may use local ephemeral storage for transient temporary operations. The life cycle of ephemeral storage is closely related to the life cycle of the pod. i.e. once the pod gets restarted, the data stored in the ephemeral storage is lost. Ephemeral storage may be used for conveniently building up an environment for demo or for a quick trial of Federator.ai. For production environment, it is always recommended to use persistent storage for Federator.ai.
Share