docs: add link to the preflight checks in readme

snyk · Mar 15, 2023 · 039ce8d · 039ce8d
1 parent 5ba6ce1
commit 039ce8d
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -750,6 +750,18 @@ Sometime it is required to load sensitive configurations (GitHub/Snyk's token) f
 * Change the workdir of the docker image to be `/broker`/
 Example of such file is located in your broker container at $HOME/.env
 
+### Preflight Checks
+The main objective of preflight checks is to catch errors and misconfigurations early, upon broker client startup rather than later when usage is occurring.
+Regardless of whether the checks were successful, the Broker client will be started. There are following checks available:
+
+| Check ID               | Description                                                                                                                                                                                                                                                | Configuration Defaults                                          |
+|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------|
+| `broker-server-status` | **Broker Server Healthcheck** validates the connectivity to the Broker Server. It performs a GET request to `{BROKER_SERVER_URL}/healthcheck`                                                                                                              | If not specified, `BROKER_SERVER_URL` is https://broker.snyk.io |
+| `rest-api-status`      | **REST API Healthcheck** validates the connectivity to the [Snyk REST API](https://apidocs.snyk.io). It performs a GET request to `{API_BASE_URL}/rest/openapi`. This check is conditional and will be executed only if high availability mode is enabled. | If not specified, `API_BASE_URL` is https://api.snyk.io         |
+
+
+
+
 ### Troubleshooting
 
 #### Support of big manifest files (> 1Mb) for GitHub / GitHub Enterprise

diff --git a/lib/client/checks/index.ts b/lib/client/checks/index.ts
@@ -92,6 +92,8 @@ const logPreflightCheckResults = (results: CheckResult[]) => {
   console.log('### Preflight checks help to catch errors early, upon broker');
   console.log('### client startup. Note, that broker client will start');
   console.log('### whether the checks were successful or not.');
+  console.log('###');
+  console.log('### See more: https://github.com/snyk/broker#preflight-checks');
   console.log('##############################################################');
 
   const checks = results.map((check) => {