Skip to content

Commit 4ad8ffb

Browse files
authored
Merge pull request #242 from mulesoft/W-17109021-hyperforce-documentation-kt
W-17109021-hyperforce-documentation-kt
2 parents 72dccf1 + 7e5caca commit 4ad8ffb

10 files changed

Lines changed: 256 additions & 33 deletions

File tree

cloudhub-2/modules/ROOT/pages/ch2-architecture.adoc

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ The following table summarizes what DNS records are available for your applicati
138138
[%header,cols="15a,10a,30a,40a,40a"]
139139
|===
140140
| Region Name | Region | Target ID | Example DNS Record | Target Name
141-
5+h| US Runtime Plane Regions
141+
5+h| US Cloud: Runtime Plane Regions
142142
| US East (N. Virginia) |usa-e1 | `cloudhub-us-east-1` | `myapp-_uniq-id_._shard_.usa-e1.cloudhub.io` | `Cloudhub-US-East-1`
143143
| US East (Ohio) |usa-e2| `cloudhub-us-east-2` | `myapp-_uniq-id_._shard_.usa-e2.cloudhub.io` | `Cloudhub-US-East-2`
144144
| US West (N. California) |usa-w1 |`cloudhub-us-west-1` | `myapp-_uniq-id_._shard_.usa-w1.cloudhub.io` | `Cloudhub-US-West-1`
@@ -151,9 +151,13 @@ The following table summarizes what DNS records are available for your applicati
151151
| EU (Ireland) |irl-e1 | `cloudhub-eu-west-1` | `myapp-_uniq-id_._shard_.irl-e1.cloudhub.io` | `Cloudhub-EU-West-1`
152152
| EU (Frankfurt) |deu-c1 | `cloudhub-eu-central-1` | `myapp-_uniq-id_._shard_.deu-c1.cloudhub.io` | `Cloudhub-EU-Central-1`
153153
| EU (London) |gbr-e1 | `cloudhub-eu-west-2` | `myapp-_uniq-id_._shard_.gbr-e1.cloudhub.io` | `Cloudhub-EU-West-2`
154-
5+h| EU Runtime Plane Regions
154+
5+h| EU Cloud: Runtime Plane Regions
155155
| EU (Ireland) |irl-e1.eu1 | `cloudhub-eu-west-1` | `myapp-_uniq-id_._shard_.irl-e1.eu1.cloudhub.io` | `Cloudhub-EU-West-1`
156156
| EU (Frankfurt) |deu-c1.eu1 | `cloudhub-eu-central-1` | `myapp-_uniq-id_._shard_.deu-c1.eu1.cloudhub.io` | `Cloudhub-EU-Central-1`
157+
5+h| Canada Cloud: Runtime Plane Regions
158+
| Canada (Central) |can-c1| `cloudhub-ca-central-1` | `myapp-uniq-id.can-c1.ca1.cloudhub.io` | `Cloudhub-CA-Central-1`
159+
5+h| Japan Cloud: Runtime Plane Regions
160+
| Asia Pacific (Tokyo) |jpn-e1| `cloudhub-ap-northeast-1` | `myapp-uniq-id.jpn-e1.jp1.cloudhub.io` | `Cloudhub-AP-Northeast-1`
157161
|===
158162

159163
For example, if you deploy an application named `myapp` to Canada (Central), the domain used to access the application is `myapp-_uniq-id_._shard_.can-c1.cloudhub.io`.

cloudhub-2/modules/ROOT/pages/index.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ CloudHub 2.0:
1414

1515
For CloudHub 2.0 pricing information, contact either your account executive or your account development representative.
1616

17+
[[cloudhub2-hyperforce]]
18+
== CloudHub 2.0 on Hyperforce
19+
20+
All features of CloudHub 2.0 are supported on Hyperforce with these exceptions:
21+
22+
When deploying to any Hyperforce supported regions, deleting the default egress traffic route, `0.0.0.0`, can result in Anypoint Monitoring to not work in CloudHub 2.0.
23+
1724

1825
== See Also
1926

hosting-home/modules/ROOT/pages/index.adoc

