diff --git a/README.md b/README.md index 8b8ca6ce..fb7b2ccf 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,17 @@ Backend for Resource Optimization Service +The Red Hat Insights resource optimization service enables RHEL customers to assess and monitor their public cloud usage and optimization. The service exposes workload metrics for CPU, memory, and disk-usage and compares them to resource limits recommended by the public cloud provider. +Currently ROS only provides suggestions for AWS RHEL instances. To enable ROS, a customer needs to perform a few prerequisite steps on targeted systems via Ansible playbook. +Underneath, ROS uses Performance Co-Pilot (PCP) to monitor and report workload metrics. + +## How it works + +![UML](http://www.plantuml.com/plantuml/png/dLLDRy964BtxLuosXrx0JTeRYb12Ggj8IK0uH4e3iXRl0AlOkzP-aA3K_xspsAv8YNC81sI_UVFz1YwjuyRv8e-ST3d2R9B0Y6Ulg0HCZSxGMgasy6UktwAIc3AJ9LSEjYiPeIAVFPGvTsjjYbYg7K7Qx6CC3_QJ0vFAoitMsOL2jP4AsOb_ZSS6hS_9UwNVWHtLm-2Nkn1Xb7kCW3wVmxV9eKw-K6LTlZRib5sdWZhLPsxed597WZk-uXRh6cv6BAAU-yFERWUmrTPHcdskkOWwUVtX5wCuXVh3ZhaCeENsCst-wo7ge5EwRvfzq8uC8HheDNHc_A3wIk_O02wEcnps5egvVObaOBwaYQ5W5O4Vh75bmTVkhSCYS0fqFCmrm75SjTHIcmDreLxerUUOIa6llnfjKshMSPLXYZkUU-waLlzS9C_9u_W-JHwl7iV3QabL28eiype8LTiwjSMvt-D2PaQpKB713KKvr6pxoAthdnzmyd588KA4hFH4U67NqtawUHhFajk_npUi1ooEsJAG2onefmVE_VX-Cdl-cYPreDnEqld3JMDEHy_fT3PEalbilEnLrRAgeczsTD5l1JY0lz01ppBjbOEcOrWRNS1icpQu1P9jZb7hHExTiGTmRP2QXjzWVbWVrBi2gTQQlY0vlFuivXHD45FOG_WfMSiyy4cp0WW7tkPQAAcEoMbPa-kayVUNT7hrtUBkFDmFrXhJLg6Da9gX1k6tSrU-MA4PziZElCc3QJwx0wT1w3SLpWAuoRPoX_LgaZzghhIfqK6WpdWCocVXb9eyzIZQpXimoxKN0Tj9WIRebRzP4bTpCJLK-j9f7L0fGYrI3AlZiymEon11uFy_FzBUyKfFP_bJeIpKbH14VK8Zr_jMiNJKm9K0RJRq69nELMjVfIgvuGMCzFkK2n7-VCxFpg9BLC8N-Ry0) + +## DB Schema +![UML](http://www.plantuml.com/plantuml/png/tLJDRjmW4BxxARXLgfeyG1L5KLJrqaEhvW4GXjdrDC1G63PritdtOfDQ45chdkk39Rxlcny-HdENM4NEpWwCR45y__eWxfL-16_4ftlne2TmQdWd9ZGWU0AH0l7ViyQeBGpbg4w4HeH8emMNn1Fo99G_MZ12HtfAuW30Gtf47rHKJbZqm7C0GP4d6WRmZ3mBLQ97rF84CI5vyJm8yVxr87rsukRcsvVRM_5HeEVXPOkBarHQK_QSQWoQNYh4rLNvlOeAoF1hGIaU9PfwRXC6Y0UAJdaDCaGwe8MQECs9mSdz_5rO14rnIVqZaH_Va9dHuc_5IBvHH0WKMHh5K5161ucL2uKfTnyXIZgiQPq3RzRWjDLFNADEAkf9nO9GALX4_YXhqssXR45EM4e1AxIfxJAX1Az62wQW8v7zK52c8BNo1arVfMSMhr0llA5SCbmsj3IGcE9yqTZ2jAvKhZNd_xQ-SR1cIfV6cqkqv-hXvvP5VmA_U5s7FMSq1TMMibbUuuG6OdS1WobODKklN7-pmq_ZEm1zujLNdaChRMrf40joC_UDqH6EIFvVVTGXoxL2wjkXFTI1AvVVOuwHSjWUeR5xUQUBowI-99hUDqWwObY7Qrio4LJgpubixZMQlC46QZhfnqvMGourLhtQ6OCI2aQESzFAccmJw0YhHF6Rjyd1x14lG_bgkIHUwFhwV6vtyKQTpmkrjmGkIlezqKdfUT-NuQu0sTa_) ## Getting Started This project uses poetry to manage the development and production environments.