From e2163479c1953faa74ce6ad606d63ad4eaf54904 Mon Sep 17 00:00:00 2001 From: Glenn Rodgers Date: Wed, 6 Mar 2024 12:08:52 -0500 Subject: [PATCH 1/6] Edits --- modules/ROOT/nav.adoc | 1 - .../pages/_partials/task-add-api-instance.adoc | 18 +++++++++++++----- modules/ROOT/pages/add-api-instances.adoc | 2 -- .../ROOT/pages/create-instance-task-mule.adoc | 2 ++ 4 files changed, 15 insertions(+), 8 deletions(-) diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index de6236527..906bdaddb 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -7,7 +7,6 @@ *** xref:create-instance-task-flex.adoc[Add a Flex Gateway API Instance] *** xref:create-instance-task-mule.adoc[Add a Mule Gateway API Instance] *** xref:create-instance-task-service-mesh.adoc[Add a Service Mesh API Instance] - *** xref:manage-exchange-api-task.adoc[Add an API Instance on a Self-Managed Server] ** xref:find-api-id-task.adoc[Obtain an API Instance ID] ** xref:export-api-latest-task.adoc[Export an API Instance] ** xref:access-developer-portal-task.adoc[Access the Developer Portal] diff --git a/modules/ROOT/pages/_partials/task-add-api-instance.adoc b/modules/ROOT/pages/_partials/task-add-api-instance.adoc index f84879bc2..6c06b863b 100644 --- a/modules/ROOT/pages/_partials/task-add-api-instance.adoc +++ b/modules/ROOT/pages/_partials/task-add-api-instance.adoc @@ -72,14 +72,22 @@ CloudHub proxy includes a CPU with 0.1 vCores and a memory of 500 MB, by default ... Select the *Version* for Mule runtime. ... Select the *Java version*. .. Enter a *Proxy app name*. -* *Hybrid:* Select Hybrid if you have a Mule runtime running on an on-premises server that you want to use. + +* *Hybrid:* Select Hybrid if you want to use a Mule runtime running on an on-premises server that is registered in Runtime Manager. See xref:runtime-manager::servers-create.adoc[Register a server in Runtime Manager] for more information. + +.. Select a target from the list or click **Add server**. +.. Enter a *Proxy app name*. + +* *Self-managed Server:* Select self-managed server if you want to create a JAR file to deploy an API proxy to a Mule runtime running on an on-premises server that is not registered in Runtime Manager. For more information, see xref:runtime-manager::mule-deployment-model.adoc[]. ++ [NOTE] --- -If you are running an API with a self-managed server, use the xref:manage-exchange-api-task.adoc[classic API creation flows] -to manage your API. --- +==== +Deploying an API proxy to a self-managed server in API Manager, does not deploy the proxy to your on-premise server. After you deploy the proxy in API Manager, to deploy the proxy to your on-premise server: + +. xref:download-proxy-task.adoc[Download your new API proxy JAR file]. +. xref:deploy-on-premises.adoc[Deploy the JAR file to your on-premise server]. +==== + .. Select a target from the list or click **Add server**. .. Enter a *Proxy app name*. diff --git a/modules/ROOT/pages/add-api-instances.adoc b/modules/ROOT/pages/add-api-instances.adoc index 8007598c4..349ae2e55 100644 --- a/modules/ROOT/pages/add-api-instances.adoc +++ b/modules/ROOT/pages/add-api-instances.adoc @@ -9,5 +9,3 @@ include::partial$task-add-api-instance.adoc[tags=flex-intro] include::partial$task-add-api-instance.adoc[tags=mule-intro] * xref:create-instance-task-service-mesh.adoc[] + include::partial$task-add-api-instance.adoc[tags=service-mesh-intro] -* xref:manage-exchange-api-task.adoc[] + -Use a Hybrid deployment type to add API instances to self-managed servers. diff --git a/modules/ROOT/pages/create-instance-task-mule.adoc b/modules/ROOT/pages/create-instance-task-mule.adoc index 49448f7ee..0679b427d 100644 --- a/modules/ROOT/pages/create-instance-task-mule.adoc +++ b/modules/ROOT/pages/create-instance-task-mule.adoc @@ -3,6 +3,8 @@ ifndef::env-site,env-github[] include::_attributes.adoc[] endif::[] :product: mule +:page-aliases: manage-exchange-api-task.adoc + include::partial$task-add-api-instance.adoc[tags=intro1;mule-intro;intro2] From 5bf90904bdbe81ce686638511128fe9b32f6cf16 Mon Sep 17 00:00:00 2001 From: Glenn Rodgers Date: Wed, 6 Mar 2024 12:41:13 -0500 Subject: [PATCH 2/6] Delete manage-exchange-api-task.adoc --- .../ROOT/pages/manage-exchange-api-task.adoc | 120 ------------------ 1 file changed, 120 deletions(-) delete mode 100644 modules/ROOT/pages/manage-exchange-api-task.adoc diff --git a/modules/ROOT/pages/manage-exchange-api-task.adoc b/modules/ROOT/pages/manage-exchange-api-task.adoc deleted file mode 100644 index 991d5b7f8..000000000 --- a/modules/ROOT/pages/manage-exchange-api-task.adoc +++ /dev/null @@ -1,120 +0,0 @@ -= Adding an API Instance on a Self-Managed Server -ifndef::env-site,env-github[] -include::_attributes.adoc[] -endif::[] - -If you are running an API on a self-managed server, you have two options for adding an API instance: - -* Manage API from Exchange -* Create new API - -== Manage API Instance from Exchange - -To manage an API instance from Exchange: - -. Navigate to *Anypoint Platform* > *API Manager*. -. In *API Administration*, click **Add API** and select **Add new API**. -. Select **Mule Gateway** as your runtime. -. Select **Deploy a proxy application** for **Proxy type**. -. Select **Hybrid** for **Target type**. -. Click **self-managed server** link at the bottom of the page. -. Click **Manage API from Exchange**. -. -. In *API Name*, search for the API that you want to manage from the list of available APIs in Exchange. -+ -The *Asset type*, *API version*, and *Asset version* fields are automatically populated. -+ -NOTE: OpenAPI Specification (OAS) 3.0 is supported, 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. -+ -. For *Managing Type*, choose the type of API endpoint that you want to create: -* *Basic Endpoint:* Use this option if you created your API outside API Manager, but want to apply policies or otherwise manage the API using API Manager. For example, if you created the API using Mule Runtime, you do not need a proxy. -+ -Select the *Application type* from the following options: - -** *Mule Application:* Use this option if you are running a Mule application. -** *Non-Mule Application managed by Anypoint Service Mesh:* Use this option if you want to manage Kubernetes-based non-Mule microservices with Anypoint Service Mesh. -* *Endpoint with Proxy:* Use this option if you want to provide additional security for your API. - -. If you want to manage the API using Mule 4 or later (recommended), accept the default selection for *Mule version*. -+ -The parameters that you must specify differ based on the Mule version you select. For detailed field descriptions, see <>. -. In *Implementation URI*, replace the example by entering the URL of the site that hosts the API. -+ -For example, you can use the URL of your API asset in Exchange. In this case, the API is consuming the JSONPlaceholder API, so enter `+http://jsonplaceholder.typicode.com+`. -. To secure outbound traffic, in *TLS Context for outbound traffic*, click *Add TLS Context* and enter the details in the *Select TLS Context* window. -. If you are creating an endpoint with proxy, accept the base path `/` for the proxy endpoint in the *Path* field, or enter another path. -+ -For example, if an API is defined with the `Implementation URI` set to `http://jsonplaceholder.typicode.com`, the proxy returns the following URIs based on the value you configure in the proxy path: -+ -[%header%autowidth.spread,cols="a,a,a"] -|=== -| *Proxy Path* | *Request* | *Response from Proxy* -|`/` | `https://domain.cloudhub.io/users` | `http://jsonplaceholder.typicode.com/users` -| `/api` | `https://domain.cloudhub.io/api/users` | `http://jsonplaceholder.typicode.com/users` -|=== -. Optionally, to fine-tune additional configurations for the API, expand *Advanced options*, specify the <>, and click *Save*. - -== Create new API - -To create a new API instance and configure the endpoint: - -. Navigate to *Anypoint Platform* > *API Manager*. -. In *API Administration*, click **Add API** and select **Add new API**. -. Select **Mule Gateway** as your runtime. -. Select **Deploy a proxy application** for **Proxy type**. -. Select **Hybrid** for **Target type**. -. Click **self-managed server** link at the bottom of the page. -. Click **Create new API**. -. Enter a name for your API. -. Select an asset type. -. Select a file upload if needed. -. Click *Continue*. -. For *Managing Type*, choose the type of API endpoint that you want to create: -* *Basic Endpoint:* Use this option if you created your API outside API Manager, but want to apply policies or otherwise manage the API using API Manager. For example, if you created the API using Mule Runtime, you do not need a proxy. -+ -Select the *Application type* from the following options: - -** *Mule Application:* Use this option if you are running a Mule application. -** *Non-Mule Application managed by Anypoint Service Mesh:* Use this option if you want to manage Kubernetes-based non-Mule microservices with Anypoint Service Mesh. -* *Endpoint with Proxy:* Use this option if you want to provide additional security for your API. - -. If you want to manage the API using Mule 4 or later (recommended), accept the default selection for *Mule version*. -+ -The parameters that you must specify differ based on the Mule version you select. For detailed field descriptions, see <>. -. In *Implementation URI*, replace the example by entering the URL of the site that hosts the API. -+ -For example, you can use the URL of your API asset in Exchange. In this case, the API is consuming the JSONPlaceholder API, so enter `+http://jsonplaceholder.typicode.com+`. -. To secure outbound traffic, in *TLS Context for outbound traffic*, click *Add TLS Context* and enter the details in the *Select TLS Context* window. -. If you are creating an endpoint with proxy, accept the base path `/` for the proxy endpoint in the *Path* field, or enter another path. -+ -For example, if an API is defined with the `Implementation URI` set to `http://jsonplaceholder.typicode.com`, the proxy returns the following URIs based on the value you configure in the proxy path: -+ -[%header%autowidth.spread,cols="a,a,a"] -|=== -| *Proxy Path* | *Request* | *Response from Proxy* -|`/` | `https://domain.cloudhub.io/users` | `http://jsonplaceholder.typicode.com/users` -| `/api` | `https://domain.cloudhub.io/api/users` | `http://jsonplaceholder.typicode.com/users` -|=== -. Optionally, to fine-tune additional configurations for the API, expand *Advanced options*, specify the <>, and click *Save*. - - - - -[[field-reference]] -== Field Input Reference - -The input that you are required to provide when adding an API from Exchange depends on your specific situation, such as whether you want to create an endpoint with proxy, or whether the API was created using Mule 3 or Mule 4: - -[%header%autowidth.spread,cols="15%,35%,15%,35%"] -|=== -| Field Name | Description | Required | Notes -| *Implementation URI* | The URL to access for the proxy or the API. | Yes| For example, you can use the URL of your API asset in Exchange. In this case, the API is consuming the JSONPlaceholder API, so enter `+http://jsonplaceholder.typicode.com+`. -| *Proxy version* | Specifies the version of the proxy to use for the endpoint.| No | -| *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/*". -| *Validations* | Specifies whether to validate inbound requests against a provided specification. | No | You can configure the validations to verify incoming request against provided specifications or by using query parameters. -| *Scheme* | Specifies whether to use HTTP or HTTPS for the validations. | Yes | If you select HTTPS, specify a TLS context for inbound traffic. -| *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. -| *Port* | Specifies the number to use if the displayed port is incorrect. | No | -| *Response timeout* | Specifies the duration after which a request times out. | No | -| *Reference 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. -|=== From c5d31a4c5f2c22d9fb37d12b7ab83e9e81863652 Mon Sep 17 00:00:00 2001 From: Glenn Rodgers Date: Wed, 6 Mar 2024 13:05:36 -0500 Subject: [PATCH 3/6] Update task-add-api-instance.adoc --- modules/ROOT/pages/_partials/task-add-api-instance.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/ROOT/pages/_partials/task-add-api-instance.adoc b/modules/ROOT/pages/_partials/task-add-api-instance.adoc index 6c06b863b..a451bb2a3 100644 --- a/modules/ROOT/pages/_partials/task-add-api-instance.adoc +++ b/modules/ROOT/pages/_partials/task-add-api-instance.adoc @@ -79,14 +79,14 @@ See xref:runtime-manager::servers-create.adoc[Register a server in Runtime Manag .. Select a target from the list or click **Add server**. .. Enter a *Proxy app name*. -* *Self-managed Server:* Select self-managed server if you want to create a JAR file to deploy an API proxy to a Mule runtime running on an on-premises server that is not registered in Runtime Manager. For more information, see xref:runtime-manager::mule-deployment-model.adoc[]. +* *Self-managed Server:* Select self-managed server if you want to create a JAR file to deploy an API proxy to a Mule runtime running on an on-premises server that is not registered in Runtime Manager. For more information, see xref:mule-runtime::mule-deployment-model.adoc[]. + [NOTE] ==== Deploying an API proxy to a self-managed server in API Manager, does not deploy the proxy to your on-premise server. After you deploy the proxy in API Manager, to deploy the proxy to your on-premise server: . xref:download-proxy-task.adoc[Download your new API proxy JAR file]. -. xref:deploy-on-premises.adoc[Deploy the JAR file to your on-premise server]. +. xref:mule-runtime::deploy-on-premises.adoc[Deploy the JAR file to your on-premise server]. ==== + .. Select a target from the list or click **Add server**. From 46793beeb81542fb02e0986c9759f28d96c40e83 Mon Sep 17 00:00:00 2001 From: Glenn Rodgers Date: Fri, 8 Mar 2024 12:16:36 -0500 Subject: [PATCH 4/6] Update task-add-api-instance.adoc --- modules/ROOT/pages/_partials/task-add-api-instance.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/_partials/task-add-api-instance.adoc b/modules/ROOT/pages/_partials/task-add-api-instance.adoc index a451bb2a3..962fd4452 100644 --- a/modules/ROOT/pages/_partials/task-add-api-instance.adoc +++ b/modules/ROOT/pages/_partials/task-add-api-instance.adoc @@ -83,7 +83,7 @@ See xref:runtime-manager::servers-create.adoc[Register a server in Runtime Manag + [NOTE] ==== -Deploying an API proxy to a self-managed server in API Manager, does not deploy the proxy to your on-premise server. After you deploy the proxy in API Manager, to deploy the proxy to your on-premise server: +Deploying an API proxy to a self-managed server in API Manager, does not deploy the proxy to your on-premise server. After you deploy the proxy in API Manager, deploy the proxy to your on-premise server: . xref:download-proxy-task.adoc[Download your new API proxy JAR file]. . xref:mule-runtime::deploy-on-premises.adoc[Deploy the JAR file to your on-premise server]. From c86f55e68dd6cb1011c7f0bb09a240f7001064dd Mon Sep 17 00:00:00 2001 From: glenn-rodgers-sf <115032644+glenn-rodgers-sf@users.noreply.github.com> Date: Fri, 8 Mar 2024 13:53:31 -0500 Subject: [PATCH 5/6] Update modules/ROOT/pages/_partials/task-add-api-instance.adoc Co-authored-by: Beth Joson <88461166+bjoson-mulesoft@users.noreply.github.com> --- modules/ROOT/pages/_partials/task-add-api-instance.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/_partials/task-add-api-instance.adoc b/modules/ROOT/pages/_partials/task-add-api-instance.adoc index 962fd4452..74676a5ca 100644 --- a/modules/ROOT/pages/_partials/task-add-api-instance.adoc +++ b/modules/ROOT/pages/_partials/task-add-api-instance.adoc @@ -83,7 +83,7 @@ See xref:runtime-manager::servers-create.adoc[Register a server in Runtime Manag + [NOTE] ==== -Deploying an API proxy to a self-managed server in API Manager, does not deploy the proxy to your on-premise server. After you deploy the proxy in API Manager, deploy the proxy to your on-premise server: +Deploying an API proxy to a self-managed server in API Manager does not deploy the proxy to your on-premise server. After you deploy the proxy in API Manager, deploy the proxy to your on-premise server: . xref:download-proxy-task.adoc[Download your new API proxy JAR file]. . xref:mule-runtime::deploy-on-premises.adoc[Deploy the JAR file to your on-premise server]. From 42df96bed03d78bc98993b82468a59c6b5644b4c Mon Sep 17 00:00:00 2001 From: Glenn Rodgers Date: Fri, 8 Mar 2024 13:55:22 -0500 Subject: [PATCH 6/6] Update task-add-api-instance.adoc --- modules/ROOT/pages/_partials/task-add-api-instance.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/ROOT/pages/_partials/task-add-api-instance.adoc b/modules/ROOT/pages/_partials/task-add-api-instance.adoc index 962fd4452..e5f2713aa 100644 --- a/modules/ROOT/pages/_partials/task-add-api-instance.adoc +++ b/modules/ROOT/pages/_partials/task-add-api-instance.adoc @@ -73,13 +73,13 @@ CloudHub proxy includes a CPU with 0.1 vCores and a memory of 500 MB, by default ... Select the *Java version*. .. Enter a *Proxy app name*. -* *Hybrid:* Select Hybrid if you want to use a Mule runtime running on an on-premises server that is registered in Runtime Manager. +* *Hybrid:* Select this option if you want to use a Mule runtime running on an on-premises server that is registered in Runtime Manager. See xref:runtime-manager::servers-create.adoc[Register a server in Runtime Manager] for more information. + .. Select a target from the list or click **Add server**. .. Enter a *Proxy app name*. -* *Self-managed Server:* Select self-managed server if you want to create a JAR file to deploy an API proxy to a Mule runtime running on an on-premises server that is not registered in Runtime Manager. For more information, see xref:mule-runtime::mule-deployment-model.adoc[]. +* *Self-managed Server:* Select this option if you want to create a JAR file to deploy an API proxy to a Mule runtime running on an on-premises server that is not registered in Runtime Manager. For more information, see xref:mule-runtime::mule-deployment-model.adoc[]. + [NOTE] ====