Skip to content

Commit 3ac8272

Browse files
sweta1308sweta1308
committed
update yaml
1 parent adccf53 commit 3ac8272

File tree

3 files changed

+72
-59
lines changed

3 files changed

+72
-59
lines changed

‎connectors/database/athena/yaml.mdx‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -162,24 +162,20 @@ This is a sample config for Athena:
162162

163163
<ContentPanel>
164164

165-
<ContentSection id={1} title="Source Configuration" lines="2-4">
165+
<ContentSection id={1} title="Source Configuration" lines="1">
166166

167167
Configure the source type and service name for your Athena connector.
168168

169169
</ContentSection>
170170

171-
<ContentSection id={2} title="Connection Type" lines="5-7">
171+
<ContentSection id={2} title="Connection Type" lines="2">
172172

173173
**type**: Set to `Athena` for Athena connections.
174174

175175
</ContentSection>
176176

177-
<ContentSection id={3} title="AWS Configuration" lines="8-16">
178-
179177
<AwsConfigDef />
180178

181-
</ContentSection>
182-
183179
<ContentSection id={4} title="S3 Staging Directory" lines="17">
184180

185181
**s3StagingDir**: The S3 staging directory is an optional parameter. Enter a staging directory to override the default staging directory for AWS Athena.

‎snippets/connectors/yaml/common/aws-config-def.mdx‎

Lines changed: 61 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,83 +1,100 @@
1-
<div>
1+
<ContentPanel>
22

3-
**awsAccessKeyId** & **awsSecretAccessKey**: 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)).
3+
<ContentSection id={1} title="AWS Access Key Credentials" lines="9-10">
44

5-
Access keys consist of two parts: An **access key ID** (for example, `AKIAIOSFODNN7EXAMPLE`), and a **secret access key** (for example, `wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`).
5+
**awsAccessKeyId** and **awsSecretAccessKey** are used to authenticate and authorize programmatic requests to AWS services.
66

7-
You must use both the access key ID and secret access key together to authenticate your requests.
7+
An access key consists of:
8+
- **Access Key ID** (for example, `AKIAIOSFODNN7EXAMPLE`)
9+
- **Secret Access Key** (for example, `wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`)
810

9-
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).
11+
Both values must be provided together when using static credentials.
1012

11-
</div>
13+
For more information, see
14+
[Managing access keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html).
1215

13-
<div>
16+
</ContentSection>
1417

15-
**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.
18+
<ContentSection id={2} title="AWS Session Token" >
1619

17-
</div>
20+
**awsSessionToken** is required when using **temporary security credentials**, such as those obtained via AWS STS.
1821

19-
<div>
22+
The session token must be provided along with the access key ID and secret access key for the duration of the session.
2023

21-
**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)).
24+
</ContentSection>
2225

23-
As AWS can have instances in multiple regions, we need to know the region the service you want reach belongs to.
26+
<ContentSection id={3} title="AWS Region">
2427

25-
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.
28+
**awsRegion** specifies the AWS Region where the target service is deployed (for example, `us-east-1`).
2629

