[Update] Multi-node and distributed hypertables
Closed this issue · 7 comments
New Intro / Getting Started
- Introduce single, primary/backup, and multinode configuration in updated intro - https://docs.timescale.com/latest/introduction [@mfreed]
- Create new "quick-start / quick configure" guide to setting up multi-node, new doc for "getting started" section - https://docs.timescale.com/beta-v2.0.0/getting-started/setup-multi-node [@solugebefola][ #525 ]
- Add "quick start" for setting up a new postgres user (simplified for data auth): https://docs.timescale.com/beta-v2.0.0/getting-started/setup-multi-node#data-node-auth [@mkindahl, @solugebefola ][ #525 ]
New Using Distributed Hypertables [@erimatnor]
https://docs.timescale.com/beta-v2.0.0/using-timescaledb/distributed-hypertables
- New intro to section with architectural picture of ANs / DNs and brief description of distributed hypertable [@erimatnor]
- Subsection: Easy configuration for ANs and DNs, adding data nodes to access node
- Subsection: Creating distributed hypertable - https://docs.timescale.com/beta-v2.0.0/using-timescaledb/distributed-hypertables#create [@erimatnor]
- Subsection: Changing the Number of Data Nodes for a Distributed Hypertable - https://docs.timescale.com/beta-v2.0.0/using-timescaledb/distributed-hypertables#changing-data-nodes [@erimatnor]
- Subsection: Advanced topic: Configuring data nodes - https://docs.timescale.com/beta-v2.0.0/getting-started/setup-multi-node#config-data-nodes
- Subsection: Advanced topic: Data authentication: Edit in light of quick-start, including some instructions about when/if each step needs to be taken https://docs.timescale.com/beta-v2.0.0/getting-started/setup-multi-node#data-node-auth [ @solugebefola ][ #525 ]
- Subsection: Current Status and Limitations (see below)
- ? Advanced topic: Schedule transaction cleanup (e.g., via custom job): https://github.com/timescale/timescaledb-private/issues/545 [ @pmwkaa ]
Current Status and Limitations
- Describe consistency model: https://github.com/timescale/timescaledb-private/issues/514
- Roles and permissions management
- Compression (only
compress_chunk, no policies) [@gayyappan ] - Continuous Aggs (currently blocked) [@gayyappan]
- Data retention policies [@gayyappan] This works on distributed hypertables.
- Custom jobs [@gayyappan]
- How do relational tables + JOINs work? [@gayyappan] already listed under Limitations section.
- Replication and HA [@gayyappan] We have docs for this. Added link to limitations section.
- Backup and recovery https://github.com/timescale/timescaledb-private/issues/516 [@gayyappan]
- UDFs https://github.com/timescale/timescaledb-private/issues/469 [ @gayyappan ]
API docs (@pmwkaa)
- Review
create_distributed_hypertable[ @k-rus ] [ #533 ] - Review
add_data_node- Improper layout as syntax/arguments should be at top [ @pmwkaa ] [ #541 ] - Review
delete_data_node(no changes required) - Review
attach_data_node(no changes required) - Review
detach_data_node[ @pmwkaa ][ #529 ] - Review
distributed_exec[ @k-rus ] [ #569 ] - Review
set_replication_factorhttps://docs.timescale.com/beta-v2.0.0/api#set_replication_factor [ @k-rus ] - Remove
allow_new_chunks(was moved to internal namespace) - Remove
block_new_chunks(was moved to internal namespace) Add label/badge to all multi-node functions
Misc
- Document multinode-specific GUCs. For instance
timescaledb.remote_data_fetchercan be set torow-by-rowandcursor, where the former is the default since the latter doesn't support parallel execution on the DN. [ @mkindahl @ryanbooz ] - Reformulate warning about using replication factor > 1 [ @k-rus ]
- Remove/reformulate warnings about using space partitioning https://github.com/timescale/timescaledb-private/issues/525 [ @k-rus ] [ #564 ]
Let's talk about the "current status and limitation", as well as how we plan to include. I do worry a bit about that sometimes we try to be very complete, so we end up writing a lot and users end up not reading because it's just too length / in the weeds.
For "Add "quick start" for setting up a new postgres user", I'm not quite sure what that's supposed to encompass vs. the overall "Create new "quick-start / quick configure" guide to setting up multi-node" changes to getting-started/setup-multinode? @mfreed
@solugebefola I'll just review when you are done. The old instructions just had a /lot/ of details about adding new databases users (and then propagating user creation to DNs as well), certification authentication approach, etc. Was thinking there was a way to just show one simplified perferred approach, rather than multiple. But let's review your draft and see what's needed.
bump? Seems like there is only "introduction" changes to add?
@mfreed close?