Skip to content

Commit

Permalink
polish gcp getting started doc (#359)
Browse files Browse the repository at this point in the history
* polish gcp getting started doc

* fix quote

* add extra serious warning on delete

* Update deployment/live/gcp/conformance/README.md

Co-authored-by: Roger Ng <[email protected]>

* Update deployment/live/gcp/conformance/README.md

Co-authored-by: Roger Ng <[email protected]>

* Update deployment/live/gcp/conformance/README.md

* Update deployment/live/gcp/conformance/README.md

* Update deployment/live/gcp/conformance/README.md

---------

Co-authored-by: Roger Ng <[email protected]>
Co-authored-by: Philippe Boneff <[email protected]>
  • Loading branch information
3 people authored Dec 5, 2024
1 parent c57fd57 commit b637d9f
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions deployment/live/gcp/conformance/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ need to be manually applied.

You'll need the following tools installed:

- [`golang`](https://go.dev/doc/install)
- [`docker`](https://docs.docker.com/engine/install/)
- [`gcloud`](https://cloud.google.com/sdk/docs/install)
- One of:
Expand All @@ -30,7 +31,12 @@ You'll need the following tools installed:

#### Google Cloud tooling

Ensure you've got already created a project you want to use, and have configured your local `gcloud`
> [!CAUTION]
> This example creates real Google Cloud resources running in your project. They will almost certainly
> cost you real money if left running. For the purposes of this demo it is strongly recommended that
> you create a new project so that you can easily clean up at the end.
Once you've got a Google Cloud project you want to use, have configured your local `gcloud`
tool use use it, and authenticated as a principle with sufficient ACLs for the project:

```bash
Expand All @@ -47,8 +53,8 @@ export GOOGLE_PROJECT=$(gcloud config get project)

# This should be a note signer string.
# You can use the generate_keys tool to create a new signer & verifier pair:
# go run github.com/transparency-dev/serverless-log/cmd/generate_keys@HEAD --key_name="TestTessera"
export TESSERA_SIGNER={VALUE}
go run github.com/transparency-dev/serverless-log/cmd/generate_keys@HEAD --key_name="TestTessera" --out_priv=tessera.sec --out_pub=tessera.pub
export TESSERA_SIGNER=$(cat tessera.sec)

# This is the name of the artifact registry docker repo to create/use.
export DOCKER_REPO_NAME=tessera-docker
Expand Down Expand Up @@ -126,3 +132,15 @@ Finally, apply the config using `terragrunt`:

This should create all necessary infrastructure, and spin up a Cloud Run instance with the
docker image you created above.

### Clean up

> [!IMPORTANT]
> You need to run this step on your project if you want to ensure you don't get charged into perpetuity
> for the resources we've setup.
**This will delete your project!**
Do not do this on a project that you didn't create expressly and exclusively to run this demo.
```bash
gcloud projects delete ${GOOGLE_PROJECT}
```

0 comments on commit b637d9f

Please sign in to comment.