---
schema_version: "1"
id: f32e9e126d3514f45827f8ff33cc2306ca37eef43c69c812aa59ab03fcc8776f
title: Deploy a Managed Flex Gateway
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/gateway/1.12/flex-gateway-managed-set-up.md
canonical_url: https://docs.mulesoft.com/gateway/1.12/flex-gateway-managed-set-up
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 4a19df51023ea3b1b038ef564508fe95d260d27a8c5f9e28109e495aaf6b5481
description: MuleSoft Documentation Site
release: "1.12"
latest: false
---
---
product: Omni Gateway
version: 1.12
---

# Deploy a Managed Flex Gateway

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Deploy a Managed Flex Gateway to a CloudHub 2.0 private space or Runtime Fabric namespace to launch
a completely managed gateway. Configure the Managed Flex Gateway as an ingress to your target space
by exposing a public endpoint, or configure the gateway to only handle internal traffic. You can
have one or more Managed Gateway in each environment that the target space is shared with. Gateways
can protect any instance from the same environment of the gateway or services in an external
network.

## Before You Begin

### CloudHub 2.0

Before getting started with Flex Gateway on CloudHub 2.0, make sure:

- The business group you want to deploy your gateway to has Managed Flex Gateway Resources. To
  redestribute Managed Flex Gateway resources to a business group, see
  [Redistribute Resources Between Existing Business Groups](https://docs.mulesoft.com/access-management/business-groups#redistribute-resources).

  > [!NOTE] Gateways cannot be shared across business groups. A user must be a member of the
  > business group to access the Flex Gateway.

- [Create a CloudHub 2.0 Private Space](https://docs.mulesoft.com/cloudhub-2/ps-create-configure)

### Runtime Fabric

Before getting started with Flex Gateway on Runtime Fabric, make sure:

- Your Runtime Fabric deployment version is 2.11.0 or later. To upgrade, see
  [Upgrading Runtime Fabric](https://docs.mulesoft.com/runtime-fabric/latest/upgrade-index).

- The business group you want to deploy your gateway to has Managed Flex Gateway Resources. To
  redestribute Managed Flex Gateway resources to a business group, see
  [Redistribute Resources Between Existing Business Groups](https://docs.mulesoft.com/access-management/business-groups#redistribute-resources).

  > [!NOTE] Gateways cannot be shared across business groups. A user must be a member of the
  > business group to access the Flex Gateway.

- Run this command in the same namespace as your Runtime Fabric agent to enable the
  `ManagedFlexGateway` resource:

  ```bash
  # When performing the helm upgrade for the first time, during Runtime Fabric creation:
  helm upgrade runtime-fabric rtf/rtf-agent -n <rtf-agent-namespace> --version <target-rtf-version> --set global.crds.flex.enabled=true

  # When enabling Managed Flex Gateway for an existing runtime fabric:
  helm upgrade runtime-fabric rtf/rtf-agent -n <rtf-agent-namespace> --reset-then-reuse-values --set global.crds.flex.enabled=true
  ```

> [!NOTE] For Flex Gateway Agent Fabric deployments on Runtime Fabric, you must enable Open
> Telemetry with a `100` percent **Sampling percentage**. You can’t override the sampling percentage
> for individual instances.

## Deploy a Managed Flex Gateway

1.  Log in to [Anypoint Platform](https://anypoint.mulesoft.com/login/) with your Anypoint username
    and password.

2.  Select **Runtime Manager**.

3.  Ensure you’re in environment where you would like to deploy your Managed Gateway

4.  Click **Flex Gateways** in the side navigation panel.

5.  Click **Managed Flex Gateway**.

6.  Click **Add Managed Flex Gateway**.

7.  Enter a **Gateway Name**.

8.  Select the **Deployment Target** where you want to deploy your Managed Flex Gateway.

9.  Select a **Release Channel**:

    <table><colgroup><col> <col></colgroup><tbody><tr><td><div><div><p>Release channel</p></div></div></td><td><div><div><p>Description</p></div></div></td></tr><tr><td><div><div><p><strong>Edge</strong></p></div></div></td><td><div><div><p>This channel releases a new minor version&nbsp;every four months. It has the latest features and shorter support windows.</p></div></div></td></tr><tr><td><div><div><p><strong>Long-Term Support</strong></p></div></div></td><td><div><div><p>This channel releases a new minor version&nbsp;once a year.</p></div></div></td></tr></tbody></table>

    To learn more about the differences between release channels, see
    [Flex Gateway Version Lifecycle](https://docs.mulesoft.com/gateway/1.12/flex-gateway-version-lifecycle).

10. Select **Version**.

    Select the latest version unless if a later version is specifically needed.

11. Select **Gateway type**:

    <table><colgroup><col> <col></colgroup><tbody><tr><td><div><div><p>Size</p></div></div></td><td><div><div><p>Description</p></div></div></td></tr><tr><td><div><div><p><strong>Small Managed Flex Gateway</strong></p></div></div></td><td><div><div><p>Use for testing and staging purposes. Small Managed Flex Gateways can deploy up to 50 APIs.</p></div></div></td></tr><tr><td><div><div><p><strong>Large Managed Flex Gateway</strong></p></div></div></td><td><div><div><p>Use for production purposes. Large Managed Flex Gateways can deploy up to 500 APIs.</p></div></div></td></tr><tr><td><div><div><p><strong>Extra Large Managed Flex Gateway</strong></p></div></div></td><td><div><div><p>Use for production purposes with higher throughput and more process demanding policies. Extra Large Managed Flex Gateways can deploy up to 500 APIs.</p></div></div></td></tr></tbody></table>

    To learn more about Managed Flex Gateway sizing, see
    [Managed Flex Gateway Limits](https://docs.mulesoft.com/gateway/1.12/flex-review-prerequisites#managed-flex-gateway-limits).

12. Configure **Advanced options**:

    Ingress

    - **Public endpoint**:

      1.  Select your desired private space **Domain**.

          To learn more, see [Creating Private Spaces](https://docs.mulesoft.com/cloudhub-2/ps-create-configure).

      2.  Enter a **Host**.

      3.  Click **Add Endpoint** to add an additional endpoint to a different domain.

          Managed Flex Gateway supports one **Public endpoint** per domain in your private space.

    - **Ingress options**:

      - **Forward SSL Session**:

        Enables SSL forwarding during a session.

        SSL forwarding is mostly used with client authentication. See
        [Enable Client Authentication](https://docs.mulesoft.com/anypoint-security/enable-client-authentication). SSL
        forwarding forwards client certificate details in HTTP request headers so they are available
        to the gateway. These fields can identify an authenticated client and allow the gateway
        policies to determine and use the identity.

        The following headers are available:

        <table><colgroup><col> <col></colgroup><thead><tr><th>Header Name</th><th>Value</th></tr></thead><tbody><tr><td><div><div><p>x-ssl-client-verify</p></div></div></td><td><div><div><p>SUCCESS/FAIL</p></div></div></td></tr><tr><td><div><div><p>x-ssl-issuer</p></div></div></td><td><div><div><p>Client certificate issuer</p></div></div></td></tr><tr><td><div><div><p>x-ssl-client-serial</p></div></div></td><td><div><div><p>Client certificate serial number</p></div></div></td></tr><tr><td><div><div><p>x-ssl-client-dn</p></div></div></td><td><div><div><p>Contents of the client certificate DN field</p></div></div></td></tr><tr><td><div><div><p>x-ssl-client-cert</p></div></div></td><td><div><div><p>Contents of the client certificate</p></div></div></td></tr></tbody></table>

      - **Last-mile Security**:

        Specifies that TLS termination and decryption for the forwarded HTTPS connections occurs in
        the gateway.

    Properties

    To configure how long Managed Flex Gateway waits for response or idle connections, configure the
    timeout properties:

    <table><colgroup><col> <col></colgroup><tbody><tr><td><div><div><p>Parameter</p></div></div></td><td><div><div><p>Description</p></div></div></td></tr><tr><td><div><div><p><strong>Upstream Connection Idle Timeout</strong></p></div></div></td><td><div><div><p>The time a upstream connection can remain idle without receiving client requests. Upstream responses are not included in this timeout.</p></div></div></td></tr><tr><td><div><div><p><strong>Upstream Response Timeout</strong></p></div></div></td><td><div><div><p>The time the upstream service has to respond from when Flex Gateway sends a request.</p></div></div></td></tr><tr><td><div><div><p><strong>Stream Idle Timeout</strong></p></div></div></td><td><div><div><p>The time a stream can remain idle without receiving additional client requests or upstream responses.</p></div></div></td></tr></tbody></table>

    You can also update timeout values later from **Runtime Configurations** in Runtime Manager. For
    details, see [Configure Timeouts for Managed Flex Gateway](https://docs.mulesoft.com/gateway/1.12/flex-managed-timeout).

    Logging

    - **Forward application logs to Anypoint Monitoring**:

      Forwards Flex Gateway logs to Anypoint Monitoring. When disabled, logs are only available in
      Runtime Manager.

    - **Additional Log Levels**:

      - **INFO**: Informative messages

      - **DEBUG**: Debugging messages

      - **WARNING**: Warning messages

      - **ERROR**: Error messages, such as when an exception occurs

      - **FATAL**: Fatal messages for when an application fails

        > [!NOTE] You can use Access Management audit logs to track Managed Flex Gateway actions,
        > such as creating, editing, starting, and stopping gateways. Audit logs don't require
        > configuration.
        >
        > To learn more, see xref:flex-managed-view-status.adoc#audit-logs\[View Managed Flex
        > Gateway Audit Logs\].

    Distributed Tracing

    - **Distributed tracing**:

      Enable to generate OpenTelemetry distributed tracing data for the Managed Flex Gateway. When
      enabled, you can set the sampling percentage.

    - **Sampling percentage**:

      Set the overall distributed tracing sampling percentage. This setting corresponds to the
      `overall` sampling percentage. The `client` and `random` sampling percentages are set to 100%
      by default, if the sampling percentage is set to a non-zero value here.

      Set the **Sampling percentage** to 0 if you want to specify the sampling percentage only on a
      per-API basis, using the Tracing policy.

      > [!NOTE] For Flex Gateway Agent Fabric deployments on Runtime Fabric, you must enable Open
      > Telemetry with a `100` percent **Sampling percentage**. You cannot override the sampling
      > percentage for individual instances.

13. Click **Save & deploy**.

## Edit a Managed Flex Gateway Settings

To edit a Managed Flex Gateway setting:

1.  From Anypoint Platform, select **Runtime Manager > Flex Gateways**.

2.  Click the Managed Flex Gateway name.

3.  In the navigation menu, click Settings.

4.  Make the necessary edits.

5.  Click **Apply changes**.

## Remove an Endpoint

To remove an endpoint:

1.  From Anypoint Platform, select **Runtime Manager > Flex Gateways**.

2.  Click the Managed Flex Gateway name.

3.  In the navigation menu, click Settings.

4.  Click **Advanced options**.

5.  In the **Public endpoint** row, click **X** (Delete).

6.  Click **Apply changes**.

## Next Steps

- [Requirements and Limits for Flex Gateway](https://docs.mulesoft.com/gateway/1.12/flex-review-prerequisites)

- [Setting Up Self-Managed Flex Gateway](https://docs.mulesoft.com/gateway/1.12/flex-gateway-set-up)