Skip to content

Commit

Permalink
docs: Update GCS signing key documentation
Browse files Browse the repository at this point in the history
This key is now taken straight from the configured service account
key.
  • Loading branch information
tazjin authored and Vincent Ambo committed Oct 27, 2019
1 parent 672673d commit dfe3eda
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 12 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,15 +79,17 @@ variables:
* `NIXERY_CHANNEL`: The name of a Nix/NixOS channel to use for building
* `NIXERY_PKGS_REPO`: URL of a git repository containing a package set (uses
locally configured SSH/git credentials)
* `NIXERY_PKGS_PATH`: A local filesystem path containing a Nix package set to use
for building
* `NIXERY_PKGS_PATH`: A local filesystem path containing a Nix package set to
use for building
* `NIX_TIMEOUT`: Number of seconds that any Nix builder is allowed to run
(defaults to 60
* `NIX_POPULARITY_URL`: URL to a file containing popularity data for the package set (see `popcount/`)
* `GCS_SIGNING_KEY`: A Google service account key (in PEM format) that can be
used to sign Cloud Storage URLs
* `GCS_SIGNING_ACCOUNT`: Google service account ID that the signing key belongs
to
(defaults to 60)
* `NIX_POPULARITY_URL`: URL to a file containing popularity data for
the package set (see `popcount/`)

If the `GOOGLE_APPLICATION_CREDENTIALS` environment variable is set to a service
account key, Nixery will also use this key to create [signed URLs][] for layers
in the storage bucket. This makes it possible to serve layers from a bucket
without having to make them publicly available.

## Roadmap

Expand Down
8 changes: 4 additions & 4 deletions docs/src/run-your-own.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,15 +85,15 @@ You may set *all* of these:

* `NIX_TIMEOUT`: Number of seconds that any Nix builder is allowed to run
(defaults to 60)
* `GCS_SIGNING_KEY`: A Google service account key (in PEM format) that can be
used to [sign Cloud Storage URLs][signed-urls]
* `GCS_SIGNING_ACCOUNT`: Google service account ID that the signing key belongs
to

To authenticate to the configured GCS bucket, Nixery uses Google's [Application
Default Credentials][ADC]. Depending on your environment this may require
additional configuration.

If the `GOOGLE_APPLICATION_CREDENTIALS` environment is configured, the service
account's private key will be used to create [signed URLs for
layers][signed-urls].

## 4. Deploy Nixery

With the above environment variables configured, you can run the image that was
Expand Down

0 comments on commit dfe3eda

Please sign in to comment.