Skip to content

Commit 2fc38ac

Browse files
Merge pull request #499 from mulesoft/apim-flex-gateway-v1-4-gr
Apim flex gateway v1 4 gr
2 parents 239909f + ea2fd8f commit 2fc38ac

7 files changed

Lines changed: 91 additions & 22 deletions

modules/ROOT/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@
5050
** xref:enable-https-mule3-proxies.adoc[Enable HTTPS in Mule 3.x API Proxies]
5151
** xref:proxy-mule3-elements.adoc[Filter Mule Headers in Mule 3.x API Proxies]
5252
** xref:proxy-domain-support.adoc[Automatic Domain Support for Mule 4 API Proxies]
53+
* xref:manage-policies-overview.adoc[Policies]
5354
* xref:analytics-landing-page.adoc[View Analytics]
5455
** xref:viewing-api-analytics.adoc[Review Analytics Usage]
5556
** xref:analytics-chart.adoc[Review Analytics Charts Usage]

modules/ROOT/pages/_partials/task-configure-proxy.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ to manage your API.
4747
.. Enter a *Proxy app name*.
4848

4949
* **Runtime Fabric:** Select Runtime Fabric if you want to deploy API Proxies to a Mule runtime engine that is managed on Runtime Fabric.
50-
See xref:runtime-fabric::proxy-deploy-runtime-fabric[Deploying API Proxies to Runtime Fabric] for more information.
50+
See xref:runtime-fabric::proxy-deploy-runtime-fabric.adoc[Deploying API Proxies to Runtime Fabric] for more information.
5151
.. Select a target from the list.
5252
.. Select the **Runtime version**.
5353
.. Enter a *Proxy app name*.
@@ -147,6 +147,10 @@ If you upload an OAS API specification to an API proxy version 1.0 or earlier, y
147147
. If you plan to have xref:building-https-proxy.adoc[HTTPS] communications, specify a TLS Context.
148148
. Click *Next*.
149149
//end::tls[]
150+
//tag::configure-endpoint[]
151+
. xref:api-manager::configure-api-task.adoc[Configure the endpoint].
152+
. Click *Next*.
153+
//end::configure-endpoint[]
150154
//tag::last-steps-heading[]
151155

152156
[[review_save_and_deploy]]
Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
1-
= Add API Alerts
1+
= Add API Alerts for Mule Gateway or Service Mesh
22
ifndef::env-site,env-github[]
33
include::_attributes.adoc[]
44
endif::[]
55

6-
To track and manage APIs, you can add one or more API alerts to your API instances. Add different xref:using-api-alerts.adoc[types of alerts] based on your requirements.
6+
To track and manage APIs, you can add one or more API alerts to your API instances. Add different xref:using-api-alerts.adoc[types of alerts] based on your requirements.
77

8-
[NOTE]
9-
====
10-
Alerts cannot be added to API instances protected by xref:automated-policies-landing-page.adoc[automated policies].
11-
====
8+
For APIs using Mule Gateway or Service Mesh as their runtime, follow the steps in this tutorial to add alerts to your APIs.
9+
10+
You cannot add Policy Violation alerts to xref:automated-policies-landing-page.adoc[automated policies].
11+
12+
NOTE: This tutorial is for Mule Gateway and Service Mesh runtimes. To add alerts to APIs using Flex Gateway as their runtime, see xref:gateway::flex-use-api-alerts.adoc[Add API Alerts for Flex Gateway].
1213

13-
To add an API alert:
14+
[[mule-gateway]]
15+
== Add API Alerts for Mule Gateway or Service Mesh
16+
To add an API alert to a Mule Gateway or Service Mesh API:
1417

15-
. Navigate to *API Manager* > *API Administration* and click the API instance for which you want to add an alert.
16-
. From the left navigation pane, select *Alerts* > *Add alert*.
18+
. Navigate to *API Manager > API Administration* and click the API instance for which you want to add an alert.
19+
. From the left navigation panel, click *Alerts > Add alert*.
1720
. Specify the alert options:
1821
* *Name*:
1922
+
@@ -28,16 +31,21 @@ You can delete an alert anytime if not required.
2831
Select a severity for the alert, for example, *Info*.
2932
* *Alert type*:
3033
+
31-
Select the type of alert to create, (for example, *Request Count*) and provide appropriate alert configuration values.
34+
Select the type of alert to create, (for example, *Request Count*) and provide appropriate alert configuration values. For information about alert types, see xref:using-api-alerts.adoc#api-alerts[API Alerts].
3235
+
3336
[TIP]
3437
====
3538
In the *For at least* and *consecutive period(s) of* fields, enter a value in the range of 1 - 999999999 to specify the time interval as a https://www.techopedia.com/definition/869/sliding-window[sliding window^].
3639
====
3740

