Docs: Note Addition for Connection Details (#509)

Co-authored-by: “Rounak <“[email protected]”>

Author: RounakDhillon

content/v1.10.x/connectors/dashboard/domo-dashboard/index.md

@@ -43,6 +43,21 @@ For questions related to scopes, click [here](https://developer.domo.com/portal/
 
 #### Connection Details
 
+{% collateContent %}
+
+{% note %} 
+
+If you are using a **Hybrid Ingestion Runner**, passwords must be referenced securely via secret paths using the following format:
+
+```
+password: secret:/my/database/password
+```
+For more details, refer to the [Hybrid Ingestion Runner Secret Management Guide](https://docs.getcollate.io/getting-started/day-1/hybrid-saas/hybrid-ingestion-runner#3.-manage-secrets-securely).
+
+{% /note %}
+
+{% /collateContent %}
+
 - **Client ID**: Client ID to Connect to DOMO Dashboard.
 - **Secret Token**: Secret Token to Connect DOMO Dashboard.
 - **Access Token**: Access to Connect to DOMO Dashboard.

content/v1.10.x/connectors/dashboard/microstrategy/index.md

@@ -53,6 +53,21 @@ However, if the user still cannot access the APIs, the following should be check
 
 #### Connection Details
 
+{% collateContent %}
+
+{% note %} 
+
+If you are using a **Hybrid Ingestion Runner**, passwords must be referenced securely via secret paths using the following format:
+
+```
+password: secret:/my/database/password
+```
+For more details, refer to the [Hybrid Ingestion Runner Secret Management Guide](https://docs.getcollate.io/getting-started/day-1/hybrid-saas/hybrid-ingestion-runner#3.-manage-secrets-securely).
+
+{% /note %}
+
+{% /collateContent %}
+
 - **Username**: Username to connect to MicroStrategy, e.g., [email protected]. This user should have access to relevant dashboards and charts in MicroStrategy to fetch the metadata.
 
 - **Password**: Password of the user account to connect with MicroStrategy.

content/v1.10.x/connectors/dashboard/mode/index.md

@@ -44,6 +44,21 @@ OpenMetadata relies on Mode's API, which is exclusive to members of the Mode Bus
 
 #### Connection Details
 
+{% collateContent %}
+
+{% note %} 
+
+If you are using a **Hybrid Ingestion Runner**, passwords must be referenced securely via secret paths using the following format:
+
+```
+password: secret:/my/database/password
+```
+For more details, refer to the [Hybrid Ingestion Runner Secret Management Guide](https://docs.getcollate.io/getting-started/day-1/hybrid-saas/hybrid-ingestion-runner#3.-manage-secrets-securely).
+
+{% /note %}
+
+{% /collateContent %}
+
 **hostPort**: Host and Port Mode Dashboard.
 The hostPort parameter specifies the host and port of the Mode server. This should be specified as a string in the format `https://app.mode.com`.
 

content/v1.10.x/connectors/dashboard/superset/index.md

@@ -49,6 +49,21 @@ The ingestion also works with Superset 2.0.0 🎉
 
 #### Connection Details
 
+{% collateContent %}
+
+{% note %} 
+
+If you are using a **Hybrid Ingestion Runner**, passwords must be referenced securely via secret paths using the following format:
+
+```
+password: secret:/my/database/password
+```
+For more details, refer to the [Hybrid Ingestion Runner Secret Management Guide](https://docs.getcollate.io/getting-started/day-1/hybrid-saas/hybrid-ingestion-runner#3.-manage-secrets-securely).
+
+{% /note %}
+
+{% /collateContent %}
+
 - **Host and Port**: The `Host and Post` parameter is common for all three modes of authentication which specifies the host and port of the Superset instance. This should be specified as a string in the format `http://hostname:port` or `https://hostname:port`. For example, you might set the hostPort parameter to `https://org.superset.com:8088`.
 
 - **Superset Connection**: Add the connection details to fetch metadata from Superset either through APIs or Database.

content/v1.10.x/connectors/database/couchbase/index.md

@@ -39,6 +39,21 @@ Configure and schedule Couchbase metadata workflows from the OpenMetadata UI:
 
 #### Connection Details
 
+{% collateContent %}
+
+{% note %} 
+
+If you are using a **Hybrid Ingestion Runner**, passwords must be referenced securely via secret paths using the following format:
+
+```
+password: secret:/my/database/password
+```
+For more details, refer to the [Hybrid Ingestion Runner Secret Management Guide](https://docs.getcollate.io/getting-started/day-1/hybrid-saas/hybrid-ingestion-runner#3.-manage-secrets-securely).
+
+{% /note %}
+
+{% /collateContent %}
+
 - **Username**: Username to connect to Couchbase.
 - **Password**: Password to connect to Couchbase.
 - **Hostport**: If couchbase is hosted on cloud then the hostport parameter specifies the connection string and if you are using couchbase server then the hostport parameter specifies hostname of the Couchbase. This should be specified as a string in the format `hostname` or `xyz.cloud.couchbase.com`. E.g., `localhost`.

content/v1.10.x/connectors/database/db2/index.md

@@ -86,6 +86,21 @@ Executing the profiler workflow or data quality tests, will require the user to
 
 #### Connection Details
 
+{% collateContent %}
+
+{% note %} 
+
+If you are using a **Hybrid Ingestion Runner**, passwords must be referenced securely via secret paths using the following format:
+
+```
+password: secret:/my/database/password
+```
+For more details, refer to the [Hybrid Ingestion Runner Secret Management Guide](https://docs.getcollate.io/getting-started/day-1/hybrid-saas/hybrid-ingestion-runner#3.-manage-secrets-securely).
+
+{% /note %}
+
+{% /collateContent %}
+
 - **Username**: Specify the User to connect to DB2. It should have enough privileges to read all the metadata.
 - **Password**: Password to connect to DB2.
 - **database**: Database of the data source.

content/v1.10.x/connectors/database/domo-database/index.md

@@ -46,6 +46,21 @@ For questions related to scopes, click [here](https://developer.domo.com/portal/
 
 #### Connection Details
 
+{% collateContent %}
+
+{% note %} 
+
+If you are using a **Hybrid Ingestion Runner**, passwords must be referenced securely via secret paths using the following format:
+
+```
+password: secret:/my/database/password
+```
+For more details, refer to the [Hybrid Ingestion Runner Secret Management Guide](https://docs.getcollate.io/getting-started/day-1/hybrid-saas/hybrid-ingestion-runner#3.-manage-secrets-securely).
+
+{% /note %}
+
+{% /collateContent %}
+
 - **Client ID**: Client ID for DOMO Database.
 - **Secret Token**: Secret Token to Connect DOMO Database.
 - **Access Token**: Access to Connect to DOMO Database.

content/v1.10.x/connectors/database/exasol/index.md

@@ -50,6 +50,21 @@ The connector requires **Exasol version 7.1 or higher** to function correctly. E
 
 ### Connection Options
 
+{% collateContent %}
+
+{% note %} 
+
+If you are using a **Hybrid Ingestion Runner**, passwords must be referenced securely via secret paths using the following format:
+
+```
+password: secret:/my/database/password
+```
+For more details, refer to the [Hybrid Ingestion Runner Secret Management Guide](https://docs.getcollate.io/getting-started/day-1/hybrid-saas/hybrid-ingestion-runner#3.-manage-secrets-securely).
+
+{% /note %}
+
+{% /collateContent %}
+
 **Connection Scheme**: Specifies the SQLAlchemy driver scheme options required to connect to Exasol.
 
 **Username**: The username used to connect to the Exasol database. Ensure that this user has sufficient privileges to read all the metadata from Exasol.

content/v1.10.x/connectors/database/mongodb/index.md

@@ -45,6 +45,21 @@ To fetch the metadata from MongoDB to OpenMetadata, the MongoDB user must have a
 
 #### Connection Details
 
+{% collateContent %}
+
+{% note %} 
+
+If you are using a **Hybrid Ingestion Runner**, passwords must be referenced securely via secret paths using the following format:
+
+```
+password: secret:/my/database/password
+```
+For more details, refer to the [Hybrid Ingestion Runner Secret Management Guide](https://docs.getcollate.io/getting-started/day-1/hybrid-saas/hybrid-ingestion-runner#3.-manage-secrets-securely).
+
+{% /note %}
+
+{% /collateContent %}
+
 - **Username**: Username to connect to Mongodb. This user must have access to perform `find` operation on collection and `listCollection` operations on database available in MongoDB.
 - **Password**: Password to connect to MongoDB.
 - **Host Port**: When using the `mongodb` connecion schema, the hostPort parameter specifies the host and port of the MongoDB. This should be specified as a string in the format `hostname:port`. E.g., `localhost:27017`. When using the `mongodb+srv` connection schema, the hostPort parameter specifies the host and port of the MongoDB. This should be specified as a string in the format `hostname`. E.g., `cluster0-abcde.mongodb.net`.

content/v1.10.x/connectors/database/pinotdb/index.md

@@ -42,6 +42,21 @@ Configure and schedule PinotDB metadata and profiler workflows from the OpenMeta
 
 #### Connection Details
 
+{% collateContent %}
+
+{% note %} 
+
+If you are using a **Hybrid Ingestion Runner**, passwords must be referenced securely via secret paths using the following format:
+
+```
+password: secret:/my/database/password
+```
+For more details, refer to the [Hybrid Ingestion Runner Secret Management Guide](https://docs.getcollate.io/getting-started/day-1/hybrid-saas/hybrid-ingestion-runner#3.-manage-secrets-securely).
+
+{% /note %}
+
+{% /collateContent %}
+
 - **Username**: Specify the User to connect to PinotDB. It should have enough privileges to read all the metadata.
 - **Password**: Password to connect to PinotDB.
 - **Host and Port**: Enter the fully qualified hostname and port number for your PinotDB deployment in the Host and Port field.  Unlike broker host, prefix http:// or https:// must be added to controller host. For example, pinot broker host can be set to `localhost:8099` and pinot controller host can be set to `http://localhost:9000`.