Skip to content

Commit 5235b87

Browse files
authored
Merge pull request #201574 from hickeys/users/ahmedb/ahmedb-frs
new serviceendpoint replacing orderer and storage endpoints
2 parents c96f270 + eb9fe1f commit 5235b87

File tree

5 files changed

+31
-28
lines changed

5 files changed

+31
-28
lines changed

articles/azure-fluid-relay/concepts/version-compatibility.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: Version compatibility with Fluid Framework releases
3-
description: |
4-
How to determine what versions of the Fluid Framework releases are compatible with Azure Fluid Relay service.
3+
description: How to determine what versions of the Fluid Framework releases are compatible with Azure Fluid Relay
54
services: azure-fluid
65
author: tylerbutler
76
ms.author: tylerbu
@@ -31,19 +30,25 @@ npx install-peerdeps @fluidframework/azure-client
3130
```
3231

3332
> [!TIP]
34-
> During Public Preview, the versions of **@fluidframework/azure-client** and **fluid-framework** will match. That is, if
35-
> the current release of **@fluidframework/azure-client** is 0.48, then it will be compatible with **fluid-framework** 0.48. The inverse is also true.
33+
> If building with any pre-release version of of **@fluidframework/azure-client** and **fluid-framework** we strongly recommend that you update to the latest 1.0 version. Earlier versions will not be
34+
> supported with the General Availability of Azure Fluid Relay. With this upgrade, you’ll make use of our new multi-region routing capability where
35+
> Azure Fluid Relay will host your session closer to your end users to improve customer experience. In the latest package, you will need to update your
36+
> serviceConfig object to the new Azure Fluid Relay service endpoint instead of the storage and orderer endpoints:
37+
> If your Azure Fluid Relay resource is in West US 2, please use **https://us.fluidrelay.azure.com**. If it is West Europe,
38+
> use **https://eu.fluidrelay.azure.com**. If it is in Southeast Asia, use **https://global.fluidrelay.azure.com**.
39+
> These values can also be found in the "Access Key" section of the Fluid Relay resource in the Azure portal. The orderer and storage endpoints will be deprecated soon.
40+
3641

3742
## Compatibility table
3843

3944
| npm package | Minimum version | API |
4045
| ---------------------------------- | :-------------- | :--------------------------------------------------------------- |
41-
| @fluidframework/azure-client | [0.48.4][] | [API](https://fluidframework.com/docs/apis/azure-client/) |
42-
| fluid-framework | [0.48.4][] | [API](https://fluidframework.com/docs/apis/fluid-framework/) |
43-
| @fluidframework/azure-service-utils | [0.48.4][] | [API](https://fluidframework.com/docs/apis/azure-service-utils/) |
44-
| @fluidframework/test-client-utils | [0.48.4][] | [API](https://fluidframework.com/docs/apis/test-client-utils/) |
46+
| @fluidframework/azure-client | [1.0.1][] | [API](https://fluidframework.com/docs/apis/azure-client/) |
47+
| fluid-framework | [1.0.1][] | [API](https://fluidframework.com/docs/apis/fluid-framework/) |
48+
| @fluidframework/azure-service-utils | [1.0.1][] | [API](https://fluidframework.com/docs/apis/azure-service-utils/) |
49+
| @fluidframework/test-client-utils | [1.0.1][] | [API](https://fluidframework.com/docs/apis/test-client-utils/) |
4550

46-
[0.48.4]: https://fluidframework.com/docs/updates/v0.48/
51+
[1.0.1]: https://fluidframework.com/docs/updates/v1.0.0/
4752

4853
## Next steps
4954

articles/azure-fluid-relay/how-tos/connect-fluid-azure-service.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ To connect to an Azure Fluid Relay instance you first need to create an `AzureCl
3535
const config = {
3636
tenantId: "myTenantId",
3737
tokenProvider: new InsecureTokenProvider("myTenantKey", { id: "userId" }),
38-
orderer: "https://myOrdererUrl",
39-
storage: "https://myStorageUrl",
38+
endpoint: "https://myServiceEndpointUrl",
39+
type: "remote",
4040
};
4141