3841
. Select *Recipients*.
39-
. Select *Create Alert*.
42+
+
43+
Specify what emails receive the email notification.
44+
45+
. Click *Create Alert*.
46+
4047

4148
== See Also
4249

4350
* xref:using-api-alerts.adoc[Review Alerts Concepts]
51+
* xref:gateway::flex-use-api-alerts.adoc[Add API Alerts for Flex Gateway]

modules/ROOT/pages/configure-api-task.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,13 @@ Not all options are available depending on the runtime as well as the API.
1414
| *API 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.
1515
| *Implementation URI* | The URL to access for the proxy or the API. It must end with a /. | Yes| For example, you can use the URL of your API asset in Exchange.
1616
| *Consumer endpoint* | Specifies a proxy application's address for consumers to use for sending requests.| No |
17-
| *Proxy version* | Specifies the version of the proxy to use for the endpoint.| No |
1817
| *Base path* | Specifies the URL prefix for all API paths, relative to the host root. It must start with a leading slash /. | No |
19-
| **Advanced Options** | | |
2018
| *Scheme* | Specifies whether to use HTTP or HTTPS. | Yes | If you select HTTPS, specify a TLS context for inbound traffic.
19+
| *TLS Context for inbound traffic* | Specifies the 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.
2120
| *Port* | Specifies the number to use if the displayed port is incorrect. | No | Port can be shared between API instances over the same Target as long as the Base paths are different. Only available on Flex 1.2.0+.
21+
| *Client provider* | Specifies a client provider for the API. | No | Anypoint Platform acts as the client provider by default. To configure an external client provider, see xref:access-management::managing-api-clients.adoc[Client Providers].
22+
| **Advanced Options** | | |
23+
| *TLS Context for outbound traffic* | Specifies the TLS Context used for the outbound traffic. | No | xref:gateway::flex-conn-tls-config.adoc[Configure a TLS Context for Flex Gateway] before adding a TLS Context to your API.
2224
|===
2325

2426
== Configure an API Instance on Service Mesh Options

modules/ROOT/pages/create-instance-task.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@ the sandbox environment, and you want to promote it to the current or production
1414
* *Import API from zip file:* Select this option if you have exported an API Instance from a different Anypoint Platform
1515
instance.
1616
17-
When you are promoting or importing an API Instance, you will not have options to alter the configuration. However,
18-
when you add a new API Instance, you will need to configure the endpoint as well as other settings.
17+
When you are promoting or importing an API Instance, you do not have options to alter the configuration. However,
18+
when you add a new API Instance, you need to xref:configure-api-task.adoc[configure the endpoint] as well as other settings.
1919

2020
== Add a New API
2121

2222
. Log in to Anypoint Platform.
2323
. In the navigation bar or the Anypoint Platform page, click *API Manager*.
2424
. Click *Add API* and select *Add new API*.
2525
. Select and configure your runtime from the following options:
26-
Flex Gateway:: Select Flex Gateway for any APIs that need a flexible, performant API gateway
27-
that will work with distributed and microservices environments and fit into your CI/CD environments.
26+
Flex Gateway:: Select Flex Gateway for any APIs that need a flexible and performant API gateway
27+
that works with distributed and microservices environments and fits into your CI/CD environments.
2828
+
2929
Choose the connected Flex Gateway you have installed and registered from the list under *Select a gateway*.
3030
+
@@ -52,11 +52,11 @@ include::partial$task-configure-proxy.adoc[tags=target-type-bullet;target-type]
5252
Service Mesh:: Select Service Mesh to extend Anypoint Platform API Management capabilities to your
5353
Istio service mesh through the deployment of a Mule Adapter.
5454
+
55-
NOTE: After adding the API on Anypoint Platform, you will need to bind it to a service using the Anypoint Service Mesh client. See xref:service-mesh::configure-service-mesh.adoc#methods-for-configuring-anypoint-service-mesh[Methods for Configuring Anypoint Service Mesh] for more information.
55+
NOTE: After adding the API on Anypoint Platform, you need to bind it to a service using the Anypoint Service Mesh client. See xref:service-mesh::configure-service-mesh.adoc#methods-for-configuring-anypoint-service-mesh[Methods for Configuring Anypoint Service Mesh] for more information.
5656
+
5757
. Click *Next*.
5858
+
59-
include::partial$task-configure-proxy.adoc[tags=mid-steps;asset-type-options;last-steps,leveloffset=+2]
59+
include::partial$task-configure-proxy.adoc[tags=mid-steps;asset-type-options;configure-endpoint;last-steps,leveloffset=+2]
6060

