diff --git a/userguide/assets/aviate/AviateOverview.pdf b/userguide/assets/aviate/AviateOverview.pdf new file mode 100644 index 000000000..786300f54 Binary files /dev/null and b/userguide/assets/aviate/AviateOverview.pdf differ diff --git a/userguide/assets/aviate/AviateOverview.png b/userguide/assets/aviate/AviateOverview.png new file mode 100644 index 000000000..e413bf5c4 Binary files /dev/null and b/userguide/assets/aviate/AviateOverview.png differ diff --git a/userguide/aviate/what_is_aviate.adoc b/userguide/aviate/what_is_aviate.adoc index 59d5ff9f3..e19208411 100644 --- a/userguide/aviate/what_is_aviate.adoc +++ b/userguide/aviate/what_is_aviate.adoc @@ -5,6 +5,18 @@ include::{sourcedir}/aviate/includes/aviate-card.adoc[] == About Aviate Aviate is designed to deliver a seamless billing experience that builds upon the core capabilities of Kill Bill. Our goal is to provide users with advanced features that cover the entire quote-to-cash lifecycle, including enhanced system observability, streamlined configurations, and valuable business intelligence. +== Overview + +Aviate is composed of two main components that work together to deliver a comprehensive billing management solution: + +* *Aviate Control Plane*: A browser-based interface that allows administrators to configure, monitor, and manage one or more Kill Bill deployments from a single, unified dashboard. It communicates with each Kill Bill instance through the Aviate plugin to provide system observability, configuration management, and business intelligence. + +* *Aviate Plugin*: A plugin installed on each Kill Bill instance that extends it with additional API endpoints. It acts as the bridge between the control plane and the Kill Bill core, enabling centralized management and real-time monitoring across all your deployments. + +The following diagram illustrates the relationship between these components: + +image::../assets/aviate/AviateOverview.png[Aviate Overview,width=50%,align=center] + == Aviate Plugin The Aviate plugin extends Kill Bill with additional endpoints. These endpoints are described in the *Aviate section* below. The plugin is available to users who have subscribed to our Flock plan, and it is installed by default on our `sandbox` deployment at https://aviate.killbill.io[aviate.killbill.io].