Skip to content

Add status page info #548

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dangrondahl merged 2 commits into from
Oct 3, 2025
Merged

Add status page info #548

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
940b28c
docs: add info about status page
dangrondahl Oct 3, 2025
0a569f1
revert prettifying changes
dangrondahl Oct 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions docs.kosli.com/content/tutorials/what_do_i_do_if_kosli_is_down.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ This will break CI workflow pipelines, blocking artifacts from being deployed.
In this situation there is a built-in mechanism to instantly turn Kosli off and keep the pipelines flowing.
When Kosli is back up, you can instantly turn Kosli back on.

{{% hint info %}}
You can check the current status of Kosli services at https://status.app.kosli.com or by running `kosli status` in the CLI.
{{% /hint %}}

## Turning Kosli CLI calls on and off instantly

If the `KOSLI_DRY_RUN` environment variable is set to `true` then all Kosli CLI commands will:
Expand All @@ -21,7 +25,7 @@ If the `KOSLI_DRY_RUN` environment variable is set to `true` then all Kosli CLI
* Exit with a zero status code

We recommend creating an Org-level KOSLI_DRY_RUN variable in your CI system and, in all CI workflows,
ensuring there is an environment variable set from it.
ensuring there is an environment variable set from it.

For example, in a [Github Action workflow](https://github.com/cyber-dojo/differ/blob/main/.github/workflows/main.yml):

Expand All @@ -32,10 +36,9 @@ env:
KOSLI_DRY_RUN: ${{ vars.KOSLI_DRY_RUN }} # true iff Kosli is down
```


## Turning Kosli API calls on and off instantly

If you are using the Kosli API in your workflows (e.g. using `curl`), we recommend using the same Org-level `KOSLI_DRY_RUN`
If you are using the Kosli API in your workflows (e.g. using `curl`), we recommend using the same Org-level `KOSLI_DRY_RUN`
environment variable and guarding the `curl` call with a simple if statement. For example:

```shell
Expand All @@ -54,7 +57,3 @@ kosli_curl()
fi
}
```