|
1 | | -//tag::intro[] |
2 | | - |
3 | | -. <<select_proxy_type, Select Proxy Type>> |
4 | | -. <<select_and_configure_target_type, Select and Configure Proxy Type>> |
5 | | -. <<select_an_api, Select an API>> |
6 | | -. <<configure_options, Configure Options>> |
7 | | -. <<review_save_and_deploy, Review, Save, and Deploy>> |
8 | | - |
9 | | -//end::intro[] |
10 | | -//tag::first-steps[] |
11 | | - |
12 | | -[[select_proxy_type]] |
13 | | -= Select a Proxy Type |
14 | | - |
15 | | -. Navigate to *Anypoint Platform* > *API Manager*. |
16 | | -. In *API Administration*, click *Add API* and select *Add new API*. |
17 | | -. Select *Mule Gateway* as your runtime. |
18 | | -. Select *Deploy a proxy application* for *Proxy type*. |
19 | | -//end::first-steps[] |
20 | | -//tag::target-type-heading[] |
21 | | - |
22 | | -[[select_and_configure_target_type]] |
23 | | -= Select and Configure a Target Type |
24 | | -//end::target-type-heading[] |
25 | | -//tag::target-type-number[] |
26 | | -. Select the *Target type* from the following options: |
27 | | -//end::target-type-number[] |
28 | | -//tag::target-type-bullet[] |
29 | | -Select the *Target type* from the following options: |
30 | | -//end::target-type-bullet[] |
31 | | - |
32 | | -//tag::target-type[] |
33 | | -+ |
34 | | -* *CloudHub 2.0*: Select this option if you want to use the Mule runtime hosted by MuleSoft in a container-based cloud infrastructure. The |
35 | | -CloudHub 2.0 proxy includes a CPU with 0.1 vCores by default. |
36 | | -.. Select the **Runtime version**. |
37 | | -.. Enter a **Proxy app name**. |
38 | | -+ |
39 | | -[NOTE] |
40 | | --- |
41 | | -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[]. |
42 | | --- |
43 | | -* *CloudHub*: Select this option if you want to use the Mule runtime hosted on the cloud by MuleSoft. The |
44 | | -CloudHub proxy includes a CPU with 0.1 vCores and a memory of 500 MB, by default. |
45 | | -.. Select the **Runtime version**. |
46 | | -.. Enter a **Proxy app name**. |
47 | | -* *Hybrid:* Select Hybrid if you have a Mule runtime running on an on-premises server that you want to use. |
48 | | -See xref:runtime-manager::servers-create.adoc[Register a server in Runtime Manager] for more information. |
49 | | -+ |
50 | | -[NOTE] |
51 | | --- |
52 | | -If you are running an API with a self-managed server, use the xref:manage-exchange-api-task.adoc[classic API creation flows] |
53 | | -to manage your API. |
54 | | --- |
55 | | -+ |
56 | | -.. Select a target from the list or click **Add server**. |
57 | | -.. Enter a *Proxy app name*. |
58 | | - |
59 | | -* **Runtime Fabric:** Select Runtime Fabric if you want to deploy API Proxies to a Mule runtime engine that is managed on Runtime Fabric. |
60 | 1 | See xref:runtime-fabric::proxy-deploy-runtime-fabric.adoc[Deploying API Proxies to Runtime Fabric] for more information. |
61 | | -.. Select a target from the list. |
62 | | -.. Select the **Runtime version**. |
63 | | -.. Enter a *Proxy app name*. |
64 | | -//end::target-type[] |
65 | | -//tag::service-mesh[] |
66 | | -* *Service Mesh:* Select Service Mesh to extend Anypoint Platform API Management capabilities to your |
67 | | -Istio service mesh through the deployment of a Mule Adapter. |
68 | | -+ |
69 | | -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. |
70 | | - |
71 | | -. Click *Next*. |
72 | | -//end::service-mesh[] |
73 | | -//tag::hybrid[] |
74 | | -. Select *Hybrid* for *Proxy deployment target*, then select the target server. |
75 | | -. Click *Next*. |
76 | | -//end::hybrid[] |
77 | | -//tag::mid-steps-heading[] |
78 | | - |
79 | | -[[select_an_api]] |
80 | | -= Select an API |
81 | | -//end::mid-steps-heading[] |
82 | | -//tag::mid-steps[] |
83 | | - |
84 | | -. Select an API from the following options: |
85 | | -* Click **Select API from Exchange** if you have an API shared with you through Exchange that you want to manage. |
86 | | -[arabic] |
87 | | -.. Click the API from the list under **Select API**. You can search for a specific API if needed. |
88 | | -.. Update the Asset type, API version, and Asset version if needed. |
89 | | - |
90 | | -* Click **Create new API**. |
91 | | -[arabic] |
92 | | -.. Enter a name for the new API asset. |
93 | | -//end::mid-steps[] |
94 | | -//tag::asset-type-options-flex[] |
95 | | -.. Select the **Asset type** from the following options: |
96 | | - |
97 | | -** **REST API:** Select this option if you have a RAML or OAS API definition file you want to include for your asset. |
98 | | -+ |
99 | | -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. |
100 | | -** **HTTP API:** Select this option if you do not have an API definition file you want to include for your asset. |
101 | | - |
102 | | -.. Optionally, you can add an **AssetId** and customize the **Version** or **API Version** details by clicking **Advanced**. |
103 | | -. Click *Next*. |
104 | | -//end::asset-type-options-flex[] |
105 | | -//tag::asset-type-options[] |
106 | | -.. Select the **Asset type** from the following options: |
107 | | - |
108 | | -** **REST API:** Select this option if you have a RAML or OAS API definition file you want to include for your asset. |
109 | | -+ |
110 | | -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. |
111 | | -** **HTTP API:** Select this option if you do not have an API definition file you want to include for your asset. |
112 | | -** **SOAP API:** Select this option if you have a WSDL API definition file or an external link to the file. |
113 | | -+ |
114 | | -Upload a WSDL file for your SOAP API or add the link to the file. + |
115 | | -This option is not available for Flex Gateway runtime at this time. |
116 | | - |
117 | | -.. Optionally, you can add an **AssetId** and customize the **Version** or **API Version** details by clicking **Advanced**. |
118 | | -. Click *Next*. |
119 | | -//end::asset-type-options[] |
120 | | -//tag::raml-oas[] |
121 | | -.. Select **REST API** as the **Asset type**. |
122 | | -.. Upload either a RAML or OAS file for your REST API. |
123 | | -+ |
124 | | -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. |
125 | | - |
126 | | -. Click *Next*. |
127 | | -//end::raml-oas[] |
128 | | -//tag::soap[] |
129 | | -.. Select **SOAP API** as the **Asset type**. |
130 | | -.. Select either *Upload a WSDL* or *Use an external link* as the method. |
131 | | -. Click *Next*. |
132 | | -//end::soap[] |
133 | | -//tag::mid-steps2[] |
134 | | - |
135 | | -[[configure_options]] |
136 | | -= Configure Options |
137 | | - |
138 | | - |
139 | | -. If you want to enable TSL for inbound traffic: |
140 | | -** Select *HTTPS* for the *Scheme*. + |
141 | | -You should now see the *Inbound TLS* field enabled. |
142 | | -** Select *Add TLS Context*. |
143 | | -*** Select the secret group where you hosted your TLS context from the *Secret group* drop-down. |
144 | | -*** Select your TLS context for your HTTPS API Proxy from the *TLS Context* drop-down. |
145 | | -. Enter the *Port* number for your API proxy. |
146 | | -. Enter the *Base path*. |
147 | | -. Click *Advanced Options*. |
148 | | -. Select optional downstream configuration settings. For more configuration settings, see xref:create-instance-task-mule.adoc[]. |
149 | | -. In *Proxy Version*, select *latest*. + |
150 | | -This value ensures that your API proxy uses the latest released proxy version. |
151 | | -If a new proxy version is available in Anypoint platform, return to this step to reconfigure your proxy to the latest version. |
152 | | -. Click *Next*. |
153 | | -. Enter your *Upstream URL*. This is the URL to access the proxy or the API. For example, you can use the URL of your API asset in Exchange. + |
154 | | -This is the only required field. For further details on the optional fields, see xref:configure-api-task.adoc[Configure an API Endpoint]. |
155 | | -. Click *Add TLS Context* for *Outbound TLS*. This is required for API instances using HTTPs communication. |
156 | | -.. Select the secret group where you hosted your TLS Context from the *Secret Group* drop-down list. |
157 | | -.. Select your TLS Context for your HTTPS API Proxy from the *TLS Context* drop-down. |
158 | | -+ |
159 | | -[NOTE] |
160 | | -If you can't see a context, check that you have the right permissions, as mentioned in <<Before You Begin>>. |
161 | | - |
162 | | -. Click *Next*. |
163 | | -//end::mid-steps2[] |
164 | | -//tag::raml-oas-version[] |
165 | | -+ |
166 | | -Versions 2.0.0 and later are the recommended versions for OAS or RAML specs, because these versions add native OAS support. |
167 | | -If you upload an OAS API specification to an API proxy version 1.0 or earlier, your API specification is translated to RAML. |
168 | | -+ |
169 | | -//end::raml-oas-version[] |
170 | | -//tag::tls[] |
171 | | -. If you plan to have xref:building-https-proxy.adoc[HTTPS] communications, specify a TLS Context. |
172 | | -. Click *Next*. |
173 | | -//end::tls[] |
174 | | -//tag::configure-endpoint[] |
175 | | -. xref:api-manager::configure-api-task.adoc[Configure the endpoint]. |
176 | | -. Click *Next*. |
177 | | -//end::configure-endpoint[] |
178 | | -//tag::last-steps-heading[] |
179 | | - |
180 | | -[[review_save_and_deploy]] |
181 | | -= Review, Save, and Deploy |
182 | | -//end::last-steps-heading[] |
183 | | -//tag::last-steps[] |
184 | | - |
185 | | -. Review your selections and edit them if necessary. |
186 | | -. If you are ready to deploy, click **Save & Deploy**. Otherwise, you can select **Save**, to save the API instance |
187 | | -and deploy it at a later time. |
188 | | -+ |
189 | | -// end::last-steps[] |
0 commit comments