Lines changed: 39 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,14 @@ In US Cloud, the control plane is physically hosted within the United States.
4040
+
4141
In the EU Cloud, the control plane is physically hosted within the European Union.
4242

43+
* Canada Cloud
44+
+
45+
In the Canada Cloud, the control plane is physically hosted in Canada.
46+
47+
* Japan Cloud
48+
+
49+
In the Japan Cloud, the control plane is physically hosted in Japan.
50+
4351
* MuleSoft Government Cloud
4452
+
4553
MuleSoft Government Cloud is a FedRAMP-compliant instance of the control plane that's managed by MuleSoft and is suitable for government agencies.
@@ -61,32 +69,32 @@ Some Anypoint Platform components are not supported in Anypoint Platform PCE. Se
6169
Not all Anypoint Platform components and features are supported in all cloud environments.
6270
The following table shows which environments support each component:
6371

64-
[%header,cols="5*a"]
72+
[%header,cols="7*a"]
6573
|===
66-
| Anypoint Platform Component | US control plane | EU control plane | MuleSoft Government Cloud | Anypoint Platform PCE
67-
| Access management | Y | Y | Y | Y
68-
| Analytics | Y | Y | N | N
69-
| Anypoint API Community Manager | Y | Y | Y | N
70-
| Anypoint API Experience Hub |Y|Y|N|N
71-
| Anypoint Code Builder | Y | Y | N | N
72-
| API Designer | Y | Y | Y | Y
73-
| Anypoint API Manager | Y | Y | Y | Y
74-
| CloudHub runtimes | Y | Y | Y | N
75-
| Customer-hosted runtimes | Y | Y | Y | Y
76-
| Anypoint DataGraph | Y | Y | N | N
77-
| Anypoint Exchange | Y | Y | Y | Y
78-
| Anypoint MQ | Y | Y | Y <<mq-support,^***^>> | N
79-
| Anypoint Monitoring | Y | Y | Y | Y
80-
| Anypoint Partner Manager | Y | Y | N | N
81-
| Runtime Fabric | Y | Y | N | N
82-
| Anypoint Runtime Manager | Y | Y | Y | Y
83-
| Secrets manager | Y | Y | N | N
84-
| Anypoint Security edge policies | N | N | N | N
85-
| Anypoint Security tokenization | N | N | N | N
86-
| Anypoint Service Mesh| Y | Y | N | N
87-
| Anypoint Studio | Y | Y | Y | Y
88-
| Anypoint Visualizer | Y | Y | Y | Y
89-
| RPA Manager | Y | Y | N | N
74+
| Anypoint Platform Component | US control plane | EU control plane | MuleSoft Government Cloud | Anypoint Platform PCE | Canada Cloud | Japan Cloud
75+
| Access management | Y | Y | Y | Y | Y | Y
76+
| Analytics | Y | Y | N | N | N | N
77+
| Anypoint API Community Manager | Y | Y | Y | N | Y | Y
78+
| Anypoint API Experience Hub |Y|Y|N|N | Y | Y
79+
| Anypoint Code Builder | Y | Y | N | N | Y | Y
80+
| API Designer | Y | Y | Y | Y | Y | Y
81+
| Anypoint API Manager | Y | Y | Y | Y | Y | Y
82+
| CloudHub runtimes | Y | Y | Y | N | Y | Y
83+
| Customer-hosted runtimes | Y | Y | Y | Y | Y | Y
84+
| Anypoint DataGraph | Y | Y | N | N | N | N
85+
| Anypoint Exchange | Y | Y | Y | Y | Y | Y
86+
| Anypoint MQ | Y | Y | Y <<mq-support,^***^>> | N | Y | Y
87+
| Anypoint Monitoring | Y | Y | Y | Y | Y | Y
88+
| Anypoint Partner Manager | Y | Y | N | N | N | N
89+
| Runtime Fabric | Y | Y | N | N | Y | Y
90+
| Anypoint Runtime Manager | Y | Y | Y | Y | Y | Y
91+
| Secrets manager | Y | Y | N | N | Y | Y
92+
| Anypoint Security edge policies | N | N | N | N | N | N
93+
| Anypoint Security tokenization | N | N | N | N | N | N
94+
| Anypoint Service Mesh| Y | Y | N | N | N | N
95+
| Anypoint Studio | Y | Y | Y | Y | Y | Y
96+
| Anypoint Visualizer | Y | Y | Y | Y | Y | Y
97+
| RPA Manager | Y | Y | N | N | N | N
9098
|===
9199

