Getting started on Kosli developer documentation

Part 1: Overview

Mon, 01 Jan 0001 00:00:00 +0000

The "Getting Started" section contains the steps you can follow to implement Kosli in your organization. It focuses on general instructions for using Kosli and doesn't delve into specific tutorials for integrating Kosli with particular tools or runtime environments.

Part 2: Install Kosli CLI

Mon, 01 Jan 0001 00:00:00 +0000

Kosli CLI can be installed from package managers, by Curling pre-built binaries, or can be used from the distributed Docker images.

Part 3: Service Accounts

Mon, 01 Jan 0001 00:00:00 +0000

Prior to engaging with Kosli, authentication is necessary. There are two methods to achieve this:

Using a service account API key (recommended). 2. Using a personal API key.

Part 4: Flows

Mon, 01 Jan 0001 00:00:00 +0000

A Kosli Flow represents a business or software process that requires change tracking. It allows you to monitor changes across all steps within a process or focus specifically on a subset of critical steps.

Part 5: Trails

Mon, 01 Jan 0001 00:00:00 +0000

Every time you execute a process represented by a Kosli Flow, you would initiate a trail to record the changes made during that specific execution.

Part 6: Artifacts

Mon, 01 Jan 0001 00:00:00 +0000

In software processes, you typically generate one or more artifacts that are deployed or distributed, such as docker images, archives, binaries, etc. You can ensure traceability for the creation of these artifacts by attesting them to Kosli, thereby establishing a binary provenance for each one.

Part 7: Attestations

Mon, 01 Jan 0001 00:00:00 +0000

Attestations are how you record the facts you care about in your software supply chain. They are the evidence that you have performed certain activities, such as running tests, security scans, or ensuring that a certain requirement is met.

Part 8: Environments

Mon, 01 Jan 0001 00:00:00 +0000

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.

Part 9: Environment Policies

Mon, 01 Jan 0001 00:00:00 +0000

Environment Policies enable you to define and enforce compliance requirements for artifact deployments across different environments.

Part 10: Approvals

Mon, 01 Jan 0001 00:00:00 +0000

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.

Part 11: Next Steps

Mon, 01 Jan 0001 00:00:00 +0000

In the previous chapters, you explored Kosli Flows and Environments and have reported some data to Kosli. The next steps would be to harness the benefits of your hard work. Here are a few areas to look at next: