From f53b9fc7baae64b04366de87392686d1c1636abb Mon Sep 17 00:00:00 2001 From: sami-alajrami Date: Tue, 10 Dec 2024 12:44:11 +0000 Subject: [PATCH] Release: Merge pull request #384 from kosli-dev/fix-random-text-in-docs Fix random 'sdf' doc-text left in example output --- docs.kosli.com/assets/metadata.json | 2 +- .../client_reference/kosli_allow_artifact.md | 16 ++++-- .../client_reference/kosli_assert_approval.md | 16 ++++-- .../client_reference/kosli_assert_artifact.md | 7 ++- .../client_reference/kosli_attest_artifact.md | 16 ++++-- .../client_reference/kosli_attest_generic.md | 7 ++- .../client_reference/kosli_attest_jira.md | 7 ++- .../client_reference/kosli_attest_junit.md | 7 ++- .../kosli_attest_pullrequest_azure.md | 7 ++- .../kosli_attest_pullrequest_bitbucket.md | 7 ++- .../kosli_attest_pullrequest_github.md | 7 ++- .../kosli_attest_pullrequest_gitlab.md | 7 ++- .../client_reference/kosli_attest_snyk.md | 7 ++- .../client_reference/kosli_attest_sonar.md | 7 ++- .../kosli_expect_deployment.md | 16 ++++-- .../client_reference/kosli_fingerprint.md | 28 ++++++++--- .../client_reference/kosli_report_approval.md | 16 ++++-- .../client_reference/kosli_report_artifact.md | 16 ++++-- .../kosli_report_evidence_artifact_generic.md | 16 ++++-- .../kosli_report_evidence_artifact_junit.md | 16 ++++-- ...ort_evidence_artifact_pullrequest_azure.md | 16 ++++-- ...evidence_artifact_pullrequest_bitbucket.md | 16 ++++-- ...rt_evidence_artifact_pullrequest_github.md | 16 ++++-- ...rt_evidence_artifact_pullrequest_gitlab.md | 16 ++++-- .../kosli_report_evidence_artifact_snyk.md | 16 ++++-- .../kosli_request_approval.md | 16 ++++-- .../content/legacy_ref/v2.10.15/_index.md | 7 --- .../content/legacy_ref/v2.10.16/_index.md | 2 +- .../content/legacy_ref/v2.10.17/_index.md | 2 +- .../content/legacy_ref/v2.10.18/_index.md | 2 +- .../content/legacy_ref/v2.11.0/_index.md | 2 +- .../content/legacy_ref/v2.11.1/_index.md | 7 +++ .../legacy_ref/{v2.10.15 => v2.11.1}/kosli.md | 0 .../kosli_allow_artifact.md | 0 .../kosli_archive_environment.md | 0 .../kosli_archive_flow.md | 0 .../kosli_assert_approval.md | 0 .../kosli_assert_artifact.md | 0 .../kosli_assert_pullrequest_azure.md | 0 .../kosli_assert_pullrequest_bitbucket.md | 0 .../kosli_assert_pullrequest_github.md | 0 .../kosli_assert_pullrequest_gitlab.md | 0 .../kosli_assert_snapshot.md | 0 .../kosli_assert_status.md | 0 .../kosli_attest_artifact.md | 4 +- .../kosli_attest_generic.md | 0 .../kosli_attest_jira.md | 0 .../kosli_attest_junit.md | 4 +- .../kosli_attest_pullrequest_azure.md | 0 .../kosli_attest_pullrequest_bitbucket.md | 0 .../kosli_attest_pullrequest_github.md | 0 .../kosli_attest_pullrequest_gitlab.md | 0 .../kosli_attest_snyk.md | 0 .../kosli_attest_sonar.md | 5 +- .../kosli_begin_trail.md | 5 +- .../{v2.10.15 => v2.11.1}/kosli_completion.md | 0 .../{v2.10.15 => v2.11.1}/kosli_config.md | 0 .../kosli_create_environment.md | 2 + .../kosli_create_flow.md | 3 ++ .../kosli_diff_snapshots.md | 0 .../kosli_disable_beta.md | 0 .../kosli_enable_beta.md | 0 .../kosli_expect_deployment.md | 0 .../kosli_fingerprint.md | 4 ++ .../kosli_get_approval.md | 0 .../kosli_get_artifact.md | 0 .../kosli_get_deployment.md | 0 .../kosli_get_environment.md | 0 .../{v2.10.15 => v2.11.1}/kosli_get_flow.md | 0 .../kosli_get_snapshot.md | 0 .../{v2.10.15 => v2.11.1}/kosli_get_trail.md | 0 .../v2.11.1/kosli_join_environment.md | 49 +++++++++++++++++++ .../kosli_list_approvals.md | 0 .../kosli_list_artifacts.md | 0 .../kosli_list_deployments.md | 0 .../kosli_list_environments.md | 0 .../{v2.10.15 => v2.11.1}/kosli_list_flows.md | 0 .../kosli_list_snapshots.md | 0 .../kosli_list_trails.md | 0 .../kosli_log_environment.md | 0 .../kosli_rename_environment.md | 0 .../kosli_rename_flow.md | 0 .../kosli_report_approval.md | 0 .../kosli_report_artifact.md | 0 .../kosli_report_evidence_artifact_generic.md | 0 .../kosli_report_evidence_artifact_junit.md | 0 ...ort_evidence_artifact_pullrequest_azure.md | 0 ...evidence_artifact_pullrequest_bitbucket.md | 0 ...rt_evidence_artifact_pullrequest_github.md | 0 ...rt_evidence_artifact_pullrequest_gitlab.md | 0 .../kosli_report_evidence_artifact_snyk.md | 0 .../kosli_report_evidence_commit_generic.md | 0 .../kosli_report_evidence_commit_jira.md | 0 .../kosli_report_evidence_commit_junit.md | 0 ...eport_evidence_commit_pullrequest_azure.md | 0 ...t_evidence_commit_pullrequest_bitbucket.md | 0 ...port_evidence_commit_pullrequest_github.md | 0 ...port_evidence_commit_pullrequest_gitlab.md | 0 .../kosli_report_evidence_commit_snyk.md | 0 .../kosli_request_approval.md | 0 .../{v2.10.15 => v2.11.1}/kosli_search.md | 0 .../kosli_snapshot_azure.md | 0 .../kosli_snapshot_docker.md | 0 .../kosli_snapshot_ecs.md | 30 +++++++++--- .../kosli_snapshot_k8s.md | 7 ++- .../kosli_snapshot_lambda.md | 36 +++++++++++++- .../kosli_snapshot_path.md | 4 +- .../kosli_snapshot_paths.md | 4 ++ .../kosli_snapshot_s3.md | 3 ++ .../kosli_snapshot_server.md | 4 ++ .../{v2.10.15 => v2.11.1}/kosli_status.md | 0 .../{v2.10.15 => v2.11.1}/kosli_tag.md | 0 .../{v2.10.15 => v2.11.1}/kosli_version.md | 0 113 files changed, 364 insertions(+), 146 deletions(-) delete mode 100644 docs.kosli.com/content/legacy_ref/v2.10.15/_index.md create mode 100644 docs.kosli.com/content/legacy_ref/v2.11.1/_index.md rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_allow_artifact.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_archive_environment.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_archive_flow.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_assert_approval.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_assert_artifact.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_assert_pullrequest_azure.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_assert_pullrequest_bitbucket.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_assert_pullrequest_github.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_assert_pullrequest_gitlab.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_assert_snapshot.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_assert_status.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_attest_artifact.md (93%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_attest_generic.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_attest_jira.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_attest_junit.md (97%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_attest_pullrequest_azure.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_attest_pullrequest_bitbucket.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_attest_pullrequest_github.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_attest_pullrequest_gitlab.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_attest_snyk.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_attest_sonar.md (95%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_begin_trail.md (96%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_completion.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_config.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_create_environment.md (96%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_create_flow.md (96%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_diff_snapshots.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_disable_beta.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_enable_beta.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_expect_deployment.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_fingerprint.md (88%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_get_approval.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_get_artifact.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_get_deployment.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_get_environment.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_get_flow.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_get_snapshot.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_get_trail.md (100%) create mode 100644 docs.kosli.com/content/legacy_ref/v2.11.1/kosli_join_environment.md rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_list_approvals.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_list_artifacts.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_list_deployments.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_list_environments.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_list_flows.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_list_snapshots.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_list_trails.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_log_environment.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_rename_environment.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_rename_flow.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_report_approval.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_report_artifact.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_report_evidence_artifact_generic.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_report_evidence_artifact_junit.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_report_evidence_artifact_pullrequest_azure.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_report_evidence_artifact_pullrequest_bitbucket.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_report_evidence_artifact_pullrequest_github.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_report_evidence_artifact_pullrequest_gitlab.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_report_evidence_artifact_snyk.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_report_evidence_commit_generic.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_report_evidence_commit_jira.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_report_evidence_commit_junit.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_report_evidence_commit_pullrequest_azure.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_report_evidence_commit_pullrequest_bitbucket.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_report_evidence_commit_pullrequest_github.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_report_evidence_commit_pullrequest_gitlab.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_report_evidence_commit_snyk.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_request_approval.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_search.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_snapshot_azure.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_snapshot_docker.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_snapshot_ecs.md (65%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_snapshot_k8s.md (74%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_snapshot_lambda.md (67%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_snapshot_path.md (86%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_snapshot_paths.md (86%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_snapshot_s3.md (91%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_snapshot_server.md (88%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_status.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_tag.md (100%) rename docs.kosli.com/content/legacy_ref/{v2.10.15 => v2.11.1}/kosli_version.md (100%) diff --git a/docs.kosli.com/assets/metadata.json b/docs.kosli.com/assets/metadata.json index 72d982286..c529f8a29 100644 --- a/docs.kosli.com/assets/metadata.json +++ b/docs.kosli.com/assets/metadata.json @@ -1 +1 @@ -{"currentversion": "v2.11.1"} +{"currentversion": "v2.11.2"} diff --git a/docs.kosli.com/content/client_reference/kosli_allow_artifact.md b/docs.kosli.com/content/client_reference/kosli_allow_artifact.md index 616c35185..30ab99f11 100644 --- a/docs.kosli.com/content/client_reference/kosli_allow_artifact.md +++ b/docs.kosli.com/content/client_reference/kosli_allow_artifact.md @@ -9,7 +9,14 @@ deprecated: false ## Synopsis Add an artifact to an environment's allowlist. -The artifact SHA256 fingerprint is calculated (based on the `--artifact-type` flag and the artifact name/path argument) or can be provided directly (with the `--fingerprint` flag). + +The artifact fingerprint can be provided directly with the `--fingerprint` flag, or +calculated based on `--artifact-type` flag. + +Artifact type can be one of: "file" for files, "dir" for directories, "oci" for container +images in registries or "docker" for local docker images. + + ```shell kosli allow artifact [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] @@ -18,16 +25,15 @@ kosli allow artifact [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] ## Flags | Flag | Description | | :--- | :--- | -| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | +| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | | -D, --dry-run | [optional] Run in dry-run mode. When enabled, no data is sent to Kosli and the CLI exits with 0 exit code regardless of any errors. | | -e, --environment string | The environment name for which the artifact is allowlisted. | | -x, --exclude strings | [optional] The comma separated list of directories and files to exclude from fingerprinting. Can take glob patterns. Only applicable for --artifact-type dir. | | -F, --fingerprint string | [conditional] The SHA256 fingerprint of the artifact. Only required if you don't specify '--artifact-type'. | | -h, --help | help for artifact | | --reason string | The reason why this artifact is allowlisted. | -| --registry-password string | [conditional] The docker registry password or access token. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-provider string | [conditional] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-username string | [conditional] The docker registry username. Only required if you want to read docker image SHA256 digest from a remote docker registry. | +| --registry-password string | [conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry. | +| --registry-username string | [conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry. | ## Flags inherited from parent commands diff --git a/docs.kosli.com/content/client_reference/kosli_assert_approval.md b/docs.kosli.com/content/client_reference/kosli_assert_approval.md index 3ed921d06..6c12a58eb 100644 --- a/docs.kosli.com/content/client_reference/kosli_assert_approval.md +++ b/docs.kosli.com/content/client_reference/kosli_assert_approval.md @@ -10,7 +10,14 @@ deprecated: false Assert an artifact in Kosli has been approved for deployment. Exits with non-zero code if the artifact has not been approved. -The artifact SHA256 fingerprint is calculated (based on the `--artifact-type` flag and the artifact name/path argument) or can be provided directly (with the `--fingerprint` flag). + +The artifact fingerprint can be provided directly with the `--fingerprint` flag, or +calculated based on `--artifact-type` flag. + +Artifact type can be one of: "file" for files, "dir" for directories, "oci" for container +images in registries or "docker" for local docker images. + + ```shell kosli assert approval [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] @@ -19,15 +26,14 @@ kosli assert approval [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] ## Flags | Flag | Description | | :--- | :--- | -| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | +| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | | -D, --dry-run | [optional] Run in dry-run mode. When enabled, no data is sent to Kosli and the CLI exits with 0 exit code regardless of any errors. | | -x, --exclude strings | [optional] The comma separated list of directories and files to exclude from fingerprinting. Can take glob patterns. Only applicable for --artifact-type dir. | | -F, --fingerprint string | [conditional] The SHA256 fingerprint of the artifact. Only required if you don't specify '--artifact-type'. | | -f, --flow string | The Kosli flow name. | | -h, --help | help for approval | -| --registry-password string | [conditional] The docker registry password or access token. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-provider string | [conditional] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-username string | [conditional] The docker registry username. Only required if you want to read docker image SHA256 digest from a remote docker registry. | +| --registry-password string | [conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry. | +| --registry-username string | [conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry. | ## Flags inherited from parent commands diff --git a/docs.kosli.com/content/client_reference/kosli_assert_artifact.md b/docs.kosli.com/content/client_reference/kosli_assert_artifact.md index 9c3f445d4..b8575b1bb 100644 --- a/docs.kosli.com/content/client_reference/kosli_assert_artifact.md +++ b/docs.kosli.com/content/client_reference/kosli_assert_artifact.md @@ -18,15 +18,14 @@ kosli assert artifact [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] ## Flags | Flag | Description | | :--- | :--- | -| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | +| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | | -D, --dry-run | [optional] Run in dry-run mode. When enabled, no data is sent to Kosli and the CLI exits with 0 exit code regardless of any errors. | | -x, --exclude strings | [optional] The comma separated list of directories and files to exclude from fingerprinting. Can take glob patterns. Only applicable for --artifact-type dir. | | -F, --fingerprint string | [conditional] The SHA256 fingerprint of the artifact. Only required if you don't specify '--artifact-type'. | | -f, --flow string | The Kosli flow name. | | -h, --help | help for artifact | -| --registry-password string | [conditional] The docker registry password or access token. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-provider string | [conditional] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-username string | [conditional] The docker registry username. Only required if you want to read docker image SHA256 digest from a remote docker registry. | +| --registry-password string | [conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry. | +| --registry-username string | [conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry. | ## Flags inherited from parent commands diff --git a/docs.kosli.com/content/client_reference/kosli_attest_artifact.md b/docs.kosli.com/content/client_reference/kosli_attest_artifact.md index c763909eb..694561c4b 100644 --- a/docs.kosli.com/content/client_reference/kosli_attest_artifact.md +++ b/docs.kosli.com/content/client_reference/kosli_attest_artifact.md @@ -9,7 +9,14 @@ deprecated: false ## Synopsis Attest an artifact creation to a Kosli flow. -The artifact SHA256 fingerprint is calculated (based on the `--artifact-type` flag and the artifact name/path argument) or can be provided directly (with the `--fingerprint` flag).To specify paths in a directory artifact that should always be excluded from the SHA256 calculation, you can add a `.kosli_ignore` file to the root of the artifact. + +The artifact fingerprint can be provided directly with the `--fingerprint` flag, or +calculated based on `--artifact-type` flag. + +Artifact type can be one of: "file" for files, "dir" for directories, "oci" for container +images in registries or "docker" for local docker images. + +To specify paths in a directory artifact that should always be excluded from the SHA256 calculation, you can add a `.kosli_ignore` file to the root of the artifact. Each line should specify a relative path or path glob to be ignored. You can include comments in this file, using `#`. The `.kosli_ignore` will be treated as part of the artifact like any other file,unless it is explicitly ignored itself. This command requires access to a git repo to associate the artifact to the git commit it is originating from. @@ -23,7 +30,7 @@ kosli attest artifact {IMAGE-NAME | FILE-PATH | DIR-PATH} [flags] | Flag | Description | | :--- | :--- | | --annotate stringToString | [optional] Annotate the attestation with data using key=value. | -| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | +| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | | -b, --build-url string | The url of CI pipeline that built the artifact. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | | -g, --commit string | [defaulted] The git commit from which the artifact was created. (defaulted in some CIs: https://docs.kosli.com/ci-defaults, otherwise defaults to HEAD ). (default "HEAD") | | -u, --commit-url string | The url for the git commit that created the artifact. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | @@ -37,9 +44,8 @@ kosli attest artifact {IMAGE-NAME | FILE-PATH | DIR-PATH} [flags] | -h, --help | help for artifact | | -n, --name string | The name of the artifact in the yml template file. | | --redact-commit-info strings | [optional] The list of commit info to be redacted before sending to Kosli. Allowed values are one or more of [author, message, branch]. | -| --registry-password string | [conditional] The docker registry password or access token. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-provider string | [conditional] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-username string | [conditional] The docker registry username. Only required if you want to read docker image SHA256 digest from a remote docker registry. | +| --registry-password string | [conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry. | +| --registry-username string | [conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry. | | --repo-root string | [defaulted] The directory where the source git repository is available. (default ".") | | -T, --trail string | The Kosli trail name. | diff --git a/docs.kosli.com/content/client_reference/kosli_attest_generic.md b/docs.kosli.com/content/client_reference/kosli_attest_generic.md index 05c40fa58..077020198 100644 --- a/docs.kosli.com/content/client_reference/kosli_attest_generic.md +++ b/docs.kosli.com/content/client_reference/kosli_attest_generic.md @@ -29,7 +29,7 @@ kosli attest generic [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | Flag | Description | | :--- | :--- | | --annotate stringToString | [optional] Annotate the attestation with data using key=value. | -| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | +| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | | --attachments strings | [optional] The comma-separated list of paths of attachments for the reported attestation. Attachments can be files or directories. All attachments are compressed and uploaded to Kosli's evidence vault. | | -g, --commit string | [conditional] The git commit for which the attestation is associated to. Becomes required when reporting an attestation for an artifact before reporting it to Kosli. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | | -C, --compliant | [defaulted] Whether the attestation is compliant or not. A boolean flag https://docs.kosli.com/faq/#boolean-flags (default true) | @@ -44,9 +44,8 @@ kosli attest generic [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | -n, --name string | The name of the attestation as declared in the flow or trail yaml template. | | -o, --origin-url string | [optional] The url pointing to where the attestation came from or is related. (defaulted to the CI url in some CIs: https://docs.kosli.com/ci-defaults ). | | --redact-commit-info strings | [optional] The list of commit info to be redacted before sending to Kosli. Allowed values are one or more of [author, message, branch]. | -| --registry-password string | [conditional] The docker registry password or access token. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-provider string | [conditional] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-username string | [conditional] The docker registry username. Only required if you want to read docker image SHA256 digest from a remote docker registry. | +| --registry-password string | [conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry. | +| --registry-username string | [conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry. | | --repo-root string | [defaulted] The directory where the source git repository is available. Only used if --commit is used. (default ".") | | -T, --trail string | The Kosli trail name. | | -u, --user-data string | [optional] The path to a JSON file containing additional data you would like to attach to the attestation. | diff --git a/docs.kosli.com/content/client_reference/kosli_attest_jira.md b/docs.kosli.com/content/client_reference/kosli_attest_jira.md index 16f5ac5f5..6ddd767f2 100644 --- a/docs.kosli.com/content/client_reference/kosli_attest_jira.md +++ b/docs.kosli.com/content/client_reference/kosli_attest_jira.md @@ -40,7 +40,7 @@ kosli attest jira [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | Flag | Description | | :--- | :--- | | --annotate stringToString | [optional] Annotate the attestation with data using key=value. | -| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | +| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | | --assert | [optional] Exit with non-zero code if the attestation is non-compliant | | --attachments strings | [optional] The comma-separated list of paths of attachments for the reported attestation. Attachments can be files or directories. All attachments are compressed and uploaded to Kosli's evidence vault. | | -g, --commit string | [conditional] The git commit for which the attestation is associated to. Becomes required when reporting an attestation for an artifact before reporting it to Kosli. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | @@ -59,9 +59,8 @@ kosli attest jira [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | -n, --name string | The name of the attestation as declared in the flow or trail yaml template. | | -o, --origin-url string | [optional] The url pointing to where the attestation came from or is related. (defaulted to the CI url in some CIs: https://docs.kosli.com/ci-defaults ). | | --redact-commit-info strings | [optional] The list of commit info to be redacted before sending to Kosli. Allowed values are one or more of [author, message, branch]. | -| --registry-password string | [conditional] The docker registry password or access token. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-provider string | [conditional] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-username string | [conditional] The docker registry username. Only required if you want to read docker image SHA256 digest from a remote docker registry. | +| --registry-password string | [conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry. | +| --registry-username string | [conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry. | | --repo-root string | [defaulted] The directory where the source git repository is available. Only used if --commit is used. (default ".") | | -T, --trail string | The Kosli trail name. | | -u, --user-data string | [optional] The path to a JSON file containing additional data you would like to attach to the attestation. | diff --git a/docs.kosli.com/content/client_reference/kosli_attest_junit.md b/docs.kosli.com/content/client_reference/kosli_attest_junit.md index 5eb50a2a4..c4c75fdee 100644 --- a/docs.kosli.com/content/client_reference/kosli_attest_junit.md +++ b/docs.kosli.com/content/client_reference/kosli_attest_junit.md @@ -31,7 +31,7 @@ kosli attest junit [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | Flag | Description | | :--- | :--- | | --annotate stringToString | [optional] Annotate the attestation with data using key=value. | -| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | +| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | | --attachments strings | [optional] The comma-separated list of paths of attachments for the reported attestation. Attachments can be files or directories. All attachments are compressed and uploaded to Kosli's evidence vault. | | -g, --commit string | [conditional] The git commit for which the attestation is associated to. Becomes required when reporting an attestation for an artifact before reporting it to Kosli. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | | --description string | [optional] attestation description | @@ -45,9 +45,8 @@ kosli attest junit [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | -n, --name string | The name of the attestation as declared in the flow or trail yaml template. | | -o, --origin-url string | [optional] The url pointing to where the attestation came from or is related. (defaulted to the CI url in some CIs: https://docs.kosli.com/ci-defaults ). | | --redact-commit-info strings | [optional] The list of commit info to be redacted before sending to Kosli. Allowed values are one or more of [author, message, branch]. | -| --registry-password string | [conditional] The docker registry password or access token. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-provider string | [conditional] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-username string | [conditional] The docker registry username. Only required if you want to read docker image SHA256 digest from a remote docker registry. | +| --registry-password string | [conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry. | +| --registry-username string | [conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry. | | --repo-root string | [defaulted] The directory where the source git repository is available. Only used if --commit is used. (default ".") | | -R, --results-dir string | [defaulted] The path to a directory with JUnit test results. By default, the directory will be uploaded to Kosli's evidence vault. (default ".") | | -T, --trail string | The Kosli trail name. | diff --git a/docs.kosli.com/content/client_reference/kosli_attest_pullrequest_azure.md b/docs.kosli.com/content/client_reference/kosli_attest_pullrequest_azure.md index fe94cf774..947782972 100644 --- a/docs.kosli.com/content/client_reference/kosli_attest_pullrequest_azure.md +++ b/docs.kosli.com/content/client_reference/kosli_attest_pullrequest_azure.md @@ -26,7 +26,7 @@ kosli attest pullrequest azure [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | Flag | Description | | :--- | :--- | | --annotate stringToString | [optional] Annotate the attestation with data using key=value. | -| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | +| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | | --assert | [optional] Exit with non-zero code if no pull requests found for the given commit. | | --attachments strings | [optional] The comma-separated list of paths of attachments for the reported attestation. Attachments can be files or directories. All attachments are compressed and uploaded to Kosli's evidence vault. | | --azure-org-url string | Azure organization url. E.g. "https://dev.azure.com/myOrg" (defaulted if you are running in Azure Devops pipelines: https://docs.kosli.com/ci-defaults ). | @@ -44,9 +44,8 @@ kosli attest pullrequest azure [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | -o, --origin-url string | [optional] The url pointing to where the attestation came from or is related. (defaulted to the CI url in some CIs: https://docs.kosli.com/ci-defaults ). | | --project string | Azure project.(defaulted if you are running in Azure Devops pipelines: https://docs.kosli.com/ci-defaults ). | | --redact-commit-info strings | [optional] The list of commit info to be redacted before sending to Kosli. Allowed values are one or more of [author, message, branch]. | -| --registry-password string | [conditional] The docker registry password or access token. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-provider string | [conditional] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-username string | [conditional] The docker registry username. Only required if you want to read docker image SHA256 digest from a remote docker registry. | +| --registry-password string | [conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry. | +| --registry-username string | [conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry. | | --repo-root string | [defaulted] The directory where the source git repository is available. Only used if --commit is used. (default ".") | | --repository string | Git repository. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | | -T, --trail string | The Kosli trail name. | diff --git a/docs.kosli.com/content/client_reference/kosli_attest_pullrequest_bitbucket.md b/docs.kosli.com/content/client_reference/kosli_attest_pullrequest_bitbucket.md index 6e4d55fb7..30062aca7 100644 --- a/docs.kosli.com/content/client_reference/kosli_attest_pullrequest_bitbucket.md +++ b/docs.kosli.com/content/client_reference/kosli_attest_pullrequest_bitbucket.md @@ -26,7 +26,7 @@ kosli attest pullrequest bitbucket [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | Flag | Description | | :--- | :--- | | --annotate stringToString | [optional] Annotate the attestation with data using key=value. | -| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | +| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | | --assert | [optional] Exit with non-zero code if no pull requests found for the given commit. | | --attachments strings | [optional] The comma-separated list of paths of attachments for the reported attestation. Attachments can be files or directories. All attachments are compressed and uploaded to Kosli's evidence vault. | | --bitbucket-password string | Bitbucket App password. See https://developer.atlassian.com/cloud/bitbucket/rest/intro/#authentication for more details. | @@ -44,9 +44,8 @@ kosli attest pullrequest bitbucket [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | -n, --name string | The name of the attestation as declared in the flow or trail yaml template. | | -o, --origin-url string | [optional] The url pointing to where the attestation came from or is related. (defaulted to the CI url in some CIs: https://docs.kosli.com/ci-defaults ). | | --redact-commit-info strings | [optional] The list of commit info to be redacted before sending to Kosli. Allowed values are one or more of [author, message, branch]. | -| --registry-password string | [conditional] The docker registry password or access token. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-provider string | [conditional] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-username string | [conditional] The docker registry username. Only required if you want to read docker image SHA256 digest from a remote docker registry. | +| --registry-password string | [conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry. | +| --registry-username string | [conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry. | | --repo-root string | [defaulted] The directory where the source git repository is available. Only used if --commit is used. (default ".") | | --repository string | Git repository. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | | -T, --trail string | The Kosli trail name. | diff --git a/docs.kosli.com/content/client_reference/kosli_attest_pullrequest_github.md b/docs.kosli.com/content/client_reference/kosli_attest_pullrequest_github.md index 796b652e5..295b5d6e5 100644 --- a/docs.kosli.com/content/client_reference/kosli_attest_pullrequest_github.md +++ b/docs.kosli.com/content/client_reference/kosli_attest_pullrequest_github.md @@ -26,7 +26,7 @@ kosli attest pullrequest github [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | Flag | Description | | :--- | :--- | | --annotate stringToString | [optional] Annotate the attestation with data using key=value. | -| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | +| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | | --assert | [optional] Exit with non-zero code if no pull requests found for the given commit. | | --attachments strings | [optional] The comma-separated list of paths of attachments for the reported attestation. Attachments can be files or directories. All attachments are compressed and uploaded to Kosli's evidence vault. | | -g, --commit string | the git merge commit to be checked for associated pull requests. | @@ -44,9 +44,8 @@ kosli attest pullrequest github [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | -n, --name string | The name of the attestation as declared in the flow or trail yaml template. | | -o, --origin-url string | [optional] The url pointing to where the attestation came from or is related. (defaulted to the CI url in some CIs: https://docs.kosli.com/ci-defaults ). | | --redact-commit-info strings | [optional] The list of commit info to be redacted before sending to Kosli. Allowed values are one or more of [author, message, branch]. | -| --registry-password string | [conditional] The docker registry password or access token. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-provider string | [conditional] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-username string | [conditional] The docker registry username. Only required if you want to read docker image SHA256 digest from a remote docker registry. | +| --registry-password string | [conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry. | +| --registry-username string | [conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry. | | --repo-root string | [defaulted] The directory where the source git repository is available. Only used if --commit is used. (default ".") | | --repository string | Git repository. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | | -T, --trail string | The Kosli trail name. | diff --git a/docs.kosli.com/content/client_reference/kosli_attest_pullrequest_gitlab.md b/docs.kosli.com/content/client_reference/kosli_attest_pullrequest_gitlab.md index 085a47f83..fe3567635 100644 --- a/docs.kosli.com/content/client_reference/kosli_attest_pullrequest_gitlab.md +++ b/docs.kosli.com/content/client_reference/kosli_attest_pullrequest_gitlab.md @@ -26,7 +26,7 @@ kosli attest pullrequest gitlab [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | Flag | Description | | :--- | :--- | | --annotate stringToString | [optional] Annotate the attestation with data using key=value. | -| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | +| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | | --assert | [optional] Exit with non-zero code if no pull requests found for the given commit. | | --attachments strings | [optional] The comma-separated list of paths of attachments for the reported attestation. Attachments can be files or directories. All attachments are compressed and uploaded to Kosli's evidence vault. | | -g, --commit string | the git merge commit to be checked for associated pull requests. | @@ -44,9 +44,8 @@ kosli attest pullrequest gitlab [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | -n, --name string | The name of the attestation as declared in the flow or trail yaml template. | | -o, --origin-url string | [optional] The url pointing to where the attestation came from or is related. (defaulted to the CI url in some CIs: https://docs.kosli.com/ci-defaults ). | | --redact-commit-info strings | [optional] The list of commit info to be redacted before sending to Kosli. Allowed values are one or more of [author, message, branch]. | -| --registry-password string | [conditional] The docker registry password or access token. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-provider string | [conditional] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-username string | [conditional] The docker registry username. Only required if you want to read docker image SHA256 digest from a remote docker registry. | +| --registry-password string | [conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry. | +| --registry-username string | [conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry. | | --repo-root string | [defaulted] The directory where the source git repository is available. Only used if --commit is used. (default ".") | | --repository string | Git repository. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | | -T, --trail string | The Kosli trail name. | diff --git a/docs.kosli.com/content/client_reference/kosli_attest_snyk.md b/docs.kosli.com/content/client_reference/kosli_attest_snyk.md index 4b69f1eaf..753d5fe9c 100644 --- a/docs.kosli.com/content/client_reference/kosli_attest_snyk.md +++ b/docs.kosli.com/content/client_reference/kosli_attest_snyk.md @@ -37,7 +37,7 @@ kosli attest snyk [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | Flag | Description | | :--- | :--- | | --annotate stringToString | [optional] Annotate the attestation with data using key=value. | -| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | +| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | | --attachments strings | [optional] The comma-separated list of paths of attachments for the reported attestation. Attachments can be files or directories. All attachments are compressed and uploaded to Kosli's evidence vault. | | -g, --commit string | [conditional] The git commit for which the attestation is associated to. Becomes required when reporting an attestation for an artifact before reporting it to Kosli. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | | --description string | [optional] attestation description | @@ -51,9 +51,8 @@ kosli attest snyk [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | -n, --name string | The name of the attestation as declared in the flow or trail yaml template. | | -o, --origin-url string | [optional] The url pointing to where the attestation came from or is related. (defaulted to the CI url in some CIs: https://docs.kosli.com/ci-defaults ). | | --redact-commit-info strings | [optional] The list of commit info to be redacted before sending to Kosli. Allowed values are one or more of [author, message, branch]. | -| --registry-password string | [conditional] The docker registry password or access token. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-provider string | [conditional] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-username string | [conditional] The docker registry username. Only required if you want to read docker image SHA256 digest from a remote docker registry. | +| --registry-password string | [conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry. | +| --registry-username string | [conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry. | | --repo-root string | [defaulted] The directory where the source git repository is available. Only used if --commit is used. (default ".") | | -R, --scan-results string | The path to Snyk scan SARIF results file from 'snyk test' and 'snyk container test'. By default, the Snyk results will be uploaded to Kosli's evidence vault. | | -T, --trail string | The Kosli trail name. | diff --git a/docs.kosli.com/content/client_reference/kosli_attest_sonar.md b/docs.kosli.com/content/client_reference/kosli_attest_sonar.md index c4fec472e..b0f6dcbf4 100644 --- a/docs.kosli.com/content/client_reference/kosli_attest_sonar.md +++ b/docs.kosli.com/content/client_reference/kosli_attest_sonar.md @@ -38,7 +38,7 @@ kosli attest sonar [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | Flag | Description | | :--- | :--- | | --annotate stringToString | [optional] Annotate the attestation with data using key=value. | -| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | +| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | | --attachments strings | [optional] The comma-separated list of paths of attachments for the reported attestation. Attachments can be files or directories. All attachments are compressed and uploaded to Kosli's evidence vault. | | -g, --commit string | [conditional] The git commit for which the attestation is associated to. Becomes required when reporting an attestation for an artifact before reporting it to Kosli. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | | --description string | [optional] attestation description | @@ -52,9 +52,8 @@ kosli attest sonar [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | -n, --name string | The name of the attestation as declared in the flow or trail yaml template. | | -o, --origin-url string | [optional] The url pointing to where the attestation came from or is related. (defaulted to the CI url in some CIs: https://docs.kosli.com/ci-defaults ). | | --redact-commit-info strings | [optional] The list of commit info to be redacted before sending to Kosli. Allowed values are one or more of [author, message, branch]. | -| --registry-password string | [conditional] The docker registry password or access token. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-provider string | [conditional] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-username string | [conditional] The docker registry username. Only required if you want to read docker image SHA256 digest from a remote docker registry. | +| --registry-password string | [conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry. | +| --registry-username string | [conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry. | | --repo-root string | [defaulted] The directory where the source git repository is available. Only used if --commit is used. (default ".") | | --sonar-api-token string | [required] SonarCloud/SonarQube API token. | | --sonar-project-key string | [conditional] The project key of the SonarCloud/SonarQube project. Only required if you want to use the project key/revision to get the scan results rather than using Sonar's metadata file. | diff --git a/docs.kosli.com/content/client_reference/kosli_expect_deployment.md b/docs.kosli.com/content/client_reference/kosli_expect_deployment.md index 649ba5661..357ac6b9a 100644 --- a/docs.kosli.com/content/client_reference/kosli_expect_deployment.md +++ b/docs.kosli.com/content/client_reference/kosli_expect_deployment.md @@ -10,7 +10,14 @@ deprecated: true ## Synopsis Report the expectation of an upcoming deployment of an artifact to an environment. -The artifact SHA256 fingerprint is calculated (based on the `--artifact-type` flag and the artifact name/path argument) or can be provided directly (with the `--fingerprint` flag). + +The artifact fingerprint can be provided directly with the `--fingerprint` flag, or +calculated based on `--artifact-type` flag. + +Artifact type can be one of: "file" for files, "dir" for directories, "oci" for container +images in registries or "docker" for local docker images. + + ```shell kosli expect deployment [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] @@ -19,7 +26,7 @@ kosli expect deployment [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] ## Flags | Flag | Description | | :--- | :--- | -| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | +| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | | -b, --build-url string | The url of CI pipeline that built the artifact. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | | -d, --description string | [optional] The deployment description. | | -D, --dry-run | [optional] Run in dry-run mode. When enabled, no data is sent to Kosli and the CLI exits with 0 exit code regardless of any errors. | @@ -28,9 +35,8 @@ kosli expect deployment [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | -F, --fingerprint string | [conditional] The SHA256 fingerprint of the artifact. Only required if you don't specify '--artifact-type'. | | -f, --flow string | The Kosli flow name. | | -h, --help | help for deployment | -| --registry-password string | [conditional] The docker registry password or access token. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-provider string | [conditional] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-username string | [conditional] The docker registry username. Only required if you want to read docker image SHA256 digest from a remote docker registry. | +| --registry-password string | [conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry. | +| --registry-username string | [conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry. | | -u, --user-data string | [optional] The path to a JSON file containing additional data you would like to attach to the deployment. | diff --git a/docs.kosli.com/content/client_reference/kosli_fingerprint.md b/docs.kosli.com/content/client_reference/kosli_fingerprint.md index 1543d9d7d..4f9178017 100644 --- a/docs.kosli.com/content/client_reference/kosli_fingerprint.md +++ b/docs.kosli.com/content/client_reference/kosli_fingerprint.md @@ -10,9 +10,10 @@ deprecated: false Calculate the SHA256 fingerprint of an artifact. Requires `--artifact-type` flag to be set. -Artifact type can be one of: "file" for files, "dir" for directories, "docker" for docker images. +Artifact type can be one of: "file" for files, "dir" for directories, "oci" for container +images in registries or "docker" for local docker images. -Fingerprinting docker images can be done using the local docker daemon or the fingerprint can be fetched +Fingerprinting container images can be done using the local docker daemon or the fingerprint can be fetched from a remote registry. When fingerprinting a 'dir' artifact, you can exclude certain paths from fingerprint calculation @@ -33,12 +34,11 @@ kosli fingerprint {IMAGE-NAME | FILE-PATH | DIR-PATH} [flags] ## Flags | Flag | Description | | :--- | :--- | -| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | +| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | | -x, --exclude strings | [optional] The comma separated list of directories and files to exclude from fingerprinting. Can take glob patterns. Only applicable for --artifact-type dir. | | -h, --help | help for fingerprint | -| --registry-password string | [conditional] The docker registry password or access token. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-provider string | [conditional] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-username string | [conditional] The docker registry username. Only required if you want to read docker image SHA256 digest from a remote docker registry. | +| --registry-password string | [conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry. | +| --registry-username string | [conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry. | ## Flags inherited from parent commands @@ -76,9 +76,23 @@ kosli fingerprint --artifact-type dir --exclude logs --exclude *.exe mydir ``` -**fingerprint a locally available docker image** +**fingerprint a locally available docker image (requires docker daemon running)** ```shell kosli fingerprint --artifact-type docker nginx:latest + +``` + +**fingerprint a public image from a remote registry** + +```shell +kosli fingerprint --artifact-type oci nginx:latest + +``` + +**fingerprint a private image from a remote registry** + +```shell +kosli fingerprint --artifact-type oci private:latest --registry-username YourUsername --registry-password YourPassword ``` diff --git a/docs.kosli.com/content/client_reference/kosli_report_approval.md b/docs.kosli.com/content/client_reference/kosli_report_approval.md index b66c7d9db..ce6fe69f1 100644 --- a/docs.kosli.com/content/client_reference/kosli_report_approval.md +++ b/docs.kosli.com/content/client_reference/kosli_report_approval.md @@ -9,7 +9,14 @@ deprecated: false ## Synopsis Report an approval of deploying an artifact to an environment to Kosli. -The artifact SHA256 fingerprint is calculated (based on the `--artifact-type` flag and the artifact name/path argument) or can be provided directly (with the `--fingerprint` flag). + +The artifact fingerprint can be provided directly with the `--fingerprint` flag, or +calculated based on `--artifact-type` flag. + +Artifact type can be one of: "file" for files, "dir" for directories, "oci" for container +images in registries or "docker" for local docker images. + + ```shell kosli report approval [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] @@ -19,7 +26,7 @@ kosli report approval [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | Flag | Description | | :--- | :--- | | --approver string | [optional] The user approving an approval. | -| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | +| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | | -d, --description string | [optional] The approval description. | | -D, --dry-run | [optional] Run in dry-run mode. When enabled, no data is sent to Kosli and the CLI exits with 0 exit code regardless of any errors. | | -e, --environment string | [defaulted] The environment the artifact is approved for. (defaults to all environments) | @@ -29,9 +36,8 @@ kosli report approval [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | -h, --help | help for approval | | --newest-commit string | [defaulted] The source commit sha for the newest change in the deployment. Can be any commit-ish. (default "HEAD") | | --oldest-commit string | [conditional] The source commit sha for the oldest change in the deployment. Can be any commit-ish. Only required if you don't specify '--environment'. | -| --registry-password string | [conditional] The docker registry password or access token. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-provider string | [conditional] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-username string | [conditional] The docker registry username. Only required if you want to read docker image SHA256 digest from a remote docker registry. | +| --registry-password string | [conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry. | +| --registry-username string | [conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry. | | --repo-root string | [defaulted] The directory where the source git repository is available. (default ".") | | -u, --user-data string | [optional] The path to a JSON file containing additional data you would like to attach to the approval. | diff --git a/docs.kosli.com/content/client_reference/kosli_report_artifact.md b/docs.kosli.com/content/client_reference/kosli_report_artifact.md index ee4df023e..140b3bae1 100644 --- a/docs.kosli.com/content/client_reference/kosli_report_artifact.md +++ b/docs.kosli.com/content/client_reference/kosli_report_artifact.md @@ -10,7 +10,14 @@ deprecated: true ## Synopsis Report an artifact creation to a Kosli flow. -The artifact SHA256 fingerprint is calculated (based on the `--artifact-type` flag and the artifact name/path argument) or can be provided directly (with the `--fingerprint` flag). + +The artifact fingerprint can be provided directly with the `--fingerprint` flag, or +calculated based on `--artifact-type` flag. + +Artifact type can be one of: "file" for files, "dir" for directories, "oci" for container +images in registries or "docker" for local docker images. + + ```shell kosli report artifact {IMAGE-NAME | FILE-PATH | DIR-PATH} [flags] @@ -19,7 +26,7 @@ kosli report artifact {IMAGE-NAME | FILE-PATH | DIR-PATH} [flags] ## Flags | Flag | Description | | :--- | :--- | -| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | +| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | | -b, --build-url string | The url of CI pipeline that built the artifact. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | | -u, --commit-url string | The url for the git commit that created the artifact. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | | -D, --dry-run | [optional] Run in dry-run mode. When enabled, no data is sent to Kosli and the CLI exits with 0 exit code regardless of any errors. | @@ -29,9 +36,8 @@ kosli report artifact {IMAGE-NAME | FILE-PATH | DIR-PATH} [flags] | -g, --git-commit string | [defaulted] The git commit from which the artifact was created. (defaulted in some CIs: https://docs.kosli.com/ci-defaults, otherwise defaults to HEAD ). | | -h, --help | help for artifact | | -n, --name string | [optional] Artifact display name, if different from file, image or directory name. | -| --registry-password string | [conditional] The docker registry password or access token. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-provider string | [conditional] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-username string | [conditional] The docker registry username. Only required if you want to read docker image SHA256 digest from a remote docker registry. | +| --registry-password string | [conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry. | +| --registry-username string | [conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry. | | --repo-root string | [defaulted] The directory where the source git repository is available. (default ".") | diff --git a/docs.kosli.com/content/client_reference/kosli_report_evidence_artifact_generic.md b/docs.kosli.com/content/client_reference/kosli_report_evidence_artifact_generic.md index 575a0f6ba..a06437a59 100644 --- a/docs.kosli.com/content/client_reference/kosli_report_evidence_artifact_generic.md +++ b/docs.kosli.com/content/client_reference/kosli_report_evidence_artifact_generic.md @@ -10,7 +10,14 @@ deprecated: true ## Synopsis Report generic evidence to an artifact in a Kosli flow. -The artifact SHA256 fingerprint is calculated (based on the `--artifact-type` flag and the artifact name/path argument) or can be provided directly (with the `--fingerprint` flag). + +The artifact fingerprint can be provided directly with the `--fingerprint` flag, or +calculated based on `--artifact-type` flag. + +Artifact type can be one of: "file" for files, "dir" for directories, "oci" for container +images in registries or "docker" for local docker images. + + ```shell kosli report evidence artifact generic [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] @@ -19,7 +26,7 @@ kosli report evidence artifact generic [IMAGE-NAME | FILE-PATH | DIR-PATH] [flag ## Flags | Flag | Description | | :--- | :--- | -| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | +| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | | -b, --build-url string | The url of CI pipeline that generated the evidence. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | | -C, --compliant | [defaulted] Whether the evidence is compliant or not. A boolean flag https://docs.kosli.com/faq/#boolean-flags (default true) | | -d, --description string | [optional] The evidence description. | @@ -32,9 +39,8 @@ kosli report evidence artifact generic [IMAGE-NAME | FILE-PATH | DIR-PATH] [flag | -f, --flow string | The Kosli flow name. | | -h, --help | help for generic | | -n, --name string | The name of the evidence. | -| --registry-password string | [conditional] The docker registry password or access token. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-provider string | [conditional] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-username string | [conditional] The docker registry username. Only required if you want to read docker image SHA256 digest from a remote docker registry. | +| --registry-password string | [conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry. | +| --registry-username string | [conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry. | | -u, --user-data string | [optional] The path to a JSON file containing additional data you would like to attach to the evidence. | diff --git a/docs.kosli.com/content/client_reference/kosli_report_evidence_artifact_junit.md b/docs.kosli.com/content/client_reference/kosli_report_evidence_artifact_junit.md index b7500ae7f..c82a94909 100644 --- a/docs.kosli.com/content/client_reference/kosli_report_evidence_artifact_junit.md +++ b/docs.kosli.com/content/client_reference/kosli_report_evidence_artifact_junit.md @@ -12,7 +12,14 @@ deprecated: true Report JUnit test evidence for an artifact in a Kosli flow. All .xml files from --results-dir are parsed and uploaded to Kosli's evidence vault. If there are no failing tests and no errors the evidence is reported as compliant. Otherwise the evidence is reported as non-compliant. -The artifact SHA256 fingerprint is calculated (based on the `--artifact-type` flag and the artifact name/path argument) or can be provided directly (with the `--fingerprint` flag). + +The artifact fingerprint can be provided directly with the `--fingerprint` flag, or +calculated based on `--artifact-type` flag. + +Artifact type can be one of: "file" for files, "dir" for directories, "oci" for container +images in registries or "docker" for local docker images. + + ```shell kosli report evidence artifact junit [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] @@ -21,7 +28,7 @@ kosli report evidence artifact junit [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] ## Flags | Flag | Description | | :--- | :--- | -| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | +| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | | -b, --build-url string | The url of CI pipeline that generated the evidence. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | | -D, --dry-run | [optional] Run in dry-run mode. When enabled, no data is sent to Kosli and the CLI exits with 0 exit code regardless of any errors. | | --evidence-fingerprint string | [optional] The SHA256 fingerprint of the evidence file or dir. | @@ -31,9 +38,8 @@ kosli report evidence artifact junit [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | -f, --flow string | The Kosli flow name. | | -h, --help | help for junit | | -n, --name string | The name of the evidence. | -| --registry-password string | [conditional] The docker registry password or access token. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-provider string | [conditional] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-username string | [conditional] The docker registry username. Only required if you want to read docker image SHA256 digest from a remote docker registry. | +| --registry-password string | [conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry. | +| --registry-username string | [conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry. | | -R, --results-dir string | [defaulted] The path to a directory with JUnit test results. By default, the directory will be uploaded to Kosli's evidence vault. (default ".") | | -u, --user-data string | [optional] The path to a JSON file containing additional data you would like to attach to the evidence. | diff --git a/docs.kosli.com/content/client_reference/kosli_report_evidence_artifact_pullrequest_azure.md b/docs.kosli.com/content/client_reference/kosli_report_evidence_artifact_pullrequest_azure.md index b4661a931..e29ab411f 100644 --- a/docs.kosli.com/content/client_reference/kosli_report_evidence_artifact_pullrequest_azure.md +++ b/docs.kosli.com/content/client_reference/kosli_report_evidence_artifact_pullrequest_azure.md @@ -11,7 +11,14 @@ deprecated: true Report an Azure Devops pull request evidence for an artifact in a Kosli flow. It checks if a pull request exists for the artifact (based on its git commit) and reports the pull-request evidence to the artifact in Kosli. -The artifact SHA256 fingerprint is calculated (based on the `--artifact-type` flag and the artifact name/path argument) or can be provided directly (with the `--fingerprint` flag). + +The artifact fingerprint can be provided directly with the `--fingerprint` flag, or +calculated based on `--artifact-type` flag. + +Artifact type can be one of: "file" for files, "dir" for directories, "oci" for container +images in registries or "docker" for local docker images. + + ```shell kosli report evidence artifact pullrequest azure [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] @@ -20,7 +27,7 @@ kosli report evidence artifact pullrequest azure [IMAGE-NAME | FILE-PATH | DIR-P ## Flags | Flag | Description | | :--- | :--- | -| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | +| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | | --assert | [optional] Exit with non-zero code if no pull requests found for the given commit. | | --azure-org-url string | Azure organization url. E.g. "https://dev.azure.com/myOrg" (defaulted if you are running in Azure Devops pipelines: https://docs.kosli.com/ci-defaults ). | | --azure-token string | Azure Personal Access token. | @@ -35,9 +42,8 @@ kosli report evidence artifact pullrequest azure [IMAGE-NAME | FILE-PATH | DIR-P | -h, --help | help for azure | | -n, --name string | The name of the evidence. | | --project string | Azure project.(defaulted if you are running in Azure Devops pipelines: https://docs.kosli.com/ci-defaults ). | -| --registry-password string | [conditional] The docker registry password or access token. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-provider string | [conditional] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-username string | [conditional] The docker registry username. Only required if you want to read docker image SHA256 digest from a remote docker registry. | +| --registry-password string | [conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry. | +| --registry-username string | [conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry. | | --repository string | Git repository. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | | -u, --user-data string | [optional] The path to a JSON file containing additional data you would like to attach to the evidence. | diff --git a/docs.kosli.com/content/client_reference/kosli_report_evidence_artifact_pullrequest_bitbucket.md b/docs.kosli.com/content/client_reference/kosli_report_evidence_artifact_pullrequest_bitbucket.md index 4d5aea083..3396f0c93 100644 --- a/docs.kosli.com/content/client_reference/kosli_report_evidence_artifact_pullrequest_bitbucket.md +++ b/docs.kosli.com/content/client_reference/kosli_report_evidence_artifact_pullrequest_bitbucket.md @@ -11,7 +11,14 @@ deprecated: true Report a Bitbucket pull request evidence for an artifact in a Kosli flow. It checks if a pull request exists for the artifact (based on its git commit) and reports the pull-request evidence to the artifact in Kosli. -The artifact SHA256 fingerprint is calculated (based on the `--artifact-type` flag and the artifact name/path argument) or can be provided directly (with the `--fingerprint` flag). + +The artifact fingerprint can be provided directly with the `--fingerprint` flag, or +calculated based on `--artifact-type` flag. + +Artifact type can be one of: "file" for files, "dir" for directories, "oci" for container +images in registries or "docker" for local docker images. + + ```shell kosli report evidence artifact pullrequest bitbucket [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] @@ -20,7 +27,7 @@ kosli report evidence artifact pullrequest bitbucket [IMAGE-NAME | FILE-PATH | D ## Flags | Flag | Description | | :--- | :--- | -| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | +| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | | --assert | [optional] Exit with non-zero code if no pull requests found for the given commit. | | --bitbucket-password string | Bitbucket App password. See https://developer.atlassian.com/cloud/bitbucket/rest/intro/#authentication for more details. | | --bitbucket-username string | Bitbucket username. | @@ -35,9 +42,8 @@ kosli report evidence artifact pullrequest bitbucket [IMAGE-NAME | FILE-PATH | D | -f, --flow string | The Kosli flow name. | | -h, --help | help for bitbucket | | -n, --name string | The name of the evidence. | -| --registry-password string | [conditional] The docker registry password or access token. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-provider string | [conditional] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-username string | [conditional] The docker registry username. Only required if you want to read docker image SHA256 digest from a remote docker registry. | +| --registry-password string | [conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry. | +| --registry-username string | [conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry. | | --repository string | Git repository. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | | -u, --user-data string | [optional] The path to a JSON file containing additional data you would like to attach to the evidence. | diff --git a/docs.kosli.com/content/client_reference/kosli_report_evidence_artifact_pullrequest_github.md b/docs.kosli.com/content/client_reference/kosli_report_evidence_artifact_pullrequest_github.md index b998a55de..2eac37b9b 100644 --- a/docs.kosli.com/content/client_reference/kosli_report_evidence_artifact_pullrequest_github.md +++ b/docs.kosli.com/content/client_reference/kosli_report_evidence_artifact_pullrequest_github.md @@ -11,7 +11,14 @@ deprecated: true Report a Github pull request evidence for an artifact in a Kosli flow. It checks if a pull request exists for the artifact (based on its git commit) and reports the pull-request evidence to the artifact in Kosli. -The artifact SHA256 fingerprint is calculated (based on the `--artifact-type` flag and the artifact name/path argument) or can be provided directly (with the `--fingerprint` flag). + +The artifact fingerprint can be provided directly with the `--fingerprint` flag, or +calculated based on `--artifact-type` flag. + +Artifact type can be one of: "file" for files, "dir" for directories, "oci" for container +images in registries or "docker" for local docker images. + + ```shell kosli report evidence artifact pullrequest github [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] @@ -20,7 +27,7 @@ kosli report evidence artifact pullrequest github [IMAGE-NAME | FILE-PATH | DIR- ## Flags | Flag | Description | | :--- | :--- | -| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | +| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | | --assert | [optional] Exit with non-zero code if no pull requests found for the given commit. | | -b, --build-url string | The url of CI pipeline that generated the evidence. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | | --commit string | Git commit for which to find pull request evidence. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | @@ -35,9 +42,8 @@ kosli report evidence artifact pullrequest github [IMAGE-NAME | FILE-PATH | DIR- | --github-token string | Github token. | | -h, --help | help for github | | -n, --name string | The name of the evidence. | -| --registry-password string | [conditional] The docker registry password or access token. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-provider string | [conditional] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-username string | [conditional] The docker registry username. Only required if you want to read docker image SHA256 digest from a remote docker registry. | +| --registry-password string | [conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry. | +| --registry-username string | [conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry. | | --repository string | Git repository. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | | -u, --user-data string | [optional] The path to a JSON file containing additional data you would like to attach to the evidence. | diff --git a/docs.kosli.com/content/client_reference/kosli_report_evidence_artifact_pullrequest_gitlab.md b/docs.kosli.com/content/client_reference/kosli_report_evidence_artifact_pullrequest_gitlab.md index 3f4a1ae18..a46453476 100644 --- a/docs.kosli.com/content/client_reference/kosli_report_evidence_artifact_pullrequest_gitlab.md +++ b/docs.kosli.com/content/client_reference/kosli_report_evidence_artifact_pullrequest_gitlab.md @@ -11,7 +11,14 @@ deprecated: true Report a Gitlab merge request evidence for an artifact in a Kosli flow. It checks if a merge request exists for the artifact (based on its git commit) and reports the merge request evidence to the artifact in Kosli. -The artifact SHA256 fingerprint is calculated (based on the `--artifact-type` flag and the artifact name/path argument) or can be provided directly (with the `--fingerprint` flag). + +The artifact fingerprint can be provided directly with the `--fingerprint` flag, or +calculated based on `--artifact-type` flag. + +Artifact type can be one of: "file" for files, "dir" for directories, "oci" for container +images in registries or "docker" for local docker images. + + ```shell kosli report evidence artifact pullrequest gitlab [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] @@ -20,7 +27,7 @@ kosli report evidence artifact pullrequest gitlab [IMAGE-NAME | FILE-PATH | DIR- ## Flags | Flag | Description | | :--- | :--- | -| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | +| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | | --assert | [optional] Exit with non-zero code if no pull requests found for the given commit. | | -b, --build-url string | The url of CI pipeline that generated the evidence. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | | --commit string | Git commit for which to find pull request evidence. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | @@ -35,9 +42,8 @@ kosli report evidence artifact pullrequest gitlab [IMAGE-NAME | FILE-PATH | DIR- | --gitlab-token string | Gitlab token. | | -h, --help | help for gitlab | | -n, --name string | The name of the evidence. | -| --registry-password string | [conditional] The docker registry password or access token. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-provider string | [conditional] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-username string | [conditional] The docker registry username. Only required if you want to read docker image SHA256 digest from a remote docker registry. | +| --registry-password string | [conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry. | +| --registry-username string | [conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry. | | --repository string | Git repository. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | | -u, --user-data string | [optional] The path to a JSON file containing additional data you would like to attach to the evidence. | diff --git a/docs.kosli.com/content/client_reference/kosli_report_evidence_artifact_snyk.md b/docs.kosli.com/content/client_reference/kosli_report_evidence_artifact_snyk.md index 5b9ebe622..9fbe8e4d1 100644 --- a/docs.kosli.com/content/client_reference/kosli_report_evidence_artifact_snyk.md +++ b/docs.kosli.com/content/client_reference/kosli_report_evidence_artifact_snyk.md @@ -20,7 +20,14 @@ Starting from v2.8.2, the Snyk results can be in Snyk JSON or SARIF output forma If no vulnerabilities are detected, the evidence is reported as compliant. Otherwise the evidence is reported as non-compliant. -The artifact SHA256 fingerprint is calculated (based on the `--artifact-type` flag and the artifact name/path argument) or can be provided directly (with the `--fingerprint` flag). + +The artifact fingerprint can be provided directly with the `--fingerprint` flag, or +calculated based on `--artifact-type` flag. + +Artifact type can be one of: "file" for files, "dir" for directories, "oci" for container +images in registries or "docker" for local docker images. + + ```shell kosli report evidence artifact snyk [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] @@ -29,7 +36,7 @@ kosli report evidence artifact snyk [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] ## Flags | Flag | Description | | :--- | :--- | -| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | +| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | | -b, --build-url string | The url of CI pipeline that generated the evidence. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | | -D, --dry-run | [optional] Run in dry-run mode. When enabled, no data is sent to Kosli and the CLI exits with 0 exit code regardless of any errors. | | --evidence-fingerprint string | [optional] The SHA256 fingerprint of the evidence file or dir. | @@ -39,9 +46,8 @@ kosli report evidence artifact snyk [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | -f, --flow string | The Kosli flow name. | | -h, --help | help for snyk | | -n, --name string | The name of the evidence. | -| --registry-password string | [conditional] The docker registry password or access token. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-provider string | [conditional] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-username string | [conditional] The docker registry username. Only required if you want to read docker image SHA256 digest from a remote docker registry. | +| --registry-password string | [conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry. | +| --registry-username string | [conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry. | | -R, --scan-results string | The path to Snyk SARIF or JSON scan results file from 'snyk test' and 'snyk container test'. By default, the Snyk results will be uploaded to Kosli's evidence vault. | | --upload-results | [defaulted] Whether to upload the provided Snyk results file as an attachment to Kosli or not. (default true) | | -u, --user-data string | [optional] The path to a JSON file containing additional data you would like to attach to the evidence. | diff --git a/docs.kosli.com/content/client_reference/kosli_request_approval.md b/docs.kosli.com/content/client_reference/kosli_request_approval.md index 9d8269e0e..dea006137 100644 --- a/docs.kosli.com/content/client_reference/kosli_request_approval.md +++ b/docs.kosli.com/content/client_reference/kosli_request_approval.md @@ -10,7 +10,14 @@ deprecated: false Request an approval of a deployment of an artifact to an environment in Kosli. The request should be reviewed in the Kosli UI. -The artifact SHA256 fingerprint is calculated (based on the `--artifact-type` flag and the artifact name/path argument) or can be provided directly (with the `--fingerprint` flag). + +The artifact fingerprint can be provided directly with the `--fingerprint` flag, or +calculated based on `--artifact-type` flag. + +Artifact type can be one of: "file" for files, "dir" for directories, "oci" for container +images in registries or "docker" for local docker images. + + ```shell kosli request approval [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] @@ -19,7 +26,7 @@ kosli request approval [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] ## Flags | Flag | Description | | :--- | :--- | -| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | +| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: [oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). | | -d, --description string | [optional] The approval description. | | -D, --dry-run | [optional] Run in dry-run mode. When enabled, no data is sent to Kosli and the CLI exits with 0 exit code regardless of any errors. | | -e, --environment string | [defaulted] The environment the artifact is approved for. (defaults to all environments) | @@ -29,9 +36,8 @@ kosli request approval [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | -h, --help | help for approval | | --newest-commit string | [defaulted] The source commit sha for the newest change in the deployment. Can be any commit-ish. (default "HEAD") | | --oldest-commit string | [conditional] The source commit sha for the oldest change in the deployment. Can be any commit-ish. Only required if you don't specify '--environment'. | -| --registry-password string | [conditional] The docker registry password or access token. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-provider string | [conditional] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry. | -| --registry-username string | [conditional] The docker registry username. Only required if you want to read docker image SHA256 digest from a remote docker registry. | +| --registry-password string | [conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry. | +| --registry-username string | [conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry. | | --repo-root string | [defaulted] The directory where the source git repository is available. (default ".") | | -u, --user-data string | [optional] The path to a JSON file containing additional data you would like to attach to the approval. | diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/_index.md b/docs.kosli.com/content/legacy_ref/v2.10.15/_index.md deleted file mode 100644 index 433ab9177..000000000 --- a/docs.kosli.com/content/legacy_ref/v2.10.15/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: v2.10.15 -bookCollapseSection: true -weight: 604 ---- - -# v2.10.15 diff --git a/docs.kosli.com/content/legacy_ref/v2.10.16/_index.md b/docs.kosli.com/content/legacy_ref/v2.10.16/_index.md index 184e2cdf6..bbfd42c24 100644 --- a/docs.kosli.com/content/legacy_ref/v2.10.16/_index.md +++ b/docs.kosli.com/content/legacy_ref/v2.10.16/_index.md @@ -1,7 +1,7 @@ --- title: v2.10.16 bookCollapseSection: true -weight: 603 +weight: 604 --- # v2.10.16 diff --git a/docs.kosli.com/content/legacy_ref/v2.10.17/_index.md b/docs.kosli.com/content/legacy_ref/v2.10.17/_index.md index c2bc90941..c8a119c5d 100644 --- a/docs.kosli.com/content/legacy_ref/v2.10.17/_index.md +++ b/docs.kosli.com/content/legacy_ref/v2.10.17/_index.md @@ -1,7 +1,7 @@ --- title: v2.10.17 bookCollapseSection: true -weight: 602 +weight: 603 --- # v2.10.17 diff --git a/docs.kosli.com/content/legacy_ref/v2.10.18/_index.md b/docs.kosli.com/content/legacy_ref/v2.10.18/_index.md index 563d6544b..72081a932 100644 --- a/docs.kosli.com/content/legacy_ref/v2.10.18/_index.md +++ b/docs.kosli.com/content/legacy_ref/v2.10.18/_index.md @@ -1,7 +1,7 @@ --- title: v2.10.18 bookCollapseSection: true -weight: 601 +weight: 602 --- # v2.10.18 diff --git a/docs.kosli.com/content/legacy_ref/v2.11.0/_index.md b/docs.kosli.com/content/legacy_ref/v2.11.0/_index.md index fe1c3229c..9ad4612bf 100644 --- a/docs.kosli.com/content/legacy_ref/v2.11.0/_index.md +++ b/docs.kosli.com/content/legacy_ref/v2.11.0/_index.md @@ -1,7 +1,7 @@ --- title: v2.11.0 bookCollapseSection: true -weight: 600 +weight: 601 --- # v2.11.0 diff --git a/docs.kosli.com/content/legacy_ref/v2.11.1/_index.md b/docs.kosli.com/content/legacy_ref/v2.11.1/_index.md new file mode 100644 index 000000000..3f50ce44d --- /dev/null +++ b/docs.kosli.com/content/legacy_ref/v2.11.1/_index.md @@ -0,0 +1,7 @@ +--- +title: v2.11.1 +bookCollapseSection: true +weight: 600 +--- + +# v2.11.1 diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_allow_artifact.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_allow_artifact.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_allow_artifact.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_allow_artifact.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_archive_environment.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_archive_environment.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_archive_environment.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_archive_environment.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_archive_flow.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_archive_flow.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_archive_flow.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_archive_flow.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_assert_approval.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_assert_approval.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_assert_approval.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_assert_approval.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_assert_artifact.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_assert_artifact.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_assert_artifact.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_assert_artifact.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_assert_pullrequest_azure.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_assert_pullrequest_azure.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_assert_pullrequest_azure.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_assert_pullrequest_azure.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_assert_pullrequest_bitbucket.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_assert_pullrequest_bitbucket.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_assert_pullrequest_bitbucket.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_assert_pullrequest_bitbucket.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_assert_pullrequest_github.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_assert_pullrequest_github.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_assert_pullrequest_github.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_assert_pullrequest_github.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_assert_pullrequest_gitlab.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_assert_pullrequest_gitlab.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_assert_pullrequest_gitlab.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_assert_pullrequest_gitlab.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_assert_snapshot.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_assert_snapshot.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_assert_snapshot.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_assert_snapshot.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_assert_status.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_assert_status.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_assert_status.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_assert_status.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_attest_artifact.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_attest_artifact.md similarity index 93% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_attest_artifact.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_attest_artifact.md index c155cf770..c763909eb 100644 --- a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_attest_artifact.md +++ b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_attest_artifact.md @@ -9,7 +9,9 @@ deprecated: false ## Synopsis Attest an artifact creation to a Kosli flow. -The artifact SHA256 fingerprint is calculated (based on the `--artifact-type` flag and the artifact name/path argument) or can be provided directly (with the `--fingerprint` flag). +The artifact SHA256 fingerprint is calculated (based on the `--artifact-type` flag and the artifact name/path argument) or can be provided directly (with the `--fingerprint` flag).To specify paths in a directory artifact that should always be excluded from the SHA256 calculation, you can add a `.kosli_ignore` file to the root of the artifact. +Each line should specify a relative path or path glob to be ignored. You can include comments in this file, using `#`. +The `.kosli_ignore` will be treated as part of the artifact like any other file,unless it is explicitly ignored itself. This command requires access to a git repo to associate the artifact to the git commit it is originating from. You can optionally redact some of the git commit data sent to Kosli using `--redact-commit-info` diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_attest_generic.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_attest_generic.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_attest_generic.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_attest_generic.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_attest_jira.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_attest_jira.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_attest_jira.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_attest_jira.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_attest_junit.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_attest_junit.md similarity index 97% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_attest_junit.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_attest_junit.md index f6c28a07b..5eb50a2a4 100644 --- a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_attest_junit.md +++ b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_attest_junit.md @@ -8,7 +8,9 @@ deprecated: false ## Synopsis -Report a junit attestation to an artifact or a trail in a Kosli flow. +Report a junit attestation to an artifact or a trail in a Kosli flow. +JUnit xml files are read from the `--results-dir` directory which defaults to the current directory. +The xml files are automatically uploaded as `--attachments` via the `--upload-results` flag which defaults to `true`. The attestation can be bound to a trail using the trail name. diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_attest_pullrequest_azure.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_attest_pullrequest_azure.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_attest_pullrequest_azure.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_attest_pullrequest_azure.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_attest_pullrequest_bitbucket.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_attest_pullrequest_bitbucket.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_attest_pullrequest_bitbucket.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_attest_pullrequest_bitbucket.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_attest_pullrequest_github.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_attest_pullrequest_github.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_attest_pullrequest_github.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_attest_pullrequest_github.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_attest_pullrequest_gitlab.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_attest_pullrequest_gitlab.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_attest_pullrequest_gitlab.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_attest_pullrequest_gitlab.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_attest_snyk.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_attest_snyk.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_attest_snyk.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_attest_snyk.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_attest_sonar.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_attest_sonar.md similarity index 95% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_attest_sonar.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_attest_sonar.md index 752cfe88c..c4fec472e 100644 --- a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_attest_sonar.md +++ b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_attest_sonar.md @@ -13,13 +13,16 @@ Retrieves results for the specified scan from SonarCloud or SonarQube and attest The results are parsed to find the status of the project's quality gate which is used to determine the attestation's compliance status. The scan to be retrieved can be specified in two ways: -1. Using metadata created by the Sonar scanner. By default this is located within a temporary .scannerwork folder in the repo base directory. +1. (Default) Using metadata created by the Sonar scanner. By default this is located within a temporary .scannerwork folder in the repo base directory. If you have overriden the location of this folder by passing parameters to the Sonar scanner, or are running Kosli's CLI locally outside the repo's base directory, you can provide the correct path using the --sonar-working-dir flag. This metadata is generated by a specific scan, allowing Kosli to retrieve the results of that scan. 2. Providing the Sonar project key and the revision of the scan (plus the SonarQube server URL if relevant). If running the Kosli CLI in some CI/CD pipeline, the revision is defaulted to the commit SHA. If you are running the command locally, or have overriden the revision in SonarCloud/SonarQube via parameters to the Sonar scanner, you can provide the correct revision using the --sonar-revision flag. Kosli then finds the scan results for the specified project key and revision. +Note that if your project is very large and you are using SonarCloud's automatic analysis, it is possible for the attest sonar command to run before the SonarCloud scan is completed. +In this case, we recommend using Kosli's Sonar webhook integration ( https://docs.kosli.com/integrations/sonar/ ) rather than the CLI to attest the scan results. + The attestation can be bound to a trail using the trail name. diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_begin_trail.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_begin_trail.md similarity index 96% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_begin_trail.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_begin_trail.md index 241bf4778..a63833cab 100644 --- a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_begin_trail.md +++ b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_begin_trail.md @@ -11,7 +11,10 @@ deprecated: false Begin or update a Kosli flow trail. You can optionally associate the trail to a git commit using `--commit` (requires access to a git repo). And you -can optionally redact some of the git commit data sent to Kosli using `--redact-commit-info` +can optionally redact some of the git commit data sent to Kosli using `--redact-commit-info`. + +`TRAIL-NAME`s must start with a letter or number, and only contain letters, numbers, `.`, `-`, `_`, and `~`. + ```shell kosli begin trail TRAIL-NAME [flags] diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_completion.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_completion.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_completion.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_completion.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_config.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_config.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_config.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_config.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_create_environment.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_create_environment.md similarity index 96% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_create_environment.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_create_environment.md index f4874fa94..2201e29fe 100644 --- a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_create_environment.md +++ b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_create_environment.md @@ -35,6 +35,8 @@ Logical environments are used for grouping of physical environments. For instanc be grouped into logical environment **prod**. Logical environments are view-only, you can not report snapshots to them. +`ENVIRONMENT-NAME`s must start with a letter or number, and only contain letters, numbers, `.`, `-`, `_`, and `~`. + ```shell kosli create environment ENVIRONMENT-NAME [flags] diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_create_flow.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_create_flow.md similarity index 96% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_create_flow.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_create_flow.md index 6973e8765..e13fe6169 100644 --- a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_create_flow.md +++ b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_create_flow.md @@ -11,6 +11,9 @@ deprecated: false Create or update a Kosli flow. You can specify flow parameters in flags. +`FLOW-NAME`s must start with a letter or number, and only contain letters, numbers, `.`, `-`, `_`, and `~`. + + ```shell kosli create flow FLOW-NAME [flags] ``` diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_diff_snapshots.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_diff_snapshots.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_diff_snapshots.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_diff_snapshots.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_disable_beta.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_disable_beta.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_disable_beta.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_disable_beta.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_enable_beta.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_enable_beta.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_enable_beta.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_enable_beta.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_expect_deployment.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_expect_deployment.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_expect_deployment.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_expect_deployment.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_fingerprint.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_fingerprint.md similarity index 88% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_fingerprint.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_fingerprint.md index 3bf6a827a..1543d9d7d 100644 --- a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_fingerprint.md +++ b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_fingerprint.md @@ -22,6 +22,10 @@ glob patterns. The supported glob pattern syntax is what is documented here: https://pkg.go.dev/path/filepath#Match , plus the ability to use recursive globs "**" +To specify paths in a directory artifact that should always be excluded from the SHA256 calculation, you can add a `.kosli_ignore` file to the root of the artifact. +Each line should specify a relative path or path glob to be ignored. You can include comments in this file, using `#`. +The `.kosli_ignore` will be treated as part of the artifact like any other file,unless it is explicitly ignored itself. + ```shell kosli fingerprint {IMAGE-NAME | FILE-PATH | DIR-PATH} [flags] ``` diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_get_approval.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_get_approval.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_get_approval.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_get_approval.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_get_artifact.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_get_artifact.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_get_artifact.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_get_artifact.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_get_deployment.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_get_deployment.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_get_deployment.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_get_deployment.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_get_environment.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_get_environment.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_get_environment.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_get_environment.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_get_flow.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_get_flow.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_get_flow.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_get_flow.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_get_snapshot.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_get_snapshot.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_get_snapshot.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_get_snapshot.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_get_trail.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_get_trail.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_get_trail.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_get_trail.md diff --git a/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_join_environment.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_join_environment.md new file mode 100644 index 000000000..0d165162d --- /dev/null +++ b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_join_environment.md @@ -0,0 +1,49 @@ +--- +title: "kosli join environment" +beta: false +deprecated: false +--- + +# kosli join environment + +## Synopsis + +Join a physical environment to a logical environment. + +```shell +kosli join environment [flags] +``` + +## Flags +| Flag | Description | +| :--- | :--- | +| -D, --dry-run | [optional] Run in dry-run mode. When enabled, no data is sent to Kosli and the CLI exits with 0 exit code regardless of any errors. | +| -h, --help | help for environment | +| --logical string | [required] The logical environment. | +| --physical string | [required] The physical environment. | + + +## Flags inherited from parent commands +| Flag | Description | +| :--- | :--- | +| -a, --api-token string | The Kosli API token. | +| -c, --config-file string | [optional] The Kosli config file path. (default "kosli") | +| --debug | [optional] Print debug logs to stdout. A boolean flag https://docs.kosli.com/faq/#boolean-flags (default false) | +| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | +| --http-proxy string | [optional] The HTTP proxy URL including protocol and port number. e.g. 'http://proxy-server-ip:proxy-port' | +| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | +| --org string | The Kosli organization. | + + +## Examples Use Cases + +**join a physical environment to a logical environment** + +```shell +kosli join environment \ + --physical prod-k8 \ + --logical prod \ + --api-token yourAPIToken \ + --org yourOrgName +``` + diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_list_approvals.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_list_approvals.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_list_approvals.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_list_approvals.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_list_artifacts.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_list_artifacts.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_list_artifacts.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_list_artifacts.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_list_deployments.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_list_deployments.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_list_deployments.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_list_deployments.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_list_environments.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_list_environments.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_list_environments.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_list_environments.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_list_flows.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_list_flows.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_list_flows.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_list_flows.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_list_snapshots.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_list_snapshots.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_list_snapshots.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_list_snapshots.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_list_trails.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_list_trails.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_list_trails.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_list_trails.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_log_environment.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_log_environment.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_log_environment.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_log_environment.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_rename_environment.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_rename_environment.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_rename_environment.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_rename_environment.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_rename_flow.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_rename_flow.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_rename_flow.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_rename_flow.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_approval.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_approval.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_approval.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_approval.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_artifact.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_artifact.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_artifact.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_artifact.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_artifact_generic.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_artifact_generic.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_artifact_generic.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_artifact_generic.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_artifact_junit.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_artifact_junit.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_artifact_junit.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_artifact_junit.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_artifact_pullrequest_azure.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_artifact_pullrequest_azure.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_artifact_pullrequest_azure.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_artifact_pullrequest_azure.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_artifact_pullrequest_bitbucket.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_artifact_pullrequest_bitbucket.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_artifact_pullrequest_bitbucket.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_artifact_pullrequest_bitbucket.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_artifact_pullrequest_github.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_artifact_pullrequest_github.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_artifact_pullrequest_github.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_artifact_pullrequest_github.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_artifact_pullrequest_gitlab.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_artifact_pullrequest_gitlab.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_artifact_pullrequest_gitlab.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_artifact_pullrequest_gitlab.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_artifact_snyk.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_artifact_snyk.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_artifact_snyk.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_artifact_snyk.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_commit_generic.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_commit_generic.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_commit_generic.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_commit_generic.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_commit_jira.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_commit_jira.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_commit_jira.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_commit_jira.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_commit_junit.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_commit_junit.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_commit_junit.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_commit_junit.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_commit_pullrequest_azure.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_commit_pullrequest_azure.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_commit_pullrequest_azure.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_commit_pullrequest_azure.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_commit_pullrequest_bitbucket.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_commit_pullrequest_bitbucket.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_commit_pullrequest_bitbucket.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_commit_pullrequest_bitbucket.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_commit_pullrequest_github.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_commit_pullrequest_github.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_commit_pullrequest_github.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_commit_pullrequest_github.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_commit_pullrequest_gitlab.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_commit_pullrequest_gitlab.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_commit_pullrequest_gitlab.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_commit_pullrequest_gitlab.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_commit_snyk.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_commit_snyk.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_report_evidence_commit_snyk.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_report_evidence_commit_snyk.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_request_approval.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_request_approval.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_request_approval.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_request_approval.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_search.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_search.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_search.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_search.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_snapshot_azure.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_snapshot_azure.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_snapshot_azure.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_snapshot_azure.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_snapshot_docker.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_snapshot_docker.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_snapshot_docker.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_snapshot_docker.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_snapshot_ecs.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_snapshot_ecs.md similarity index 65% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_snapshot_ecs.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_snapshot_ecs.md index 6efe92ca1..48084dc44 100644 --- a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_snapshot_ecs.md +++ b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_snapshot_ecs.md @@ -8,7 +8,8 @@ deprecated: false ## Synopsis -Report a snapshot of running containers in an AWS ECS cluster or service to Kosli. +Report a snapshot of running containers in one or more AWS ECS cluster(s) to Kosli. +Skip `--clusters` and `--clusters-regex` to report all clusters in a given AWS account. Or use `--exclude` and/or `--exclude-regex` to report all clusters excluding some. The reported data includes container image digests and creation timestamps. To authenticate to AWS, you can either: @@ -30,10 +31,12 @@ kosli snapshot ecs ENVIRONMENT-NAME [flags] | --aws-key-id string | The AWS access key ID. | | --aws-region string | The AWS region. | | --aws-secret-key string | The AWS secret access key. | -| -C, --cluster string | The name of the ECS cluster. | +| --clusters strings | [optional] The comma-separated list of ECS cluster names to snapshot. Can't be used together with --exclude or --exclude-regex. | +| --clusters-regex strings | [optional] The comma-separated list of ECS cluster name regex patterns to snapshot. Can't be used together with --exclude or --exclude-regex. | | -D, --dry-run | [optional] Run in dry-run mode. When enabled, no data is sent to Kosli and the CLI exits with 0 exit code regardless of any errors. | +| --exclude strings | [optional] The comma-separated list of ECS cluster names to exclude. Can't be used together with --exclude or --exclude-regex. | +| --exclude-regex strings | [optional] The comma-separated list of ECS cluster name regex patterns to exclude. Can't be used together with --clusters or --clusters-regex. | | -h, --help | help for ecs | -| -s, --service-name string | [optional] The name of the ECS service. | ## Flags inherited from parent commands @@ -58,7 +61,7 @@ export AWS_ACCESS_KEY_ID=yourAWSAccessKeyID export AWS_SECRET_ACCESS_KEY=yourAWSSecretAccessKey kosli snapshot ecs yourEnvironmentName \ - --cluster yourECSClusterName \ + --clusters yourECSClusterName \ --api-token yourAPIToken \ --org yourOrgName @@ -72,22 +75,33 @@ export AWS_ACCESS_KEY_ID=yourAWSAccessKeyID export AWS_SECRET_ACCESS_KEY=yourAWSSecretAccessKey kosli snapshot ecs yourEnvironmentName \ - --cluster yourECSClusterName \ + --clusters yourECSClusterName \ --service-name yourECSServiceName \ --api-token yourAPIToken \ --org yourOrgName ``` -**report what is running in in a specific AWS ECS service within a cluster (AWS auth provided in flags)** +**report what is running in all ECS clusters in an AWS account (AWS auth provided in flags)** + +```shell +kosli snapshot ecs yourEnvironmentName \ + --aws-key-id yourAWSAccessKeyID \ + --aws-secret-key yourAWSSecretAccessKey \ + --aws-region yourAWSRegion \ + --api-token yourAPIToken \ + --org yourOrgName + +``` + +**report what is running in all ECS clusters in an AWS account except for clusters with names matching given regex patterns** ```shell kosli snapshot ecs yourEnvironmentName \ - --cluster yourECSClusterName \ - --service-name yourECSServiceName \ --aws-key-id yourAWSAccessKeyID \ --aws-secret-key yourAWSSecretAccessKey \ --aws-region yourAWSRegion \ + --exclude-regex "those-names.*" \ --api-token yourAPIToken \ --org yourOrgName ``` diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_snapshot_k8s.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_snapshot_k8s.md similarity index 74% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_snapshot_k8s.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_snapshot_k8s.md index 480ab5ce3..04a3902ab 100644 --- a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_snapshot_k8s.md +++ b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_snapshot_k8s.md @@ -9,6 +9,7 @@ deprecated: false ## Synopsis Report a snapshot of running pods in a K8S cluster or namespace(s) to Kosli. +Skip `--namespaces` and `--namespaces-regex` to report all pods in all namespaces in a cluster. The reported data includes pod container images digests and creation timestamps. You can customize the scope of reporting to include or exclude namespaces. @@ -20,10 +21,12 @@ kosli snapshot k8s ENVIRONMENT-NAME [flags] | Flag | Description | | :--- | :--- | | -D, --dry-run | [optional] Run in dry-run mode. When enabled, no data is sent to Kosli and the CLI exits with 0 exit code regardless of any errors. | -| -x, --exclude-namespaces strings | [conditional] The comma separated list of namespaces regex patterns NOT to report artifacts info from. Can't be used together with --namespace. | +| -x, --exclude-namespaces strings | [optional] The comma separated list of namespaces names to exclude from reporting artifacts info from. Can't be used together with --namespaces or --namespaces-regex. | +| --exclude-namespaces-regex strings | [optional] The comma separated list of namespaces regex patterns to exclude from reporting artifacts info from. Can't be used together with --namespaces or --namespaces-regex. | | -h, --help | help for k8s | | -k, --kubeconfig string | [defaulted] The kubeconfig path for the target cluster. (default "$HOME/.kube/config") | -| -n, --namespaces strings | [conditional] The comma separated list of namespaces regex patterns to report artifacts info from. Can't be used together with --exclude-namespace. | +| -n, --namespaces strings | [optional] The comma separated list of namespaces names to report artifacts info from. Can't be used together with --exclude-namespaces or --exclude-namespaces-regex. | +| --namespaces-regex strings | [optional] The comma separated list of namespaces regex patterns to report artifacts info from. Can't be used together with --exclude-namespaces --exclude-namespaces-regex. | ## Flags inherited from parent commands diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_snapshot_lambda.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_snapshot_lambda.md similarity index 67% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_snapshot_lambda.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_snapshot_lambda.md index 4f1a65bfb..4748cbd9e 100644 --- a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_snapshot_lambda.md +++ b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_snapshot_lambda.md @@ -9,7 +9,7 @@ deprecated: false ## Synopsis Report a snapshot of artifacts deployed as one or more AWS Lambda functions and their digests to Kosli. -Skip `--function-names` to report all functions in a given AWS account. +Skip `--function-names` and `--function-names-regex` to report all functions in a given AWS account. Or use `--exclude` and/or `--exclude-regex` to report all functions excluding some. To authenticate to AWS, you can either: 1) provide the AWS static credentials via flags or by exporting the equivalent KOSLI env vars (e.g. KOSLI_AWS_KEY_ID) @@ -31,7 +31,10 @@ kosli snapshot lambda ENVIRONMENT-NAME [flags] | --aws-region string | The AWS region. | | --aws-secret-key string | The AWS secret access key. | | -D, --dry-run | [optional] Run in dry-run mode. When enabled, no data is sent to Kosli and the CLI exits with 0 exit code regardless of any errors. | -| --function-names strings | [optional] The comma-separated list of AWS Lambda function names to be reported. | +| --exclude strings | [optional] The comma-separated list of AWS Lambda function names to be excluded. Cannot be used together with --function-names | +| --exclude-regex strings | [optional] The comma-separated list of name regex patterns for AWS Lambda functions to be excluded. Cannot be used together with --function-names. Allowed regex patterns are described in https://github.com/google/re2/wiki/Syntax | +| --function-names strings | [optional] The comma-separated list of AWS Lambda function names to be reported. Cannot be used together with --exclude or --exclude-regex. | +| --function-names-regex strings | [optional] The comma-separated list of AWS Lambda function names regex patterns to be reported. Cannot be used together with --exclude or --exclude-regex. | | -h, --help | help for lambda | @@ -62,6 +65,21 @@ kosli snapshot lambda yourEnvironmentName \ ``` +**report all (excluding some) Lambda functions running in an AWS account (AWS auth provided in env variables)** + +```shell +export AWS_REGION=yourAWSRegion +export AWS_ACCESS_KEY_ID=yourAWSAccessKeyID +export AWS_SECRET_ACCESS_KEY=yourAWSSecretAccessKey + +kosli snapshot lambda yourEnvironmentName \ + --exclude function1,function2 \ + --exclude-regex "^not-wanted.*" \ + --api-token yourAPIToken \ + --org yourOrgName + +``` + **report what is running in the latest version of an AWS Lambda function (AWS auth provided in env variables)** ```shell @@ -76,6 +94,20 @@ kosli snapshot lambda yourEnvironmentName \ ``` +**report what is running in the latest version of AWS Lambda functions that match a name regex** + +```shell +export AWS_REGION=yourAWSRegion +export AWS_ACCESS_KEY_ID=yourAWSAccessKeyID +export AWS_SECRET_ACCESS_KEY=yourAWSSecretAccessKey + +kosli snapshot lambda yourEnvironmentName \ + --function-names-regex yourFunctionNameRegexPattern \ + --api-token yourAPIToken \ + --org yourOrgName + +``` + **report what is running in the latest version of multiple AWS Lambda functions (AWS auth provided in env variables)** ```shell diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_snapshot_path.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_snapshot_path.md similarity index 86% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_snapshot_path.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_snapshot_path.md index ab156fd93..ae1746974 100644 --- a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_snapshot_path.md +++ b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_snapshot_path.md @@ -14,7 +14,9 @@ You can exclude certain paths or patterns from the artifact fingerprint using `- The supported glob pattern syntax is what is documented here: https://pkg.go.dev/path/filepath#Match , plus the ability to use recursive globs "**" - +To specify paths in a directory artifact that should always be excluded from the SHA256 calculation, you can add a `.kosli_ignore` file to the root of the artifact. +Each line should specify a relative path or path glob to be ignored. You can include comments in this file, using `#`. +The `.kosli_ignore` will be treated as part of the artifact like any other file,unless it is explicitly ignored itself. ```shell kosli snapshot path ENVIRONMENT-NAME [flags] diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_snapshot_paths.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_snapshot_paths.md similarity index 86% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_snapshot_paths.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_snapshot_paths.md index 1944352b0..a8375de77 100644 --- a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_snapshot_paths.md +++ b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_snapshot_paths.md @@ -20,6 +20,10 @@ glob patterns. The supported glob pattern syntax is what is documented here: https://pkg.go.dev/path/filepath#Match , plus the ability to use recursive globs "**" +To specify paths in a directory artifact that should always be excluded from the SHA256 calculation, you can add a `.kosli_ignore` file to the root of the artifact. +Each line should specify a relative path or path glob to be ignored. You can include comments in this file, using `#`. +The `.kosli_ignore` will be treated as part of the artifact like any other file,unless it is explicitly ignored itself. + This is an example YAML paths spec file: ```yaml version: 1 diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_snapshot_s3.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_snapshot_s3.md similarity index 91% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_snapshot_s3.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_snapshot_s3.md index 1d9461eff..cce69bfbe 100644 --- a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_snapshot_s3.md +++ b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_snapshot_s3.md @@ -21,6 +21,9 @@ More details can be found here: https://aws.github.io/aws-sdk-go-v2/docs/configu You can report the entire bucket content, or filter some of the content using `--include` and `--exclude`. In all cases, the content is reported as one artifact. If you wish to report separate files/dirs within the same bucket as separate artifacts, you need to run the command twice. +To specify paths in a directory artifact that should always be excluded from the SHA256 calculation, you can add a `.kosli_ignore` file to the root of the artifact. +Each line should specify a relative path or path glob to be ignored. You can include comments in this file, using `#`. +The `.kosli_ignore` will be treated as part of the artifact like any other file,unless it is explicitly ignored itself. ```shell kosli snapshot s3 ENVIRONMENT-NAME [flags] diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_snapshot_server.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_snapshot_server.md similarity index 88% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_snapshot_server.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_snapshot_server.md index 35c86286d..025cfa329 100644 --- a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_snapshot_server.md +++ b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_snapshot_server.md @@ -19,6 +19,10 @@ glob patterns. The supported glob pattern syntax is what is documented here: https://pkg.go.dev/path/filepath#Match , plus the ability to use recursive globs "**" +To specify paths in a directory artifact that should always be excluded from the SHA256 calculation, you can add a `.kosli_ignore` file to the root of the artifact. +Each line should specify a relative path or path glob to be ignored. You can include comments in this file, using `#`. +The `.kosli_ignore` will be treated as part of the artifact like any other file,unless it is explicitly ignored itself. + ```shell kosli snapshot server ENVIRONMENT-NAME [flags] ``` diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_status.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_status.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_status.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_status.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_tag.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_tag.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_tag.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_tag.md diff --git a/docs.kosli.com/content/legacy_ref/v2.10.15/kosli_version.md b/docs.kosli.com/content/legacy_ref/v2.11.1/kosli_version.md similarity index 100% rename from docs.kosli.com/content/legacy_ref/v2.10.15/kosli_version.md rename to docs.kosli.com/content/legacy_ref/v2.11.1/kosli_version.md