92100
[[mq-support]]
@@ -127,13 +135,13 @@ Connectors that retrieve and manipulate files on the file system are not support
127135

128136
The following table lists the runtime plane options that are supported in each control plane hosting option.
129137

130-
[%header,cols="5*a"]
138+
[%header,cols="7*a"]
131139
|===
132-
| Runtime Plane | US control plane | EU control plane | MuleSoft Government Cloud | Anypoint Platform PCE
133-
| CloudHub 2.0 | Y | Y | N | N
134-
| CloudHub | Y | Y | Y | N
135-
| Standalone runtimes | Y | Y | Y | Y
136-
| Runtime Fabric | Y | Y | N | N
140+
| Runtime Plane | US control plane | EU control plane | MuleSoft Government Cloud | Anypoint Platform PCE | Canada cloud | Japan cloud
141+
| CloudHub 2.0 | Y | Y | N | N | Y | Y
142+
| CloudHub | Y | Y | Y | N | N | N
143+
| Standalone runtimes | Y | Y | Y | Y | Y | Y
144+
| Runtime Fabric | Y | Y | N | N | Y | Y
137145
|===
138146

139147
== See Also

hyperforce/antora.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
name: hyperforce
2+
title: Hyperforce
3+
version: master
4+
nav:
5+
- modules/ROOT/nav.adoc
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
:attachmentsdir: {moduledir}/assets/attachments
2+
:partialsdir: {moduledir}/pages/_partials
3+
:imagesdir: {moduledir}/assets/images
4+
:examplesdir: {moduledir}/examples

