Skip to content

Commit

Permalink
Merge pull request #8611 from cockroachdb/remove-follow-the-workload-…
Browse files Browse the repository at this point in the history
…tutorial

De-emphasize follow-the-workload
  • Loading branch information
jseldess committed Oct 14, 2020
2 parents 590e913 + 0eb159e commit 54b2ed1
Show file tree
Hide file tree
Showing 22 changed files with 18 additions and 319 deletions.
1 change: 0 additions & 1 deletion _includes/cockroachcloud/app/see-also-links.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,4 @@ You might also be interested in the following pages:
- [Fault Tolerance & Recovery](../stable/demo-fault-tolerance-and-recovery.html)
- [Automatic Rebalancing](../stable/demo-automatic-rebalancing.html)
- [Cross-Cloud Migration](../stable/demo-automatic-cloud-migration.html)
- [Follow-the-Workload](../stable/demo-follow-the-workload.html)
- [Automated Operations](../stable/orchestrate-a-local-cluster-with-kubernetes-insecure.html)
6 changes: 0 additions & 6 deletions _includes/sidebar-data-v20.1.json
Original file line number Diff line number Diff line change
Expand Up @@ -92,12 +92,6 @@
"/${VERSION}/demo-automatic-cloud-migration.html"
]
},
{
"title": "Follow-the-Workload",
"urls": [
"/${VERSION}/demo-follow-the-workload.html"
]
},
{
"title": "Orchestration with Kubernetes",
"urls": [
Expand Down
6 changes: 0 additions & 6 deletions _includes/sidebar-data-v20.2.json
Original file line number Diff line number Diff line change
Expand Up @@ -93,12 +93,6 @@
"/${VERSION}/demo-automatic-cloud-migration.html"
]
},
{
"title": "Follow-the-Workload",
"urls": [
"/${VERSION}/demo-follow-the-workload.html"
]
},
{
"title": "Orchestration with Kubernetes",
"urls": [
Expand Down
1 change: 0 additions & 1 deletion _includes/v20.1/app/see-also-links.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,4 @@ You might also be interested in the following pages:
- [Fault Tolerance & Recovery](demo-fault-tolerance-and-recovery.html)
- [Automatic Rebalancing](demo-automatic-rebalancing.html)
- [Cross-Cloud Migration](demo-automatic-cloud-migration.html)
- [Follow-the-Workload](demo-follow-the-workload.html)
- [Automated Operations](orchestrate-a-local-cluster-with-kubernetes-insecure.html)
1 change: 0 additions & 1 deletion _includes/v20.1/misc/explore-benefits-see-also.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,5 @@
- [Low Latency Multi-Region Deployment](demo-low-latency-multi-region-deployment.html)
- [Serializable Transactions](demo-serializable.html)
- [Cross-Cloud Migration](demo-automatic-cloud-migration.html)
- [Follow-the-Workload](demo-follow-the-workload.html)
- [Orchestration](orchestrate-a-local-cluster-with-kubernetes-insecure.html)
- [JSON Support](demo-json-support.html)
1 change: 0 additions & 1 deletion _includes/v20.2/app/see-also-links.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,4 @@ You might also be interested in the following pages:
- [Fault Tolerance & Recovery](demo-fault-tolerance-and-recovery.html)
- [Automatic Rebalancing](demo-automatic-rebalancing.html)
- [Cross-Cloud Migration](demo-automatic-cloud-migration.html)
- [Follow-the-Workload](demo-follow-the-workload.html)
- [Automated Operations](orchestrate-a-local-cluster-with-kubernetes-insecure.html)
1 change: 0 additions & 1 deletion _includes/v20.2/misc/explore-benefits-see-also.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,5 @@
- [Low Latency Multi-Region Deployment](demo-low-latency-multi-region-deployment.html)
- [Serializable Transactions](demo-serializable.html)
- [Cross-Cloud Migration](demo-automatic-cloud-migration.html)
- [Follow-the-Workload](demo-follow-the-workload.html)
- [Orchestration](orchestrate-a-local-cluster-with-kubernetes-insecure.html)
- [JSON Support](demo-json-support.html)
6 changes: 6 additions & 0 deletions _redirects
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@ layout: null
/docs/*/contribute-to-cockroachdb.html https://wiki.crdb.io/wiki/spaces/CRDB/pages/73204033/Contributing+to+CockroachDB 301!
/docs/*/deploy-a-test-cluster.html /docs/cockroachcloud/quickstart.html 301!

# Removed pages
/docs/v20.1/demo-follow-the-workload.html /docs/v20.1/topology-follow-the-workload.html 301!
/docs/v20.2/demo-follow-the-workload.html /docs/v20.2/topology-follow-the-workload.html 301!
/docs/stable/demo-follow-the-workload.html /docs/stable/topology-follow-the-workload.html 301!
/docs/dev/demo-follow-the-workload.html /docs/dev/topology-follow-the-workload.html 301!

# Old training pages redirect to Cockroach University
/docs/*/training/* https://university.cockroachlabs.com 301!

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion v20.1/architecture/replication-layer.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Because CockroachDB serves reads from a range's leaseholder, it benefits your cl

{{site.data.alerts.callout_info}}

This feature is also called [Follow-the-Workload](../demo-follow-the-workload.html) in our documentation.
This feature is also called [Follow-the-Workload](../topology-follow-the-workload.html) in our documentation.

{{site.data.alerts.end}}

Expand Down
2 changes: 1 addition & 1 deletion v20.1/cockroach-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ The `--locality` flag accepts arbitrary key-value pairs that describe the locati

- CockroachDB spreads the replicas of each piece of data across as diverse a set of localities as possible, with the order determining the priority. Locality can also be used to influence the location of data replicas in various ways using [replication zones](configure-replication-zones.html#replication-constraints).

- When there is high latency between nodes (e.g., cross-datacenter deployments), CockroachDB uses locality to move range leases closer to the current workload, reducing network round trips and improving read performance, also known as ["follow-the-workload"](demo-follow-the-workload.html). In a deployment across more than 3 datacenters, however, to ensure that all data benefits from "follow-the-workload", you must increase your replication factor to match the total number of datacenters.
- When there is high latency between nodes (e.g., cross-datacenter deployments), CockroachDB uses locality to move range leases closer to the current workload, reducing network round trips and improving read performance, also known as ["follow-the-workload"](topology-follow-the-workload.html). In a deployment across more than 3 datacenters, however, to ensure that all data benefits from "follow-the-workload", you must increase your replication factor to match the total number of datacenters.

- Locality is also a prerequisite for using the [table partitioning](partitioning.html) and [**Node Map**](enable-node-map.html) enterprise features.

Expand Down
2 changes: 1 addition & 1 deletion v20.1/configure-replication-zones.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ When starting a node with the [`cockroach start`](cockroach-start.html) command,

Attribute Type | Description
---------------|------------
**Node Locality** | <a name="zone-config-node-locality"></a> Using the [`--locality`](cockroach-start.html#locality) flag, you can assign arbitrary key-value pairs that describe the location of the node. Locality might include region, country, datacenter, rack, etc. The key-value pairs should be ordered into _locality tiers_ that range from most inclusive to least inclusive (e.g., region before datacenter as in `region=eu,dc=paris`), and the keys and the order of key-value pairs must be the same on all nodes. It's typically better to include more pairs than fewer. For example:<br><br>`--locality=region=east,datacenter=us-east-1`<br>`--locality=region=east,datacenter=us-east-2`<br>`--locality=region=west,datacenter=us-west-1`<br><br>CockroachDB attempts to spread replicas evenly across the cluster based on locality, with the order of locality tiers determining the priority. Locality can also be used to influence the location of data replicas in various ways using replication zones.<br><br>When there is high latency between nodes, CockroachDB uses locality to move range leases closer to the current workload, reducing network round trips and improving read performance. See [Follow-the-workload](demo-follow-the-workload.html) for more details.
**Node Locality** | <a name="zone-config-node-locality"></a> Using the [`--locality`](cockroach-start.html#locality) flag, you can assign arbitrary key-value pairs that describe the location of the node. Locality might include region, country, datacenter, rack, etc. The key-value pairs should be ordered into _locality tiers_ that range from most inclusive to least inclusive (e.g., region before datacenter as in `region=eu,dc=paris`), and the keys and the order of key-value pairs must be the same on all nodes. It's typically better to include more pairs than fewer. For example:<br><br>`--locality=region=east,datacenter=us-east-1`<br>`--locality=region=east,datacenter=us-east-2`<br>`--locality=region=west,datacenter=us-west-1`<br><br>CockroachDB attempts to spread replicas evenly across the cluster based on locality, with the order of locality tiers determining the priority. Locality can also be used to influence the location of data replicas in various ways using replication zones.<br><br>When there is high latency between nodes, CockroachDB uses locality to move range leases closer to the current workload, reducing network round trips and improving read performance. See [Follow-the-workload](topology-follow-the-workload.html) for more details.
**Node Capability** | Using the `--attrs` flag, you can specify node capability, which might include specialized hardware or number of cores, for example:<br><br>`--attrs=ram:64gb`
**Store Type/Capability** | Using the `attrs` field of the `--store` flag, you can specify disk type or capability, for example:<br><br>`--store=path=/mnt/ssd01,attrs=ssd`<br>`--store=path=/mnt/hda1,attrs=hdd:7200rpm`

Expand Down
3 changes: 1 addition & 2 deletions v20.1/show-range-for-row.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,5 +82,4 @@ Field | Description
- [`CREATE INDEX`](create-index.html)
- [Indexes](indexes.html)
- [Partitioning tables](partitioning.html)
+ [Follow-the-Workload](demo-follow-the-workload.html)
+ [Architecture Overview](architecture/overview.html)
- [Architecture Overview](architecture/overview.html)
3 changes: 1 addition & 2 deletions v20.1/show-ranges.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,5 +121,4 @@ Field | Description
- [`CREATE INDEX`](create-index.html)
- [Indexes](indexes.html)
- [Partitioning tables](partitioning.html)
+ [Follow-the-Workload](demo-follow-the-workload.html)
+ [Architecture Overview](architecture/overview.html)
- [Architecture Overview](architecture/overview.html)
2 changes: 1 addition & 1 deletion v20.1/topology-follow-the-workload.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ If read performance is your main focus for a table, but you want low-latency rea

## Configuration

Aside from [deploying a cluster across three regions](#cluster-setup) properly, with each node started with the [`--locality`](cockroach-start.html#locality) flag specifying its region and AZ combination, this pattern requires no extra configuration. CockroachDB will balance the replicas for a table across the three regions and will assign the range lease to the replica in the region with the greatest demand at any given time (the [follow-the-workload](demo-follow-the-workload.html) feature). This means that read latency in the active region will be low while read latency in other regions will be higher due to having to leave the region to reach the leaseholder. Write latency will be higher as well due to always involving replicas in multiple regions.
Aside from [deploying a cluster across three regions](#cluster-setup) properly, with each node started with the [`--locality`](cockroach-start.html#locality) flag specifying its region and AZ combination, this pattern requires no extra configuration. CockroachDB will balance the replicas for a table across the three regions and will assign the range lease to the replica in the region with the greatest demand at any given time (the follow-the-workload feature). This means that read latency in the active region will be low while read latency in other regions will be higher due to having to leave the region to reach the leaseholder. Write latency will be higher as well due to always involving replicas in multiple regions.

<img src="{{ 'images/v20.1/topology-patterns/topology_follower_reads1.png' | relative_url }}" alt="Follower reads topology" style="max-width:100%" />

Expand Down
2 changes: 1 addition & 1 deletion v20.2/architecture/replication-layer.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Because CockroachDB serves reads from a range's leaseholder, it benefits your cl

{{site.data.alerts.callout_info}}

This feature is also called [Follow-the-Workload](../demo-follow-the-workload.html) in our documentation.
This feature is also called [Follow-the-Workload](../topology-follow-the-workload.html) in our documentation.

{{site.data.alerts.end}}

Expand Down
2 changes: 1 addition & 1 deletion v20.2/cockroach-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ The `--locality` flag accepts arbitrary key-value pairs that describe the locati

- CockroachDB spreads the replicas of each piece of data across as diverse a set of localities as possible, with the order determining the priority. Locality can also be used to influence the location of data replicas in various ways using [replication zones](configure-replication-zones.html#replication-constraints).

- When there is high latency between nodes (e.g., cross-datacenter deployments), CockroachDB uses locality to move range leases closer to the current workload, reducing network round trips and improving read performance, also known as ["follow-the-workload"](demo-follow-the-workload.html). In a deployment across more than 3 datacenters, however, to ensure that all data benefits from "follow-the-workload", you must increase your replication factor to match the total number of datacenters.
- When there is high latency between nodes (e.g., cross-datacenter deployments), CockroachDB uses locality to move range leases closer to the current workload, reducing network round trips and improving read performance, also known as ["follow-the-workload"](topology-follow-the-workload.html). In a deployment across more than 3 datacenters, however, to ensure that all data benefits from "follow-the-workload", you must increase your replication factor to match the total number of datacenters.

- Locality is also a prerequisite for using the [table partitioning](partitioning.html) and [**Node Map**](enable-node-map.html) enterprise features.

Expand Down
2 changes: 1 addition & 1 deletion v20.2/configure-replication-zones.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ When starting a node with the [`cockroach start`](cockroach-start.html) command,

Attribute Type | Description
---------------|------------
**Node Locality** | <a name="zone-config-node-locality"></a> Using the [`--locality`](cockroach-start.html#locality) flag, you can assign arbitrary key-value pairs that describe the location of the node. Locality might include region, country, datacenter, rack, etc. The key-value pairs should be ordered into _locality tiers_ that range from most inclusive to least inclusive (e.g., region before datacenter as in `region=eu,dc=paris`), and the keys and the order of key-value pairs must be the same on all nodes. It's typically better to include more pairs than fewer. For example:<br><br>`--locality=region=east,datacenter=us-east-1`<br>`--locality=region=east,datacenter=us-east-2`<br>`--locality=region=west,datacenter=us-west-1`<br><br>CockroachDB attempts to spread replicas evenly across the cluster based on locality, with the order of locality tiers determining the priority. Locality can also be used to influence the location of data replicas in various ways using replication zones.<br><br>When there is high latency between nodes, CockroachDB uses locality to move range leases closer to the current workload, reducing network round trips and improving read performance. See [Follow-the-workload](demo-follow-the-workload.html) for more details.
**Node Locality** | <a name="zone-config-node-locality"></a> Using the [`--locality`](cockroach-start.html#locality) flag, you can assign arbitrary key-value pairs that describe the location of the node. Locality might include region, country, datacenter, rack, etc. The key-value pairs should be ordered into _locality tiers_ that range from most inclusive to least inclusive (e.g., region before datacenter as in `region=eu,dc=paris`), and the keys and the order of key-value pairs must be the same on all nodes. It's typically better to include more pairs than fewer. For example:<br><br>`--locality=region=east,datacenter=us-east-1`<br>`--locality=region=east,datacenter=us-east-2`<br>`--locality=region=west,datacenter=us-west-1`<br><br>CockroachDB attempts to spread replicas evenly across the cluster based on locality, with the order of locality tiers determining the priority. Locality can also be used to influence the location of data replicas in various ways using replication zones.<br><br>When there is high latency between nodes, CockroachDB uses locality to move range leases closer to the current workload, reducing network round trips and improving read performance. See [Follow-the-workload](topology-follow-the-workload.html) for more details.
**Node Capability** | Using the `--attrs` flag, you can specify node capability, which might include specialized hardware or number of cores, for example:<br><br>`--attrs=ram:64gb`
**Store Type/Capability** | Using the `attrs` field of the `--store` flag, you can specify disk type or capability, for example:<br><br>`--store=path=/mnt/ssd01,attrs=ssd`<br>`--store=path=/mnt/hda1,attrs=hdd:7200rpm`

Expand Down
Loading

0 comments on commit 54b2ed1

Please sign in to comment.