diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 2271f1da..34190539 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -5,9 +5,9 @@ * xref:api-instance-landing-page.adoc[Manage API Instances] ** xref:add-api-instances.adoc[Add API Instances] *** xref:create-instance-task-mule.adoc[Add a Mule Gateway API Instance] - *** xref:create-instance-task-flex.adoc[Add a Flex Gateway API Instance] - *** xref:create-instance-task-agent-tool.adoc[Add a Flex Gateway Agent or Tool instance] - *** xref:create-instance-task-mcp-bridge.adoc[Add a Flex Gateway MCP Bridge instance] + *** xref:create-instance-task-flex.adoc[Add an Omni Gateway API Instance] + *** xref:create-instance-task-agent-tool.adoc[Add an Omni Gateway Agent or Tool instance] + *** xref:create-instance-task-mcp-bridge.adoc[Add an Omni Gateway MCP Bridge instance] *** xref:create-instance-public-exchange.adoc[Add an MCP Server from Public Exchange] ** xref:find-api-id-task.adoc[Obtain an API Instance ID] ** xref:export-api-latest-task.adoc[Export an API Instance] diff --git a/modules/ROOT/pages/_partials/api-configuration-tables.adoc b/modules/ROOT/pages/_partials/api-configuration-tables.adoc index cfdc4484..3d205bfd 100644 --- a/modules/ROOT/pages/_partials/api-configuration-tables.adoc +++ b/modules/ROOT/pages/_partials/api-configuration-tables.adoc @@ -1,10 +1,10 @@ -//tag::flex-downstream-self-managed[] +//tag::omni-downstream-self-managed[] [%header%autowidth.spread,cols="15%,35%,15%,35%"] |=== | Field Name | Description | Required | Notes | *Protocol* | Specifies whether to use HTTP or HTTPS. | Yes | If you select HTTPS, specify a TLS context for inbound traffic. -| *Inbound TLS* | TLS Context used for the inbound traffic of HTTPS APIs | No | xref:gateway::flex-conn-tls-config.adoc[Configure a TLS Context for Flex Gateway] before adding a TLS Context to your API. Only available on Flex 1.4.0+. -| *Port* | Specifies the number to use if the displayed port is incorrect. | No | API instances can share the same port across the same target if the *Base path* is different for both instances. Only available on Flex 1.2.0+. +| *Inbound TLS* | TLS Context used for the inbound traffic of HTTPS APIs | No | xref:gateway::flex-conn-tls-config.adoc[Configure a TLS Context for Omni Gateway] before adding a TLS Context to your API. Only available on Omni 1.4.0+. +| *Port* | Specifies the number to use if the displayed port is incorrect. | No | API instances can share the same port across the same target if the *Base path* is different for both instances. Only available on Omni 1.2.0+. | *Base path* | Specifies the URL prefix for all API paths, relative to the host root. It must start with a leading slash `/`. | Yes | | *Instance label* | Specifies a label for the API. | No | If you have multiple managed instances of the same API, add a label to differentiate each instance from the others. | *Advanced Options* | | | @@ -12,9 +12,9 @@ | *Manual Approval* | Enables manual approval for API Requests. | No | After submitting the instance, you must go to *Contracts* to approve or revoke the request. |=== -//end::flex-downstream-self-managed[] +//end::omni-downstream-self-managed[] -//tag::flex-downstream-managed[] +//tag::omni-downstream-managed[] [%header%autowidth.spread,cols="15%,35%,15%,35%"] |=== | Field Name | Description | Required | Notes @@ -24,23 +24,23 @@ | *Advanced Options* | | | | *Consumer endpoint* | Specifies a proxy application's address for consumers to use for sending requests.| No | |=== -//end::flex-downstream-managed[] +//end::omni-downstream-managed[] -//tag::flex-downstream-agent-tool-self-managed[] +//tag::omni-downstream-agent-tool-self-managed[] [%header%autowidth.spread,cols="15%,35%,15%,35%"] |=== | Field Name | Description | Required | Notes | *Protocol* | Specifies whether to use HTTP or HTTPS. | Yes | If you select HTTPS, specify a TLS context for inbound traffic. -| *Inbound TLS* | TLS Context used for the inbound HTTPS traffic. | No | xref:gateway::flex-conn-tls-config.adoc[Configure a TLS Context for Flex Gateway] before adding a TLS Context to your server. +| *Inbound TLS* | TLS Context used for the inbound HTTPS traffic. | No | xref:gateway::flex-conn-tls-config.adoc[Configure a TLS Context for Omni Gateway] before adding a TLS Context to your server. | *Port* | Specifies the number to use if the displayed port is incorrect. | No | Instances can share the same port across the same target if the *Base path* is different for both instances. | *Base path* | Specifies the URL prefix for all server paths, relative to the host root. It must start with a leading slash `/`. | Yes | | *Instance label* | Specifies a label for the instance. | No | If you have multiple managed instances of the same asset, add a label to differentiate each instance from the others. | *Advanced Options* | | | | *Consumer endpoint* | Specifies a proxy application's address for consumers to use for sending requests.| No | |=== -//end::flex-downstream-agent-tool-self-managed[] +//end::omni-downstream-agent-tool-self-managed[] -//tag::flex-downstream-agent-tool-managed[] +//tag::omni-downstream-agent-tool-managed[] [%header%autowidth.spread,cols="15%,35%,15%,35%"] |=== | Field Name | Description | Required | Notes @@ -50,25 +50,25 @@ | *Advanced Options* | | | | *Consumer endpoint* | Specifies a proxy application's address for consumers to use for sending requests.| No | |=== -//end::flex-downstream-agent-tool-managed[] +//end::omni-downstream-agent-tool-managed[] -//tag::flex-upstream[] +//tag::omni-upstream[] [%header%autowidth.spread,cols="15%,35%,15%,35%"] |=== | Field Name | Description | Required | Notes | *Upstream URL* | URL to access for the proxy or API. This must end with a `/`. | Yes | For example, you can use the URL of your API asset in Exchange. -| *Outbound TLS* | TLS Context used for the outbound traffic to the upstream service | No | xref:gateway::flex-conn-tls-config.adoc[Configure a TLS Context for Flex Gateway] before adding a TLS Context to your API. Only available on Flex 1.4.0+. +| *Outbound TLS* | TLS Context used for the outbound traffic to the upstream service | No | xref:gateway::flex-conn-tls-config.adoc[Configure a TLS Context for Omni Gateway] before adding a TLS Context to your API. Only available on Omni 1.4.0+. |=== -//end::flex-upstream[] +//end::omni-upstream[] -//tag::flex-upstream-agent-tool[] +//tag::omni-upstream-agent-tool[] [%header%autowidth.spread,cols="15%,35%,15%,35%"] |=== | Field Name | Description | Required | Notes | *Upstream URL* | URL to access for the upstream service. This must end with a `/`. | Yes | For example, you can use the URL of your asset in Exchange. -| *Outbound TLS* | TLS Context used for the outbound traffic to the upstream service | No | xref:gateway::flex-conn-tls-config.adoc[Configure a TLS Context for Flex Gateway] before adding a TLS Context to your server. +| *Outbound TLS* | TLS Context used for the outbound traffic to the upstream service | No | xref:gateway::flex-conn-tls-config.adoc[Configure a TLS Context for Omni Gateway] before adding a TLS Context to your server. |=== -//end::flex-upstream-agent-tool[] +//end::omni-upstream-agent-tool[] //tag::mule-app-downstream[] [%header%autowidth.spread,cols="15%,35%,15%,35%"] diff --git a/modules/ROOT/pages/_partials/task-add-api-instance.adoc b/modules/ROOT/pages/_partials/task-add-api-instance.adoc index d003434b..c31f70d6 100644 --- a/modules/ROOT/pages/_partials/task-add-api-instance.adoc +++ b/modules/ROOT/pages/_partials/task-add-api-instance.adoc @@ -3,19 +3,19 @@ After you have created an API using Design Center or any other application, you //end::intro1[] -//tag::flex-intro[] -Use Flex Gateway for any APIs that need a flexible and performant API gateway +//tag::omni-intro[] +Use Omni Gateway for any APIs that need a flexible and performant API gateway that works with distributed and microservices environments and fits into your CI/CD environments. -//end::flex-intro[] +//end::omni-intro[] -//tag::flex-agent-tool-intro[] -Use Flex Gateway for any agent, broker, LLM, or MCP server that needs a flexible and performant gateway that works with distributed and microservices environments and fits into your CI/CD environments. +//tag::omni-agent-tool-intro[] +Use Omni Gateway for any agent, broker, LLM, or MCP server that needs a flexible and performant gateway that works with distributed and microservices environments and fits into your CI/CD environments. -//end::flex-agent-tool-intro[] +//end::omni-agent-tool-intro[] //tag::mcp-bridge-intro[] -Use Flex Gateway MCP Bridge to create MCP servers to expose your current API instances as MCP tools so agents can discover and call them. +Use Omni Gateway MCP Bridge to create MCP servers to expose your current API instances as MCP tools so agents can discover and call them. //end::mcp-bridge-intro[] @@ -128,8 +128,8 @@ For more information about versions in Exchange, see xref:exchange::asset-versio .. Enter a *Name* for the new API asset. //end::mid-steps[] -// Assets type options for flex because flex does not support soap APIs -//tag::asset-type-options-flex[] +// Assets type options for omni because omni does not support soap APIs +//tag::asset-type-options-omni[] .. Select the **Asset type** from the following options: ** **REST API:** Select this option if you have a RAML or OAS API definition file you want to include for your asset. @@ -145,7 +145,7 @@ Upload a WSDL file for your SOAP API or add the link to the file. For more information about versions in Exchange, see xref:exchange::asset-versions.adoc[]. .. If you chose a *RAML/OAS* asset type, view the *Conformance Status* of the API to ensure the API is conformant. If the *Conformance Status* is nonconformant, after deployment, view the *Governance Report* to find and fix the conformance issues. For more information about the *Governance Report*, see xref:govern-api-instances.adoc[]. . Click *Next*. -//end::asset-type-options-flex[] +//end::asset-type-options-omni[] // All API assets types //tag::asset-type-options[] diff --git a/modules/ROOT/pages/add-api-alert-task.adoc b/modules/ROOT/pages/add-api-alert-task.adoc index 5ce0ebe1..07db2924 100644 --- a/modules/ROOT/pages/add-api-alert-task.adoc +++ b/modules/ROOT/pages/add-api-alert-task.adoc @@ -5,9 +5,9 @@ endif::[] Instance alerts in API Manager email recipients when request volume, response codes, response times, or other conditions cross thresholds you set for an API instance on Mule Gateway or Anypoint Service Mesh. You name each alert, set severity, choose from xref:using-api-alerts.adoc[alert types], configure time ranges as sliding windows, and specify email recipients. -Policy Violation alerts are unavailable for xref:automated-policies-landing-page.adoc[automated policies], and Flex Gateway instances use xref:gateway::flex-use-api-alerts.adoc[a separate alert workflow]. +Policy Violation alerts are unavailable for xref:automated-policies-landing-page.adoc[automated policies], and Omni Gateway instances use xref:gateway::flex-use-api-alerts.adoc[a separate alert workflow]. -NOTE: This task applies to Mule Gateway and Anypoint Service Mesh runtimes only. To add alerts to instances that use Flex Gateway as their runtime, see xref:gateway::flex-use-api-alerts.adoc[Add Instance Alerts for Flex Gateway]. +NOTE: This task applies to Mule Gateway and Anypoint Service Mesh runtimes only. To add alerts to instances that use Omni Gateway as their runtime, see xref:gateway::flex-use-api-alerts.adoc[Add Instance Alerts for Omni Gateway]. [[mule-gateway]] == Configure an Instance Alert diff --git a/modules/ROOT/pages/add-api-instances.adoc b/modules/ROOT/pages/add-api-instances.adoc index 34f4e5bb..4aadbb67 100644 --- a/modules/ROOT/pages/add-api-instances.adoc +++ b/modules/ROOT/pages/add-api-instances.adoc @@ -6,9 +6,9 @@ endif::[] * xref:create-instance-task-mule.adoc[] + include::partial$task-add-api-instance.adoc[tags=mule-intro] * xref:create-instance-task-flex.adoc[] + -include::partial$task-add-api-instance.adoc[tags=flex-intro] +include::partial$task-add-api-instance.adoc[tags=omni-intro] * xref:create-instance-task-agent-tool.adoc[] + -include::partial$task-add-api-instance.adoc[tags=flex-agent-tool-intro] +include::partial$task-add-api-instance.adoc[tags=omni-agent-tool-intro] * xref:create-instance-task-mcp-bridge.adoc[] + include::partial$task-add-api-instance.adoc[tags=mcp-bridge-intro] * xref:create-instance-public-exchange.adoc[] + diff --git a/modules/ROOT/pages/analytics-landing-page.adoc b/modules/ROOT/pages/analytics-landing-page.adoc index 6e02dc29..e3413770 100644 --- a/modules/ROOT/pages/analytics-landing-page.adoc +++ b/modules/ROOT/pages/analytics-landing-page.adoc @@ -6,7 +6,7 @@ endif::[] :keywords: analytics :page-aliases: analytics-concept.adoc -NOTE: *Mule API Analytics* does not support Flex Gateway APIs. For Flex Gateway Analytics, see xref:gateway::flex-view-api-metrics.adoc[]. +NOTE: *Mule API Analytics* does not support Omni Gateway APIs. For Omni Gateway Analytics, see xref:gateway::flex-view-api-metrics.adoc[]. Mule API Analytics can provide insight into how your Mule APIs are being used and how they are performing. From API Manager, you can access the Mule API Analytics dashboard, create a custom dashboard, create and manage charts, and create reports. From API Manager, you can get following types of analytics: diff --git a/modules/ROOT/pages/create-instance-task-agent-tool.adoc b/modules/ROOT/pages/create-instance-task-agent-tool.adoc index e5ea5417..ddd14769 100644 --- a/modules/ROOT/pages/create-instance-task-agent-tool.adoc +++ b/modules/ROOT/pages/create-instance-task-agent-tool.adoc @@ -1,4 +1,4 @@ -= Adding a Flex Gateway Agent or Tool Instance += Adding an Omni Gateway Agent or Tool Instance ifndef::env-site,env-github[] include::_attributes.adoc[] endif::[] @@ -6,7 +6,7 @@ endif::[] :page-aliases: create-instance-task-a2a.adoc, create-instance-task-mcp.adoc -include::partial$task-add-api-instance.adoc[tags=flex-agent-tool-intro] +include::partial$task-add-api-instance.adoc[tags=omni-agent-tool-intro] This diagram shows the upstream and downstream configurations of the instance. In this configuration, the downstream service is the service making requests that are completed by the upstream service. These terms represent the direction of dependency, not the direction of information. @@ -15,18 +15,18 @@ image:server-upstream-downstream-config.png[The instance is deployed on a gatewa [[add-server]] == Add a New Agent or Tool Instance -To add and manage server instances for Flex Gateway, use the *Agent and Tool Instances* section in API Manager. -These server instances can represent Agents, MCP servers, or LLM servers that extend Flex Gateway functionality. +To add and manage server instances for Omni Gateway, use the *Agent and Tool Instances* section in API Manager. +These server instances can represent Agents, MCP servers, or LLM servers that extend Omni Gateway functionality. . Navigate to *Anypoint Platform* > *API Manager*. . Click *Agent and Tool Instances*. . Click *Add* and select the protocol: *Agent*, *MCP Server*, or *LLM*. -. Select a Flex Gateway to deploy the server instance to from *Select a gateway*. +. Select an Omni Gateway to deploy the server instance to from *Select a gateway*. + [NOTE] -- -If you don't see a Flex Gateway listed, or you see a Flex Gateway but its status is *Not Running*, -See xref:gateway::flex-install.adoc[Install Flex Gateway] and xref:gateway::flex-conn-reg-run.adoc[Register and Run in Connected Mode] for more information. +If you don't see an Omni Gateway listed, or you see an Omni Gateway but its status is *Not Running*, +See xref:gateway::flex-install.adoc[Install Omni Gateway] and xref:gateway::flex-conn-reg-run.adoc[Register and Run in Connected Mode] for more information. -- . Click *Next*. @@ -42,22 +42,22 @@ NOTE: Your asset is published to Exchange after it's protected. . Configure the downstream configuration settings: + -.Managed Flex Gateway +.Managed Omni Gateway [%collapsible] ==== -include::partial$api-configuration-tables.adoc[tags=flex-downstream-agent-tool-managed] +include::partial$api-configuration-tables.adoc[tags=omni-downstream-agent-tool-managed] ==== + -.Self-Managed Flex Gateway (Connected Mode) +.Self-Managed Omni Gateway (Connected Mode) [%collapsible] ==== -include::partial$api-configuration-tables.adoc[tags=flex-downstream-agent-tool-self-managed] +include::partial$api-configuration-tables.adoc[tags=omni-downstream-agent-tool-self-managed] ==== . Click *Next*. . Configure one of the server upstream configurations: + -include::partial$api-configuration-tables.adoc[tags=flex-upstream-agent-tool] +include::partial$api-configuration-tables.adoc[tags=omni-upstream-agent-tool] . Click *Next*. + diff --git a/modules/ROOT/pages/create-instance-task-flex.adoc b/modules/ROOT/pages/create-instance-task-flex.adoc index 2064462c..9e12fc0e 100644 --- a/modules/ROOT/pages/create-instance-task-flex.adoc +++ b/modules/ROOT/pages/create-instance-task-flex.adoc @@ -1,50 +1,50 @@ -= Adding a Flex Gateway API Instance += Adding an Omni Gateway API Instance ifndef::env-site,env-github[] include::_attributes.adoc[] endif::[] :product: flex -include::partial$task-add-api-instance.adoc[tags=intro1;flex-intro;intro2] +include::partial$task-add-api-instance.adoc[tags=intro1;omni-intro;intro2] [[add-api]] == Add a New API . Navigate to *Anypoint Platform* > *API Manager*. . In *API Administration*, click *Add* and select *Add new API*. -. Select *Flex Gateway*. -. Select a connected Flex Gateway you have installed and registered from the list under *Select a gateway*. +. Select *Omni Gateway*. +. Select a connected Omni Gateway you have installed and registered from the list under *Select a gateway*. + [NOTE] -- -If you don't see a Flex Gateway listed, or you see a Flex Gateway but its status is *Not Running*, -See xref:gateway::flex-install.adoc[Install Flex Gateway] and xref:gateway::flex-conn-reg-run.adoc[Register and Run in Connected Mode] for more information. +If you don't see an Omni Gateway listed, or you see an Omni Gateway but its status is *Not Running*, +See xref:gateway::flex-install.adoc[Install Omni Gateway] and xref:gateway::flex-conn-reg-run.adoc[Register and Run in Connected Mode] for more information. -- . Click *Next*. + -include::partial$task-add-api-instance.adoc[tags=mid-steps;asset-type-options-flex] +include::partial$task-add-api-instance.adoc[tags=mid-steps;asset-type-options-omni] . Configure the downstream configuration settings: + -.Managed Flex Gateway +.Managed Omni Gateway [%collapsible] ==== -include::partial$api-configuration-tables.adoc[tags=flex-downstream-managed] +include::partial$api-configuration-tables.adoc[tags=omni-downstream-managed] ==== + -.Self-Managed Flex Gateway (Connected Mode) +.Self-Managed Omni Gateway (Connected Mode) [%collapsible] ==== -include::partial$api-configuration-tables.adoc[tags=flex-downstream-self-managed] +include::partial$api-configuration-tables.adoc[tags=omni-downstream-self-managed] ==== . Click *Next*. . Configure one of the following upstream configurations: ** *Single Upstream Service* + -For Flex Gateway versions 1.4.x or earlier or Flex Gateway version 1.5.x with a single upstream service, configure the following upstream configuration settings: +For Omni Gateway versions 1.4.x or earlier or Omni Gateway version 1.5.x with a single upstream service, configure the following upstream configuration settings: + -include::partial$api-configuration-tables.adoc[tags=flex-upstream] +include::partial$api-configuration-tables.adoc[tags=omni-upstream] ** *Multiple Upstream Services* + -Flex Gateway version 1.5.x or later supports API instances that expose multiple upstream services through a single consumer endpoint. + +Omni Gateway version 1.5.x or later supports API instances that expose multiple upstream services through a single consumer endpoint. + To configure multiple upstream services, see <>. . Click *Next*. + @@ -52,15 +52,15 @@ include::partial$task-add-api-instance.adoc[tags=last-steps] [[traffic-management]] -== Multiple Upstream Services for Flex Gateway Running in Connected Mode +== Multiple Upstream Services for Omni Gateway Running in Connected Mode -Flex Gateway version 1.5.x or later supports API instances that expose multiple upstream services through a single consumer endpoint. +Omni Gateway version 1.5.x or later supports API instances that expose multiple upstream services through a single consumer endpoint. -Flex Gateway manages request traffic by using different routes that can each direct traffic to multiple upstream services. Flex Gateway directs traffic to the routes by using the route order and the individual route's rules. Additionally, you can add a weighted percentage to each upstream service within a route to manage the percentage of requests sent to the upstream service. +Omni Gateway manages request traffic by using different routes that can each direct traffic to multiple upstream services. Omni Gateway directs traffic to the routes by using the route order and the individual route's rules. Additionally, you can add a weighted percentage to each upstream service within a route to manage the percentage of requests sent to the upstream service. In the following diagram, different routes manage requests to flight information databases and to a customer service application. Route one has two upstream services defined, which direct 70% of requests to a stable database and 30% of requests to a beta database. -image:multiple-upstreams.png[Flex Gateway manages the traffic to multiple upstreams] +image:multiple-upstreams.png[Omni Gateway manages the traffic to multiple upstreams] === Limits @@ -91,9 +91,9 @@ All rules are optional. If a rule does not have a value, that rule is ignored. F Different routes can support the same upstream services. If you cannot capture all requests for a particular set of upstream services in a single route rule set, you can define multiple routes with different rules for full coverage. -Only requests that meet all of the rules defined in the ruleset are directed to that route. If a request does not meet the rules for any route, Flex Gateway returns a `404` error code. +Only requests that meet all of the rules defined in the ruleset are directed to that route. If a request does not meet the rules for any route, Omni Gateway returns a `404` error code. -Flex Gateway supports the following route rules: +Omni Gateway supports the following route rules: Method:::: + @@ -145,15 +145,15 @@ NOTE: To delete a header, click the *Trash Can* icon (image:trash-can-icon.png[2 ==== Route Order -In addition to using route rules, Flex Gateway directs requests to different routes by using the top to bottom order of how the routes appear on the page. +In addition to using route rules, Omni Gateway directs requests to different routes by using the top to bottom order of how the routes appear on the page. -Flex Gateway directs requests to the first route if the request meets the route rules. +Omni Gateway directs requests to the first route if the request meets the route rules. To define the route order, use the up and down arrows to arrange the routes. Route ordering is very important when a request can meet the route rules of multiple routes. You should order the routes with more complex route rules first. If you do not define a route order, routes are ordered in the order they were created. -For example, in a configuration in which route one has the `GET` method defined as a rule and route two has no route rules defined, all `GET` requests are sent to route one and all other requests are sent to route two. If the route order was reversed and route one had no route rules, Flex Gateway would direct all requests to route one before any `GET` requests could reach route two. +For example, in a configuration in which route one has the `GET` method defined as a rule and route two has no route rules defined, all `GET` requests are sent to route one and all other requests are sent to route two. If the route order was reversed and route one had no route rules, Omni Gateway would direct all requests to route one before any `GET` requests could reach route two. === Upstream Services @@ -174,7 +174,7 @@ Configure the following fields for each upstream service: | Field Name | Description | Required | Notes | *Upstream URL* | URL to access for the proxy or API. This must end with a `/`. | Yes | For example, you can use the URL of your API asset in Exchange. | *Upstream Label* | Label for the upstream service | No | If you have multiple upstream service instances, add a label to each one to differentiate it from the others. -| *TLS* | TLS context used for the outbound traffic to the upstream service | No | xref:gateway::flex-conn-tls-config.adoc[Configure a TLS Context for Flex Gateway] before adding a TLS context to your API. Add a TLS context by clicking *Add TLS Context*. +| *TLS* | TLS context used for the outbound traffic to the upstream service | No | xref:gateway::flex-conn-tls-config.adoc[Configure a TLS Context for Omni Gateway] before adding a TLS context to your API. Add a TLS context by clicking *Add TLS Context*. | *Weight* | Percentage of requests to send to that upstream service | Yes | This value is configurable only if you have multiple upstream services. The sum of all upstream weights must equal `100%`. |=== diff --git a/modules/ROOT/pages/create-instance-task-mcp-bridge.adoc b/modules/ROOT/pages/create-instance-task-mcp-bridge.adoc index d672c51b..0b98b2e2 100644 --- a/modules/ROOT/pages/create-instance-task-mcp-bridge.adoc +++ b/modules/ROOT/pages/create-instance-task-mcp-bridge.adoc @@ -4,7 +4,7 @@ include::_attributes.adoc[] endif::[] :product: flex -Flex Gateway MCP Bridge enables you to create MCP servers from your existing API instances. With the MCP Bridge, you can expose your current API instances as MCP tools so agents can discover and call them. +Omni Gateway MCP Bridge enables you to create MCP servers from your existing API instances. With the MCP Bridge, you can expose your current API instances as MCP tools so agents can discover and call them. Define your MCP bridge by selecting API instances and mapping them to MCP tools. When an agent requests the list of available tools (`tools/list`), the gateway responds with an MCP descriptor that defines each tool's name, description, and input schema. When an agent calls a tool (`tools/call`), the MCP Bridge maps the tool name and arguments to an HTTP request based on your configuration. @@ -17,7 +17,7 @@ NOTE: MCP Bridge doesn't support API instances with multiple upstream services. [[add-server]] == Add a New Agent or Tool Instance -To add and a new MCP Bridge for Flex Gateway: +To add and a new MCP Bridge for Omni Gateway: . Ensure that all APIs you want to add to your MCP Serve exist in Exchange. . To begin creating your MCP Server instance, you can start from these locations: @@ -27,23 +27,23 @@ To add and a new MCP Bridge for Flex Gateway: ** From *Agent and Tool Instances*: ... Click *Add* > *MCP Bridge*. -. From *Select a gateway*, choose a Flex Gateway for deploying the MCP server instance. +. From *Select a gateway*, choose an Omni Gateway for deploying the MCP server instance. . Click *Next*. . Select the API instances you want to add to your MCP Server. . Define the MCP server's asset name. . Click *Next*. . Configure the downstream configuration settings: + -.Managed Flex Gateway +.Managed Omni Gateway [%collapsible] ==== -include::partial$api-configuration-tables.adoc[tags=flex-downstream-agent-tool-managed] +include::partial$api-configuration-tables.adoc[tags=omni-downstream-agent-tool-managed] ==== + -.Self-Managed Flex Gateway (Connected Mode) +.Self-Managed Omni Gateway (Connected Mode) [%collapsible] ==== -include::partial$api-configuration-tables.adoc[tags=flex-downstream-agent-tool-self-managed] +include::partial$api-configuration-tables.adoc[tags=omni-downstream-agent-tool-self-managed] ==== . Click *Next*. @@ -53,7 +53,7 @@ include::partial$api-configuration-tables.adoc[tags=flex-downstream-agent-tool-s | Field Name | Description | Required | Notes | *Route Label* | Label to better identify multiple API instances. | Yes | By default, the label is the API name. | *Upstream URL* | URL to access for the upstream service. This must end with a `/`. | Yes | For example, use the URL of your asset in Exchange. -| *Outbound TLS* | TLS Context used for the outbound traffic to the upstream service | No | xref:gateway::flex-conn-tls-config.adoc[Configure a TLS Context for Flex Gateway] before adding a TLS Context to your server. +| *Outbound TLS* | TLS Context used for the outbound traffic to the upstream service | No | xref:gateway::flex-conn-tls-config.adoc[Configure a TLS Context for Omni Gateway] before adding a TLS Context to your server. |=== + To switch among API instances, select the name of the API. diff --git a/modules/ROOT/pages/latest-overview-concept.adoc b/modules/ROOT/pages/latest-overview-concept.adoc index 545fa1cc..ffbcccf3 100644 --- a/modules/ROOT/pages/latest-overview-concept.adoc +++ b/modules/ROOT/pages/latest-overview-concept.adoc @@ -6,7 +6,7 @@ endif::[] :page-aliases: general:getting-started:api-lifecycle-overview.adoc Anypoint API Manager (API Manager) is a component of Anypoint Platform that enables you to manage, govern, and secure APIs and server instances. -It provides an interface to configure the runtime capabilities of Anypoint Flex Gateway, Anypoint Mule Gateway, Anypoint Service Mesh, and server instance types such as Agents, MCP servers, and LLM servers. +It provides an interface to configure the runtime capabilities of Anypoint Omni Gateway, Anypoint Mule Gateway, Anypoint Service Mesh, and server instance types such as Agents, MCP servers, and LLM servers. API Manager helps organizations implement API governance policies, monitor API performance, manage server connectivity, and ensure security compliance across their API ecosystem. The tool supports both cloud and on-premises deployments, making it suitable for various enterprise environments. @@ -47,7 +47,7 @@ image::api-manager-ui-overview.png["API Manager page navigation shown with callo An _API group_ is an API asset that enables organizations to publish a group of API instances as a single unit. For details, see xref:api-groups-landing-page.adoc[]. * *Agent and Tool Instances* + -The _Agent and Tool Instances_ tab represents server instances that extend Anypoint Flex Gateway with additional capabilities such as Agents, MCP servers, and LLM servers. You can add, configure, and manage these server instances directly from this section. +The _Agent and Tool Instances_ tab represents server instances that extend Anypoint Omni Gateway with additional capabilities such as Agents, MCP servers, and LLM servers. You can add, configure, and manage these server instances directly from this section. For details, see xref:create-instance-task-agent-tool.adoc[]. * *Automated Policies* + @@ -126,10 +126,10 @@ NOTE: Governance policies and SLA tiers require the endpoint to be in *Active* s === API Instances -An API instance describes a configuration of an API that is deployed on one of the following runtimes: Flex Gateway, Mule Gateway, or Anypoint Service Mesh. +An API instance describes a configuration of an API that is deployed on one of the following runtimes: Omni Gateway, Mule Gateway, or Anypoint Service Mesh. API Manager manages API instances after they are created by using the *Add*, *Promote*, or *Import* options. API instances remain under management until they are deleted. -API Manager also manages *server instances* (Agent and Tool Instances) that extend Flex Gateway functionality through Agents, MCP servers, or LLM servers. These are managed separately from API instances. +API Manager also manages *server instances* (Agent and Tool Instances) that extend Omni Gateway functionality through Agents, MCP servers, or LLM servers. These are managed separately from API instances. For more detail, see xref:api-instance-landing-page.adoc[]. diff --git a/modules/ROOT/pages/manage-policies-overview.adoc b/modules/ROOT/pages/manage-policies-overview.adoc index 1fa4c552..b871025c 100644 --- a/modules/ROOT/pages/manage-policies-overview.adoc +++ b/modules/ROOT/pages/manage-policies-overview.adoc @@ -5,7 +5,7 @@ endif::[] :imagesdir: ../assets/images :page-aliases: -From API Manager, you can apply policies to APIs in Flex Gateway Connected Mode, Mule Gateway, or Anypoint Service Mesh. +From API Manager, you can apply policies to APIs in Omni Gateway Connected Mode, Mule Gateway, or Anypoint Service Mesh. Policies enable you to enforce regulations to help manage security, control traffic, and improve adaptability of your APIs. For example, a policy can control authentication, access, allotted consumption, and service level access (SLA). You can implement these regulations with no modification to the code implementation. diff --git a/modules/ROOT/pages/using-api-alerts.adoc b/modules/ROOT/pages/using-api-alerts.adoc index 13181973..b2a36ad1 100644 --- a/modules/ROOT/pages/using-api-alerts.adoc +++ b/modules/ROOT/pages/using-api-alerts.adoc @@ -16,7 +16,7 @@ The platform supports three types of alerts: Instance alerts and contracts alerts are managed by Anypoint API Monitoring. Runtime alerts are managed by Anypoint Runtime Manager (Runtime Manager). -Refer to xref:gateway::flex-use-api-alerts.adoc[Using Flex Gateway API Alert] to learn how to use the new API Monitoring alerts. +Refer to xref:gateway::flex-use-api-alerts.adoc[Using Omni Gateway API Alert] to learn how to use the new API Monitoring alerts. [NOTE] @@ -180,10 +180,10 @@ Contracts Alerts are sent from `no-reply@mulesoft.com`. This cannot be customize Alerts in Runtime Manager differ from API alerts and contracts alerts. For example, Runtime Manager flags CPU usage, secure data gateway status, and deployment success or failure. See xref:runtime-manager::alerts-on-runtime-manager.adoc[Runtime Manager Alerts]. -== Flex Gateway Alerts +== Omni Gateway Alerts -Alerts for Flex Gateway differ from API alerts and contract alerts. For example, Flex Gateway includes *Alert Logic* options and the ability -to customize the subject and message of *Email notifications*. See xref:gateway::flex-use-api-alerts.adoc[Using Flex Gateway API Alerts] +Alerts for Omni Gateway differ from API alerts and contract alerts. For example, Omni Gateway includes *Alert Logic* options and the ability +to customize the subject and message of *Email notifications*. See xref:gateway::flex-use-api-alerts.adoc[Using Omni Gateway API Alerts] for more information. == Alert Rate Limits