Bash source ~/.zshrc # Use the file you edited
Get Started with Agent Networks
Setting up Anypoint Code Builder, permissions, access, and gateways ensures that you can create agent networks quickly and easily.
Before You Begin with Agent Networks
Before you start your agent network project, make sure that you have these products and access.
Agent Network Prerequisites
Task | Product Prerequisites | Permissions and Access Prerequisites |
---|---|---|
Set up agent network |
||
Create target space using Anypoint Runtime Manager |
Managed Flex Gateway with target space entitlements. At least one small Managed Flex Gateway and one large Managed Flex Gateway are required.
|
|
Set up ingress and egress gateways for target space using Anypoint Code Builder desktop command palette command |
Managed Flex Gateway with target space entitlements. At least one small Managed Flex Gateway and one large Managed Flex Gateway are required.
|
Runtime Manager: Manage Servers permission |
Set up ingress and egress gateways for target space using Anypoint CLI |
Managed Flex Gateway with target space entitlements. At least one small Managed Flex Gateway and one large Managed Flex Gateway are required.
|
Runtime Manager: Manage Servers permission |
Create project |
||
Create project using Anypoint Code Builder desktop with MuleSoft Dev Agent |
Anypoint Code Builder. For more information, see Setting Up the Desktop IDE.
|
A tenant relationship established with a trusted Salesforce organization.
|
Create project using Anypoint Code Builder desktop UI or command palette commands |
Anypoint Code Builder. For more information, see Setting Up the Desktop IDE.
|
Configure your allowlist. For more information, see URLs to Allow to Run Anypoint Code Builder. |
Create project using Anypoint CLI |
Java 17. Since agent network binaries require Java to build the agent network, make sure you install Java 17 on your machine and set the JAVA_HOME environment variable.
|
Runtime Manager: Manage Servers permission |
Define agent network specification |
||
Add Exchange assets to project using Anypoint Code Builder desktop with MuleSoft Dev Agent |
Einstein enablement in Access Management. For more information, see Enabling or Disabling Agentforce for Anypoint Platform.
|
A tenant relationship established with a trusted Salesforce organization.
|
Add Exchange assets to project using Anypoint CLI |
Java 17. Since agent network binaries require Java to build the agent network, make sure you install Java 17 on your machine and set the JAVA_HOME environment variable.
|
Runtime Manager: Manage Servers and Anypoint Design Center: Design Center Developer permissions |
Build project (applies only to CLI) |
||
Build project using Anypoint CLI |
Java 17. Since agent network binaries require Java to build the agent network, make sure you install Java 17 on your machine and set the JAVA_HOME environment variable.
|
Runtime Manager: Manage Servers permission |
Publish project assets to Exchange |
||
Publish project assets using Anypoint Code Builder desktop with MuleSoft Dev Agent |
Einstein enablement in Access Management. For more information, see Enabling or Disabling Agentforce for Anypoint Platform.
|
A tenant relationship established with a trusted Salesforce organization.
|
Publish project assets using Anypoint Code Builder desktop UI or command palette commands |
Allowlist Anypoint Code Builder URLs. For more information, see URLs to Allow to Run Anypoint Code Builder.
|
|
Publish project assets using Anypoint CLI |
Java 17. Since agent network binaries require Java to build the agent network, make sure you install Java 17 on your machine and set the JAVA_HOME environment variable.
|
Anypoint Exchange: Exchange Contributor and Runtime Manager: Manage Servers permissions |
Deploy project instance |
||
Deploy project instance using Anypoint Code Builder desktop with MuleSoft Dev Agent |
Einstein enablement in Access Management. For more information, see Enabling or Disabling Agentforce for Anypoint Platform.
|
A tenant relationship established with a trusted Salesforce organization.
|
Deploy project instance using Anypoint Code Builder desktop UI or command palette commands |
Allowlist Anypoint Code Builder URLs. For more information, see URLs to Allow to Run Anypoint Code Builder.
|
|
Deploy project instance using Anypoint CLI |
Java 17. Since agent network binaries require Java to build the agent network, make sure you install Java 17 on your machine and set the JAVA_HOME environment variable.
|
API Manager: Deploy API Proxies and Manage Policies and Runtime Manager: Create Applications permissions |
Verify and Add the Anypoint Environment Variable for Your Non-U.S. Region
Before you start Anypoint Code Builder desktop to create agent networks, if you’re not located in the U.S., make sure that the ANYPOINT_ENV
environment variable is set to the appropriate value for your region.
Sample Valid Values
These are valid values for some geographic regions.
Region | Value |
---|---|
U.S. |
|
Canada |
|
Europe |
|
Japan |
|
MacOS
If you run Anypoint Code Builder desktop on macOS, verify your environment variable and add it if needed.
Verify the ANYPOINT_ENV
Environment Variable
-
Open a Terminal window and run this command:
bash
. -
Run this command:
echo $ANYPOINT_ENV
.
If the value doesn’t reflect your geographic region, or it is empty, set the ANYPOINT_ENV
environment variable.
Add the ANYPOINT_ENV
Environment Variable
Include environment variables by adding an export command to a shell configuration file.
-
Open a Terminal window.
-
Determine the shell configuration file you need to edit. To see your default shell, run
echo $SHELL
. Common files are:-
~/.bashrc
or~/.bash_profile
for Bash users -
~/.zshrc
for Zsh users -
~/.profile
-
-
Open the shell configuration file with a text editor.
-
In the text editor, at the end of the file, add this line:
export ANYPOINT_ENV={region value}
. -
Save and close the file.
-
If you want to use the updated shell configuration file without logging out and back in, source the file. For example:
Windows
If you run Anypoint Code Builder desktop on Windows, verify your environment variable and add it if needed.
Verify the ANYPOINT_ENV Environment Variable
-
Open a Command Prompt or PowerShell window.
-
If you’re in a Command Prompt window, run this command:
echo %ANYPOINT_ENV%
. If you’re in a PowerShell window, run this command:echo $env:ANYPOINT_ENV
.
If the value doesn’t reflect your geographic region (or is empty), set the ANYPOINT_ENV
environment variable.
Add the ANYPOINT_ENV Environment Variable Using System Properties
-
Open System Properties. Tip: From the Start menu, search for
Edit the system environment variables
. -
In System Properties, click Environment Variables.
-
Choose whether to set a User variable (for the current user) or a System variable (for all users). For most cases, setting a User variable is sufficient.
-
In the User or System variable area, click New.
-
In variable name, enter
ANYPOINT_ENV
. -
In variable value, enter the value for your region. For example, if you’re in the U.S., enter
prod
. -
Save the changes.
-
Open a new Command Prompt or PowerShell window to load the new variable.
Set the ANYPOINT_ENV Environment Variable Using Command Prompt or PowerShell
If the ANYPOINT_ENV
environment variable exists, and you want to change the value quickly, use a Command Prompt or PowerShell window.
-
Open a Command Prompt or PowerShell window.
-
If you’re in a Command Prompt window, run this command:
setx ANYPOINT_ENV {region value}
which sets the value permanently for new Command Prompt windows. If you’re in a PowerShell window, run this command:{Environment}::SetEnvironmentVariable("ANYPOINT_ENV", "{region value}", "User")
which sets the value for the current user.
Create a Target Space for Your Environment
To deploy an agent network, you need a target space. You can either create a private space for CloudHub 2.0 deployment or a target space for Runtime Fabric (limited availability). For more information about Runtime Fabric deployments, see Managed Flex Gateway on Runtime Fabric.
Create a Private Space for CloudHub 2.0 Deployment
-
Open Anypoint Runtime Manager.
-
Select the environment to use.
-
Select Private Spaces.
-
Select Create private space.
-
Enter a name for the private space. We recommend
agent-network-space
. -
Select Create.
-
Select Create private network.
-
For the created private space, select Environments.
-
Associate the space with the business group and environments you need to deploy your agent network to. You must complete this step so that the private space appears as a valid deployment target in Anypoint Code Builder and Anypoint CLI.
Set Up Agent Network Gateways for Your Target Space
After you create a target space, set up the ingress and egress gateways for deployment. For agent networks, at least one small Managed Flex Gateway and one large Managed Flex Gateway is required in your environment. For more information about gateways, see Flex Gateway Deployment Models. For more information about Runtime Fabric deployments, see Managed Flex Gateway on Runtime Fabric.
-
In Anypoint Code Builder desktop, open the Command Palette.
-
Select MuleSoft: Set Up Agent Network Gateways.
-
If you’re not logged in already, log in to your Anypoint Platform account.
-
Select the business group, environment, and private space.
-
These gateways are created automatically in the selected private space.
-
agent-network-ingress-gw (with public and internal endpoint)
-
agent-network-egress-gw (with internal endpoint only)
-