6161

6262
== Promote API from Environment

modules/ROOT/pages/datagraph-landing-page.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ ifndef::env-site,env-github[]
33
include::_attributes.adoc[]
44
endif::[]
55

6-
You manage Anypoint DataGraph in API Manager. The DataGraph Administration page for a particular environment appears only after you have added at least one API schema to that environment's unified schema.
6+
You manage Anypoint DataGraph in API Manager. The DataGraph Administration page for a given environment appears only after you have added at least one API schema to that environment's unified schema.
77

8-
As an Anypoint DataGraph administrator:
8+
Both Anypoint DataGraph administrators and contributors can:
99

1010
* Use the xref:datagraph-settings.adoc[Anypoint DataGraph Administration settings] to select environments, view and edit the GraphQL endpoint of a unified schema, configure policies, and configure client providers.
1111
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
= Gateway Policies in API Manager
2+
ifndef::env-site,env-github[]
3+
include::_attributes.adoc[]
4+
endif::[]
5+
:imagesdir: ../assets/images
6+
:page-aliases:
7+
8+
From API Manager, you can apply policies to APIs in Flex Gateway Connected Mode or in Mule Gateway.
9+
10+
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).
11+
12+
With policies, you can implement these regulations with no modification to the code implementation.
13+
14+
Because the policies are implemented by the Gateway, policies are documented in the xref:gateway-home::gateway-overview.adoc[Gateway documentation]. For more information, see the xref:policies::policies-overview.adoc[Policy documentation] or use the links in the following sections.
15+
16+
== Policies Included in Flex Gateway and Mule Gateway
17+
18+
* xref:policies::policies-included-directory.adoc[Included Policies Directory]
19+
20+
== Applying Policies in Flex Gateway Connected Mode and in Mule Gateway
21+
22+
* xref:policies::policies-included-apply.adoc[Apply an Included Policy]
23+
24+
== See Also
25+
26+
* xref:policies::policies-included-reorder.adoc[]
27+
* xref:policies::policies-policy-categories.adoc[Policy Categories]
28+
* xref:policies::policies-compare-versions.adoc[Comparison of Mule 3 and Mule 4 Policies]
29+
* xref:policies::policies-flex-dataweave-support.adoc[DataWeave Support in Flex Gateway Policies]
30+
* xref:policies::policies-automated-overview.adoc[Automated Policies]
31+
* xref:policies::policies-resource-level-overview.adoc[Resource-Level Policies]
32+
* xref:policies::policies-custom-overview.adoc[Custom Policies]
33+
34+
35+
36+
// You can apply policies to any HTTP-based APIs, such as:
37+
38+
// An APIkit project
39+
40+
// For example, deploy the APIkit project to Anypoint Platform using API Autodiscovery, and then apply a policy.
41+
42+
// An API running on CloudHub
43+
44+
// Design an API on Anypoint Platform, configure a proxy for Cloudhub, and apply a policy.
45+
46+
// An API running on Anypoint Runtime Fabric
47+
48+
// Design an API on Anypoint Platform, configure a proxy for Runtime Fabric, and apply a policy.
49+
50+
// An API deployed to a private or cloud-based Mule runtime engine (Mule) 3.8.x or later
51+
52+
// You can apply a policy to any API implemented in Anypoint Platform, as long as the API is exposed through an HTTP listener. You can also apply a policy to APIs not implemented in Anypoint Platform by deploying a proxy application to control how and when a received request is forwarded to its implementation endpoint. Anypoint API Manager supports RAML, HTTP, or SOAP-based proxies.
53+
54+
// When applying a policy with SLA, you can set an API alert to notify you when an API request violates that policy. By default, a policy applies to the entire API, filtering traffic requests to every resource and method. You can configure this to provide resource-level granularity if needed.

0 commit comments

Comments
 (0)