Skip to content

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

Merged
merged 55 commits into from
Jul 16, 2025

Conversation

billy-the-fish
Copy link
Contributor

No description provided.

Verified

This commit was signed with the committer’s verified signature. The key has expired.
6543 6543

Verified

This commit was signed with the committer’s verified signature. The key has expired.
6543 6543
Copy link

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

@billy-the-fish billy-the-fish marked this pull request as draft June 10, 2025 10:38
philkra and others added 12 commits June 12, 2025 11:06

Verified

This commit was signed with the committer’s verified signature. The key has expired.
6543 6543

Verified

This commit was signed with the committer’s verified signature. The key has expired.
6543 6543

Verified

This commit was signed with the committer’s verified signature. The key has expired.
6543 6543

Verified

This commit was signed with the committer’s verified signature. The key has expired.
6543 6543

Verified

This commit was signed with the committer’s verified signature. The key has expired.
6543 6543
API

Verified

This commit was signed with the committer’s verified signature. The key has expired.
6543 6543

Verified

This commit was signed with the committer’s verified signature. The key has expired.
6543 6543

Verified

This commit was signed with the committer’s verified signature. The key has expired.
6543 6543
Signed-off-by: Philip Krauss <[email protected]>

Verified

This commit was signed with the committer’s verified signature. The key has expired.
6543 6543

Verified

This commit was signed with the committer’s verified signature. The key has expired.
6543 6543

Verified

This commit was signed with the committer’s verified signature. The key has expired.
6543 6543

Verified

This commit was signed with the committer’s verified signature. The key has expired.
6543 6543
Copy link
Contributor

@atovpeko atovpeko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. 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.
  2. Need a variable for TigerLake?

philkra and others added 10 commits June 25, 2025 13:55

Verified

This commit was signed with the committer’s verified signature. The key has expired.
6543 6543
Co-authored-by: Anastasiia Tovpeko <[email protected]>
Signed-off-by: Philip Krauss <[email protected]>

Verified

This commit was signed with the committer’s verified signature. The key has expired.
6543 6543
* chore: first changes.

* chore: a few edits.
yep
billy-the-fish and others added 26 commits July 7, 2025 15:57
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.
Copy link
Contributor

@atovpeko atovpeko left a 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/>
Copy link
Contributor

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">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<Tabs label="Install TimescaleDB">
<Tabs label="Connect Tiger Cloud service to a data lake">


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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**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]
Copy link
Contributor

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`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* `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

@philkra philkra merged commit ca7ca3a into latest Jul 16, 2025
3 checks passed
@philkra philkra deleted the 334-docs-rfc-create-the-docs-for-tigerlake branch July 16, 2025 09:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants