mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-09-25 17:04:54 +00:00
Doc: Updated Hive,MySQL,Postgres,Snowflake Service Connection Docs (#17127)
Co-authored-by: Prajwal Pandit <prajwalpandit@Prajwals-MacBook-Air.local> Co-authored-by: Ayush Shah <ayush@getcollate.io>
This commit is contained in:
Prajwal214
GitHub
parent
d25efedcb6
commit
25ad439123
@ -11,39 +11,56 @@ You can find further information on the Hive connector in the [docs](https://doc
|
||||
|
||||
## Hive Server Connection Details
|
||||
|
||||
### Scheme
|
||||
$$section
|
||||
### Scheme $(id="scheme")
|
||||
SQLAlchemy driver scheme options. If you are unsure about this setting, you can use the default value. OpenMetadata supports both `Hive` and `Impala`.
|
||||
$$
|
||||
|
||||
### Username
|
||||
$$section
|
||||
### Username $(id="username")
|
||||
Username to connect to Hive. This user should have the necessary privileges described in the section above.
|
||||
$$
|
||||
|
||||
### Password
|
||||
$$section
|
||||
### Password $(id="password")
|
||||
Password to connect to Hive.
|
||||
$$
|
||||
|
||||
### Host Port
|
||||
$$section
|
||||
### Host Port $(id="hostPort")
|
||||
|
||||
This parameter specifies the host and port of the Hive instance. This should be specified as a string in the format `hostname:port`. For example, you might set the hostPort parameter to `myhivehost:10000`.
|
||||
|
||||
If you are running the OpenMetadata ingestion in a docker and your services are hosted on the `localhost`, then use `host.docker.internal:10000` as the value.
|
||||
|
||||
### Auth
|
||||
$$
|
||||
$$section
|
||||
### Authentication Mode $(id="auth")
|
||||
The auth parameter specifies the authentication method to use when connecting to the Hive server. Possible values are `LDAP`, `NONE`, `CUSTOM`, or `KERBEROS`. If you are using Kerberos authentication, you should set auth to `KERBEROS`. If you are using custom authentication, you should set auth to `CUSTOM` and provide additional options in the `authOptions` parameter.
|
||||
$$
|
||||
|
||||
### Kerberos Service Name
|
||||
$$section
|
||||
### Kerberos Service Name $(id="kerberosServiceName")
|
||||
This parameter specifies the Kerberos service name to use for authentication. This should only be specified if using Kerberos authentication. The default value is `hive`.
|
||||
$$
|
||||
|
||||
### Database Schema
|
||||
$$section
|
||||
### Database Schema $(id="databaseSchema")
|
||||
Schema of the data source. This is optional parameter, if you would like to restrict the metadata reading to a single schema. When left blank, OpenMetadata Ingestion attempts to scan all the schemas.
|
||||
$$
|
||||
|
||||
### Database Name
|
||||
$$section
|
||||
### Database Name $(id="databaseName")
|
||||
In OpenMetadata, the Database Service hierarchy works as follows:
|
||||
```
|
||||
Database Service > Database > Schema > Table
|
||||
```
|
||||
In the case of Hive, we won't have a Database as such. If you'd like to see your data in a database named something other than `default`, you can specify the name in this field.
|
||||
$$
|
||||
|
||||
### Auth Options
|
||||
$$section
|
||||
### Auth Options $(id="authOptions")
|
||||
Authentication options to pass to Hive connector. These options are based on SQLAlchemy.
|
||||
$$
|
||||
|
||||
### Connection Options
|
||||
Additional connection options to build the URL that can be sent to service during the connection. The connectionOptions parameter is specific to the connection method being used. For example, if you are using SSL encryption, you might set the connectionOptions parameter to {'ssl': 'true', 'sslTrustStore': '/path/to/truststore'}.
|
||||
@ -57,24 +74,27 @@ Additional connection arguments such as security or protocol configs that can be
|
||||
|
||||
Username to connect to Postgres. This user should have privileges to read all the metadata in Postgres.
|
||||
|
||||
### Auth Config
|
||||
$$section
|
||||
### Auth Config $(id="authType")
|
||||
There are 2 types of auth configs:
|
||||
- Basic Auth.
|
||||
- IAM based Auth.
|
||||
- Azure Based Auth.
|
||||
|
||||
User can authenticate the Postgres Instance with auth type as `Basic Authentication` i.e. Password **or** by using `IAM based Authentication` to connect to AWS related services.
|
||||
User can authenticate the Postgres Instance with auth type as `Basic Authentication` i.e. Password **or** by using `IAM based Authentication` to connect to AWS related services **or** by using `Azure Baed Authentication` to connecto to Azure releated services.
|
||||
$$
|
||||
|
||||
### Basic Auth
|
||||
## Basic Auth
|
||||
|
||||
### Password $(id="password")
|
||||
|
||||
Password to connect to Postgres/MySQL.
|
||||
|
||||
|
||||
## IAM Auth Config
|
||||
|
||||
### Password
|
||||
|
||||
Password to connect to Postgres.
|
||||
|
||||
### IAM Auth Config
|
||||
|
||||
### AWS Access Key ID
|
||||
$$section
|
||||
### AWS Access Key ID $(id="awsAccessKeyId")
|
||||
|
||||
When you interact with AWS, you specify your AWS security credentials to verify who you are and whether you have permission to access the resources that you are requesting. AWS uses the security credentials to authenticate and authorize your requests ([docs](https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html)).
|
||||
|
||||
@ -85,40 +105,52 @@ Access keys consist of two parts:
|
||||
You must use both the access key ID and secret access key together to authenticate your requests.
|
||||
|
||||
You can find further information on how to manage your access keys [here](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html)
|
||||
$$
|
||||
|
||||
### AWS Secret Access Key
|
||||
$$section
|
||||
### AWS Secret Access Key $(id="awsSecretAccessKey")
|
||||
|
||||
Secret access key (for example, `wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`).
|
||||
$$
|
||||
|
||||
### AWS Region
|
||||
$$section
|
||||
### AWS Region $(id="awsRegion")
|
||||
|
||||
Each AWS Region is a separate geographic area in which AWS clusters data centers ([docs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html)).
|
||||
|
||||
As AWS can have instances in multiple regions, we need to know the region the service you want reach belongs to.
|
||||
|
||||
Note that the AWS Region is the only required parameter when configuring a connection. When connecting to the services programmatically, there are different ways in which we can extract and use the rest of AWS configurations. You can find further information about configuring your credentials [here](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html#configuring-credentials).
|
||||
$$
|
||||
|
||||
### AWS Session Token
|
||||
$$section
|
||||
### AWS Session Token $(id="awsSessionToken")
|
||||
|
||||
If you are using temporary credentials to access your services, you will need to inform the AWS Access Key ID and AWS Secrets Access Key. Also, these will include an AWS Session Token.
|
||||
|
||||
You can find more information on [Using temporary credentials with AWS resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html).
|
||||
$$
|
||||
|
||||
### Endpoint URL
|
||||
$$section
|
||||
### Endpoint URL $(id="endPointURL")
|
||||
|
||||
To connect programmatically to an AWS service, you use an endpoint. An *endpoint* is the URL of the entry point for an AWS web service. The AWS SDKs and the AWS Command Line Interface (AWS CLI) automatically use the default endpoint for each service in an AWS Region. But you can specify an alternate endpoint for your API requests.
|
||||
|
||||
Find more information on [AWS service endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html).
|
||||
$$
|
||||
|
||||
### Profile Name
|
||||
$$section
|
||||
### Profile Name $(id="profileName")
|
||||
|
||||
A named profile is a collection of settings and credentials that you can apply to an AWS CLI command. When you specify a profile to run a command, the settings and credentials are used to run that command. Multiple named profiles can be stored in the config and credentials files.
|
||||
|
||||
You can inform this field if you'd like to use a profile other than `default`.
|
||||
|
||||
Find here more information about [Named profiles for the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
|
||||
$$
|
||||
|
||||
### Assume Role ARN
|
||||
$$section
|
||||
### Assume Role ARN $(id="assumeRoleArn")
|
||||
|
||||
Typically, you use `AssumeRole` within your account or for cross-account access. In this field you'll set the `ARN` (Amazon Resource Name) of the policy of the other account.
|
||||
|
||||
@ -127,20 +159,81 @@ A user who wants to access a role in a different account must also have permissi
|
||||
This is a required field if you'd like to `AssumeRole`.
|
||||
|
||||
Find more information on [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html).
|
||||
$$
|
||||
|
||||
### Assume Role Session Name
|
||||
$$section
|
||||
### Assume Role Session Name $(id="assumeRoleSessionName")
|
||||
|
||||
An identifier for the assumed role session. Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons.
|
||||
|
||||
By default, we'll use the name `OpenMetadataSession`.
|
||||
|
||||
Find more information about the [Role Session Name](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html#:~:text=An%20identifier%20for%20the%20assumed%20role%20session.).
|
||||
$$
|
||||
|
||||
### Assume Role Source Identity
|
||||
$$section
|
||||
### Assume Role Source Identity $(id="assumeRoleSourceIdentity")
|
||||
|
||||
The source identity specified by the principal that is calling the `AssumeRole` operation. You can use source identity information in AWS CloudTrail logs to determine who took actions with a role.
|
||||
|
||||
Find more information about [Source Identity](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html#:~:text=Required%3A%20No-,SourceIdentity,-The%20source%20identity).
|
||||
$$
|
||||
|
||||
## Azure Auth Config
|
||||
|
||||
$$section
|
||||
### Client ID $(id="clientId")
|
||||
|
||||
This is a unique identifier for the service account. To fetch this key, look for the value associated with the `client_id` key in the service account key file.
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Client Secret $(id="clientSecret")
|
||||
To get the client secret, follow these steps:
|
||||
|
||||
1. Log into [Microsoft Azure](https://ms.portal.azure.com/#allservices).
|
||||
2. Search for `App registrations` and select the `App registrations link`.
|
||||
3. Select the `Azure AD` app you're using for this connection.
|
||||
4. Under `Manage`, select `Certificates & secrets`.
|
||||
5. Under `Client secrets`, select `New client secret`.
|
||||
6. In the `Add a client secret` pop-up window, provide a description for your application secret. Choose when the application should expire, and select `Add`.
|
||||
7. From the `Client secrets` section, copy the string in the `Value` column of the newly created application secret.
|
||||
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Tenant ID $(id="tenantId")
|
||||
|
||||
To get the tenant ID, follow these steps:
|
||||
|
||||
1. Log into [Microsoft Azure](https://ms.portal.azure.com/#allservices).
|
||||
2. Search for `App registrations` and select the `App registrations link`.
|
||||
3. Select the `Azure AD` app you're using for Power BI.
|
||||
4. From the `Overview` section, copy the `Directory (tenant) ID`.
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Storage Account Name $(id="accountName")
|
||||
|
||||
Account Name of your storage account
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Key Vault Name $(id="vaultName")
|
||||
|
||||
Key Vault Name
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Scopes $(id="scopes")
|
||||
|
||||
To let OM use the Trino Auth APIs using your Azure AD app, you'll need to add the scope
|
||||
1. Log into [Microsoft Azure](https://ms.portal.azure.com/#allservices).
|
||||
2. Search for `App registrations` and select the `App registrations link`.
|
||||
3. Select the `Azure AD` app you're using for Trino.
|
||||
4. From the `Expose an API` section, copy the `Application ID URI`
|
||||
5. Make sure the URI ends with `/.default` in case it does not, you can append the same manually
|
||||
$$
|
||||
|
||||
### Host and Port
|
||||
|
||||
@ -160,116 +253,28 @@ $$note
|
||||
if you are using `IAM auth`, select either `allow` (recommended) or other option based on your use case.
|
||||
$$
|
||||
|
||||
### Classification Name
|
||||
$$section
|
||||
### Classification Name $(id="classificationName")
|
||||
|
||||
By default, the Postgres policy tags in OpenMetadata are classified under the name `PostgresPolicyTags`. However, you can create a custom classification name of your choice for these tags. Once you have ingested Postgres data, the custom classification name will be visible in the Classifications list on the Tags page.
|
||||
$$
|
||||
|
||||
### Ingest All Databases
|
||||
|
||||
If ticked, the workflow will be able to ingest all database in the cluster. If not ticked, the workflow will only ingest tables from the database set above.
|
||||
|
||||
### Connection Arguments
|
||||
|
||||
Additional connection arguments such as security or protocol configs that can be sent to service during connection.
|
||||
|
||||
### Connection Options
|
||||
|
||||
Additional connection options to build the URL that can be sent to service during the connection.
|
||||
|
||||
## Hive Mysql Metastore Connection Details
|
||||
|
||||
|
||||
### Scheme $(id="scheme")
|
||||
SQLAlchemy driver scheme options. If you are unsure about this setting, you can use the default value.
|
||||
|
||||
|
||||
|
||||
### Username $(id="username")
|
||||
Username to connect to MySQL. This user should have access to the `INFORMATION_SCHEMA` to extract metadata. Other workflows may require different permissions -- refer to the section above for more information.
|
||||
|
||||
### Auth Config $(id="authType")
|
||||
There are 2 types of auth configs:
|
||||
- Basic Auth.
|
||||
- IAM based Auth.
|
||||
|
||||
User can authenticate the Mysql Instance with auth type as `Basic Authentication` i.e. Password **or** by using `IAM based Authentication` to connect to AWS related services.
|
||||
|
||||
|
||||
### Basic Auth
|
||||
|
||||
### Password $(id="password")
|
||||
Password to connect to MySQL.
|
||||
|
||||
### IAM Auth Config
|
||||
|
||||
$$note
|
||||
If you are using IAM auth, add <br />`"ssl": {"ssl-mode": "allow"}` under Connection Arguments
|
||||
$$
|
||||
|
||||
### AWS Access Key ID $(id="awsAccessKeyId")
|
||||
|
||||
When you interact with AWS, you specify your AWS security credentials to verify who you are and whether you have permission to access the resources that you are requesting. AWS uses the security credentials to authenticate and authorize your requests ([docs](https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html)).
|
||||
|
||||
Access keys consist of two parts:
|
||||
1. An access key ID (for example, `AKIAIOSFODNN7EXAMPLE`),
|
||||
2. And a secret access key (for example, `wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`).
|
||||
|
||||
You must use both the access key ID and secret access key together to authenticate your requests.
|
||||
|
||||
You can find further information on how to manage your access keys [here](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html)
|
||||
|
||||
### AWS Secret Access Key $(id="awsSecretAccessKey")
|
||||
|
||||
Secret access key (for example, `wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`).
|
||||
|
||||
### AWS Region $(id="awsRegion")
|
||||
|
||||
Each AWS Region is a separate geographic area in which AWS clusters data centers ([docs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html)).
|
||||
|
||||
As AWS can have instances in multiple regions, we need to know the region the service you want reach belongs to.
|
||||
|
||||
Note that the AWS Region is the only required parameter when configuring a connection. When connecting to the services programmatically, there are different ways in which we can extract and use the rest of AWS configurations. You can find further information about configuring your credentials [here](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html#configuring-credentials).
|
||||
|
||||
### AWS Session Token $(id="awsSessionToken")
|
||||
|
||||
If you are using temporary credentials to access your services, you will need to inform the AWS Access Key ID and AWS Secrets Access Key. Also, these will include an AWS Session Token.
|
||||
|
||||
You can find more information on [Using temporary credentials with AWS resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html).
|
||||
|
||||
### Endpoint URL $(id="endPointURL")
|
||||
|
||||
To connect programmatically to an AWS service, you use an endpoint. An *endpoint* is the URL of the entry point for an AWS web service. The AWS SDKs and the AWS Command Line Interface (AWS CLI) automatically use the default endpoint for each service in an AWS Region. But you can specify an alternate endpoint for your API requests.
|
||||
|
||||
Find more information on [AWS service endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html).
|
||||
|
||||
### Profile Name $(id="profileName")
|
||||
|
||||
A named profile is a collection of settings and credentials that you can apply to an AWS CLI command. When you specify a profile to run a command, the settings and credentials are used to run that command. Multiple named profiles can be stored in the config and credentials files.
|
||||
|
||||
You can inform this field if you'd like to use a profile other than `default`.
|
||||
|
||||
Find here more information about [Named profiles for the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
|
||||
|
||||
### Assume Role ARN $(id="assumeRoleArn")
|
||||
|
||||
Typically, you use `AssumeRole` within your account or for cross-account access. In this field you'll set the `ARN` (Amazon Resource Name) of the policy of the other account.
|
||||
|
||||
A user who wants to access a role in a different account must also have permissions that are delegated from the account administrator. The administrator must attach a policy that allows the user to call `AssumeRole` for the `ARN` of the role in the other account.
|
||||
|
||||
This is a required field if you'd like to `AssumeRole`.
|
||||
|
||||
Find more information on [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html).
|
||||
|
||||
### Assume Role Session Name $(id="assumeRoleSessionName")
|
||||
|
||||
An identifier for the assumed role session. Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons.
|
||||
|
||||
By default, we'll use the name `OpenMetadataSession`.
|
||||
|
||||
Find more information about the [Role Session Name](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html#:~:text=An%20identifier%20for%20the%20assumed%20role%20session.).
|
||||
|
||||
### Assume Role Source Identity $(id="assumeRoleSourceIdentity")
|
||||
|
||||
The source identity specified by the principal that is calling the `AssumeRole` operation. You can use source identity information in AWS CloudTrail logs to determine who took actions with a role.
|
||||
|
||||
Find more information about [Source Identity](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html#:~:text=Required%3A%20No-,SourceIdentity,-The%20source%20identity).
|
||||
|
||||
### Host Port $(id="hostPort")
|
||||
|
||||
@ -277,6 +282,8 @@ This parameter specifies the host and port of the MySQL instance. This should be
|
||||
|
||||
If you are running the OpenMetadata ingestion in a docker and your services are hosted on the `localhost`, then use `host.docker.internal:3306` as the value.
|
||||
|
||||
|
||||
|
||||
### Database Name $(id="databaseName")
|
||||
In OpenMetadata, the Database Service hierarchy works as follows:
|
||||
```
|
||||
@ -284,20 +291,35 @@ Database Service > Database > Schema > Table
|
||||
```
|
||||
In the case of MySQL, we won't have a Database as such. If you'd like to see your data in a database named something other than `default`, you can specify the name in this field.
|
||||
|
||||
|
||||
|
||||
### Database Schema $(id="databaseSchema")
|
||||
This is an optional parameter. When set, the value will be used to restrict the metadata reading to a single database (corresponding to the value passed in this field). When left blank, OpenMetadata will scan all the databases.
|
||||
|
||||
|
||||
$$section
|
||||
### SSL CA $(id="sslCA")
|
||||
Provide the path to SSL CA file, which needs to be local in the ingestion process.
|
||||
$$
|
||||
|
||||
$$section
|
||||
### SSL Certificate $(id="sslCert")
|
||||
Provide the path to SSL client certificate file (`ssl_cert`)
|
||||
$$
|
||||
|
||||
$$section
|
||||
### SSL Key $(id="sslKey")
|
||||
Provide the path to SSL key file (`ssl_key`)
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Connection Options $(id="connectionOptions")
|
||||
Additional connection options to build the URL that can be sent to the service during the connection.
|
||||
|
||||
Additional connection options to build the URL that can be sent to service during the connection.
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Connection Arguments $(id="connectionArguments")
|
||||
Additional connection arguments such as security or protocol configs that can be sent to the service during connection.
|
||||
|
||||
Additional connection arguments such as security or protocol configs that can be sent to service during connection.
|
||||
$$
|
||||
@ -46,8 +46,9 @@ $$section
|
||||
There are 2 types of auth configs:
|
||||
- Basic Auth.
|
||||
- IAM based Auth.
|
||||
- Azure Based Auth.
|
||||
|
||||
User can authenticate the Mysql Instance with auth type as `Basic Authentication` i.e. Password **or** by using `IAM based Authentication` to connect to AWS related services.
|
||||
User can authenticate the Mysql Instance with auth type as `Basic Authentication` i.e. Password **or** by using `IAM based Authentication` to connect to AWS related services **or** by using `Azure Baed Authentication` to connecto to Azure releated services.
|
||||
$$
|
||||
|
||||
|
||||
@ -150,6 +151,62 @@ The source identity specified by the principal that is calling the `AssumeRole`
|
||||
Find more information about [Source Identity](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html#:~:text=Required%3A%20No-,SourceIdentity,-The%20source%20identity).
|
||||
$$
|
||||
|
||||
## Azure Auth Config
|
||||
|
||||
$$section
|
||||
### Client ID $(id="clientId")
|
||||
|
||||
This is a unique identifier for the service account. To fetch this key, look for the value associated with the `client_id` key in the service account key file.
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Client Secret $(id="clientSecret")
|
||||
To get the client secret, follow these steps:
|
||||
|
||||
1. Log into [Microsoft Azure](https://ms.portal.azure.com/#allservices).
|
||||
2. Search for `App registrations` and select the `App registrations link`.
|
||||
3. Select the `Azure AD` app you're using for this connection.
|
||||
4. Under `Manage`, select `Certificates & secrets`.
|
||||
5. Under `Client secrets`, select `New client secret`.
|
||||
6. In the `Add a client secret` pop-up window, provide a description for your application secret. Choose when the application should expire, and select `Add`.
|
||||
7. From the `Client secrets` section, copy the string in the `Value` column of the newly created application secret.
|
||||
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Tenant ID $(id="tenantId")
|
||||
|
||||
To get the tenant ID, follow these steps:
|
||||
|
||||
1. Log into [Microsoft Azure](https://ms.portal.azure.com/#allservices).
|
||||
2. Search for `App registrations` and select the `App registrations link`.
|
||||
3. Select the `Azure AD` app you're using for Power BI.
|
||||
4. From the `Overview` section, copy the `Directory (tenant) ID`.
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Storage Account Name $(id="accountName")
|
||||
|
||||
Account Name of your storage account
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Key Vault Name $(id="vaultName")
|
||||
|
||||
Key Vault Name
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Scopes $(id="scopes")
|
||||
|
||||
To let OM use the Trino Auth APIs using your Azure AD app, you'll need to add the scope
|
||||
1. Log into [Microsoft Azure](https://ms.portal.azure.com/#allservices).
|
||||
2. Search for `App registrations` and select the `App registrations link`.
|
||||
3. Select the `Azure AD` app you're using for Trino.
|
||||
4. From the `Expose an API` section, copy the `Application ID URI`
|
||||
5. Make sure the URI ends with `/.default` in case it does not, you can append the same manually
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Host Port $(id="hostPort")
|
||||
|
||||
|
||||
@ -52,8 +52,9 @@ $$section
|
||||
There are 2 types of auth configs:
|
||||
- Basic Auth.
|
||||
- IAM based Auth.
|
||||
- Azure Based Auth.
|
||||
|
||||
User can authenticate the Postgres Instance with auth type as `Basic Authentication` i.e. Password **or** by using `IAM based Authentication` to connect to AWS related services.
|
||||
User can authenticate the Postgres Instance with auth type as `Basic Authentication` i.e. Password **or** by using `IAM based Authentication` to connect to AWS related services **or** by using `Azure Baed Authentication` to connecto to Azure releated services.
|
||||
$$
|
||||
|
||||
## Basic Auth
|
||||
@ -151,6 +152,62 @@ The source identity specified by the principal that is calling the `AssumeRole`
|
||||
Find more information about [Source Identity](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html#:~:text=Required%3A%20No-,SourceIdentity,-The%20source%20identity).
|
||||
$$
|
||||
|
||||
## Azure Auth Config
|
||||
|
||||
$$section
|
||||
### Client ID $(id="clientId")
|
||||
|
||||
This is a unique identifier for the service account. To fetch this key, look for the value associated with the `client_id` key in the service account key file.
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Client Secret $(id="clientSecret")
|
||||
To get the client secret, follow these steps:
|
||||
|
||||
1. Log into [Microsoft Azure](https://ms.portal.azure.com/#allservices).
|
||||
2. Search for `App registrations` and select the `App registrations link`.
|
||||
3. Select the `Azure AD` app you're using for this connection.
|
||||
4. Under `Manage`, select `Certificates & secrets`.
|
||||
5. Under `Client secrets`, select `New client secret`.
|
||||
6. In the `Add a client secret` pop-up window, provide a description for your application secret. Choose when the application should expire, and select `Add`.
|
||||
7. From the `Client secrets` section, copy the string in the `Value` column of the newly created application secret.
|
||||
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Tenant ID $(id="tenantId")
|
||||
|
||||
To get the tenant ID, follow these steps:
|
||||
|
||||
1. Log into [Microsoft Azure](https://ms.portal.azure.com/#allservices).
|
||||
2. Search for `App registrations` and select the `App registrations link`.
|
||||
3. Select the `Azure AD` app you're using for Power BI.
|
||||
4. From the `Overview` section, copy the `Directory (tenant) ID`.
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Storage Account Name $(id="accountName")
|
||||
|
||||
Account Name of your storage account
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Key Vault Name $(id="vaultName")
|
||||
|
||||
Key Vault Name
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Scopes $(id="scopes")
|
||||
|
||||
To let OM use the Trino Auth APIs using your Azure AD app, you'll need to add the scope
|
||||
1. Log into [Microsoft Azure](https://ms.portal.azure.com/#allservices).
|
||||
2. Search for `App registrations` and select the `App registrations link`.
|
||||
3. Select the `Azure AD` app you're using for Trino.
|
||||
4. From the `Expose an API` section, copy the `Application ID URI`
|
||||
5. Make sure the URI ends with `/.default` in case it does not, you can append the same manually
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Host and Port $(id="hostPort")
|
||||
|
||||
|
||||
@ -168,3 +168,107 @@ $$section
|
||||
|
||||
Additional connection arguments such as security or protocol configs that can be sent to service during connection.
|
||||
$$
|
||||
|
||||
## Sample Storage AWS S3 Config
|
||||
|
||||
$$section
|
||||
### AWS Access Key ID $(id="awsAccessKeyId")
|
||||
|
||||
When you interact with AWS, you specify your AWS security credentials to verify who you are and whether you have permission to access the resources that you are requesting. AWS uses the security credentials to authenticate and authorize your requests ([docs](https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html)).
|
||||
|
||||
Access keys consist of two parts:
|
||||
1. An access key ID (for example, `AKIAIOSFODNN7EXAMPLE`),
|
||||
2. And a secret access key (for example, `wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`).
|
||||
|
||||
You must use both the access key ID and secret access key together to authenticate your requests.
|
||||
|
||||
You can find further information on how to manage your access keys [here](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html)
|
||||
$$
|
||||
|
||||
$$section
|
||||
### AWS Secret Access Key $(id="awsSecretAccessKey")
|
||||
|
||||
Secret access key (for example, `wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`).
|
||||
$$
|
||||
|
||||
$$section
|
||||
### AWS Region $(id="awsRegion")
|
||||
|
||||
Each AWS Region is a separate geographic area in which AWS clusters data centers ([docs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html)).
|
||||
|
||||
As AWS can have instances in multiple regions, we need to know the region the service you want reach belongs to.
|
||||
|
||||
Note that the AWS Region is the only required parameter when configuring a connection. When connecting to the services programmatically, there are different ways in which we can extract and use the rest of AWS configurations. You can find further information about configuring your credentials [here](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html#configuring-credentials).
|
||||
$$
|
||||
|
||||
$$section
|
||||
### AWS Session Token $(id="awsSessionToken")
|
||||
|
||||
If you are using temporary credentials to access your services, you will need to inform the AWS Access Key ID and AWS Secrets Access Key. Also, these will include an AWS Session Token.
|
||||
|
||||
You can find more information on [Using temporary credentials with AWS resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html).
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Endpoint URL $(id="endPointURL")
|
||||
|
||||
To connect programmatically to an AWS service, you use an endpoint. An *endpoint* is the URL of the entry point for an AWS web service. The AWS SDKs and the AWS Command Line Interface (AWS CLI) automatically use the default endpoint for each service in an AWS Region. But you can specify an alternate endpoint for your API requests.
|
||||
|
||||
Find more information on [AWS service endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html).
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Profile Name $(id="profileName")
|
||||
|
||||
A named profile is a collection of settings and credentials that you can apply to an AWS CLI command. When you specify a profile to run a command, the settings and credentials are used to run that command. Multiple named profiles can be stored in the config and credentials files.
|
||||
|
||||
You can inform this field if you'd like to use a profile other than `default`.
|
||||
|
||||
Find here more information about [Named profiles for the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Assume Role ARN $(id="assumeRoleArn")
|
||||
|
||||
Typically, you use `AssumeRole` within your account or for cross-account access. In this field you'll set the `ARN` (Amazon Resource Name) of the policy of the other account.
|
||||
|
||||
A user who wants to access a role in a different account must also have permissions that are delegated from the account administrator. The administrator must attach a policy that allows the user to call `AssumeRole` for the `ARN` of the role in the other account.
|
||||
|
||||
This is a required field if you'd like to `AssumeRole`.
|
||||
|
||||
Find more information on [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html).
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Assume Role Session Name $(id="assumeRoleSessionName")
|
||||
|
||||
An identifier for the assumed role session. Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons.
|
||||
|
||||
By default, we'll use the name `OpenMetadataSession`.
|
||||
|
||||
Find more information about the [Role Session Name](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html#:~:text=An%20identifier%20for%20the%20assumed%20role%20session.).
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Assume Role Source Identity $(id="assumeRoleSourceIdentity")
|
||||
|
||||
The source identity specified by the principal that is calling the `AssumeRole` operation. You can use source identity information in AWS CloudTrail logs to determine who took actions with a role.
|
||||
|
||||
Find more information about [Source Identity](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html#:~:text=Required%3A%20No-,SourceIdentity,-The%20source%20identity).
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Bucket Name $(id="bucketName")
|
||||
|
||||
A bucket name in Data Lake is a unique identifier used to organize and store data objects.
|
||||
|
||||
It's similar to a folder name, but it's used for object storage rather than file storage.
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Prefix $(id="prefix")
|
||||
|
||||
The prefix of a data source refers to the first part of the data path that identifies the source or origin of the data.
|
||||
|
||||
It's used to organize and categorize data within the container, and can help users easily locate and access the data they need.
|
||||
$$
|
||||
Loading…
x
Reference in New Issue
Block a user