Fix Docs for Elasticsearch & Trino (#13716)

This commit is contained in:
Mayur Singal 2023-10-26 13:37:38 +05:30 committed by GitHub
parent cb25c5fae2
commit 2336ba5b85
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 18 additions and 6 deletions

View File

@ -72,7 +72,11 @@ Executing the profiler workflow or data quality tests, will require the user to
#### Connection Details
- **Username**: Specify the User to connect to Trino. It should have enough privileges to read all the metadata.
- **Password**: Password to connect to Trino.
- **Auth Config**: User can authenticate the Trino Instance with auth type as `Basic Authentication` i.e. Password **or** by using `JWT Authentication`.
- **Basic Auth**:
- **Password**: Password to connect to Trino.
- **JWT Auth Config**:
- **JWT**: JWT can be used to authenticate with trino. Follow the steps in the [official trino](https://trino.io/docs/current/security/jwt.html) documentation to setup trino with jwt.
- **Host and Port**: Enter the fully qualified hostname and port number for your Trino deployment in the Host and Port field.
- **Catalog**: Trino offers a catalog feature where all the databases are stored. (Providing the Catalog is not mandatory from 0.12.2 or greater versions)
- **DatabaseSchema**: DatabaseSchema of the data source. This is optional parameter, if you would like to restrict the metadata reading to a single databaseSchema. When left blank, OpenMetadata Ingestion attempts to scan all the databaseSchema.

View File

@ -94,7 +94,11 @@ This is a sample config for Trino:
{% codeInfo srNumber=2 %}
**password**: Password to connect to Trino.
- **authType**: User can authenticate the Trino Instance with auth type as `Basic Authentication` i.e. Password **or** by using `JWT Authentication`.
- **Basic Auth**:
- **password**: Password to connect to Trino.
- **JWT Auth Config**:
- **jwt**: JWT can be used to authenticate with trino. Follow the steps in the [official trino](https://trino.io/docs/current/security/jwt.html) documentation to setup trino with jwt.
{% /codeInfo %}
@ -186,7 +190,11 @@ source:
username: <username>
```
```yaml {% srNumber=3 %}
password: <password>
authType:
# For basic auth
password: password
# # For JWT auth
# jwt: jwt_token
```
```yaml {% srNumber=4 %}
catalog: <catalog>

View File

@ -50,7 +50,7 @@ We extract ElasticSearch's metadata by using its [API](https://www.elastic.co/gu
- Password: Password of the user account to connect with ElasticSearch.
2. API Key Authentication
- API Key: API Key to connect to ElasticSearch required when API Key Authentication is enabled on ElasticSearch.
- API Key Id: Enter API Key ID In case of API Key Authentication if there is any API Key ID associated with the API Key, otherwise this field can be left blank..
- API Key Id: Enter API Key ID In case of API Key Authentication if there is any API Key ID associated with the API Key, otherwise this field can be left blank.
- **Client Certificate Path**: In case the SSL is enabled on your ElasticSearch instance and CA certificate is required for authentication, then specify the path of certificate in this field. NOTE: In case of docker deployment you need to store this certificate accessible to OpenMetadata Ingestion docker container, you can do it via copying the certificate to the docker container or store it in the volume associate with the OpenMetadata Ingestion container.
- **Connection Timeout in Seconds**: Connection timeout configuration for communicating with ElasticSearch APIs.

View File

@ -13,9 +13,9 @@ You can find further information on the ElasticSearch connector in the [docs](ht
$$section
### Host and Port $(id="hostPort")
This parameter specifies the host and port of the ElasticSearch instance. This should be specified as a string in the format `hostname:port`. For example, you might set the hostPort parameter to `localhost:9200`.
This parameter specifies the host and port of the ElasticSearch instance. This should be specified as a string in the format `http://hostname:port`. For example, you might set the hostPort parameter to `http://localhost:9200` or `https://localhost:9200`.
If you are running the OpenMetadata ingestion in a docker and your services are hosted on the `localhost`, then use `host.docker.internal:9200` as the value.
If you are running the OpenMetadata ingestion in a docker and your services are hosted on the `localhost`, then use `http://host.docker.internal:9200` as the value.
$$
$$section