diff --git a/modules/ROOT/images/omni-pillars.png b/modules/ROOT/images/omni-pillars.png new file mode 100644 index 000000000..31520df6a Binary files /dev/null and b/modules/ROOT/images/omni-pillars.png differ diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 3c74d7a30..185b10a54 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -1,6 +1,8 @@ .xref:index.adoc[Anypoint Platform] * xref:index.adoc[Documentation] -* xref:mulesoft-omni.adoc[MuleSoft Omni] +* xref:omni-overview.adoc[] + ** xref:omni-start-home.adoc[] + ** xref:omni-compare.adoc[] * xref:learning-map-mulesoft-ai.adoc[] * xref:learning-map-agent-fabric.adoc[Agent Fabric] ** xref:agent-fabric-release-notes.adoc[] diff --git a/modules/ROOT/pages/mulesoft-omni.adoc b/modules/ROOT/pages/mulesoft-omni.adoc deleted file mode 100644 index 3f2592aab..000000000 --- a/modules/ROOT/pages/mulesoft-omni.adoc +++ /dev/null @@ -1,89 +0,0 @@ -= Get Started with MuleSoft Omni -:page-aliases: -:page-article-style: learning-map - -MuleSoft Omni pairs an AI-powered assistant with one place to manage your portfolio. The assistant helps you connect and tune integrations across your ecosystem. It shows how agents, APIs, gateways, MCP servers, and LLMs fit together, where to apply governance, and how to act on performance and cost signals. Omni walks you through setup so you keep integrations compliant and visible without switching tools. - -Omni centers the UI on the jobs you do. Under *Portfolio* in the left navigation, you get a catalog for each asset type you manage: agents, MCP servers, LLMs, APIs, and gateways. For each asset, you move through overview, instances, governance, and observability on one path. Cross-cutting governance and monitoring sit under *Governance* and *Observability*. Environment-wide controls sit under *Platform*. - -Portfolio, Governance, Observability, and Platform are the four areas where you work with your portfolio. - -From sign-in through *Home* and your catalogs, you open each asset and use its detail tabs in one place. - -== End-to-End Journey: Working in MuleSoft Omni - -This walkthrough follows the path you take in Omni so you can grow and tune your AI portfolio across agents, APIs, gateways, MCP servers, and LLMs. - -. *Signing in* -+ -Sign in to Omni with your credentials. You land on *Home*. -. *Opening catalogs* -+ -Under *Portfolio* in the main navigation, open the catalog you need: *Agents*, *MCP Servers*, *LLMs*, *APIs*, or *Gateways*. -. *Opening an asset and using Overview* -+ -The catalog lists assets in a clear layout. Select one to open its detail page. Start on *Overview* for a summary and portfolio context. Graphs and fields differ by asset type. -. *Reviewing instances and deployments* -+ -On *Agents*, *MCP Servers*, *LLMs*, and *APIs*, open the *Instances* tab to review deployments, environment, version, status, gateway protection, and configuration or endpoint detail for that type. Gateways don't include an *Instances* tab. -. *Checking performance* -+ -On *Monitoring*, review live metrics such as latency, invocation counts, and error rates when Omni shows runtime data. What you see depends on how gateways expose the asset. -. *Managing policies and governance* -+ -On the *Policies* tab, review which governance policies apply and adjust runtime policy where Omni lets you. For gateways, use *Governance* instead. -. *Reading conformance* -+ -On *Agents*, *APIs*, and *MCP Servers*, open *Conformance Report* for rule-level compliance, violations, warnings, and conformance status. For gateways, use *Governance*. -. *Reviewing versions* -+ -Open *Versions* when you need change history for the asset. -. *Getting help or sharing feedback* -+ -Send feedback to the support team or open *Help & Support* for documentation and contact options. - -== What You Can Do in Each Area - -The left navigation groups work into *Portfolio*, *Governance*, *Observability*, and *Platform*. - -[#portfolio#agents] -=== Portfolio - -image::reuse::lm_start.png[] - -*Portfolio* lists your AI portfolio in five catalogs: *Agents*, *MCP Servers*, *LLMs*, *APIs*, and *Gateways*. Browse each list, compare performance and cost, inspect configuration, and trace how assets connect. In any catalog, select *Add* to register or connect another asset of that type. Omni guides you through the flow so the new entry appears with the rest of your portfolio and you can govern and observe it the same way. - -Each catalog targets one asset type: - -* *Agents*: task-focused runtimes. Inspect status, cost, latency, skills, and related detail. -* *MCP Servers*: Model Context Protocol (MCP) endpoints that agents and tools call for context and capabilities. -* *LLMs*: model connections your flows depend on. -* *APIs*: APIs you integrate across agents and services. -* *Gateways*: gateways that front traffic where Omni applies routing, policies, and focused monitoring. - -[[governance]] -=== Governance - -image::reuse::lm_explore_1.png[] - -Use *Governance* for compliance, security, and spend discipline. Open *Cost Management* and *Governance Strategies* to steer budgets and policy posture. Apply and manage policies across APIs, agents, and related portfolio assets so you meet requirements and protect data. Track compliance with reports and rule analysis, close gaps, and stay audit-ready. Where Omni supports automation, use it to keep policy rollout consistent across instances. - -[[observability]] -=== Observability - -image::reuse::lm_analyze_1.png[] - -Use *Observability* for runtime health and day-to-day operations. Open *Dashboards*, *Reports*, and *Notifications* to watch latency, throughput, errors, and related signals, including gateway-focused views when Omni provides them. Investigate incidents, troubleshoot slowdowns, and compare what you see in operations with governance reporting as you assess production behavior. - -[[platform]] -=== Platform - -image::reuse::lm_test_1.png[] - -*Platform* includes environment-wide tools and settings, including *Providers*. Configure how Omni connects to external systems and supporting services for agents, APIs, MCP servers, and LLMs. Adjust options so Omni matches how your organization integrates and operates. - -=== More help - -image::reuse::lm_audience_end_1.png[] - -Open *Help & Support* in Omni when you need documentation or want to contact support. diff --git a/modules/ROOT/pages/omni-compare.adoc b/modules/ROOT/pages/omni-compare.adoc new file mode 100644 index 000000000..5046a0b7e --- /dev/null +++ b/modules/ROOT/pages/omni-compare.adoc @@ -0,0 +1,75 @@ += Comparing MuleSoft Omni and Anypoint Platform +:page-aliases: + +Both MuleSoft Omni and Anypoint Platform ship robust capabilities, but they emphasize different strengths, especially when you manage AI assets such as agents, LLMs, and MCP servers next to APIs and gateways. + +Adopting Omni gives you a fuller way to manage and optimize AI assets, with the flexibility and governance modern AI-driven environments need. You configure AI policies and map relationships among assets faster and more seamlessly in Omni because the UI targets that portfolio. This is helpful when AI is central to your strategy. + +You still rely on MuleSoft Anypoint Platform for API and integration work, such as designing and evolving specifications, implementing and testing Mule apps in Anypoint Studio or Anypoint Code Builder, running CI/CD, deploying to runtimes such as CloudHub or Runtime Fabric, and using *Exchange* and *API Manager* for publishing, deep lifecycle policy, and runtime depth when *Omni* links you there. + +== Benefits of Adopting Omni + +Unified Relationships Across Entity Types:: *Overview* and graph-style context in Omni show how agents, MCP servers, LLMs, APIs, and gateways connect. You reason about dependencies and impact more easily than when each silo lives only in its legacy console. +Governance Framed for AI As Well As APIs:: You apply and review governance across domains such as access and security, performance and cost, data privacy and integrity, and compliance and observability, aligned to the asset you're viewing. Policy and conformance work stays next to the asset instead of only in a separate API-only mental model. +Cost and Usage Signals for AI Operations:: Omni includes cost management tooling aimed at portfolio spend, including visibility into token usage and optimization angles that matter for MCP servers and related AI paths. Use it when you need instance-level usage context tied to the same catalog as the rest of the portfolio. +Instance-Level Policy Control:: For instances backed by Flex Gateway where the product supports it, Omni surfaces instance-level governance, including options to tune policy order and draw from a named policy catalog. Use that when you need fine-grained control in the portfolio UI, and keep deeper runtime-only workflows in Anypoint when Omni links you there. +Provider Breadth for AI Connections:: *Platform* includes *Providers* and related configuration so Omni can connect AI and integration assets across multiple vendors, such as AWS Bedrock and Google Vertex AI, in addition to your existing MuleSoft footprint. That supports multi-vendor AI stacks without forcing each vendor's console to be your only view. +Managed and unmanaged instances:: Omni supports creating managed instances on Flex Gateway when you want full support paths including authentication and monitoring, or unmanaged-style instances when you want a lighter footprint. Pick the model per asset and gateway strategy. +Assistant Across the Portfolio:: The in-product assistant targets setup, questions, and recommendations across the assets Omni tracks. The classic Anypoint control plane doesn't center that same assistant-led experience. + + +== What to Manage Where + +MuleSoft Omni and Anypoint Platform each offer distinct capabilities that can guide where you perform different tasks. Understanding each platform’s strengths helps you pick the right environment and still combine tools when a workflow spans Omni and Anypoint. + +[cols="1,1,2a,2a",options="header"] +|=== +| Task | Preferred Experience | Why | Example for Dual Use + +| API design and documentation +| Anypoint Platform +a| +The Anypoint Platform offers powerful tools like Anypoint Studio and Design Center for crafting APIs with RAML or OAS and publishing detailed documentation. +a| +If you need to cross-reference API design with specific governance policies already established in Omni, you can consult documentation in Omni for quick access to compliance details. + +| Policy enforcement and governance +| MuleSoft Omni +a| +Omni excels in applying and managing governance policies across agents, APIs, and other assets with detailed compliance tracking and reporting features. +a| +Use Anypoint Platform for initial policy setup when launching a new API. Use Omni for ongoing monitoring and adjustment to ensure policies remain effective and compliant. + +| Integration development +| Anypoint Platform +a| +Anypoint Studio is specifically designed for developing integrations and flows, offering seamless tools for connecting systems and designing workflows. +a| +If an integration involves workflows managed by multiple AI agents, you can start working in Anypoint Platform and then use Omni to ensure each agent's compliance with integration standards. + +| Multi-agent ecosystem management +| MuleSoft Omni +a| +Omni is designed to monitor and optimize interactions between AI agents, ensuring cohesive operation across the ecosystem. +a| +Conduct initial API integration testing in Anypoint to verify functionality, then switch to Omni for monitoring agents that interact with those APIs. + +| Cost and performance optimization +| MuleSoft Omni +a| +Omni provides comprehensive tools for monitoring and optimizing cost, token usage, and performance metrics across various entities. +a| +Use Anypoint Platform to initially monitor API performance under load during development, and use Omni for ongoing cost optimization when APIs are in full production. + +| Runtime application management +| Anypoint Platform +a| +Anypoint Runtime Manager is robust for deploying, managing, and monitoring Mule applications during runtime operations. +a| +Deploy applications via Anypoint to leverage its runtime monitoring, then switch to Omni for broader operational oversight involving governance and policy application across running assets. +|=== + + +== See Also + +* xref:omni-overview.adoc[Get Started with MuleSoft Omni]. diff --git a/modules/ROOT/pages/omni-overview.adoc b/modules/ROOT/pages/omni-overview.adoc new file mode 100644 index 000000000..435402800 --- /dev/null +++ b/modules/ROOT/pages/omni-overview.adoc @@ -0,0 +1,77 @@ += MuleSoft Omni Overview +:page-aliases: +:page-article-style: learning-map + +MuleSoft Omni helps you manage, optimize, and govern a multi-agent ecosystem from one place. Work with agents, APIs, MCP servers, LLMs, and gateways as a single portfolio. View asset relationships, apply governance and cost discipline, and act on observability signals instead of working in separate silos. Omni pairs this portfolio view with an in-product assistant to connect integrations, tune configurations, and get answers in context. + +* Register agents, MCP servers, and LLM proxies from any provider or registry. +* Monitor latency, cost, invocations, and failures in real time. +* Secure instances with compatible policies across your entire registry. +* Transcode existing REST APIs into MCP servers instantly. + +image::omni-pillars.png[] + +The end-to-end journey for Omni consists of various tasks, each with links to relevant content to assist you in completing them. + +[.lm-table, cols="1a,1a,1a", grid="none"] +|=== +| image::lm_start.png[] +[.lm-bold]##Learn About Omni## + +Omni helps you manage, optimize, and govern a multi-agent ecosystem from one place. + +//- ToDo [Video] +//- ToDo [Trailhead] + +| image::lm_explore_1.png[] +[.lm-bold]##Register## + +Register agents, MCP servers, and LLM proxies from any provider or registry. + +//- xref: + +| image::lm_build_1.png[] +[.lm-bold]##Monitor## + +Monitor latency, cost, invocations, and failures in real time. + +//- xref: +|=== + +[.lm-table, cols="1a,1a", width="66%", grid="none"] +|=== +| image::lm_build_1.png[] +[.lm-bold]##Secure## + +Secure instances with compatible policies across your entire registry. + +//- xref: + +| image::lm_analyze_1.png[] +[.lm-bold]##Transcode## + +Transcode existing REST APIs into MCP servers instantly. + +//- xref: + + +|=== + + +== Omni Capabilities + +Omni supports the full lifecycle of AI-connected integration assets: + +Entity Management:: Register and manage agents, REST and GraphQL APIs, MCP servers, LLMs, and gateways, including MuleSoft Flex Gateway, external gateways, and unmanaged gateways. Each type has a dedicated catalog under *Portfolio*. + +Governance and Compliance:: Define and apply policies across domains such as access and security, performance and cost, data privacy and integrity, and compliance and observability. Conformance reporting summarizes rule violations and severity so you can close gaps systematically. + +Cost and Performance Optimization:: Monitor token usage, per-instance signals, and daily cost where the product exposes them. Apply governance strategies and related controls, such as tool mapping and tool sanitization, to reduce spend and risk where Omni supports them. + +Instance Management:: Create and review instances for supported asset types. Choose managed paths through Flex Gateway when you need deeper monitoring and policy enforcement, or choose lighter models when that matches your operating model. + + +== See Also + +* xref:omni-start-home.adoc[Get Started with MuleSoft Omni] +* xref:omni-compare.adoc[Comparing MuleSoft Omni and Anypoint Platform] diff --git a/modules/ROOT/pages/omni-start-home.adoc b/modules/ROOT/pages/omni-start-home.adoc new file mode 100644 index 000000000..82fce96b8 --- /dev/null +++ b/modules/ROOT/pages/omni-start-home.adoc @@ -0,0 +1,118 @@ += Get Started with MuleSoft Omni +:page-aliases: + +Grow and tune your AI portfolio by registering and monitoring agents, APIs, and gateways in centralized catalogs. Sign in through the entry point your organization provides, such as Anypoint Platform, Slack, or a direct URL, to access dashboards and governance strategies based on your assigned permissions. You can review live performance metrics, manage security policies, and track rule-level compliance through automated conformance reports. + +These tools ensure your AI assets remain audit-ready while providing clear visibility into cost and runtime health across your organization. + +== Access MuleSoft Omni + +Your organization determines how you access Omni. Common options include these environments. + +* Anypoint Platform ++ +In Anypoint Platform, look for the Omni banner or shortcut and choose *Go to Omni*. Your administrator can also add a direct link in the main navigation or workspace. +* Slack ++ +If your organization integrates Omni with Slack, use the Omni Slack app to receive notifications and alerts, and follow links back into the product. Your workspace can also offer shortcuts or slash commands your admin configures. +* Coding assistants ++ +If your organization connects Omni to a supported assistant, such as Claude Code, follow your internal instructions to open Omni features from that development environment. +* Direct URL ++ +Your organization can share a standalone URL that signs you in to Omni outside other apps. Use the address your administrator or internal documentation provides. +* Custom integrations ++ +Your organization can build access through another tool. Follow the internal access instructions for custom integrations. + +[NOTE] +Available access points depend on how your administrators configured Omni's integrations with other platforms. + + +== Before You Begin + +Before you rely on Omni in production, complete these checks with your administrator. Requirements vary by entry point and how your administrator integrates Omni with other systems. + +Access and Credentials:: ++ +* Confirm that you have a user account for your organization's entry path, such as Anypoint Platform, and valid credentials to log in. +* Confirm that you can reach Omni and integrated services, such as Anypoint Platform, Slack, or a connected coding assistant, from the networks and locations you use. + +Platform and Product Access:: ++ +* Confirm that your organization has the MuleSoft Omni entitlement and an administrator enabled it for your Anypoint business group or organization. +* Confirm that required integrations with Anypoint Platform, Slack, or your development environment work end to end. +* If Omni connects to other services, work with your administrator to configure authentication, such as API keys or OAuth tokens, to ensure successful connections. +* Confirm that your administrator approved and configured required external connections, such as cloud providers under *Providers*. + + +[[permissions]] +== Permissions + +Omni uses Anypoint Platform access control. Your administrator maps tasks to roles and permissions in Anypoint Access Management. Exact permission names differ by organization. Use this table with your internal access guide. + + +[cols="20%,~",options="header"] +|=== +|Audience |Typical Permissions and Tasks + +|Administrator +a| +* Integration setup: Configure and manage integrations with external systems that Omni relies on. +* Policy management: Define and enforce governance policies across APIs, agents, and other managed entities. +* Access control: Assign user roles and access levels so teams see only the Omni areas and actions they need. + +|Business user +a| +* Portfolio operations: View and work with APIs, agents, and other entities in your catalogs, including asset registration flows when your policies allow it. +* Governance insights: Open dashboards and reports that surface compliance and performance metrics. +* Instance management: When your organization allows it, create or change instances under the guided conditions Omni exposes. + +|Developer +a| +* API design and documentation: Design, document, and publish APIs that Omni tracks as part of your integration work. +* Tools and MCP servers: When you use MCP servers, adjust tool settings and invoke operations your administrator permits. + +|=== + +If you can't complete an action or a page shows an authorization error, ask your Anypoint organization administrator for the matching permission or role. + +== Typical Omni Workflow + +Manage and tune your AI portfolio by registering assets, applying security policies, and monitoring runtime health. Access centralized catalogs to track agents and gateways while verifying compliance through conformance reports and cost management tools. These integrated features help you optimize performance and maintain audit readiness across your environment + +. Complete onboarding and access ++ +Confirm your credentials and the permissions your administrator assigned, as described in <>. Finish integration setup for supporting systems, such as connected providers under *Platform* > *Providers*, before you depend on Omni in production. +. Learn the layout ++ +Sign in through your entry path and land on *Home*. Scan *Portfolio* catalogs, *Governance*, *Observability*, and *Platform* so you know where to register assets, apply policies, read health signals, and manage providers. +. Register assets in Portfolio ++ +Under *Portfolio*, open *Agents*, *MCP Servers*, *LLMs*, *APIs*, or *Gateways*. Add assets to work with. Register manually or use connected providers under *Platform* > *Providers* if your organization enables discovery flows. +. Create and manage instances ++ +On *Agents*, *MCP Servers*, *LLMs*, and *APIs*, open *Instances* to create managed or unmanaged deployments that match your needs. Managed instances on Flex Gateway give stronger governance and monitoring when Omni exposes them. *Gateways* don't include an *Instances* tab. +. Configure policies ++ +On the *Policies* tab for a service or instance, apply governance policies that match access control, data privacy, performance, and compliance goals. Use *Governance* for gateway-wide policy work, organization strategies, and cost tools. +. Review compliance ++ +On *Agents*, *APIs*, and *MCP Servers*, open *Conformance Report* to review scores, violations, and warnings, then address the findings your governance team prioritizes. For gateways, use *Governance* for the same compliance story at the scope Omni supports. +. Monitor runtime health ++ +On *Monitoring*, review live metrics such as latency, error rates, and request volume when Omni surfaces Flex Gateway data for managed paths. Compare what you see with dashboards, reports, or notifications under *Observability* when your administrator enabled those views for your team. +. Manage cost ++ +Under *Governance*, open *Cost Management* to study token usage and related spend signals. Apply the cost reduction strategies your organization adopted, such as tool mapping or tool sanitization, where Omni supports them. +. Operate and tune the portfolio ++ +Coordinate agents, APIs, gateways, MCP servers, and LLMs so traffic, policies, and integrations stay aligned. Open *Versions* when you need configuration history before you change instances or policies. Adjust policies, instances, or registrations when monitoring and governance insights show drift or new risk. +. Improve on each cycle ++ +Feed findings from monitoring and governance back into planning for the next change window. + +== See also + +* xref:omni-overview.adoc[MuleSoft Omni Overview] +* xref:omni-compare.adoc[Comparing MuleSoft Omni and Anypoint Platform]