4242
const clientProps = {
@@ -59,8 +59,8 @@ const config = {
5959
"myAzureFunctionUrl" + "/api/GetAzureToken",
6060
{ userId: "userId", userName: "Test User" }
6161
),
62-
orderer: "https://myOrdererUrl",
63-
storage: "https://myStorageUrl",
62+
endpoint: "https://myServiceEndpointUrl",
63+
type: "remote",
6464
};
6565

6666
const clientProps = {
@@ -86,8 +86,8 @@ const config = {
8686
"myAzureFunctionUrl" + "/api/GetAzureToken",
8787
{ userId: "UserId", userName: "Test User", additionalDetails: userDetails }
8888
),
89-
orderer: "https://myOrdererUrl",
90-
storage: "https://myStorageUrl",
89+
endpoint: "https://myServiceEndpointUrl",
90+
type: "remote",
9191
};
9292
```
9393

articles/azure-fluid-relay/how-tos/local-mode-with-azure-client.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ This article walks through the steps to configure **AzureClient** in local mode
2828
connection: {
2929
tenantId: LOCAL_MODE_TENANT_ID,
3030
tokenProvider: new InsecureTokenProvider("", { id: "123", name: "Test User" }),
31-
orderer: "http://localhost:7070",
32-
storage: "http://localhost:7070",
31+
endpoint: "http://localhost:7070",
32+
type: "remote",
3333
},
3434
};
3535

articles/azure-fluid-relay/how-tos/test-automation.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,15 @@ function createAzureClient(): AzureClient {
3434
const user = { id: "userId", name: "Test User" };
3535

3636
const connectionConfig = useAzure ? {
37+
type: "remote",
3738
tenantId: "myTenantId",
3839
tokenProvider: new InsecureTokenProvider(tenantKey, user),
39-
orderer: "https://myOrdererUrl",
40-
storage: "https://myStorageUrl",
40+
endpoint: "https://myServiceEndpointUrl",
4141
} : {
42-
tenantId: LOCAL_MODE_TENANT_ID,
42+
type: "local",
4343
tokenProvider: new InsecureTokenProvider("", user),
44-
orderer: "http://localhost:7070",
45-
storage: "http://localhost:7070",
44+
endpoint: "http://localhost:7070",
4645
};
47-
4846
const clientProps = {
4947
connection: config,
5048
};

articles/azure-fluid-relay/quickstarts/quickstart-dice-roll.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,16 +55,16 @@ To run against the Azure Fluid Relay service, you'll need to update your app's c
5555

5656
### Configure and create an Azure client
5757

58-
To configure the Azure client, replace the values in the `serviceConfig` object in `app.js` with your Azure Fluid Relay
59-
service configuration values. These values can be found in the "Access Key" section of the Fluid Relay resource in the Azure portal.
58+
To configure the Azure client, replace the local connection `serviceConfig` object in `app.js` with your Azure Fluid Relay
59+
service configuration values. These values can be found in the "Access Key" section of the Fluid Relay resource in the Azure portal. Your `serviceConfig` object should look like this with the values replaced
6060

6161
```javascript
6262
const serviceConfig = {
6363
connection: {
64-
tenantId: LOCAL_MODE_TENANT_ID, // REPLACE WITH YOUR TENANT ID
64+
tenantId: "MY_TENANT_ID", // REPLACE WITH YOUR TENANT ID
6565
tokenProvider: new InsecureTokenProvider("" /* REPLACE WITH YOUR PRIMARY KEY */, { id: "userId" }),
66-
orderer: "http://localhost:7070", // REPLACE WITH YOUR ORDERER ENDPOINT
67-
storage: "http://localhost:7070", // REPLACE WITH YOUR STORAGE ENDPOINT
66+
endpoint: "https://myServiceEndpointUrl", // REPLACE WITH YOUR SERVICE ENDPOINT
67+
type: "remote",
6868
}
6969
};
7070
```

0 commit comments

Comments
 (0)