Skip to content

Commit

Permalink
Update operator.md
Browse files Browse the repository at this point in the history
Signed-off-by: Colm O hEigeartaigh <[email protected]>
  • Loading branch information
coheigea authored and jeffmendoza committed Apr 5, 2023
1 parent b36c299 commit 78285a1
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,16 @@ needed. Allstar does not currently listen to webhooks, so no incoming network
configuration needed. Only outgoing calls to GitHub are made. Allstar is
currently stateless. It is best to only run one instance to avoid potential race
conditions on enforcement actions, ex: pinging an issue twice at the same time.

## Configuration via Environment Variables

Allstar supports various operator configuration options which can be set via environment variables:
|Name|Description|Default|
|----|----|----|
|APP_ID|The application ID of the created GitHub App.||
|PRIVATE_KEY|The raw value of the private key for the GitHub App. KEY_SECRET must be set to "direct".||
|KEY_SECRET|The name of a secret containing a private key.||
|DO_NOTHING_ON_OPT_OUT|Boolean flag which defines if allstar should do nothing and skip the corresponding checks when a repository is opted out.|false|
|ALLSTAR_LOG_LEVEL|The minimum logging level that allstar should use when emitting logs. Acceptable values are: panic ; fatal ; error ; warn ; info ; debug ; trace|info|
|NOTICE_PING_DURATION_HOURS|The duration (in hours) to wait between pinging notice actions, such as updating a GitHub issue.|24|

0 comments on commit 78285a1

Please sign in to comment.