Skip to content

Latest commit

 

History

History
81 lines (60 loc) · 4.89 KB

operator.md

File metadata and controls

81 lines (60 loc) · 4.89 KB
Raw

Operator Instructions

You don't need to run an instance of Allstar to use it. The OpenSSF runs an instance that anyone can install and use here. However, you may wish to create and run your own instance of Allstar for security or customization reasons.

Create a GitHub App

Follow the instructions here to create a new app.

  • Name/Description/Homepage URL Something specific to your instance.
  • Callback URL Leave blank, Allstar does not auth as a user.
  • Request user authorization (OAuth) during installation uncheck.
  • Webhooks/Subscribe to events Uncheck and leave blank. Allstar does not listen for webhooks at this time.
  • Permissions Follow this example: image

Note: As Allstar is developed, it may evolve the permissions needed or start listening for webhooks, please follow along development in this repo.

Get ID and key.

See the instructions to create and download a private key. Also note down the App ID in the General / About section of your new app.

Upload the private key contents to a supported service by Go CDK Runtime Configuration. Also note, the Runtime Configuration library will support a local file as well.

Edit pkg/config/operator/operator.go and set the AppID and KeySecret link. Alternatively, you can provide the AppID and KeySecret as environment variables APP_ID and KEY_SECRET. You may need to edit pkg/ghclients/ghclients.go and add a new import line for your secret service, ex: _ "gocloud.dev/runtimevar/gcpsecretmanager".

Warning, this is not a recommended practice for security. If you are not using a supported runtime you may provide the contents of the private key directly in the environment variable PRIVATE_KEY. Allstar will only use this if the contents of KEY_SECRET is set exactly to direct.

Run Allstar.

Build cmd/allstar/ and run in any environment. No cli configuration 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.
ALLSTAR_GHE_URL The URL of the GitHub Enterprise instance to use. Leave empty to use github.com
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

Self-hosted GitHub Enterprise specifics

In case you want to operate Allstar with a self-hosted GitHub Enterprise instance, you need to set the ALLSTAR_GHE_URL environment variable to the URL of your GitHub Enterprise instance URL. The different API endpoints for API and upload are appended automatically.

Example:

Given, your GHE instance URL is "https://my-ghe.example.com", you need to set the following environment variables:

export ALLSTAR_GHE_URL="https://my-ghe.example.com"
export GH_HOST="my-ghe.example.com"  # This is used by the Scorecard dependency. Might result in errors if not set.