Skip to content

Commit

Permalink
Readme updates (#57)
Browse files Browse the repository at this point in the history
* README updates

* README updates

* README updates, added Requirements section
  • Loading branch information
salsferrazza authored and phriscage committed Nov 4, 2019
1 parent a070565 commit cc4e6e5
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,26 @@ The ```BigQuery Datashare Toolkit (BQDS)``` is a solution for data publishers to

While ```BQDS``` is used for data management and entitlement, it does *not* manage any commercial aspects of delivery. Hence, it is assumed that publishers already have licensing arrangements and that consumers have furnished you the GCP account ID's corresponding to their entitled users. These are required for the creation of the authorized views within BigQuery.

```BQDS``` is open-source. Some supporting infrastructure, such as [storage buckets](https://cloud.google.com/storage/), serverless functions, and BigQuery datasets, must be maintained within GCP by publishers in order to use BQDS. As a consumer, when your GCP account is added to the publisher entitlements, you can view published data as if it were your own, ready to integrate into your analytics workflow, machine learning model, or runtime application. Publishers are responsible for managing the limited BQDS support infrastructure for their datasets. While consumers are billed for BigQuery compute and networking, Publishers incur costs only on the storage of their data in BigQuery and Cloud Storage.
```BQDS``` is open-source. Some supporting infrastructure, such as [storage buckets](https://cloud.google.com/storage/), serverless functions, and BigQuery datasets, must be maintained within GCP by publishers in order to use BQDS. As a consumer, when your GCP account is added to the publisher entitlements, you can view published data as if it were your own, ready to integrate into your analytics workflow, machine learning model, or runtime application. Publishers are responsible for managing the limited BQDS support infrastructure for their datasets. While consumers are billed for BigQuery compute and networking, publishers incur costs only on the storage of their data in BigQuery and Cloud Storage.

For publisher projects that do not have the Cloud Functions API enabled at the time of running [deploy.sh](ingestion/bin/deploy.sh), the API will be enabled on the project's behalf.

## Requirements

### Publishers

- A GCP account with billing enabled
- A Google Cloud Storage bucket to store staged data
- Several BigQuery datasets to store entitled data and authorized views
- A Cloud Function to ingest the inbound data
- Ability to run command-line applications (like Cloud Shell) for entitlements

### Consumers

- A GCP account with billing enabled
- Entitlements granted to the specific datasets to which you are licensed


## Principles

```BQDS``` aims to embody certain key principles. Among these are:
Expand Down

0 comments on commit cc4e6e5

Please sign in to comment.