You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs.kosli.com/content/faq/_index.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -131,8 +131,8 @@ API-TOKEN = "123456abcdef"
131
131
132
132
When calling Kosli command you can skip the file extension. For example, to list environments with `org` and `api-token` in the configuration file you would run:
133
133
134
-
```
135
-
$ kosli list environments --config-file kosli-conf
134
+
```shell {.command}
135
+
kosli list environments --config-file kosli-conf
136
136
```
137
137
138
138
`--config-file` defaults to `kosli`, so if you name your file `kosli.<yaml|toml|json>` and the file is in the same location as where you run Kosli commands from, you can skip the `--config-file` altogether.
@@ -163,8 +163,8 @@ part of the template, the state of the extra evidence will affect the overall co
163
163
164
164
The `--compliant` flag is a [boolean flag](#boolean-flags).
165
165
To report generic evidence as non-compliant use `--compliant=false`, as in this example:
Copy file name to clipboardExpand all lines: docs.kosli.com/content/getting_started/approvals.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
1
---
2
-
title: "Part 9: Approvals"
2
+
title: "Part 10: Approvals"
3
3
bookCollapseSection: false
4
4
weight: 300
5
5
summary: "When an artifact is ready to be deployed to a given environment, an approval may be reported to Kosli. An approval can be requested which will require a manual action, or reported automatically. This will be recorded in Kosli so the decision made outside your CI system won't be lost."
6
6
---
7
-
# Part 9: Approvals
7
+
# Part 10: Approvals
8
8
9
9
When an artifact is ready to be deployed to a given [environment](/getting_started/environments/), an approval may be reported to Kosli. An approval can be requested which will require a manual action, or reported automatically. This will be recorded in Kosli so the decision made outside your CI system won't be lost.
Copy file name to clipboardExpand all lines: docs.kosli.com/content/getting_started/attestations.md
+11-12Lines changed: 11 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,8 +39,8 @@ When you make an attestation, you have the choice of what `name` to attach it to
39
39
40
40
The `jira-ticket` attestation belongs to a single trail and is not linked to a specific artifact. In this example, the id of the trail is the git commit.
41
41
42
-
```shell
43
-
$ kosli attest jira \
42
+
```shell {.command}
43
+
kosli attest jira \
44
44
--flow backend-ci \
45
45
--trail $(git rev-parse HEAD) \
46
46
--name jira-ticket
@@ -51,8 +51,8 @@ $ kosli attest jira \
51
51
52
52
Some attestations are attached to a specific artifact, like the unit tests for the `backend` artifact. Often, evidence like unit tests are created _before_ the artifact is built. To attach the evidence to the artifact before its creation, use `backend` (the artifact's `name` from the template), as well as `unit-tests` (the attestation's `name` from the template).
53
53
54
-
```shell
55
-
$ kosli attest junit \
54
+
```shell {.command}
55
+
kosli attest junit \
56
56
--name backend.unit-tests \
57
57
--flow backend-ci \
58
58
--trail $(git rev-parse HEAD) \
@@ -65,8 +65,8 @@ This attestation belongs to any artifact attested with the matching `name` from
65
65
66
66
Once the artifact has been built, it can be attested with the following command.
@@ -88,8 +88,8 @@ Often, evidence like snyk reports are created _after_ the artifact is built. In
88
88
89
89
The following attestation will only belong to the artifact `my_company/backend:latest` attested above and its fingerprint, in this case calculated by the Kosli CLI.
@@ -107,12 +107,12 @@ Typically, the Flow and Trail are explicitly setup before making the attestation
107
107
This is done with the `create flow` and `begin trail` commands, either of which can specify the name of the template yaml file above
108
108
(e.g. `.kosli.yml`) whose contents define overall compliance. For example:
109
109
110
-
```shell
111
-
$ kosli create flow backend-ci \
110
+
```shell {.command}
111
+
kosli create flow backend-ci \
112
112
--template-file .kosli.yml
113
113
...
114
114
115
-
$ kosli begin trail $(git rev-parse HEAD) \
115
+
kosli begin trail $(git rev-parse HEAD) \
116
116
--flow backend-ci \
117
117
...
118
118
```
@@ -142,7 +142,6 @@ Attestations are append-only immutable records. You can report the same attestat
142
142
However, only the latest version of the attestation is considered when evaluating compliance.
143
143
144
144
145
-
146
145
## Evidence Vault
147
146
148
147
Along with attestations data, you can attach additional supporting evidence files. These will be securely stored in Kosli's **Evidence Vault** and can easily be retrieved when needed. Alternatively, you can store the evidence files in your own preferred storage and only attach links to it in the Kosli attestation.
Copy file name to clipboardExpand all lines: docs.kosli.com/content/getting_started/environments.md
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,11 @@
2
2
title: "Part 8: Environments"
3
3
bookCollapseSection: false
4
4
weight: 280
5
-
summary: "Kosli environments allow you to record the artifacts running in your runtime environments and how they change. Every time an environment change (or a set of changes) is reported, Kosli creates a new environment snapshot containing the status of the environment at a given point in time."
5
+
summary: "Kosli environments allow you to record the artifacts running in your runtime environments and how they change. Every time an environment change (or a set of changes) is reported, Kosli creates a new environment snapshot containing the status of the environment at a given point in time. The change record created in Kosli enables you to retrospectively perform runtime forensics about what ran where and when."
6
6
---
7
7
# Part 8: Environments
8
8
9
-
Kosli environments allow you to record the artifacts running in your runtime environments and how they change. Every time an environment change (or a set of changes) is reported, Kosli creates a new environment snapshot containing the status of the environment at a given point in time.
9
+
Kosli environments allow you to record the artifacts running in your runtime environments and how they change. Every time an environment change (or a set of changes) is reported, Kosli creates a new environment snapshot containing the status of the environment at a given point in time. The change record created in Kosli enables you to retrospectively perform runtime forensics about what ran where and when.
10
10
11
11
## Create an environment
12
12
@@ -21,7 +21,7 @@ Make sure that type of Kosli environment matches the type of the environment you
21
21
To create an environment via CLI, you would run a command like this:
22
22
23
23
```shell {.command}
24
-
$ kosli create environment quickstart \
24
+
kosli create environment quickstart \
25
25
--environment-type docker \
26
26
--description "quickstart environment for tutorial"
27
27
```
@@ -42,8 +42,8 @@ After the new environment is created you'll be redirected to its page, which wil
42
42
43
43
## Snapshoting an environment
44
44
45
-
To record the current status of your environment you need to make Kosli CLI snapshot the running artifacts in it and report it to Kosli.
46
-
When Kosli receives an environment report, if the received list of running artifacts is different than what is in the latest environment snapshot, a new environment snapshot is created. Snapshots are immutable and can't be tampered with.
45
+
To record the current status of your environment you need to use the Kosli CLI to snapshot the running artifacts in it and report it to Kosli.
46
+
When Kosli receives an environment report, if the received list of running artifacts is different than what is in the latest environment snapshot, a new snapshot is created. Snapshots are immutable and can't be tampered with.
47
47
48
48
Currently, the following environment types are supported:
49
49
- Kubernetes
@@ -52,6 +52,7 @@ Currently, the following environment types are supported:
52
52
- AWS Simple Storage Service (S3)
53
53
- AWS Lambda
54
54
- AWS Elastic Container Service (ECS)
55
+
- Azure Web Apps and Function Apps
55
56
56
57
You can report environment snapshots manually using the `kosli snapshot [...]` commands for testing. For production use, however, you would configure the reporting to happen automatically on regular intervals, e.g. via a cron job or scheduled CI job, or on certain events.
0 commit comments