-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(bigtable): removes cbt source code (#5843)
* chore(bigtable): removes cbt source code * chore: added back README with redirect * fix: refactored Bigtable loadtest.go * fix: scantest * fix: dependencies * fix: build * fix: go.sum
- Loading branch information
Showing
14 changed files
with
34 additions
and
3,963 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,58 +1,4 @@ | ||
# CBT: Cloud Bigtable Tool | ||
# Cloud Bigtable CLI tool (cbt) | ||
|
||
This is the source for `cbt`. | ||
|
||
## Build and Run | ||
To build the tool locally, run this command in this directory: | ||
|
||
``` | ||
go build . | ||
``` | ||
|
||
That will build the cbt binary in that directory. To run commands with the `cbt` you built (rather | ||
than the official one) invoke it with the directory prefix like this: | ||
|
||
``` | ||
./cbt help | ||
``` | ||
|
||
## Documentation | ||
|
||
This tool gets documented on the [Go packages website](https://pkg.go.dev/cloud.google.com/go/bigtable/cmd/cbt) | ||
as well as the [cloud site](https://cloud.google.com/bigtable/docs/cbt-reference). | ||
|
||
### Go Package Documentation | ||
|
||
This command will generate a file with a package description which gets used for the pkg.go.dev. You should update this after any changes to the usage or descriptions of the commands. To | ||
generate the file, run: | ||
|
||
``` | ||
go generate | ||
``` | ||
|
||
The output will be in [cbtdoc.go](cbtdoc.go). | ||
|
||
You may want to verify this looks good locally. To do that, you will need to generate the doc into | ||
your GOPATH version of the directory, then run `godoc` and you can view the [local version](http://localhost:6060/pkg/cloud.google.com/go/bigtable/cmd/cbt/) | ||
|
||
``` | ||
go run . -o $(go env GOPATH)/src/cloud.google.com/go/bigtable/cmd/cbt/cbtdoc.go doc | ||
godoc | ||
``` | ||
|
||
### Cloud Site Documentation | ||
|
||
The Cloud documentation uses the `cbt mddoc` command to generate part of the [cbt Reference](https://cloud.google.com/bigtable/docs/cbt-reference) page. | ||
To preview what it will look like upon generation, you can generate it into a file with the command: | ||
|
||
``` | ||
go run . -o doc.md mddoc | ||
``` | ||
|
||
This will create a file doc.md. You don't need to check it into this repository, so delete | ||
it once you are happy with the output. | ||
|
||
## Configuration | ||
|
||
The configuration for the options (`-project`, `-instance`, and `-creds`) is in [cbtconfig.go](../../internal/cbtconfig/cbtconfig.go). | ||
So change that file if you need to modify those. | ||
Development on the `cbt` tool has moved to | ||
[another repo](https://github.com/googleapis/cloud-bigtable-cbt-cli). |
Oops, something went wrong.