solana/storage-bigtable
Rachael Pai aea17c35ae
Add a stringified credential option for LedgerStorage (#24314)
* add a stringified credential option for LedgerStorage

* fix clippy::useless-format warning

* change CredentialOption to enum CredentialType

* rename credential_option to credential_type

* restore LedgerStorage new fn signature

* fmt

Co-authored-by: Tyera Eulberg <tyera@solana.com>
2022-04-13 14:35:06 -06:00
..
build-proto Bump tonic, tonic-build, prost, and etcd-client (#24147) 2022-04-08 10:21:45 -06:00
proto Bump tonic, tonic-build, prost, and etcd-client (#24147) 2022-04-08 10:21:45 -06:00
src Add a stringified credential option for LedgerStorage (#24314) 2022-04-13 14:35:06 -06:00
Cargo.toml Bump tonic, tonic-build, prost, and etcd-client (#24147) 2022-04-08 10:21:45 -06:00
README.md Add configuration info 2020-08-05 14:27:12 -07:00
init-bigtable.sh Add configuration info 2020-08-05 14:27:12 -07:00

README.md

BigTable Setup

Development Environment

The Cloud BigTable emulator can be used during development/test. See https://cloud.google.com/bigtable/docs/emulator for general setup information.

Process:

  1. Run gcloud beta emulators bigtable start in the background
  2. Run $(gcloud beta emulators bigtable env-init) to establish the BIGTABLE_EMULATOR_HOST environment variable
  3. Run ./init-bigtable.sh to configure the emulator
  4. Develop/test

Production Environment

Export a standard GOOGLE_APPLICATION_CREDENTIALS environment variable to your service account credentials. The project should contain a BigTable instance called solana-ledger that has been initialized by running the ./init-bigtable.sh script.

Depending on what operation mode is required, either the https://www.googleapis.com/auth/bigtable.data or https://www.googleapis.com/auth/bigtable.data.readonly OAuth scope will be requested using the provided credentials.