Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
34 changes: 17 additions & 17 deletions modules/ROOT/pages/_partials/api-configuration-tables.adoc
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
//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* | | |
| *Consumer endpoint* | Specifies a proxy application's address for consumers to use for sending requests.| No |
| *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
Expand All @@ -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
Expand All @@ -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%"]
Expand Down
20 changes: 10 additions & 10 deletions modules/ROOT/pages/_partials/task-add-api-instance.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]

Expand Down Expand Up @@ -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.
Expand All @@ -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[]
Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/add-api-alert-task.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/add-api-instances.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[] +
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/analytics-landing-page.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
24 changes: 12 additions & 12 deletions modules/ROOT/pages/create-instance-task-agent-tool.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
= 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::[]
:product: flex

: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.

Expand All @@ -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*.

Expand All @@ -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*.
+
Expand Down
Loading