Skip to content

Commit 9292e25

Browse files
glenn-rodgers-sfglenn-rodgers-sf
authored
Merge pull request #535 from mulesoft/W-13480387-fix-partial-gr
W-13480387 fix partial gr
2 parents ebd8d2d + 3bc9cf8 commit 9292e25

11 files changed

Lines changed: 188 additions & 213 deletions

‎modules/ROOT/pages/_partials/api-configuration-tables.adoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464
|===
6565
| Field Name | Description | Required | Notes
6666
| *Protocol* | Specifies whether to use HTTP or HTTPS for the validations. | Yes | If you select HTTPS, specify a TLS context for inbound traffic.
67-
| *Inbound TLS* | Specifies the TLS context to secure inbound traffic. | No | Only available on Mule 4+. If you can't see a context, ensure that you have the correct permissions.
67+
| *Inbound TLS* | Specifies the TLS context to secure inbound traffic. | No | Only available on Mule 4+. If you can't see a context, ensure that you have the correct permissions. To enable HTTPS in Mule 3 environment, see xref:enable-https-mule3-proxies.adoc[enable HTTPS in Mule 3x].
6868
| *Port* | Specifies the number to use if the displayed port is incorrect. | Yes |
6969
| *Base path* | Specifies the URL prefix for all API paths, relative to the host root. It must start with a leading slash `/`. | Yes |
7070
| *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.
@@ -76,7 +76,7 @@
7676
| *Service Name* | Name of your WSDL service. | Yes | Only avaliable for WSDL APIs.
7777
| *Service Port* | Port for your WSDL your service. | Yes | Only avaliable for WSDL APIs.
7878
| *Service Namespace* | Namespace of your WSDL service. | Yes | Only avaliable for WSDL APIs.
79-
| *Enable Console* | Specifies whether you can expose and test your API specification. | No | You can specify a different path in *Console Path*, for example, "/spec/*". Only available if you have an attached API definition. Only available on Mule 3+.
79+
| *Enable Console* | Specifies whether you can expose and test your API specification. | No | You can specify a different path in *Console Path*, for example, `/spec/*`. Only available if you have an attached API definition. Only available on Mule 3+.
8080
| *Validations* | Specifies whether to validate inbound requests against a provided specification. | No | Only available if you have an attached API definition. Only available on Mule 3+.
8181
| *Strict validations (optional)* | Specifies whether to validate inbound requests against query parameters. | No | Only available if you have an attached API definition. Only available on Mule 3+
8282
| *User Domain* | Specifies whether to use an API gateway domain. | No | If you chose *Hybrid* as the proxy deployment target previously in the configuration, ensure that you select this option. You must install the API gateway domain in Mule 3.8 and later.

‎modules/ROOT/pages/_partials/task-add-api-instance.adoc‎

Lines changed: 168 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,171 @@ The following diagram shows the relationship of the upstream and downstream conf
3838
image:api-upstream-downstream-config.png[The API instance is deployed on a gateway between the upstream and downstream configuration]
3939

