From c8ff67262d7a62d62ac2a04fd20627b0774ff049 Mon Sep 17 00:00:00 2001 From: Alan Bernstein Date: Mon, 14 May 2018 18:15:37 -0500 Subject: [PATCH] Add some links --- docs/administration.md | 4 ++-- docs/api-reference.md | 2 +- docs/configuration.md | 4 ++-- docs/faq.md | 5 ++--- docs/glossary.md | 2 ++ 5 files changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/administration.md b/docs/administration.md index 63d75b53b..f8f620c4a 100644 --- a/docs/administration.md +++ b/docs/administration.md @@ -24,7 +24,7 @@ Pilosa holds all row/column bitmap data in main memory. While this data is compr #### CPUs -Pilosa is a concurrent application written in Go and can take full advantage of multicore machines. The main unit of parallelism is the slice, so a single query will only use a number of cores up to the number of slices stored on that host. Multiple queries can still take advantage of multiple cores as well though, so tuning in this area is dependent on the expected workload. +Pilosa is a concurrent application written in Go and can take full advantage of multicore machines. The main unit of parallelism is the [slice](../data-model/#slice), so a single query will only use a number of cores up to the number of slices stored on that host. Multiple queries can still take advantage of multiple cores as well though, so tuning in this area is dependent on the expected workload. #### Disk @@ -113,7 +113,7 @@ Pilosa v0.9 introduces a few compatibility changes that need to be addressed. **Data directory changes**: These changes need to occur while the cluster is shut down, before starting Pilosa v0.9: -Pilosa v0.9 adds two new files to the data directory, an `.id` file and a `.topology` file. Due to the way Pilosa internally shards indices, upgrading a Pilosa cluster will result in data loss if an existing cluster is brought up without these files. New clusters will generate them automatically, but you may migrate an existing cluster by using a tool we called `topology-generator`: +Pilosa v0.9 adds two new files to the data directory, an `.id` file and a `.topology` file. Due to the way Pilosa internally shards indices, upgrading a Pilosa cluster will result in data loss if an existing cluster is brought up without these files. New clusters will generate them automatically, but you may migrate an existing cluster by using a tool we called [`topology-generator`](https://github.com/pilosa/upgrade-utils/tree/master/v0.9/topology-generator): 1. Observe the `cluster.hosts` configuration value in Pilosa v0.8. The ordering of the nodes in the config file is significant, as it determines shard (AKA slice) ownership. Pilosa v0.9 uses UUIDs for each node, and the ordering is alphabetical. 2. Install the `topology-generator`: `go get github.com/pilosa/upgrade-utils/v0.9/topology-generator`. diff --git a/docs/api-reference.md b/docs/api-reference.md index 2e744954e..b110534cb 100644 --- a/docs/api-reference.md +++ b/docs/api-reference.md @@ -63,7 +63,7 @@ curl -XDELETE localhost:10101/index/user `POST /index//query` -Sends a query to the Pilosa server with the given index. The request body is UTF-8 encoded text and response body is in JSON by default. +Sends a [query](../query-language) to the Pilosa server with the given index. The request body is UTF-8 encoded text and response body is in JSON by default. ``` request curl localhost:10101/index/user/query \ diff --git a/docs/configuration.md b/docs/configuration.md index b6b49d4ab..c6ed8fbd4 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -213,7 +213,7 @@ The config file is in the [toml format](https://github.com/toml-lang/toml) and h ``` #### Metric Service -* Description: Which stats service to use. Choose from [statsd, expvar, none]. +* Description: Which stats service to use for collecting [metrics](../administration/#metrics). Choose from [statsd, expvar, none]. * Flag: `--metric.service=statsd` * Env: `PILOSA_METRIC_SERVICE=statsd` * Config: @@ -248,7 +248,7 @@ The config file is in the [toml format](https://github.com/toml-lang/toml) and h #### Metric Diagnostics -* Description: Enable reporting of limited usage statistics to Pilosa developers. To disable, set to false. +* Description: Enable [reporting](../administration/#diagnostics) of limited usage statistics to Pilosa developers. To disable, set to false. * Flag: `metric.diagnostics` * Env: `PILOSA_METRIC_DIAGNOSTICS` * Config: diff --git a/docs/faq.md b/docs/faq.md index 56b16777b..0e633046d 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -32,12 +32,11 @@ For the case where data is continually mutating, one would apply a parallel data ### What languages can I use with it? -There is currently client support for Go, Python, and Java. If you want to use Pilosa with a different language, you can access Pilosa via the Pilosa API. +There is currently [client support](../client-libraries) for [Go](https://github.com/pilosa/go-pilosa), [Python](https://github.com/pilosa/python-pilosa), and [Java](https://github.com/pilosa/java-pilosa). If you want to use Pilosa with a different language, you can access Pilosa via the [Pilosa API](../api-reference). ### Do you query Pilosa using SQL? -One can access Pilosa directly via the terminal using the Pilosa Query Language (PQL), but a typical implementation would use one of the Pilosa client libraries to integrate with an existing codebase. There is currently client support for Go, Python, and Java. - +One can access Pilosa directly via the terminal using the [Pilosa Query Language](../query-language) (PQL), but a typical implementation would use one of the Pilosa client libraries to integrate with an existing codebase. There is currently client support for Go, Python, and Java. ### Replication on each node? diff --git a/docs/glossary.md b/docs/glossary.md index 9b883017d..fb1a46690 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -26,6 +26,8 @@ nav = [] [Frame](../data-model/#frame): Frames are used to group [rows](#row) into different categories. Row IDs are namespaced by frame such that the same row ID in a different frame refers to a different row. For [ranked](#topn) frames, rows are kept in sorted order within the frame. +[Gossip](https://en.wikipedia.org/wiki/Gossip_protocol): A protocol used by Pilosa for internal communication. + [Index](../data-model/#index): An Index is a top level container in Pilosa, analogous to a database in an RDBMS. Queries cannot operate across multiple indexes. [Jump Consistent Hash](https://arxiv.org/pdf/1406.2294v1.pdf): A fast, minimal memory, consistent hash algorithm that evenly distributes the workload even when the number of buckets changes.