diff --git a/docs/concepts/driver_registry.md b/docs/concepts/driver_registry.md index df744bb4..aadabb69 100644 --- a/docs/concepts/driver_registry.md +++ b/docs/concepts/driver_registry.md @@ -18,6 +18,13 @@ limitations under the License. dbc installs drivers from a "driver registry" which is an internet-accessible index of installable [ADBC driver](./driver.md) packages. -By default, dbc is configured to communicate with Columnar's public and private driver registries. Most drivers will be from the public registry but some will be marked with a `[private]` label which means they're from the private registry. See [Private Drivers](../guides/private_drivers.md) for information on how to install and use private drivers. +By default, dbc is configured to communicate with two driver registries: the public ADBC driver registry, which is affiliated with the [ADBC Driver Foundry](https://adbc-drivers.org) and hosted by Columnar, and Columnar's private driver registry. Most drivers will be from the public registry but some will be marked with a `[private]` label which means they're from the private registry. See [Private Drivers](../guides/private_drivers.md) for information on how to install and use private drivers. + +- Public: [https://dbc-cdn.columnar.tech](https://dbc-cdn.columnar.tech) +- Private: [https://dbc-cdn-private.columnar.tech](https://dbc-cdn-private.columnar.tech) + +!!! note + + If you access these registries without dbc, please set a user agent. See [Can I download drivers directly from the driver registries?](../getting_started/faq.md#can-i-download-drivers-directly-from-the-driver-registries). When you run a command like [`dbc search`](../reference/cli.md#search) or [`dbc install`](../reference/cli.md#install), dbc gets information about the drivers that are available from each configured registry by downloading its `index.yaml` or using a cached copy. diff --git a/docs/getting_started/faq.md b/docs/getting_started/faq.md index f65b0888..ebed8640 100644 --- a/docs/getting_started/faq.md +++ b/docs/getting_started/faq.md @@ -35,3 +35,11 @@ ADBC is [Apache Arrow ADBC](http://arrow.apache.org/adbc), a cross-platform, dat ## Who makes dbc? dbc is built and maintained by [Columnar](https://columnar.tech). + +## Can I download drivers directly from the driver registries? + +Yes. We ask that you set an HTTP user agent that identifies your tool so we can understand how the registries are used: + +```console +$ curl -A "my-tool/1.0 (+https://github.com/me/my-tool)" -O https://dbc-cdn.columnar.tech/index.yaml +``` diff --git a/docs/guides/installing.md b/docs/guides/installing.md index e2df216c..64794d10 100644 --- a/docs/guides/installing.md +++ b/docs/guides/installing.md @@ -48,7 +48,7 @@ teradata [private] An ADBC driver for Teradata developed by Columnar ``` -The short names in lowercase on the left of the output are the names you need to pass to [`dbc install`](../reference/cli.md#install). These drivers are available from Columnar's [driver registry](../concepts/driver_registry.md). +The short names in lowercase on the left of the output are the names you need to pass to [`dbc install`](../reference/cli.md#install). These drivers are available from the public ADBC [driver registry](../concepts/driver_registry.md). !!! note diff --git a/docs/guides/private_drivers.md b/docs/guides/private_drivers.md index 2c1e0710..648a8938 100644 --- a/docs/guides/private_drivers.md +++ b/docs/guides/private_drivers.md @@ -18,7 +18,7 @@ limitations under the License. {{ since_version('v0.2.0') }} -Most [drivers](../concepts/driver.md) available with [dbc](../index.md) are hosted on Columnar's public [driver registry](../concepts/driver_registry.md). However, some of the drivers you see when you run [`dbc search`](../reference/cli.md#search) may be marked with a `[private]` label. +Most [drivers](../concepts/driver.md) available with [dbc](../index.md) are hosted on the public ADBC [driver registry](../concepts/driver_registry.md). However, some of the drivers you see when you run [`dbc search`](../reference/cli.md#search) may be marked with a `[private]` label. To install and use these drivers, you must: diff --git a/docs/reference/analytics.md b/docs/reference/analytics.md index a13614b5..eaaecdfd 100644 --- a/docs/reference/analytics.md +++ b/docs/reference/analytics.md @@ -4,13 +4,20 @@ Columnar collects basic, anonymized information in order to help us better under ## What data do we collect? -When you use dbc to search for or install a driver, dbc communicates with Columnar's CDN which is hosted using [Amazon Web Services](http://aws.amazon.com). Requests to the CDN include information such as: +When you use dbc to search for or install a driver, dbc sends requests to the [driver registries](../concepts/driver_registry.md) it's configured to use. By default, these are: + +- The public ADBC driver registry (https://dbc-cdn.columnar.tech), which is affiliated with the [ADBC Driver Foundry](https://adbc-drivers.org) and hosted by Columnar +- Columnar's private driver registry (https://dbc-cdn-private.columnar.tech) + +Both registries are served from a CDN that Columnar operates on [Amazon Web Services](http://aws.amazon.com). Requests to the CDN include information such as: - IP address - dbc version - Operating system name and architecture (e.g., linux/amd64) - A non-reversible but stable per-machine ID and a random UUID (generated once per install) +Tools that access the registries without dbc are asked to set a user agent that identifies them. See the [FAQ](../getting_started/faq.md#can-i-download-drivers-directly-from-the-driver-registries). + ## Where does it get stored? The above data is stored as part of the normal recording of HTTP request logs to the CDN. Logs are stored in a private S3 bucket which is only accessible to authorized Columnar staff.