4040
//end::intro2[]
41+
42+
43+
// Steps
44+
45+
// First steps for all Mule proxies
46+
//tag::proxy-first-steps[]
47+
. Navigate to *Anypoint Platform* > *API Manager*.
48+
. In *API Administration*, click *Add API* and select *Add new API*.
49+
. Select *Mule Gateway* as your runtime.
50+
. Select *Deploy a proxy application* for *Proxy type*.
51+
//end::proxy-first-steps[]
52+
53+
// All target types for Mule apps and proxies
54+
//tag::target-type[]
55+
. Select the *Target type* from the following options:
56+
+
57+
* *CloudHub 2.0*: Select this option if you want to use the Mule runtime hosted by MuleSoft in a container-based cloud infrastructure. The
58+
CloudHub 2.0 proxy includes a CPU with 0.1 vCores by default.
59+
.. Select the **Runtime version**.
60+
.. Enter a **Proxy app name**.
61+
+
62+
[NOTE]
63+
--
64+
When deploying an API directly to CloudHub 2.0, you cannot choose the region where the API is deployed. If you have a private space, your API is deployed to your private space. Otherwise, your API is deployed to the shared space in your default region. If you have multiple private spaces, a private space is chosen for you. Private spaces in your default region are chosen first. To learn more about spaces, see xref:cloudhub-2::ch2-shared-space-about.adoc[] and xref:cloudhub-2::ch2-private-space-about.adoc[].
65+
--
66+
* *CloudHub*: Select this option if you want to use the Mule runtime hosted on the cloud by MuleSoft. The
67+
CloudHub proxy includes a CPU with 0.1 vCores and a memory of 500 MB, by default.
68+
.. Select the **Runtime version**.
69+
.. Enter a **Proxy app name**.
70+
* *Hybrid:* Select Hybrid if you have a Mule runtime running on an on-premises server that you want to use.
71+
See xref:runtime-manager::servers-create.adoc[Register a server in Runtime Manager] for more information.
72+
+
73+
[NOTE]
74+
--
75+
If you are running an API with a self-managed server, use the xref:manage-exchange-api-task.adoc[classic API creation flows]
76+
to manage your API.
77+
--
78+
+
79+
.. Select a target from the list or click **Add server**.
80+
.. Enter a *Proxy app name*.
81+
82+
* **Runtime Fabric:** Select Runtime Fabric if you want to deploy API Proxies to a Mule runtime engine that is managed on Runtime Fabric.
83+
See xref:runtime-fabric::proxy-deploy-runtime-fabric.adoc[Deploying API Proxies to Runtime Fabric] for more information.
84+
.. Select a target from the list.
85+
.. Select the **Runtime version**.
86+
.. Enter a *Proxy app name*.
87+
//end::target-type[]
88+
89+
// Only the hybrid type proxy
90+
//tag::hybrid[]
91+
. Select *Hybrid* for *Target Type*, then select the target server.
92+
. Click *Next*.
93+
//end::hybrid[]
94+
95+
// Select api steps
96+
//tag::mid-steps[]
97+
. Select an API from the following options:
98+
* Click **Select API from Exchange** if you have an API shared with you through Exchange that you want to manage.
99+
[arabic]
100+
.. Click the API from the list under **Select API**. You can search for a specific API if needed.
101+
.. Update the *Asset type*, *API version*, and *Asset version* if needed.
102+
103+
* Click **Create new API**:
104+
[arabic]
105+
.. Enter a *Name* for the new API asset.
106+
//end::mid-steps[]
107+
108+
// Assets type options for flex because flex does not support soap APIs
109+
//tag::asset-type-options-flex[]
110+
.. Select the **Asset type** from the following options:
111+
112+
** **REST API:** Select this option if you have a RAML or OAS API definition file you want to include for your asset.
113+
+
114+
Upload either a RAML or OAS file for your REST API. Versions 2.0.0 and later are the recommended versions for OAS or RAML specs, because these versions add native OAS support. If you upload an OAS API specification to an API proxy version 1.0 or earlier, your API specification is translated to RAML.
115+
** **HTTP API:** Select this option if you do not have an API definition file you want to include for your asset.
116+
117+
.. Optionally, click *Advanced* to edit the *AssetId* and the *Version*.
118+
. Click *Next*.
119+
//end::asset-type-options-flex[]
120+
121+
// All API assets types
122+
//tag::asset-type-options[]
123+
.. Select the **Asset type** from the following options:
124+
125+
** **REST API:** Select this option if you have a RAML or OAS API definition file you want to include for your asset.
126+
+
127+
Upload either a RAML or OAS file for your REST API. Versions 2.0.0 and later are the recommended versions for OAS or RAML specs, because these versions add native OAS support. If you upload an OAS API specification to an API proxy version 1.0 or earlier, your API specification is translated to RAML.
128+
** **HTTP API:** Select this option if you do not have an API definition file you want to include for your asset.
129+
** **SOAP API:** Select this option if you have a WSDL API definition file or an external link to the file.
130+
+
131+
Upload a WSDL file for your SOAP API or add the link to the file. +
132+
This option is not available for Flex Gateway runtime at this time.
133+
134+
.. Optionally, click *Advanced* to edit the *AssetId* and the *Version*.
135+
. Click *Next*.
136+
//end::asset-type-options[]
137+
138+
// asset type options for REST Proxies
139+
//tag::raml-oas[]
140+
.. Select **REST API** as the **Asset type**.
141+
.. Upload either a RAML or OAS file for your REST API.
142+
+
143+
NOTE: Anypoint API Manager supports OpenAPI Specification (OAS) 3.0, with the exception of the callback feature. To work around this issue, handle the callback outside of the Mule runtime engine domain or use an OAS 3.0 specification that does not use callbacks.
144+
145+
.. Optionally, click *Advanced* to edit the *AssetId* and the *Version*.
146+
. Click *Next*.
147+
//end::raml-oas[]
148+
149+
// asset type options for SOAP Proxies
150+
//tag::soap[]
151+
.. Select **SOAP API** as the **Asset type**.
152+
.. Select either *Upload a WSDL* or *Use an external link* as the method.
153+
.. Optionally, click *Advanced* to edit the *AssetId* and the *Version*.
154+
. Click *Next*.
155+
//end::soap[]
156+
157+
// Mule proxies downstream
158+
//tag::proxy-downstream[]
159+
160+
. Configure the downstream configuration settings:
161+
+
162+
.Expand for configuration settings.
163+
[%collapsible]
164+
====
165+
include::partial$api-configuration-tables.adoc[tags=mule-proxy-downstream]
166+
====
167+
168+
. Click *Next*.
169+
//end::proxy-downstream[]
170+
171+
// HTTPS Mule proxies downstream
172+
//tag::https-proxy-downstream[]
173+
174+
. Configure the downstream configuration settings:
175+
+
176+
.Expand for configuration settings.
177+
[%collapsible]
178+
====
179+
include::partial$api-configuration-tables.adoc[tags=mule-proxy-downstream]
180+
====
181+
+
182+
NOTE: To configure an HTTPS Proxy, you must select *HTTPS* and configure an *Inbound TLS* context.
183+
184+
. Click *Next*.
185+
//end::https-proxy-downstream[]
186+
187+
// Mule proxies upstream
188+
//tag::proxy-upstream[]
189+
190+
. Configure the upstream configuration settings:
191+
+
192+
.Expand for configuration settings.
193+
[%collapsible]
194+
====
195+
include::partial$api-configuration-tables.adoc[tags=mule-proxy-upstream]
196+
====
197+
198+
. Click *Next*.
199+
//end::proxy-upstream[]
200+
201+
// Steps to save
202+
//tag::last-steps[]
203+
204+
. Review your selections and edit them if necessary.
205+
. If you are ready to deploy, click **Save & Deploy**. Otherwise, you can select **Save**, to save the API instance
206+
and deploy it at a later time.
207+
+
208+
// end::last-steps[]

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

Lines changed: 0 additions & 189 deletions
This file was deleted.

‎modules/ROOT/pages/building-https-proxy.adoc‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,9 @@ Set TLS context's target to *Mule*.
3030

3131
== Configure your HTTPS API Proxy
3232

33-
Configure your HTTPS API Proxy by completing the following tasks:
33+
Configure your HTTPS API Proxy by completing the following steps:
3434

35-
include::partial$task-configure-proxy.adoc[tags=intro;first-steps;target-type-heading;target-type-number;target-type;mid-steps-heading;mid-steps;asset-type-options;mid-steps2;raml-oas-version,leveloffset=+2]
36-
37-
include::partial$task-configure-proxy.adoc[tags=last-steps-heaing;last-steps,leveloffset=+2]
35+
include::partial$task-add-api-instance.adoc[tags=proxy-first-steps;target-type;mid-steps;asset-type-options;https-proxy-downstream;proxy-upstream;last-steps]
3836

3937

4038
== API Proxy Deployment

0 commit comments

Comments
 (0)