27-
You can find further information about configuring your credentials [here](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html#configuring-credentials).
30+
This is the **only required parameter** when configuring an AWS connection. Other credentials can be resolved automatically using environment variables, AWS profiles, or IAM roles.
2831

29-
</div>
32+
Learn more in the
33+
[AWS Regions and Availability Zones documentation](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html).
3034

31-
<div>
35+
</ContentSection>
3236

33-
**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.
37+
<ContentSection id={4} title="Custom Endpoint URL">
3438

35-
Find more information on [AWS service endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html).
39+
**endPointURL** is an optional custom endpoint used to connect to an AWS service.
3640

37-
</div>
41+
You may want to specify this when:
42+
- Using VPC endpoints
43+
- Connecting to local or AWS-compatible services
44+
- Overriding the default regional endpoint
3845

39-
<div>
46+
See
47+
[AWS service endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html) for details.
4048

41-
**profileName**: A named profile is a collection of settings and credentials that you can apply to a 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.
49+
</ContentSection>
4250

43-
You can inform this field if you'd like to use a profile other than `default`.
51+
<ContentSection id={5} title="AWS Profile Name">
4452

45-
Find here more information about [Named profiles for the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
53+
**profileName** specifies the AWS CLI profile to use for authentication.
4654

47-
</div>
55+
Profiles store credentials and configuration in AWS config files.
56+
If not specified, the `default` profile is used.
4857

49-
<div>
58+
Learn more about
59+
[Named profiles for the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
5060

51-
**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.
61+
</ContentSection>
5262

53-
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.
63+
<ContentSection id={6} title="Assume Role ARN">
5464

55-
This is a required field if you'd like to `AssumeRole`.
65+
**assumeRoleArn** is the Amazon Resource Name (ARN) of the IAM role to assume.
5666

57-
Find more information on [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html).
67+
This is commonly used for:
68+
- Cross-account access
69+
- Delegated permissions
70+
- Enhanced security setups
5871

59-
<Tip>
60-
When using Assume Role authentication, ensure you provide the following details:
61-
- **AWS Region**: Specify the AWS region for your deployment.
62-
- **Assume Role ARN**: Provide the ARN of the role in your AWS account that OpenMetadata will assume.
63-
</Tip>
72+
This field is **required** when using Assume Role authentication.
6473

65-
</div>
74+
See the
75+
[AssumeRole API reference](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html).
6676

67-
<div>
77+
</ContentSection>
6878

69-
**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.
79+
<ContentSection id={7} title="Assume Role Session Name">
7080

71-
By default, we'll use the name `OpenMetadataSession`.
81+
**assumeRoleSessionName** identifies the assumed role session.
7282

73-
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.).
83+
This value helps uniquely identify a session when the same role is assumed multiple times or by different principals.
7484

75-
</div>
85+
If not provided, the default value `OpenMetadataSession` is used.
7686

77-
<div>
87+
</ContentSection>
7888

79-
**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.
89+
<ContentSection id={8} title="Assume Role Source Identity">
8090

81-
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).
91+
**assumeRoleSourceIdentity** is an optional source identity passed when assuming a role.
8292

83-
</div>
93+
This value is recorded in AWS CloudTrail logs and can be used to trace actions performed using the assumed role.
94+
95+
See
96+
[Source Identity in AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html).
97+
98+
</ContentSection>
99+
100+
</ContentPanel>

‎snippets/connectors/yaml/query-usage.mdx‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,57 +13,57 @@ This is a sample config for {connector} Usage:
1313

1414
<ContentPanel>
1515

16-
<ContentSection id={1} title="Source Configuration" lines="1-3">
16+
<ContentSection id={1} title="Source Configuration" lines="4">
1717

1818
Configure the source type and service name for your usage workflow.
1919

2020
</ContentSection>
2121

22-
<ContentSection id={2} title="Usage Config Type" lines="4-5">
22+
<ContentSection id={2} title="Usage Config Type" lines="6">
2323

2424
**type**: Set to `DatabaseUsage` for database usage ingestion.
2525

2626
</ContentSection>
2727

28-
<ContentSection id={3} title="Query Log Duration" lines="6-7">
28+
<ContentSection id={3} title="Query Log Duration" lines="8">
2929

3030
**queryLogDuration**: Configuration to tune how far we want to look back in query logs to process usage data (in days).
3131

3232
</ContentSection>
3333

34-
<ContentSection id={4} title="Stage File Location" lines="8-9">
34+
<ContentSection id={4} title="Stage File Location" lines="10">
3535

3636
**stageFileLocation**: Temporary file name to store the query logs before processing. Absolute file path required.
3737

3838
Note that the location is a directory that will be cleaned at the end of the ingestion.
3939

4040
</ContentSection>
4141

42-
<ContentSection id={5} title="Result Limit" lines="10">
42+
<ContentSection id={5} title="Result Limit" lines="11">
4343

4444
**resultLimit**: Configuration to set the limit for query logs.
4545

4646
</ContentSection>
4747

48-
<ContentSection id={6} title="Query Log File Path" lines="11-12">
48+
<ContentSection id={6} title="Query Log File Path" lines="13">
4949

5050
**queryLogFilePath**: Configuration to set the file path for query logs. If instead of getting the query logs from the database we want to pass a file with the queries.
5151

5252
</ContentSection>
5353

54-
<ContentSection id={7} title="Processor Configuration" lines="13-15">
54+
<ContentSection id={7} title="Processor Configuration" lines="14-16">
5555

5656
Choose the `query-parser` processor to parse and process the query logs.
5757

5858
</ContentSection>
5959

60-
<ContentSection id={8} title="Stage Configuration" lines="16-18">
60+
<ContentSection id={8} title="Stage Configuration" lines="17-20">
6161

6262
Configure the staging location for table usage data before it's sent to OpenMetadata.
6363

6464
</ContentSection>
6565

66-
<ContentSection id={9} title="Bulk Sink Configuration" lines="19-21">
66+
<ContentSection id={9} title="Bulk Sink Configuration" lines="21-24">
6767

6868
Configure the bulk sink for metadata usage ingestion.
6969

0 commit comments

Comments
 (0)