You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/data_catalog/data_catalog_fabric_bff.mdx
+10-9Lines changed: 10 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -85,19 +85,19 @@ Here can be found an example of configuration that assumes Fabric BFF and Job Ru
85
85
86
86
#### Console Communication
87
87
88
-
In order for Data Catalog UI to know which environments can be linked to [Mia Platform CRUD connections](#todo-crud-section),
88
+
In order for Data Catalog UI to know which environments can be linked to [Mia Platform CRUD connections](/data_catalog/frontend/data_catalog_connections.mdx#mia-platform-crud),
89
89
the service needs to contact Mia-Platform Console and retrieve the list of Projects that should be accessible from this Data Catalog instance.
90
90
91
91
To achieve so, it is first necessary that your Company Owner creates a dedicated [Service Account](/development_suite/identity-and-access-management/manage-service-accounts.md)
92
92
on your Mia-Platform Console instance and assign to it the proper permissions for listing the Console projects of interest.
93
93
94
94
:::tip Good practices in permissions assignment
95
95
Pay attention to the level of access to the resources that you assign to the Service Account.
96
-
For Control Plane use case, a good practice may be to assign the role of `guest` at Company level while granting
97
-
the `reporter` role to all the projects that should be visible by Control Plane.
96
+
For Data Catalog use case, a good practice may be to assign the role of `guest` at Company level while granting
97
+
the `reporter` role to all the projects that should be visible by Data Catalog.
98
98
About permissions assignment, it is possible to go even more granular in case you want to allow visibility only to a subset of runtime environments of a specific project.
99
99
In fact, to do that, you may opt to assign the role of `guest` even at Project level while granting
100
-
the `reporter` role solely to those runtime environments that should be visible by Control Plane.
100
+
the `reporter` role solely to those runtime environments that should be visible by Data Catalog.
101
101
:::
102
102
103
103
Once the service account has been registered, your Company Owner needs to hand over to you its credentials, which are:
@@ -115,7 +115,7 @@ These details then should be inserted in your Fabric BFF service configuration u
115
115
:::caution
116
116
It is responsibility of your Company Owner to ensure that service account credentials are properly processed according to your company security policies.
117
117
118
-
Furthermore, it is of <u>extreme importance</u> understanding that **any**Control Plane user will be able to list the project name
118
+
Furthermore, it is of <u>extreme importance</u> understanding that **any**Data Catalog user with enough permissions for [connections management](/data_catalog/frontend/data_catalog_connections.mdx)will be able to view the project name
119
119
and available environments of all the projects that can be accessed by the service account configured on Fabric BFF.
120
120
:::
121
121
@@ -125,10 +125,10 @@ This is and example of `console` property configuration:
125
125
126
126
:::tip
127
127
The following properties support [secret resolution](/fast_data/configuration/secrets_resolution.md):
128
-
-`console.target`
129
-
-`console.auth.credentials.clientId`
130
-
-`console.auth.credentials.clientKeyId`
131
-
-`console.auth.credentials.privateKey`
128
+
-`console.rest.target`
129
+
-`console.rest.auth.credentials.clientId`
130
+
-`console.rest.auth.credentials.clientKeyId`
131
+
-`console.rest.auth.credentials.privateKey`
132
132
:::
133
133
134
134
A custom x509 certificate can be added to the default root keychain of certificates for any client/reversed-proxy reached by Fabric BFF.
@@ -230,6 +230,7 @@ The following routes are exposed over the `/api/job-runner` endpoint and are for
|`/feedback`| Websocket | HEAD | Route used by Websocket for authentication. |
233
234
|`/feedback`| Websocket | GET | Route for receiving feedback messages from the `Status` method of the [Job Runner gRPC service.](/data_catalog/data_catalog_job_runner.mdx#job-runner)|
234
235
|`/job-runner/*`| REST | * | Routes prefixed with `/job-runner` are converted into gRPC requests towards Job Runner service.<br/> For more details please read [corresponding documentation](/data_catalog/data_catalog_job_runner.mdx#grpc-services)|
235
236
|`/agent/drivers`| REST | GET | Route for invoking the `ListDrivers` method of the [ODBC Client gRPC service.](/data_catalog/data_catalog_job_runner.mdx#odbc-client)|
|`/assets/search`| REST | GET | Search for dataset assets and their metadata |
219
219
|`/assets/search-parents`| REST | GET | Search for name of system of record or table name |
220
+
|`/bulk-actions`| Websocket | HEAD | Route used by Websocket for authentication. |
220
221
|`/bulk-actions`| Websocket | GET | Route for handling async operations over multiple datasets records |
221
222
|`/tags/count`| REST | GET | Count how many unique tags exists among all data assets |
222
223
|`/tags/items`| REST | GET | List existing tags associated to data assets |
@@ -279,3 +280,10 @@ The following steps needs to be followed:
279
280
280
281
See [Routes paragraph](#open-lineage-routes) to more details. Remember also to update the [users management microfrontend](/data_catalog/secure_access.mdx#users-management)
281
282
to support the new permission `update:lineage`.
283
+
284
+
### From 0.2.x to 0.3.0
285
+
286
+
- A migration CLI must run to update data-fabric records. To do so, you must retrieve the docker image `data-fabric/fabric_admin:0.4.0` and run the following subcommand
287
+
```shell
288
+
docker run --pull=always <registry-url>/data-fabric/fabric-admin:latest open-lineage update-records --url=<MONGODB_URL>
Copy file name to clipboardExpand all lines: docs/development_suite/api-console/api-design/endpoints.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -225,7 +225,7 @@ The **Advanced** tab is visible only if the Envoy API Gateway service is enabled
225
225
-**Rate limit** (_integer_): the maximum frequency (in terms of requests per second) with which requests are forwarded to the underlying service;
226
226
-**Request body size** (_decimal_): the maximum body size of user requests.
227
227
-**Iframe embedding options**: the X-Frame-Options directive that is considered when the endpoint response should be embedded in an iframe;
228
-
-**Protcol options**:this options instruct Envoy to process the request with the protocol coming from the downstream connection, allowing to dinamically infer the protocol to be used (HTTP/1.1 or HTTP/2);
228
+
-**Protocol options**:this options instruct Envoy to process the request with the protocol coming from the downstream connection, allowing to dinamically infer the protocol to be used (HTTP/1.1 or HTTP/2);
229
229
230
230
:::warning
231
231
This `Iframe embedding` option is configurable only for the `Envoy API Gateway`, instead for`Nginx API Gateway` it is required to configure it manually using the `Advanced` section of the Console
0 commit comments