-
Notifications
You must be signed in to change notification settings - Fork 122
334 docs rfc create the docs for tigerlake #4194
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Allow 10 minutes from last push for the staging site to build. If the link doesn't work, try using incognito mode instead. For internal reviewers, check web-documentation repo actions for staging build status. Link to build for this PR: http://docs-dev.timescale.com/docs-334-docs-rfc-create-the-docs-for-tigerlake |
Signed-off-by: Philip Krauss <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- I'd say the very first sentence on the page should explain that this is an integration, and then proceed to say what it does.
- Need a variable for TigerLake?
Co-authored-by: Anastasiia Tovpeko <[email protected]> Signed-off-by: Philip Krauss <[email protected]>
* chore: first changes. * chore: a few edits.
Co-authored-by: gayyappan <[email protected]> Signed-off-by: Iain Cox <[email protected]>
Co-authored-by: gayyappan <[email protected]> Signed-off-by: Iain Cox <[email protected]>
…om:timescale/docs into 334-docs-rfc-create-the-docs-for-tigerlake # Conflicts: # use-timescale/tigerlake.md
Co-authored-by: gayyappan <[email protected]> Signed-off-by: Philip Krauss <[email protected]>
* chore: update lake procedure. * chore: update lake procedure.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A couple of very small things.
|
||
## Prerequisites | ||
|
||
<IntegrationPrereqsCloud/> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we need to update our prereqs to say "with the real-time analytics enabled" to match the new UI
|
||
To connect a $SERVICE_LONG to your data lake: | ||
|
||
<Tabs label="Install TimescaleDB"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
<Tabs label="Install TimescaleDB"> | |
<Tabs label="Connect Tiger Cloud service to a data lake"> |
use-timescale/tigerlake.md
Outdated
|
||
1. **Set the AWS region to host your table bucket** | ||
1. In [AWS CloudFormation][cmc], select the current AWS region at the top-right of the page. | ||
1. Set it to the Region to create your table bucket in. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1. Set it to the Region to create your table bucket in. | |
1. Set it to the region to create your table bucket in. |
1. In [AWS CloudFormation][cmc], select the current AWS region at the top-right of the page. | ||
1. Set it to the Region to create your table bucket in. | ||
|
||
**This must match the region your $SERVICE_LONG is running in**: if the regions do not match AWS charges you for |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
**This must match the region your $SERVICE_LONG is running in**: if the regions do not match AWS charges you for | |
**This must match the region your $SERVICE_LONG is running in**: if the regions do not match, AWS charges you for |
|
||
* `StackName`: the name for this CloudFormation stack | ||
* `BucketName`: the name of the S3 table bucket to create | ||
* `ProjectID`: enter your $SERVICE_LONG [connection details][get-project-id] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Project ID and service ID are combined in a single bullet in the first tab, think we can do the same here (or split there as well)
1. Copy the `Amazon Resource Name (ARN)` for your table bucket. | ||
|
||
1. **Create an ARN role** | ||
1. In [IAM Dashboard][iam-dashboard], click `Roles` then click `Create role` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1. In [IAM Dashboard][iam-dashboard], click `Roles` then click `Create role` | |
1. In [IAM Dashboard][iam-dashboard], click `Roles` then click `Create role`. |
|
||
1. **Create an ARN role** | ||
1. In [IAM Dashboard][iam-dashboard], click `Roles` then click `Create role` | ||
1. In `Select trusted entity`, click `Custom trust policy`, replace the **Custom trust policy** code block with the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1. In `Select trusted entity`, click `Custom trust policy`, replace the **Custom trust policy** code block with the | |
1. In `Select trusted entity`, click `Custom trust policy`, then replace the `Custom trust policy` code block with the |
`"Principal": { "AWS": "arn:aws:iam::123456789012:root" }` does not mean `root` access. This delegates | ||
permissions to the entire AWS account, not just the root user. | ||
|
||
1. Replace `<ProjectID>` and `<ServiceID>` with the the [connection details][get-project-id] for your $LAKE_LONG |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1. Replace `<ProjectID>` and `<ServiceID>` with the the [connection details][get-project-id] for your $LAKE_LONG | |
1. Replace `<ProjectID>` and `<ServiceID>` with the [connection details][get-project-id] for your $LAKE_LONG |
1. In `Permissions policies`. click `Next`. | ||
1. In `Role details`, enter `Role name`, then click `Create role`. | ||
1. In `Roles`, select the role you just created, then click `Add Permissions` > `Create inline policy`. | ||
1. Select `JSON` then replace the `Policy editor` code block with the following: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
1. Select `JSON` then replace the `Policy editor` code block with the following: | |
1. Select `JSON`, then replace the `Policy editor` code block with the following: |
|
||
* `tigerlake.iceberg_sync`: `boolean`, set to `true` to start streaming, or `false` to stop the stream. A stream | ||
**cannot** resume after being stopped. | ||
* `tigerlake.iceberg_partitionby`: optional property to define a partition specification in Iceberg. By default the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* `tigerlake.iceberg_partitionby`: optional property to define a partition specification in Iceberg. By default the | |
* `tigerlake.iceberg_partitionby`: optional property to define a partition specification in Iceberg. By default |
No description provided.