Skip to main content

​
Before you start

Sign in to Peak as an Admin. Use test or staging keys. Code in any pull request from the repository can read them.

​
Add keys

  1. Open Previews.
  2. Open your repository.
  3. Under Keys, enter a value beside each key marked Missing.
  4. Choose Save.
Choose Add key to add a key Peak didn’t ask for. Choose Skip beside a key that previews don’t need. Peak sets it to an empty value. Expect a key marked Optional (sync: false in render.yaml) never to block a preview. Without a value, the variable is unset, as in a Render preview. Expect each key to apply to every preview of the repository. Expect a preview to fail with Missing keys while a key is Missing. Push again to use a new value in an open pull request.

​
Paste a .env file

  1. Choose Paste .env.
  2. Paste the file.
  3. Check the keys Peak needs. Tick any other key to save it too.
  4. Choose Save.

​
Fill environment groups

Check Groups for each Render environment group that render.yaml links but doesn’t define. Each service that links a group gets all its variables, also as build arguments. A service’s own variables win. A group linked later wins over one linked earlier.
  1. Choose Paste .env beside the group.
  2. Paste the file and choose Save.
Or use Import from Render. Choose Clear to remove all of a group’s variables.

​
Import from Render

Expect Import from Render while a key is Missing or a group is listed.
  1. Create an API key in Render.
  2. Choose Import from Render.
  3. Paste the key and choose Import.
Peak copies missing keys from the Render services that have the same names as your services, and from their linked environment groups. A key that render.yaml takes from a service outside it comes from the Render service with that name. Each listed group gets every variable of the Render group with that name. Peak keeps the values you already set. Peak uses the API key once and does not store it. Revoke the API key in Render after the import.

​
Check stored keys

Check each key’s state: Set, Missing, Optional, or Not needed. Peak never shows a value again. To change a value, enter a new one and choose Save. Choose Remove to delete a key.

​
Check generated values

Expect Peak to set these values for each preview. Add no key for them. Expect generated values to stay the same across pushes and restarts of a preview.

​
Fork pull requests

Expect no preview for a pull request from a fork. Expect fork code never to get your keys.