hyperforce/modules/ROOT/nav.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.xref:index.adoc[Hyperforce]
2+
* xref:index.adoc[Overview]
3+
* xref:hyperforce-release-notes.adoc[Release Notes]
4+
* xref:configure-mule-hyperforce.adoc[Configuring Mule to Access Hyperforce]
5+
* xref:deploy-mule-apps-hyperforce.adoc[Deploying Mule Apps to Hyperforce]
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
= Configuring Mule Properties to Access Hyperforce
2+
3+
To deploy Mule apps to a Salesforce Hyperforce (Hyperforce) instance, you must configure Mule runtime engine (Mule) to access a Hyperforce instance. To do this, you must:
4+
5+
* Redefine the configuration properties that enable Mule to point to a Hyperforce instance.
6+
* Provide the xref:access-management::managing-business-groups.adoc#client-id-and-secret[client ID and client secret] of the environment belonging to your organization.
7+
8+
By default, Mule is configured to point to the US control plane. If you do not override these properties, the API gateway capability of Mule is disabled in the Hyperforce instance.
9+
10+
You can configure Mule properties using a `wrapper.conf file`, the command line, or CloudHub 2.0. To configure Mule properties through Maven, refer to xref:exchange::to-publish-assets-maven.adoc#publish-an-asset-to-exchange-using-maven[Publish assets using Maven].
11+
12+
== Configure Mule Properties in the Wrapper.conf File
13+
14+
To configure Mule in the `wrapper.conf` file, modify the following properties, replacing `<n>` with an integer value that is unique within `wrapper.conf`. Ensure that you use the supported region endpoint domains:
15+
16+
* `ca1.platform.mulesoft.com`
17+
* `jp1.platform.mulesoft.com`
18+
19+
The following example shows the `wrapper.conf` file configuration for Canada Cloud (`ca1.platform.mulesoft.com`):
20+
21+
----
22+
wrapper.java.additional.<n>=-Danypoint.platform.client_id=<environment client ID>
23+
wrapper.java.additional.<n>=-Danypoint.platform.client_secret=<environment client secret>
24+
wrapper.java.additional.<n>=-Danypoint.platform.base_uri=https://ca1.platform.mulesoft.com
25+
wrapper.java.additional.<n>=-Danypoint.platform.analytics_base_uri=https://analytics-ingest.ca1.platform.mulesoft.com
26+
----
27+
28+
== Configure Mule Properties via the Command Line
29+
To configure Mule properties via the command line, use the following options when starting Mule. Note that `./` applies only to Unix environments. Ensure that you use the supported region endpoint domains:
30+
31+
* `ca1.platform.mulesoft.com`
32+
* `jp1.platform.mulesoft.com`
33+
34+
The following example shows the properties configuration for Canada Cloud `ca1.platform.mulesoft.com` via the command like:
35+
36+
----
37+
./mule -M-Danypoint.platform.client_id=<environment client ID> -M-
38+
Danypoint.platform.client_secret=<environment client secret> -M-Danypoint.platform.base_uri=ca1.platform.mulesoft.com
39+
-M-Danypoint.platform.analytics_base_uri=https://analytics-ingest.ca1.platform.mulesoft.com
40+
----
41+
42+
== Configure Mule Properties for CloudHub 2.0
43+
44+
When deploying to CloudHub 2.0, in the *Properties* tab of Anypoint Runtime Manager, include the following properties. Ensure that you also use the supported region endpoint domains:
45+
46+
* `ca1.platform.mulesoft.com`
47+
* `jp1.platform.mulesoft.com`
48+
49+
The following example shows the properties configuration for Canada Cloud `ca1.platform.mulesoft.com` :
50+
51+
----
52+
anypoint.platform.client_id=<environment client ID>
53+
anypoint.platform.client_secret=<environment client secret>
54+
anypoint.platform.base_uri=https://ca1.platform.mulesoft.com
55+
anypoint.platform.analytics_base_uri=https://analytics-ingest.ca1.platform.mulesoft.com
56+
----
57+
58+
== See Also
59+
60+
* xref:deploy-mule-apps-hyperforce.adoc[Deploying Mule Apps to Hyperforce]
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
= Deploying Mule Apps to Hyperforce
2+
3+
When deploying Mule Apps to a Salesforce Hyperforce (Hyperforce) instance, you deploy on CloudHub 2.0 to a private or shared space. Consider the following guidelines.
4+
5+
== Before You Begin
6+
Before deploying Mule apps to Hyperforce, review the following points:
7+
8+
* Hyperforce Instance +
9+
Your MuleSoft account must have access to a Hyperforce instance. Contact your MuleSoft account representative to provision a MuleSoft license to a Hyperforce instance.
10+
11+
* Hyperforce Endpoints +
12+
Hyperforce has a different base URL, exchange and platform endpoints. For a successful deployment change the Anypoint Platform endpoints URLs to the supported Hyperforce regions endpoints:
13+
14+
** xref:configure-mule-hyperforce.adoc[Configuring Mule to access Hyperforce]
15+
** xref:exchange::to-publish-assets-maven.adoc#publish-an-asset-to-exchange-using-maven[Publish an Asset to Exchange Using Maven]
16+
** xref:anypoint-code-builder::start-acb.adoc#change-clouds[Configure Hyperforce in Anypoint Code Builder]
17+
** xref:studio::hyperforce-configuration.adoc[Configure Hyperforce in Anypoint Studio]
18+
19+
== Deploy Mule Apps to Hyperforce
20+
To deploy a Mule app to a Hyperforce instance, deploy the app to a CloudHub 2.0 private or shared space. For details, refer to xref:cloudhub-2::ch2-deploy.adoc[Deploying to CloudHub 2.0] and xref:cloudhub-2::ch2-architecture.adoc#shared-global-regions[Shared Global Regions].
21+
22+
Note that deploying to xref:cloudhub::index.adoc[CloudHub] is not supported.
23+
24+
== See Also
25+
26+
* xref:configure-mule-hyperforce.adoc[Configuring Mule to Access Hyperforce]
27+
* xref:index.adoc[Salesforce Hyperforce]
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
include::release-notes::hyperforce/hyperforce-release-notes.adoc[]
Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
= Salesforce Hyperforce
2+
3+
Salesforce Hyperforce (Hyperforce) is a modern, scalable, and secure infrastructure designed to support your MuleSoft application deployments. Hyperforce enables you to deliver Mule apps rapidly and reliably to locations worldwide, giving you more choice and control over data residency. Mule apps benefit from its integration of enhanced standards for compliance, scalability, security, agility, and privacy.
4+
5+
With Hyperforce, you can use a globally distributed and reliable platform to ensure optimal performance and reliability for your integrations and APIs.
6+
7+
Some key benefits:
8+
9+
* Data Residency +
10+
Enables you to serve your users globally while maintaining control over data residency and compliance.
11+
12+
* Scalability +
13+
Enables you to grow and scale your business more flexibly and sustainably.
14+
15+
* Security +
16+
Follows least-privileged control, zero-trust principles, and encrypts data both at rest and in transit.
17+
18+
* Agility +
19+
Minimizes downtime for releases and maintenance. Additionally, it accelerates development and testing environments and offers extensive interoperability with AWS, streamlining your workflow.
20+
21+
* Privacy +
22+
Provides you privacy standards that give you control and transparency over your users' data.
23+
24+
== Before You Begin
25+
26+
Before deploying Mule apps to Hyperforce your MuleSoft account must have access to a Hyperforce instance. Contact your MuleSoft account representative to provision a MuleSoft license to a Hyperforce instance.
27+
28+
After you have access to a Hyperforce instance, refer to these topics:
29+
30+
* xref:configure-mule-hyperforce.adoc[Configuring Mule to Access Hyperforce]
31+
* xref:deploy-mule-apps-hyperforce.adoc[Deploying Mule Apps to Hyperforce]
32+
33+
34+
== Features Supported on Hyperforce
35+
36+
The following table provides Anypoint Platform features supported on Hyperforce:
37+
38+
[%header%autowidth.spread]
39+
|===
40+
| Features/Components|Included | Notes
41+
| xref:access-management::index.adoc[Access Management]|Yes | -
42+
| Anypoint Integration Advanced | No | -
43+
| xref:api-manager::latest-overview-concept.adoc[Anypoint API Manager]|Yes | For details, refer to xref:api-manager::latest-overview-concept.adoc#APIM-hyperforce[API Manager on Hyperforce], xref:api-manager::analytics-landing-page.adoc[Mule API Analytics], and xref:api-manager::using-api-alerts.adoc[Reviewing Alerts Concepts]
44+
| xref:api-manager::analytics-landing-page.adoc[Anypoint Mule API Analytics] |No | -
45+
| xref:visualizer::index.adoc[Anypoint Visualizer] |Yes | For exceptions, refer to xref:visualizer::index.adoc#visualizer-hyperforce[Anypoint Visualizer on Hyperforce]
46+
| xref:anypoint-code-builder::index.adoc[Anypoint Code Builder (Desktop IDE)] |Yes | For exceptions, refer to xref:anypoint-code-builder::int-ai-developing-integrations.adoc[Einstein for Anypoint Code Builder Generative Flows] and xref:anypoint-code-builder::index.adoc#us-eu-clouds[Anypoint Code Builder Cloud IDE].
47+
| xref:exchange::index.adoc[Anypoint Exchange] |Yes | For exceptions, refer to xref:exchange::index.adoc#exchange-on-hyperforce[Anypoint Exchange on Hyperforce]
48+
| xref:mq::index.adoc[Anypoint MQ] |Yes |For exceptions, refer to xref:mq::index.adoc#mq-on-hyperforce[Anypoint MQ on Hyperforce]
49+
| xref:monitoring::index.adoc[Anypoint Monitoring] |Yes | For details, refer to xref:monitoring::index.adoc#features[Monitoring Features by Control Plane]
50+
| xref:partner-manager::index.adoc[Anypoint Partner Manager]|No| -
51+
| xref:runtime-manager::index.adoc[Anypoint Runtime Manager]|Yes | -
52+
| xref:anypoint-security::index-secrets-manager.adoc[Anypoint Security Secrets Manager]|Yes | -
53+
| xref:studio::index.adoc[Anypoint Studio]|Yes |-
54+
| xref:api-community-manager::index.adoc[API Community Manager]|Yes | -
55+
| xref:design-center::design-create-publish-api-specs.adoc[API Designer]|No | -
56+
| xref:api-experience-hub::index.adoc[API Experience Hub]|No |-
57+
| xref:api-functional-monitoring::index.adoc[API Functional Monitoring]|Yes | -
58+
| xref:api-governance::index.adoc[API Governance]|Yes | -
59+
| xref:design-center::design-mocking-service.adoc[API Mocking Service]|Yes | -
60+
| Connectors |Yes | All connectors owned by MuleSoft.
61+
| xref:cloudhub-2::index.adoc[CloudHub 2.0]|Yes | For exceptions, refer to xref:cloudhub-2::index.adoc#cloudhub2-hyperforce[CloudHub 2.0 on Hyperforce]
62+
| xref:cloudhub::index.adoc[CloudHub]|No |-
63+
| Dataloader | No | -
64+
| xref:gateway-home::index.adoc#anypoint_flex_gateway[Flex Gateway] | Yes | For details, refer to xref:gateway::flex-review-prerequisites.adoc#flex-gateway-hyperforce[Flex Gateway on Hyperforce], xref:gateway::flex-use-api-alerts.adoc[Using Flex Gateway API Alerts], and xref:gateway::flex-view-api-metrics.adoc[Viewing Key Metrics for Flex Gateway APIs]
65+
| xref:gateway-home::index.adoc#anypoint_mule_gateway[Mule Gateway] | Yes | For exceptions, refer to xref:mule-gateway::mule-gateway-capabilities-mule4.adoc#mule-gateway-hyperforce[Mule Gateway on Hyperforce]
66+
| xref:mule-runtime::index.adoc[Mule runtime engine] | Yes | Mule 3 is not supported as it reached EOL.
67+
| xref:munit::index.adoc[MUnit] | Yes | -
68+
| xref:object-store::index.adoc[Object Store V2] | Yes | For exceptions, refer to xref:object-store::index.adoc#osv2-on-hyperforce[Object Store V2 on Hyperforce]
69+
| xref:runtime-fabric::index.adoc[Runtime Fabric] | No | Contact your account manager to unlock this capability.
70+
| Hybrid Standalone Deployment | No | -
71+
|===
72+
73+
== Hyperforce Supported Regions
74+
75+
Hyperforce is available in these regions:
76+
77+
[%header%autowidth.spread]
78+
|===
79+
|Location | Region Control Plane | Anypoint Platform URL
80+
|North America | Canada Cloud | ca1.platform.mulesoft.com
81+
|APAC | Japan Cloud | jp1.platform.mulesoft.com
82+
|===
83+
84+
== Mule Runtime Version Compatibility
85+
86+
* Hyperforce is compatible with Mule runtime engine versions under support, 4.4.0 and later.
87+
* Hyperforce supports the Mule runtime engine LTS and Edge release channels. The recommended customer profile is LTS. For more information, visit xref:release-notes::mule-runtime/lts-edge-release-cadence.adoc[].
88+
89+
== Contact Salesforce Support
90+
91+
If you need to contact Salesforce Support, under the Salesforce Help Portal section refer to https://help.salesforce.com/s/articleView?id=000394257&type=1#:~:text=your%20Trailblazer%20profile-,Salesforce%20Help%20Portal,-Logging%20in%20to[Logging in to Salesforce Help Portal Using Trailblazer].
92+
93+
[NOTE]
94+
Use the single-use code method to open support cases.
95+
96+
97+
== See Also
98+
99+
* xref:configure-mule-hyperforce.adoc[Configuring Mule to Access Hyperforce]
100+
* xref:deploy-mule-apps-hyperforce.adoc[Deploying Mule Apps to Hyperforce]
101+
102+

0 commit comments

Comments
 (0)