Skip to content

Commit 940b28c

Browse files
committed
docs: add info about status page
1 parent 54de4a7 commit 940b28c

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: "What do I do if Kosli is down?"
2+
title: 'What do I do if Kosli is down?'
33
bookCollapseSection: false
44
weight: 507
5-
summary: "Customers use Kosli to attest evidence of their business and software processes. If Kosli is down, these attestations will fail. 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."
5+
summary: 'Customers use Kosli to attest evidence of their business and software processes. If Kosli is down, these attestations will fail. 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.'
66
---
77

88
# What do I do if Kosli is down?
@@ -13,29 +13,33 @@ This will break CI workflow pipelines, blocking artifacts from being deployed.
1313
In this situation there is a built-in mechanism to instantly turn Kosli off and keep the pipelines flowing.
1414
When Kosli is back up, you can instantly turn Kosli back on.
1515

16+
{{% hint info %}}
17+
You can check the current status of Kosli services at https://status.app.kosli.com or by running `kosli status` in the CLI.
18+
{{% /hint %}}
19+
1620
## Turning Kosli CLI calls on and off instantly
1721

1822
If the `KOSLI_DRY_RUN` environment variable is set to `true` then all Kosli CLI commands will:
19-
* Not communicate with Kosli at all
20-
* Print the payload they would have sent
21-
* Exit with a zero status code
23+
24+
- Not communicate with Kosli at all
25+
- Print the payload they would have sent
26+
- Exit with a zero status code
2227

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

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

2833
```yaml
2934
name: Main
30-
...
35+
---
3136
env:
32-
KOSLI_DRY_RUN: ${{ vars.KOSLI_DRY_RUN }} # true iff Kosli is down
37+
KOSLI_DRY_RUN: ${{ vars.KOSLI_DRY_RUN }} # true iff Kosli is down
3338
```
3439
35-
3640
## Turning Kosli API calls on and off instantly
3741
38-
If you are using the Kosli API in your workflows (e.g. using `curl`), we recommend using the same Org-level `KOSLI_DRY_RUN`
42+
If you are using the Kosli API in your workflows (e.g. using `curl`), we recommend using the same Org-level `KOSLI_DRY_RUN`
3943
environment variable and guarding the `curl` call with a simple if statement. For example:
4044

4145
```shell
@@ -54,7 +58,3 @@ kosli_curl()
5458
fi
5559
}
5660
```
57-
58-
59-
60-

0 commit comments

Comments
 (0)