From 9a86727353ad97f9c3663d7729fedc5ceac08bcf Mon Sep 17 00:00:00 2001 From: sami-alajrami Date: Mon, 13 Nov 2023 13:19:53 +0000 Subject: [PATCH] Release: Auto approve: Fixed wrong logic in check of membership (#47) --- docs.kosli.com/assets/metadata.json | 2 +- .../kosli_report_evidence_commit_jira.md | 15 +++ docs.kosli.com/content/helm/_index.md | 4 +- .../content/legacy_ref/v0.1.38/_index.md | 7 -- .../content/legacy_ref/v0.1.38/kosli.md | 31 ------ .../legacy_ref/v0.1.38/kosli_approval_get.md | 63 ------------ .../legacy_ref/v0.1.38/kosli_approval_ls.md | 63 ------------ .../legacy_ref/v0.1.38/kosli_artifact_get.md | 59 ----------- .../legacy_ref/v0.1.38/kosli_artifact_ls.md | 62 ------------ .../v0.1.38/kosli_assert_artifact.md | 61 ------------ .../kosli_assert_bitbucket-pullrequest.md | 54 ---------- .../v0.1.38/kosli_assert_environment.md | 57 ----------- .../kosli_assert_github-pullrequest.md | 54 ---------- .../kosli_assert_gitlab-mergerequest.md | 54 ---------- .../legacy_ref/v0.1.38/kosli_assert_status.md | 34 ------- ...t_report_evidence_bitbucket-pullrequest.md | 78 --------------- .../kosli_commit_report_evidence_generic.md | 70 ------------- ...mmit_report_evidence_github-pullrequest.md | 77 --------------- ...mit_report_evidence_gitlab-mergerequest.md | 76 -------------- .../kosli_commit_report_evidence_junit.md | 66 ------------- .../kosli_commit_report_evidence_snyk.md | 66 ------------- .../legacy_ref/v0.1.38/kosli_completion.md | 80 --------------- .../v0.1.38/kosli_deployment_get.md | 57 ----------- .../legacy_ref/v0.1.38/kosli_deployment_ls.md | 63 ------------ .../kosli_environment_allowedartifacts_add.md | 42 -------- .../v0.1.38/kosli_environment_declare.md | 51 ---------- .../v0.1.38/kosli_environment_diff.md | 52 ---------- .../v0.1.38/kosli_environment_get.md | 57 ----------- .../v0.1.38/kosli_environment_inspect.md | 34 ------- .../v0.1.38/kosli_environment_log.md | 72 -------------- .../v0.1.38/kosli_environment_ls.md | 34 ------- .../v0.1.38/kosli_environment_rename.md | 47 --------- .../kosli_environment_report_docker.md | 47 --------- .../v0.1.38/kosli_environment_report_ecs.md | 82 ---------------- .../v0.1.38/kosli_environment_report_k8s.md | 75 -------------- .../kosli_environment_report_lambda.md | 72 -------------- .../v0.1.38/kosli_environment_report_s3.md | 70 ------------- .../kosli_environment_report_server.md | 47 --------- .../v0.1.38/kosli_expect_deployment.md | 45 --------- .../legacy_ref/v0.1.38/kosli_fingerprint.md | 39 -------- .../v0.1.38/kosli_pipeline_approval_assert.md | 63 ------------ .../v0.1.38/kosli_pipeline_approval_report.md | 74 -------------- .../kosli_pipeline_approval_request.md | 74 -------------- ...kosli_pipeline_artifact_report_creation.md | 72 -------------- ...t_report_evidence_bitbucket-pullrequest.md | 86 ---------------- ...peline_artifact_report_evidence_generic.md | 79 --------------- ...fact_report_evidence_github-pullrequest.md | 84 ---------------- ...act_report_evidence_gitlab-mergerequest.md | 98 ------------------- ...pipeline_artifact_report_evidence_junit.md | 71 -------------- ..._pipeline_artifact_report_evidence_snyk.md | 71 -------------- ..._pipeline_artifact_report_evidence_test.md | 72 -------------- .../v0.1.38/kosli_pipeline_declare.md | 74 -------------- .../v0.1.38/kosli_pipeline_inspect.md | 34 ------- .../legacy_ref/v0.1.38/kosli_pipeline_ls.md | 34 ------- .../legacy_ref/v0.1.38/kosli_search.md | 51 ---------- .../legacy_ref/v0.1.38/kosli_status.md | 36 ------- .../legacy_ref/v0.1.38/kosli_version.md | 43 -------- .../content/legacy_ref/v2.6.10/_index.md | 2 +- .../content/legacy_ref/v2.6.11/_index.md | 2 +- .../content/legacy_ref/v2.6.12/_index.md | 7 ++ .../legacy_ref/{v2.6.7 => v2.6.12}/kosli.md | 2 +- .../kosli_allow_artifact.md | 2 +- .../kosli_assert_approval.md | 2 +- .../kosli_assert_artifact.md | 2 +- .../kosli_assert_pullrequest_azure.md | 2 +- .../kosli_assert_pullrequest_bitbucket.md | 2 +- .../kosli_assert_pullrequest_github.md | 2 +- .../kosli_assert_pullrequest_gitlab.md | 2 +- .../kosli_assert_snapshot.md | 2 +- .../kosli_assert_status.md | 2 +- .../{v2.6.7 => v2.6.12}/kosli_completion.md | 2 +- .../kosli_create_audit-trail.md | 2 +- .../kosli_create_environment.md | 2 +- .../{v2.6.7 => v2.6.12}/kosli_create_flow.md | 2 +- .../kosli_diff_snapshots.md | 2 +- .../{v2.6.7 => v2.6.12}/kosli_disable_beta.md | 2 +- .../{v2.6.7 => v2.6.12}/kosli_enable_beta.md | 2 +- .../kosli_expect_deployment.md | 4 +- .../{v2.6.7 => v2.6.12}/kosli_fingerprint.md | 2 +- .../{v2.6.7 => v2.6.12}/kosli_get_approval.md | 23 +++-- .../{v2.6.7 => v2.6.12}/kosli_get_artifact.md | 2 +- .../kosli_get_audit-trail.md | 2 +- .../kosli_get_deployment.md | 17 +++- .../kosli_get_environment.md | 2 +- .../{v2.6.7 => v2.6.12}/kosli_get_flow.md | 2 +- .../{v2.6.7 => v2.6.12}/kosli_get_snapshot.md | 27 +++-- .../{v2.6.7 => v2.6.12}/kosli_get_workflow.md | 2 +- .../kosli_list_approvals.md | 2 +- .../kosli_list_artifacts.md | 2 +- .../kosli_list_audit-trails.md | 2 +- .../kosli_list_deployments.md | 2 +- .../kosli_list_environments.md | 2 +- .../{v2.6.7 => v2.6.12}/kosli_list_flows.md | 2 +- .../kosli_list_snapshots.md | 2 +- .../kosli_list_workflows.md | 2 +- .../kosli_log_environment.md | 2 +- .../kosli_rename_environment.md | 2 +- .../kosli_report_approval.md | 2 +- .../kosli_report_artifact.md | 2 +- .../kosli_report_evidence_artifact_generic.md | 4 +- .../kosli_report_evidence_artifact_junit.md | 2 +- ...ort_evidence_artifact_pullrequest_azure.md | 2 +- ...evidence_artifact_pullrequest_bitbucket.md | 2 +- ...rt_evidence_artifact_pullrequest_github.md | 2 +- ...rt_evidence_artifact_pullrequest_gitlab.md | 2 +- .../kosli_report_evidence_artifact_snyk.md | 2 +- .../kosli_report_evidence_commit_generic.md | 4 +- .../kosli_report_evidence_commit_jira.md | 2 +- .../kosli_report_evidence_commit_junit.md | 2 +- ...eport_evidence_commit_pullrequest_azure.md | 2 +- ...t_evidence_commit_pullrequest_bitbucket.md | 2 +- ...port_evidence_commit_pullrequest_github.md | 2 +- ...port_evidence_commit_pullrequest_gitlab.md | 2 +- .../kosli_report_evidence_commit_snyk.md | 2 +- .../kosli_report_evidence_workflow.md | 2 +- .../kosli_report_workflow.md | 4 +- .../kosli_request_approval.md | 2 +- .../{v2.6.7 => v2.6.12}/kosli_search.md | 2 +- .../kosli_snapshot_docker.md | 2 +- .../{v2.6.7 => v2.6.12}/kosli_snapshot_ecs.md | 2 +- .../{v2.6.7 => v2.6.12}/kosli_snapshot_k8s.md | 2 +- .../kosli_snapshot_lambda.md | 2 +- .../{v2.6.7 => v2.6.12}/kosli_snapshot_s3.md | 2 +- .../kosli_snapshot_server.md | 2 +- .../{v2.6.7 => v2.6.12}/kosli_status.md | 2 +- .../{v2.6.7 => v2.6.12}/kosli_version.md | 2 +- .../content/legacy_ref/v2.6.7/_index.md | 7 -- .../content/legacy_ref/v2.6.8/_index.md | 2 +- .../content/legacy_ref/v2.6.9/_index.md | 2 +- 129 files changed, 139 insertions(+), 3319 deletions(-) delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/_index.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_approval_get.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_approval_ls.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_artifact_get.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_artifact_ls.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_assert_artifact.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_assert_bitbucket-pullrequest.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_assert_environment.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_assert_github-pullrequest.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_assert_gitlab-mergerequest.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_assert_status.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_commit_report_evidence_bitbucket-pullrequest.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_commit_report_evidence_generic.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_commit_report_evidence_github-pullrequest.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_commit_report_evidence_gitlab-mergerequest.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_commit_report_evidence_junit.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_commit_report_evidence_snyk.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_completion.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_deployment_get.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_deployment_ls.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_allowedartifacts_add.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_declare.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_diff.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_get.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_inspect.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_log.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_ls.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_rename.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_report_docker.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_report_ecs.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_report_k8s.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_report_lambda.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_report_s3.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_report_server.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_expect_deployment.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_fingerprint.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_approval_assert.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_approval_report.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_approval_request.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_creation.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_evidence_bitbucket-pullrequest.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_evidence_generic.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_evidence_github-pullrequest.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_evidence_gitlab-mergerequest.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_evidence_junit.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_evidence_snyk.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_evidence_test.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_declare.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_inspect.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_ls.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_search.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_status.md delete mode 100644 docs.kosli.com/content/legacy_ref/v0.1.38/kosli_version.md create mode 100644 docs.kosli.com/content/legacy_ref/v2.6.12/_index.md rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli.md (87%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_allow_artifact.md (94%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_assert_approval.md (95%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_assert_artifact.md (95%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_assert_pullrequest_azure.md (93%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_assert_pullrequest_bitbucket.md (93%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_assert_pullrequest_github.md (93%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_assert_pullrequest_gitlab.md (93%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_assert_snapshot.md (92%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_assert_status.md (85%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_completion.md (93%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_create_audit-trail.md (92%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_create_environment.md (90%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_create_flow.md (92%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_diff_snapshots.md (93%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_disable_beta.md (85%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_enable_beta.md (85%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_expect_deployment.md (92%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_fingerprint.md (94%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_get_approval.md (72%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_get_artifact.md (93%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_get_audit-trail.md (90%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_get_deployment.md (72%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_get_environment.md (87%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_get_flow.md (86%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_get_snapshot.md (66%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_get_workflow.md (91%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_list_approvals.md (92%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_list_artifacts.md (92%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_list_audit-trails.md (90%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_list_deployments.md (92%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_list_environments.md (87%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_list_flows.md (86%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_list_snapshots.md (94%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_list_workflows.md (91%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_log_environment.md (94%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_rename_environment.md (89%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_report_approval.md (96%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_report_artifact.md (96%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_report_evidence_artifact_generic.md (95%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_report_evidence_artifact_junit.md (96%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_report_evidence_artifact_pullrequest_azure.md (97%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_report_evidence_artifact_pullrequest_bitbucket.md (97%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_report_evidence_artifact_pullrequest_github.md (97%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_report_evidence_artifact_pullrequest_gitlab.md (97%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_report_evidence_artifact_snyk.md (96%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_report_evidence_commit_generic.md (93%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_report_evidence_commit_jira.md (96%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_report_evidence_commit_junit.md (95%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_report_evidence_commit_pullrequest_azure.md (96%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_report_evidence_commit_pullrequest_bitbucket.md (96%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_report_evidence_commit_pullrequest_github.md (96%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_report_evidence_commit_pullrequest_gitlab.md (96%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_report_evidence_commit_snyk.md (95%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_report_evidence_workflow.md (94%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_report_workflow.md (86%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_request_approval.md (96%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_search.md (90%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_snapshot_docker.md (90%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_snapshot_ecs.md (95%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_snapshot_k8s.md (95%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_snapshot_lambda.md (96%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_snapshot_s3.md (94%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_snapshot_server.md (94%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_status.md (88%) rename docs.kosli.com/content/legacy_ref/{v2.6.7 => v2.6.12}/kosli_version.md (90%) delete mode 100644 docs.kosli.com/content/legacy_ref/v2.6.7/_index.md diff --git a/docs.kosli.com/assets/metadata.json b/docs.kosli.com/assets/metadata.json index 1b49f3e9b..e96bbf2d2 100644 --- a/docs.kosli.com/assets/metadata.json +++ b/docs.kosli.com/assets/metadata.json @@ -1 +1 @@ -{"currentversion": "v2.6.12"} +{"currentversion": "v2.6.13"} diff --git a/docs.kosli.com/content/client_reference/kosli_report_evidence_commit_jira.md b/docs.kosli.com/content/client_reference/kosli_report_evidence_commit_jira.md index 0e74b8c94..63d6bc51b 100644 --- a/docs.kosli.com/content/client_reference/kosli_report_evidence_commit_jira.md +++ b/docs.kosli.com/content/client_reference/kosli_report_evidence_commit_jira.md @@ -27,6 +27,7 @@ kosli report evidence commit jira [flags] ## Flags | Flag | Description | | :--- | :--- | +| --assert | [optional] Exit with non-zero code if no jira issue reference found, or jira issue does not exist, for the given commit or branch. | | -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 verify and given 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. | @@ -95,5 +96,19 @@ kosli report evidence commit jira \ --org yourOrgName \ --user-data /path/to/json/file.json + +# fail if no issue reference is found, or the issue is not found in your jira instance +kosli report evidence commit jira \ + --commit yourGitCommitSha1 \ + --name yourEvidenceName \ + --jira-base-url https://kosli.atlassian.net \ + --jira-username user@domain.com \ + --jira-api-token yourJiraAPIToken \ + --flows yourFlowName \ + --build-url https://exampleci.com \ + --api-token yourAPIToken \ + --org yourOrgName \ + --assert + ``` diff --git a/docs.kosli.com/content/helm/_index.md b/docs.kosli.com/content/helm/_index.md index 579937da7..a67e3c0a6 100644 --- a/docs.kosli.com/content/helm/_index.md +++ b/docs.kosli.com/content/helm/_index.md @@ -61,7 +61,7 @@ helm upgrade [RELEASE-NAME] kosli/k8s-reporter | kosliApiToken.secretKey | string | `""` | the name of the key in the secret data which contains the kosli API token | | kosliApiToken.secretName | string | `""` | the name of the secret containing the kosli API token | | nameOverride | string | `""` | overrides the name used for the created k8s resources. If `fullnameOverride` is provided, it has higher precedence than this one | -| podAnnotations | object | `{}` | any custom annotations to be added to the cronjob | +| podAnnotations | object | `{}` | | | reporterConfig.dryRun | bool | `false` | whether the dry run mode is enabled or not. In dry run mode, the reporter logs the reports to stdout and does not send them to kosli. | | reporterConfig.kosliEnvironmentName | string | `""` | the name of kosli environment that the k8s cluster/namespace correlates to | | reporterConfig.kosliOrg | string | `""` | the name of the kosli org | @@ -74,5 +74,5 @@ helm upgrade [RELEASE-NAME] kosli/k8s-reporter | serviceAccount.name | string | `""` | the name of the service account to use. If not set and create is true, a name is generated using the fullname template | ---------------------------------------------- -Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0) +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/_index.md b/docs.kosli.com/content/legacy_ref/v0.1.38/_index.md deleted file mode 100644 index 41e663b81..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: v0.1.38 -bookCollapseSection: true -weight: 608 ---- - -# Kosli Client v0.1.38 diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli.md deleted file mode 100644 index 64ec81de9..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "kosli" ---- - -## kosli - -The Kosli CLI. - -### Synopsis - -The Kosli evidence reporting CLI. - -Environment variables: -You can set any flag from an environment variable by capitalizing it in snake case and adding the KOSLI_ prefix. -For example, to set --api-token from an environment variable, you can export KOSLI_API_TOKEN=YOUR_API_TOKEN. - -Setting the API token to DRY_RUN sets the --dry-run flag. - - -### Flags -| 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. | -| -h, --help | help for kosli | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_approval_get.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_approval_get.md deleted file mode 100644 index 1657dff89..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_approval_get.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: "kosli approval get" ---- - -## kosli approval get - -Get an approval from a specified pipeline. - -### Synopsis - -Get an approval from a specified pipeline. -The expected argument is an expression to specify the approval to get. -It has the format [SEPARATOR][INTEGER_REFERENCE] - -Specify SNAPPISH by: - pipelineName~ N'th behind the latest approval - pipelineName# approval number N - pipelineName the latest approval - -Examples of valid expressions are: pipe (latest approval), pipe#10 (approval number 10), pipe~2 (the third latest approval) - -```shell -kosli approval get SNAPPISH [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -h, --help | help for get | -| -o, --output string | [defaulted] The format of the output. Valid formats are: [table, json]. (default "table") | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# get second behind the latest approval from a pipeline -kosli approval get pipelineName~1 \ - --api-token yourAPIToken \ - --owner orgName - -# get the 10th approval from a pipeline -kosli approval get pipelineName#10 \ - --api-token yourAPIToken \ - --owner orgName - -# get the latest approval from a pipeline -kosli approval get pipelineName \ - --api-token yourAPIToken \ - --owner orgName -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_approval_ls.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_approval_ls.md deleted file mode 100644 index 52b0d17c5..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_approval_ls.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: "kosli approval ls" ---- - -## kosli approval ls - -List approvals in a pipeline. - -### Synopsis - -List approvals in a pipeline. -The results are paginated and ordered from latests to oldest. -By default, the page limit is 15 approvals per page. - - -```shell -kosli approval ls PIPELINE-NAME [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -h, --help | help for ls | -| -o, --output string | [defaulted] The format of the output. Valid formats are: [table, json]. (default "table") | -| --page int | [defaulted] The page number of a response. (default 1) | -| -n, --page-limit int | [defaulted] The number of elements per page. (default 15) | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# list the last 15 approvals for a pipeline: -kosli approval list yourPipelineName \ - --api-token yourAPIToken \ - --owner yourOrgName - -# list the last 30 approvals for a pipeline: -kosli approval list yourPipelineName \ - --page-limit 30 \ - --api-token yourAPIToken \ - --owner yourOrgName - -# list the last 30 approvals for a pipeline (in JSON): -kosli approval list yourPipelineName \ - --page-limit 30 \ - --api-token yourAPIToken \ - --owner yourOrgName \ - --output json - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_artifact_get.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_artifact_get.md deleted file mode 100644 index 13e7f6f38..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_artifact_get.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: "kosli artifact get" ---- - -## kosli artifact get - -Get artifact from a specified pipeline - -### Synopsis - -Get artifact from a specified pipeline -You can get an artifact by its fingerprint or by its git commit sha. -In case of using the git commit, it is possible to get multiple artifacts matching the git commit. - -The expected argument is an expression to specify the artifact to get. -It has the format - -Specify SNAPPISH by: - pipelineName@ artifact with a given fingerprint. The fingerprint can be short or complete. - pipelineName: artifact with a given commit SHA. The commit sha can be short or complete. - -Examples of valid expressions are: pipe@184c799cd551dd1d8d5c5f9a5d593b2e931f5e36122ee5c793c1d08a19839cc0, pipe:110d048bf1fce72ba546cbafc4427fb21b958dee - - -```shell -kosli artifact get SNAPPISH [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -h, --help | help for get | -| -o, --output string | [defaulted] The format of the output. Valid formats are: [table, json]. (default "table") | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell -# get an artifact with a given fingerprint from a pipeline -kosli artifact get pipelineName@fingerprint \ - --api-token yourAPIToken \ - --owner orgName -# get an artifact with a given commit SHA from a pipeline -kosli artifact get pipelineName:commitSHA \ - --api-token yourAPIToken \ - --owner orgName -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_artifact_ls.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_artifact_ls.md deleted file mode 100644 index 399eb903f..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_artifact_ls.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: "kosli artifact ls" ---- - -## kosli artifact ls - -List artifacts in a pipeline. - -### Synopsis - -List artifacts in a pipeline. The results are paginated and ordered from latests to oldest. -By default, the page limit is 15 artifacts per page. - - -```shell -kosli artifact ls PIPELINE-NAME [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -h, --help | help for ls | -| -o, --output string | [defaulted] The format of the output. Valid formats are: [table, json]. (default "table") | -| --page int | [defaulted] The page number of a response. (default 1) | -| -n, --page-limit int | [defaulted] The number of elements per page. (default 15) | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# list the last 15 artifacts for a pipeline: -kosli artifact list yourPipelineName \ - --api-token yourAPIToken \ - --owner yourOrgName - -# list the last 30 artifacts for a pipeline: -kosli artifact list yourPipelineName \ - --page-limit 30 \ - --api-token yourAPIToken \ - --owner yourOrgName - -# list the last 30 artifacts for a pipeline (in JSON): -kosli artifact list yourPipelineName \ - --page-limit 30 \ - --api-token yourAPIToken \ - --owner yourOrgName \ - --output json - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_assert_artifact.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_assert_artifact.md deleted file mode 100644 index 256606765..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_assert_artifact.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: "kosli assert artifact" ---- - -## kosli assert artifact - -Assert the compliance status of an artifact in Kosli. - -### Synopsis - -Assert the compliance status of an artifact in Kosli. -Exits with non-zero code if the artifact has a non-compliant status. - -```shell -kosli assert artifact [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -t, --artifact-type string | [conditional] The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you don't specify '--sha256' or '--fingerprint'. | -| -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 artifact | -| -p, --pipeline string | The Kosli pipeline 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. | -| -s, --sha256 string | [conditional] The SHA256 fingerprint for the artifact. Only required if you don't specify '--artifact-type'. | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# fail if an artifact has a non-compliant status (using the artifact fingerprint) -kosli assert artifact \ - --sha256 184c799cd551dd1d8d5c5f9a5d593b2e931f5e36122ee5c793c1d08a19839cc0 \ - --pipeline yourPipelineName \ - --api-token yourAPIToken \ - --owner yourOrgName - -# fail if an artifact has a non-compliant status (using the artifact name and type) -kosli assert artifact library/nginx:1.21 \ - --artifact-type docker \ - --pipeline yourPipelineName \ - --api-token yourAPIToken \ - --owner yourOrgName - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_assert_bitbucket-pullrequest.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_assert_bitbucket-pullrequest.md deleted file mode 100644 index 480042a03..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_assert_bitbucket-pullrequest.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: "kosli assert bitbucket-pullrequest" ---- - -## kosli assert bitbucket-pullrequest - -Assert if a Bitbucket pull request for a git commit exists. - -### Synopsis - -Assert if a Bitbucket pull request for a git commit exists. -The command exits with non-zero exit code -if no pull requests were found for the commit. - -```shell -kosli assert bitbucket-pullrequest [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| --bitbucket-password string | Bitbucket App password. See https://developer.atlassian.com/cloud/bitbucket/rest/intro/#authentication for more details. | -| --bitbucket-username string | Bitbucket username. | -| --bitbucket-workspace string | Bitbucket workspace ID. | -| --commit string | Git commit for which to find pull request 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. | -| -h, --help | help for bitbucket-pullrequest | -| --repository string | Git repository. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -kosli assert bitbucket-pullrequest \ - --bitbucket-username yourBitbucketUsername \ - --bitbucket-password yourBitbucketPassword \ - --bitbucket-workspace yourBitbucketWorkspace \ - --commit yourGitCommit \ - --repository yourBitbucketGitRepository - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_assert_environment.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_assert_environment.md deleted file mode 100644 index 860b35e3d..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_assert_environment.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "kosli assert environment" ---- - -## kosli assert environment - -Assert the compliance status of an environment in Kosli. - -### Synopsis - -Assert the compliance status of an environment in Kosli. -Exits with non-zero code if the environment has a non-compliant status. -The expected argument is an expression to specify the specific environment snapshot to assert. -It has the format [SEPARATOR][SNAPSHOT_REFERENCE] - -Separators can be: -- '#' to specify a specific snapshot number for the environment that is being asserted. -- '~' to get N-th behind the latest snapshot. - -Examples of valid expressions are: -- prod (latest snapshot of prod) -- prod#10 (snapshot number 10 of prod) -- prod~2 (third latest snapshot of prod) - - -```shell -kosli assert environment ENVIRONMENT-NAME-OR-EXPRESSION [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 | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -kosli assert environment prod#5 \ - --api-token yourAPIToken \ - --owner yourOrgName - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_assert_github-pullrequest.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_assert_github-pullrequest.md deleted file mode 100644 index 5c67339c7..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_assert_github-pullrequest.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: "kosli assert github-pullrequest" ---- - -## kosli assert github-pullrequest - -Assert if a Github pull request for a git commit exists. - -### Synopsis - -Assert if a Github pull request for a git commit exists. -The command exits with non-zero exit code -if no pull requests were found for the commit. - -```shell -kosli assert github-pullrequest [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| --commit string | Git commit for which to find pull request 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. | -| --github-base-url string | [optional] GitHub base URL (only needed for GitHub Enterprise installations). | -| --github-org string | Github organization. (defaulted if you are running in GitHub Actions: https://docs.kosli.com/ci-defaults ). | -| --github-token string | Github token. | -| -h, --help | help for github-pullrequest | -| --repository string | Git repository. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -kosli assert github-pullrequest \ - --github-token yourGithubToken \ - --github-org yourGithubOrg \ - --commit yourArtifactGitCommit \ - --commit yourGitCommit \ - --repository yourGithubGitRepository - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_assert_gitlab-mergerequest.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_assert_gitlab-mergerequest.md deleted file mode 100644 index 2732238f9..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_assert_gitlab-mergerequest.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: "kosli assert gitlab-mergerequest" ---- - -## kosli assert gitlab-mergerequest - -Assert if a Gitlab pull request for a git commit exists. - -### Synopsis - -Assert if a Gitlab pull request for a git commit exists. -The command exits with non-zero exit code -if no pull requests were found for the commit. - -```shell -kosli assert gitlab-mergerequest [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| --commit string | Git commit for which to find pull request 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. | -| --gitlab-base-url string | [optional] Gitlab base URL (only needed for on-prem Gitlab installations). | -| --gitlab-org string | Gitlab organization. (defaulted if you are running in Gitlab Pipelines: https://docs.kosli.com/ci-defaults ). | -| --gitlab-token string | Gitlab token. | -| -h, --help | help for gitlab-mergerequest | -| --repository string | Git repository. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -kosli assert gitlab-mergerequest \ - --github-token yourGithubToken \ - --github-org yourGithubOrg \ - --commit yourArtifactGitCommit \ - --commit yourGitCommit \ - --repository yourGithubGitRepository - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_assert_status.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_assert_status.md deleted file mode 100644 index 979b0eb30..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_assert_status.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "kosli assert status" ---- - -## kosli assert status - -Assert the status of Kosli server. - -### Synopsis - -Assert the status of Kosli server. -Exits with non-zero code if Kosli server down. - -```shell -kosli assert status [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -h, --help | help for status | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_commit_report_evidence_bitbucket-pullrequest.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_commit_report_evidence_bitbucket-pullrequest.md deleted file mode 100644 index 493970549..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_commit_report_evidence_bitbucket-pullrequest.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: "kosli commit report evidence bitbucket-pullrequest" ---- - -## kosli commit report evidence bitbucket-pullrequest - -Report a Bitbucket pull request evidence for a commit in a Kosli pipeline. - -### Synopsis - -Report a Bitbucket pull request evidence for a commit in a Kosli pipeline. -It checks if a pull request exists for the git commit and reports the pull-request evidence to the commit in Kosli. - -```shell -kosli commit report evidence bitbucket-pullrequest [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| --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. | -| --bitbucket-workspace string | Bitbucket workspace ID. | -| -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 ). | -| -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 bitbucket-pullrequest | -| -n, --name string | The name of the evidence. | -| -p, --pipelines strings | The comma separated list of pipelines for which a commit evidence belongs. | -| --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 this evidence. | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# report a pull request evidence to Kosli -kosli commit report evidence bitbucket-pullrequest \ - --commit yourArtifactGitCommit \ - --repository yourBitbucketGitRepository \ - --bitbucket-username yourBitbucketUsername \ - --bitbucket-password yourBitbucketPassword \ - --bitbucket-workspace yourBitbucketWorkspace \ - --name yourEvidenceName \ - --pipelines yourPipelineName \ - --build-url https://exampleci.com \ - --owner yourOrgName \ - --api-token yourAPIToken - -# fail if a pull request does not exist for your commit -kosli commit report evidence bitbucket-pullrequest \ - --commit yourArtifactGitCommit \ - --repository yourBitbucketGitRepository \ - --bitbucket-username yourBitbucketUsername \ - --bitbucket-password yourBitbucketPassword \ - --bitbucket-workspace yourBitbucketWorkspace \ - --name yourEvidenceName \ - --pipelines yourPipelineName \ - --build-url https://exampleci.com \ - --owner yourOrgName \ - --api-token yourAPIToken \ - --assert - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_commit_report_evidence_generic.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_commit_report_evidence_generic.md deleted file mode 100644 index ca0491e95..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_commit_report_evidence_generic.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: "kosli commit report evidence generic" ---- - -## kosli commit report evidence generic - -Report Generic evidence for a commit in a Kosli pipeline. - -### Synopsis - -Report Generic evidence for a commit in a Kosli pipeline. - -```shell -kosli commit report evidence generic [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -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 | The git commit SHA1 for which the evidence belongs. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | -| -C, --compliant | [defaulted] Whether the evidence is compliant or not. | -| -d, --description string | [optional] The evidence 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 generic | -| -n, --name string | The name of the evidence. | -| -p, --pipelines strings | The comma separated list of pipelines for which a commit evidence belongs. | -| -u, --user-data string | [optional] The path to a JSON file containing additional data you would like to attach to this evidence. | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# report Generic evidence for a commit related to one Kosli pipeline: -kosli commit report evidence generic \ - --commit yourGitCommitSha1 \ - --name yourEvidenceName \ - --description "some description" \ - --compliant \ - --pipelines yourPipelineName \ - --build-url https://exampleci.com \ - --api-token yourAPIToken \ - --owner yourOrgName - -# report Generic evidence for a commit related to multiple Kosli pipelines with user-data: -kosli commit report evidence generic \ - --commit yourGitCommitSha1 \ - --name yourEvidenceName \ - --description "some description" \ - --compliant \ - --pipelines yourFirstPipelineName,yourSecondPipelineName \ - --build-url https://exampleci.com \ - --api-token yourAPIToken \ - --owner yourOrgName \ - --user-data /path/to/json/file.json - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_commit_report_evidence_github-pullrequest.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_commit_report_evidence_github-pullrequest.md deleted file mode 100644 index d44acf87c..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_commit_report_evidence_github-pullrequest.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: "kosli commit report evidence github-pullrequest" ---- - -## kosli commit report evidence github-pullrequest - -Report a Github pull request evidence for a git commit in a Kosli pipeline. - -### Synopsis - -Report a Github pull request evidence for a git commit in a Kosli pipeline. -It checks if a pull request exists for a commit and report the pull-request evidence to the commit in Kosli. - - -```shell -kosli commit report evidence github-pullrequest [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| --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 ). | -| -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. | -| --github-base-url string | [optional] GitHub base URL (only needed for GitHub Enterprise installations). | -| --github-org string | Github organization. (defaulted if you are running in GitHub Actions: https://docs.kosli.com/ci-defaults ). | -| --github-token string | Github token. | -| -h, --help | help for github-pullrequest | -| -n, --name string | The name of the evidence. | -| -p, --pipelines strings | The comma separated list of pipelines for which a commit evidence belongs. | -| --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 this evidence. | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# report a pull request commit evidence to Kosli -kosli commit report evidence github-pullrequest \ - --commit yourGitCommitSha1 \ - --repository yourGithubGitRepository \ - --github-token yourGithubToken \ - --github-org yourGithubOrg \ - --name yourEvidenceName \ - --pipelines yourPipelineName1,yourPipelineName2 \ - --build-url https://exampleci.com \ - --owner yourOrgName \ - --api-token yourAPIToken - -# fail if a pull request does not exist for your commit -kosli commit report evidence github-pullrequest \ - --commit yourGitCommitSha1 \ - --repository yourGithubGitRepository \ - --github-token yourGithubToken \ - --github-org yourGithubOrg \ - --name yourEvidenceName \ - --pipelines yourPipelineName1,yourPipelineName2 \ - --build-url https://exampleci.com \ - --owner yourOrgName \ - --api-token yourAPIToken \ - --assert - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_commit_report_evidence_gitlab-mergerequest.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_commit_report_evidence_gitlab-mergerequest.md deleted file mode 100644 index 0fb40787c..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_commit_report_evidence_gitlab-mergerequest.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: "kosli commit report evidence gitlab-mergerequest" ---- - -## kosli commit report evidence gitlab-mergerequest - -Report a Gitlab merge request evidence for a commit in a Kosli pipeline. - -### Synopsis - -Report a Gitlab merge request evidence for a commit in a Kosli pipeline. -It checks if a merge request exists for the git commit and reports the merge-request evidence to the commit in Kosli. - -```shell -kosli commit report evidence gitlab-mergerequest [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| --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 ). | -| -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. | -| --gitlab-base-url string | [optional] Gitlab base URL (only needed for on-prem Gitlab installations). | -| --gitlab-org string | Gitlab organization. (defaulted if you are running in Gitlab Pipelines: https://docs.kosli.com/ci-defaults ). | -| --gitlab-token string | Gitlab token. | -| -h, --help | help for gitlab-mergerequest | -| -n, --name string | The name of the evidence. | -| -p, --pipelines strings | The comma separated list of pipelines for which a commit evidence belongs. | -| --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 this evidence. | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# report a merge request evidence to Kosli -kosli commit report evidence gitlab-mergerequest \ - --commit yourArtifactGitCommit \ - --repository yourBitbucketGitRepository \ - --gitlab-token yourGitlabToken \ - --gitlab-org yourGitlabOrg \ - --name yourEvidenceName \ - --pipelines yourPipelineName \ - --build-url https://exampleci.com \ - --owner yourOrgName \ - --api-token yourAPIToken - -# fail if a pull request does not exist for your commit -kosli commit report evidence gitlab-mergerequest \ - --commit yourArtifactGitCommit \ - --repository yourBitbucketGitRepository \ - --gitlab-token yourGitlabToken \ - --gitlab-org yourGitlabOrg \ - --name yourEvidenceName \ - --pipelines yourPipelineName \ - --build-url https://exampleci.com \ - --owner yourOrgName \ - --api-token yourAPIToken \ - --assert - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_commit_report_evidence_junit.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_commit_report_evidence_junit.md deleted file mode 100644 index d46088e60..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_commit_report_evidence_junit.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: "kosli commit report evidence junit" ---- - -## kosli commit report evidence junit - -Report JUnit test evidence for a commit in a Kosli pipeline. - -### Synopsis - -Report JUnit test evidence for an artifact in a Kosli pipeline. - -```shell -kosli commit report evidence junit [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -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 | The git commit SHA1 for which the evidence belongs. (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. | -| -h, --help | help for junit | -| -n, --name string | The name of the evidence. | -| -p, --pipelines strings | The comma separated list of pipelines for which a commit evidence belongs. | -| -R, --results-dir string | [defaulted] The path to a folder with JUnit test results. (default ".") | -| -u, --user-data string | [optional] The path to a JSON file containing additional data you would like to attach to this evidence. | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# report JUnit test evidence for a commit related to one Kosli pipeline: -kosli commit report evidence junit \ - --commit yourGitCommitSha1 \ - --name yourEvidenceName \ - --pipelines yourPipelineName \ - --build-url https://exampleci.com \ - --api-token yourAPIToken \ - --owner yourOrgName \ - --results-dir yourFolderWithJUnitResults - -# report JUnit test evidence for a commit related to multiple Kosli pipelines: -kosli commit report evidence junit \ - --commit yourGitCommitSha1 \ - --name yourEvidenceName \ - --pipelines yourFirstPipelineName,yourSecondPipelineName \ - --build-url https://exampleci.com \ - --api-token yourAPIToken \ - --owner yourOrgName \ - --results-dir yourFolderWithJUnitResults - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_commit_report_evidence_snyk.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_commit_report_evidence_snyk.md deleted file mode 100644 index 15d5b0737..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_commit_report_evidence_snyk.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: "kosli commit report evidence snyk" ---- - -## kosli commit report evidence snyk - -Report Snyk evidence for a commit in a Kosli pipeline. - -### Synopsis - -Report Snyk evidence for a commit in a Kosli pipeline. - -```shell -kosli commit report evidence snyk [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -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 | The git commit SHA1 for which the evidence belongs. (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. | -| -h, --help | help for snyk | -| -n, --name string | The name of the evidence. | -| -p, --pipelines strings | The comma separated list of pipelines for which a commit evidence belongs. | -| -R, --scan-results string | The path to Snyk scan results Json file. | -| -u, --user-data string | [optional] The path to a JSON file containing additional data you would like to attach to this evidence. | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# report Snyk evidence for a commit related to one Kosli pipeline: -kosli commit report evidence snyk \ - --commit yourGitCommitSha1 \ - --name yourEvidenceName \ - --pipelines yourPipelineName \ - --build-url https://exampleci.com \ - --api-token yourAPIToken \ - --owner yourOrgName \ - --scan-results yourSnykJSONScanResults - -# report Snyk evidence for a commit related to multiple Kosli pipelines: -kosli commit report evidence snyk \ - --commit yourGitCommitSha1 \ - --name yourEvidenceName \ - --pipelines yourFirstPipelineName,yourSecondPipelineName \ - --build-url https://exampleci.com \ - --api-token yourAPIToken \ - --owner yourOrgName \ - --scan-results yourSnykJSONScanResults - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_completion.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_completion.md deleted file mode 100644 index 707a86af3..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_completion.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: "kosli completion" ---- - -## kosli completion - -Generate completion script - -### Synopsis - -To load completions: - - ### Bash - -``` - $ source <(kosli completion bash) -``` - To load completions for each session, execute once: - - On Linux: - ``` - $ kosli completion bash > /etc/bash_completion.d/kosli - ``` - On macOS: - ``` - $ kosli completion bash > $(brew --prefix)/etc/bash_completion.d/kosli - ``` - ### Zsh - - If shell completion is not already enabled in your environment, -you will need to enable it. You can execute the following once: - ``` - $ echo "autoload -U compinit; compinit" >> ~/.zshrc - ``` - To load completions for each session, execute once: - ``` - $ kosli completion zsh > "${fpath[1]}/_kosli" - ``` - You will need to start a new shell for this setup to take effect. - - ### fish - ``` - $ kosli completion fish | source - ``` - To load completions for each session, execute once: - ``` - $ kosli completion fish > ~/.config/fish/completions/kosli.fish - ``` - ### PowerShell - ``` - PS> kosli completion powershell | Out-String | Invoke-Expression - ``` - To load completions for every new session, run: - ``` - PS> kosli completion powershell > kosli.ps1 - ``` - and source this file from your PowerShell profile. - - -```shell -kosli completion [bash|zsh|fish|powershell] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -h, --help | help for completion | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_deployment_get.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_deployment_get.md deleted file mode 100644 index b2b2b03e8..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_deployment_get.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "kosli deployment get" ---- - -## kosli deployment get - -Get a deployment from a specified pipeline. - -### Synopsis - -Get a deployment from a specified pipeline. -Specify SNAPPISH by: - pipelineName~ N'th behind the latest deployment - pipelineName# deployment number N - pipelineName the latest deployment - -```shell -kosli deployment get SNAPPISH [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -h, --help | help for get | -| -o, --output string | [defaulted] The format of the output. Valid formats are: [table, json]. (default "table") | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell -# get previous deployment in a pipeline -kosli deployment get pipelineName~1 \ - --api-token yourAPIToken \ - --owner orgName - -# get the 10th deployment in a pipeline -kosli deployment get pipelineName#10 \ - --api-token yourAPIToken \ - --owner orgName - -# get the latest deployment in a pipeline -kosli deployment get pipelineName \ - --api-token yourAPIToken \ - --owner orgName -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_deployment_ls.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_deployment_ls.md deleted file mode 100644 index a8e6abc73..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_deployment_ls.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: "kosli deployment ls" ---- - -## kosli deployment ls - -List deployments in a pipeline. - -### Synopsis - -List deployments in a pipeline. -The results are paginated and ordered from latests to oldest. -By default, the page limit is 15 deployments per page. - - -```shell -kosli deployment ls PIPELINE-NAME [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -h, --help | help for ls | -| -o, --output string | [defaulted] The format of the output. Valid formats are: [table, json]. (default "table") | -| --page int | [defaulted] The page number of a response. (default 1) | -| -n, --page-limit int | [defaulted] The number of elements per page. (default 15) | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# list the last 15 deployments for a pipeline: -kosli deployment list yourPipelineName \ - --api-token yourAPIToken \ - --owner yourOrgName - -# list the last 30 deployments for a pipeline: -kosli deployment list yourPipelineName \ - --page-limit 30 \ - --api-token yourAPIToken \ - --owner yourOrgName - -# list the last 30 deployments for a pipeline (in JSON): -kosli deployment list yourPipelineName \ - --page-limit 30 \ - --api-token yourAPIToken \ - --owner yourOrgName \ - --output json - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_allowedartifacts_add.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_allowedartifacts_add.md deleted file mode 100644 index 831c45ded..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_allowedartifacts_add.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: "kosli environment allowedartifacts add" ---- - -## kosli environment allowedartifacts add - -Add an artifact to an environment's allowlist. - -### Synopsis - -Add an artifact to an environment's allowlist. -The artifact SHA256 fingerprint is calculated (based on --artifact-type flag) or alternatively it can be provided directly (with --sha256 flag). - -```shell -kosli environment allowedartifacts add {IMAGE-NAME | FILE-PATH | DIR-PATH} [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -t, --artifact-type string | [conditional] The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you don't specify '--sha256' or '--fingerprint'. | -| -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. | -| -h, --help | help for add | -| --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. | -| -s, --sha256 string | [conditional] The SHA256 fingerprint for the artifact. Only required if you don't specify '--artifact-type'. | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_declare.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_declare.md deleted file mode 100644 index 6e48cf6cf..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_declare.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "kosli environment declare" ---- - -## kosli environment declare - -Declare a Kosli environment. - -### Synopsis - -Declare a Kosli environment. - -```shell -kosli environment declare [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -d, --description string | [optional] The environment 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. | -| -t, --environment-type string | The type of environment. Valid types are: [K8S, ECS, server, S3, lambda, docker]. | -| -h, --help | help for declare | -| -n, --name string | The name of environment to be created. | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# declare a Kosli environment: -kosli environment declare - --name yourEnvironmentName \ - --environment-type K8S \ - --description "my new env" \ - --api-token yourAPIToken \ - --owner yourOrgName - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_diff.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_diff.md deleted file mode 100644 index 6f6f514da..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_diff.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: "kosli environment diff" ---- - -## kosli environment diff - -Diff snapshots. - -### Synopsis - -Diff snapshots. -Specify SNAPPISH_1 and SNAPPISH_2 by: - environmentName~ N'th behind the latest snapshot - environmentName# snapshot number N - environmentName the latest snapshot - -```shell -kosli environment diff SNAPPISH_1 SNAPPISH_2 [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -h, --help | help for diff | -| -o, --output string | [defaulted] The format of the output. Valid formats are: [table, json]. (default "table") | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell -# compare the third latest snapshot in an environment to the latest -kosli environment diff envName~3 envName \ - --api-token yourAPIToken \ - --owner orgName - -# compare two different environments of the same type -kosli environment diff envName1 envName2 \ - --api-token yourAPIToken \ - --owner orgName -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_get.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_get.md deleted file mode 100644 index 2605d6dfe..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_get.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "kosli environment get" ---- - -## kosli environment get - -Get a specific environment snapshot. - -### Synopsis - -Get a specific environment snapshot. -Specify SNAPPISH by: - environmentName~ N'th behind the latest snapshot - environmentName# snapshot number N - environmentName the latest snapshot - -```shell -kosli environment get ENVIRONMENT-NAME-OR-EXPRESSION [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -h, --help | help for get | -| -o, --output string | [defaulted] The format of the output. Valid formats are: [table, json]. (default "table") | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell -# get the latest snapshot of an environment: -kosli environment get yourEnvironmentName - --api-token yourAPIToken \ - --owner yourOrgName - -# get the SECOND latest snapshot of an environment: -kosli environment get yourEnvironmentName~1 - --api-token yourAPIToken \ - --owner yourOrgName - -# get the snapshot number 23 of an environment: -kosli environment get yourEnvironmentName#23 - --api-token yourAPIToken \ - --owner yourOrgName -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_inspect.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_inspect.md deleted file mode 100644 index 13c7b7143..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_inspect.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "kosli environment inspect" ---- - -## kosli environment inspect - -Inspect an environment metadata. - -### Synopsis - -Inspect an environment metadata. - -```shell -kosli environment inspect ENVIRONMENT-NAME [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -h, --help | help for inspect | -| -o, --output string | [defaulted] The format of the output. Valid formats are: [table, json]. (default "table") | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_log.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_log.md deleted file mode 100644 index 205080e6f..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_log.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: "kosli environment log" ---- - -## kosli environment log - -List environment events. - -### Synopsis - -List environment events. -The results are paginated and ordered from latests to oldest. -By default, the page limit is 15 events per page. - -You can optionally specify an INTERVAL between two snapshot expressions with ... -Expressions can be: - ~N N'th behind the latest snapshot - N snapshot number N - NOW the latest snapshot -Either expression can be omitted to default to NOW. - - -```shell -kosli environment log ENV_NAME [INTERVAL] [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -h, --help | help for log | -| -l, --long | [optional] Print detailed output. | -| -o, --output string | [defaulted] The format of the output. Valid formats are: [table, json]. (default "table") | -| --page int | [defaulted] The page number of a response. (default 1) | -| -n, --page-limit int | [defaulted] The number of elements per page. (default 15) | -| --reverse | [defaulted] Reverse the order of output list. | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# list the last 15 events for an environment: -kosli environment log yourEnvironmentName \ - --api-token yourAPIToken \ - --owner yourOrgName - -# list the last 30 events for an environment: -kosli environment log yourEnvironmentName \ - --page-limit 30 \ - --api-token yourAPIToken \ - --owner yourOrgName - -# list the last 30 events for an environment (in JSON): -kosli environment log yourEnvironmentName \ - --page-limit 30 \ - --api-token yourAPIToken \ - --owner yourOrgName \ - --output json - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_ls.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_ls.md deleted file mode 100644 index 062f9e100..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_ls.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "kosli environment ls" ---- - -## kosli environment ls - -List environments. - -### Synopsis - -List environments. - -```shell -kosli environment ls [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -h, --help | help for ls | -| -o, --output string | [defaulted] The format of the output. Valid formats are: [table, json]. (default "table") | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_rename.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_rename.md deleted file mode 100644 index 956bed8e9..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_rename.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "kosli environment rename" ---- - -## kosli environment rename - -Rename a Kosli environment. - -### Synopsis - -Rename a Kosli environment. -The environment will remain available under its old name until that name is taken by another environment. - - -```shell -kosli environment rename OLD_NAME NEW_NAME [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 rename | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# rename a Kosli environment: -kosli environment rename oldName newName \ - --api-token yourAPIToken \ - --owner yourOrgName - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_report_docker.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_report_docker.md deleted file mode 100644 index cc277a75a..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_report_docker.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "kosli environment report docker" ---- - -## kosli environment report docker - -Report running containers data from docker host to Kosli. - -### Synopsis - -Report running containers data from docker host to Kosli. -The reported data includes container image digests -and creation timestamps. Containers running images which have not -been pushed to or pulled from a registry will be ignored. - -```shell -kosli environment report docker ENVIRONMENT-NAME [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 docker | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# report what is running in a docker host: -kosli environment report docker yourEnvironmentName \ - --api-token yourAPIToken \ - --owner yourOrgName -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_report_ecs.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_report_ecs.md deleted file mode 100644 index 464272e5e..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_report_ecs.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -title: "kosli environment report ecs" ---- - -## kosli environment report ecs - -Report running containers data from AWS ECS cluster or service to Kosli. - -### Synopsis - -Report running containers data from AWS ECS cluster or service to Kosli. -The reported data includes container image digests and creation timestamps. -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) - 2) export the AWS env vars (e.g. AWS_ACCESS_KEY_ID). - 3) Use a shared config/credentials file under the $HOME/.aws -Option 1 takes highest precedence, while option 3 is the lowest. -More details can be found here: https://aws.github.io/aws-sdk-go-v2/docs/configuring-sdk/#specifying-credentials - - -```shell -kosli environment report ecs ENVIRONMENT-NAME [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| --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. | -| -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 ecs | -| -s, --service-name string | The name of the ECS service. | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# report what is running in an entire AWS ECS cluster: -export AWS_REGION=yourAWSRegion -export AWS_ACCESS_KEY_ID=yourAWSAccessKeyID -export AWS_SECRET_ACCESS_KEY=yourAWSSecretAccessKey - -kosli environment report ecs yourEnvironmentName \ - --cluster yourECSClusterName \ - --api-token yourAPIToken \ - --owner yourOrgName - -# report what is running in a specific AWS ECS service: -export AWS_REGION=yourAWSRegion -export AWS_ACCESS_KEY_ID=yourAWSAccessKeyID -export AWS_SECRET_ACCESS_KEY=yourAWSSecretAccessKey - -kosli environment report ecs yourEnvironmentName \ - --service-name yourECSServiceName \ - --api-token yourAPIToken \ - --owner yourOrgName - -# report what is running in in a specific AWS ECS service (AWS auth provided in flags): -kosli environment report ecs yourEnvironmentName \ - --service-name yourECSServiceName \ - --aws-key-id yourAWSAccessKeyID \ - --aws-secret-key yourAWSSecretAccessKey \ - --aws-region yourAWSRegion \ - --api-token yourAPIToken \ - --owner yourOrgName - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_report_k8s.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_report_k8s.md deleted file mode 100644 index a23a738de..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_report_k8s.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: "kosli environment report k8s" ---- - -## kosli environment report k8s - -Report running pods data from K8S cluster or namespace(s) to Kosli. - -### Synopsis - -Report running pods data from K8S cluster or namespace(s) to Kosli. -The reported data includes pod container images digests and creation timestamps. You can customize the scope of reporting -to include or exclude namespaces. - -```shell -kosli environment report k8s ENVIRONMENT-NAME [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. | -| -x, --exclude-namespace strings | [conditional] The comma separated list of namespaces regex patterns NOT to report artifacts info from. Can't be used together with --namespace. | -| -h, --help | help for k8s | -| -k, --kubeconfig string | [defaulted] The kubeconfig path for the target cluster. (default "$HOME/.kube/config") | -| -n, --namespace strings | [conditional] The comma separated list of namespaces regex patterns to report artifacts info from. Can't be used together with --exclude-namespace. | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# report what is running in an entire cluster using kubeconfig at $HOME/.kube/config: -kosli environment report k8s yourEnvironmentName \ - --api-token yourAPIToken \ - --owner yourOrgName - -# report what is running in an entire cluster using kubeconfig at $HOME/.kube/config -(with global flags defined in environment or in a config file): -export KOSLI_API_TOKEN=yourAPIToken -export KOSLI_OWNER=yourOrgName - -kosli environment report k8s yourEnvironmentName - -# report what is running in an entire cluster excluding some namespaces using kubeconfig at $HOME/.kube/config: -kosli environment report k8s yourEnvironmentName \ - --exclude-namespace kube-system,utilities \ - --api-token yourAPIToken \ - --owner yourOrgName - -# report what is running in a given namespace in the cluster using kubeconfig at $HOME/.kube/config: -kosli environment report k8s yourEnvironmentName \ - --namespace your-namespace \ - --api-token yourAPIToken \ - --owner yourOrgName - -# report what is running in a cluster using kubeconfig at a custom path: -kosli environment report k8s yourEnvironmentName \ - --kubeconfig /path/to/kube/config \ - --api-token yourAPIToken \ - --owner yourOrgName - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_report_lambda.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_report_lambda.md deleted file mode 100644 index 2d90a7f31..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_report_lambda.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: "kosli environment report lambda" ---- - -## kosli environment report lambda - -Report the artifact deployed in an AWS Lambda and its digest to Kosli. - -### Synopsis - -Report the artifact deployed in an AWS Lambda and its digest to Kosli. -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) - 2) export the AWS env vars (e.g. AWS_ACCESS_KEY_ID). - 3) Use a shared config/credentials file under the $HOME/.aws -Option 1 takes highest precedence, while option 3 is the lowest. -More details can be found here: https://aws.github.io/aws-sdk-go-v2/docs/configuring-sdk/#specifying-credentials - - -```shell -kosli environment report lambda ENVIRONMENT-NAME [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| --aws-key-id string | The AWS access key ID. | -| --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-name string | The name of the AWS Lambda function. | -| --function-version string | [optional] The version of the AWS Lambda function. | -| -h, --help | help for lambda | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# report what is running in the latest version AWS Lambda function (AWS auth provided in env variables): -export AWS_REGION=yourAWSRegion -export AWS_ACCESS_KEY_ID=yourAWSAccessKeyID -export AWS_SECRET_ACCESS_KEY=yourAWSSecretAccessKey - -kosli environment report lambda yourEnvironmentName \ - --function-name yourFunctionName \ - --api-token yourAPIToken \ - --owner yourOrgName - -# report what is running in a specific version of an AWS Lambda function (AWS auth provided in flags): -kosli environment report lambda yourEnvironmentName \ - --function-name yourFunctionName \ - --function-version yourFunctionVersion \ - --aws-key-id yourAWSAccessKeyID \ - --aws-secret-key yourAWSSecretAccessKey \ - --aws-region yourAWSRegion \ - --api-token yourAPIToken \ - --owner yourOrgName - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_report_s3.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_report_s3.md deleted file mode 100644 index fb25432c2..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_report_s3.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: "kosli environment report s3" ---- - -## kosli environment report s3 - -Report an artifact deployed in AWS S3 bucket to Kosli. - -### Synopsis - -Report an artifact deployed in AWS S3 bucket to Kosli. -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) - 2) export the AWS env vars (e.g. AWS_ACCESS_KEY_ID). - 3) Use a shared config/credentials file under the $HOME/.aws -Option 1 takes highest precedence, while option 3 is the lowest. -More details can be found here: https://aws.github.io/aws-sdk-go-v2/docs/configuring-sdk/#specifying-credentials - - -```shell -kosli environment report s3 ENVIRONMENT-NAME [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| --aws-key-id string | The AWS access key ID. | -| --aws-region string | The AWS region. | -| --aws-secret-key string | The AWS secret access key. | -| --bucket string | The name of the S3 bucket. | -| -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 s3 | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# report what is running in an AWS S3 bucket (AWS auth provided in env variables): -export AWS_REGION=yourAWSRegion -export AWS_ACCESS_KEY_ID=yourAWSAccessKeyID -export AWS_SECRET_ACCESS_KEY=yourAWSSecretAccessKey - -kosli environment report s3 yourEnvironmentName \ - --bucket yourBucketName \ - --api-token yourAPIToken \ - --owner yourOrgName - -# report what is running in an AWS S3 bucket (AWS auth provided in flags): -kosli environment report s3 yourEnvironmentName \ - --bucket yourBucketName \ - --aws-key-id yourAWSAccessKeyID \ - --aws-secret-key yourAWSSecretAccessKey \ - --aws-region yourAWSRegion \ - --api-token yourAPIToken \ - --owner yourOrgName - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_report_server.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_report_server.md deleted file mode 100644 index eb3cd5166..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_environment_report_server.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "kosli environment report server" ---- - -## kosli environment report server - -Report artifacts running in a server environment to Kosli. - -### Synopsis - -Report artifacts running in a server environment to Kosli. -You can report directory or file artifacts in one or more server paths. - -```shell -kosli environment report server ENVIRONMENT-NAME [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 server | -| -p, --paths strings | The comma separated list of artifact directories. | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# report directory artifacts running in a server at a list of paths: -kosli environment report server yourEnvironmentName \ - --paths a/b/c,e/f/g \ - --api-token yourAPIToken \ - --owner yourOrgName -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_expect_deployment.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_expect_deployment.md deleted file mode 100644 index ebf6d2e04..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_expect_deployment.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "kosli expect deployment" ---- - -## kosli expect deployment - -Report a deployment of an artifact to an environment to Kosli. - -### Synopsis - -Report a deployment of an artifact to an environment to Kosli. -The artifact SHA256 fingerprint is calculated (based on --artifact-type flag) or alternatively it can be provided directly (with --sha256 flag). - -```shell -kosli expect deployment [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -t, --artifact-type string | [conditional] The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you don't specify '--sha256' or '--fingerprint'. | -| -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 artifact 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 | The environment name. | -| -h, --help | help for deployment | -| -p, --pipeline string | The Kosli pipeline 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. | -| -s, --sha256 string | [conditional] The SHA256 fingerprint for the artifact. Only required if you don't specify '--artifact-type'. | -| -u, --user-data string | [optional] The path to a JSON file containing additional data you would like to attach to this deployment. | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_fingerprint.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_fingerprint.md deleted file mode 100644 index bcfa5d308..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_fingerprint.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "kosli fingerprint" ---- - -## kosli fingerprint - -Calculate the SHA256 fingerprint of an artifact. - -### Synopsis - -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. - -```shell -kosli fingerprint {IMAGE-NAME | FILE-PATH | DIR-PATH} [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -t, --artifact-type string | [conditional] The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you don't specify '--sha256' or '--fingerprint'. | -| -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. | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_approval_assert.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_approval_assert.md deleted file mode 100644 index 9236b6457..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_approval_assert.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: "kosli pipeline approval assert" ---- - -## kosli pipeline approval assert - -Assert if an artifact in Kosli has been approved for deployment. - -### Synopsis - -Assert if an artifact in Kosli has been approved for deployment. -Exits with non-zero code if artifact has not been approved. -The artifact SHA256 fingerprint is calculated (based on --artifact-type flag) or alternatively it can be provided directly (with --sha256 flag). - -```shell -kosli pipeline approval assert [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -t, --artifact-type string | [conditional] The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you don't specify '--sha256' or '--fingerprint'. | -| -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 assert | -| -p, --pipeline string | The Kosli pipeline 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. | -| -s, --sha256 string | [conditional] The SHA256 fingerprint for the artifact. Only required if you don't specify '--artifact-type'. | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# Assert that a file type artifact has been approved -kosli pipeline approval assert FILE.tgz \ - --api-token yourAPIToken \ - --artifact-type file \ - --owner yourOrgName \ - --pipeline yourPipelineName - - -# Assert that an artifact with a provided fingerprint (sha256) has been approved -kosli pipeline approval assert \ - --api-token yourAPIToken \ - --owner yourOrgName \ - --pipeline yourPipelineName \ - --sha256 yourSha256 - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_approval_report.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_approval_report.md deleted file mode 100644 index 1e4d15dd1..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_approval_report.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: "kosli pipeline approval report" ---- - -## kosli pipeline approval report - -Report an approval of deploying an artifact to Kosli. - -### Synopsis - -Report an approval of deploying an artifact to Kosli. -The artifact SHA256 fingerprint is calculated (based on --artifact-type flag) or alternatively it can be provided directly (with --sha256 flag). - -```shell -kosli pipeline approval report [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -t, --artifact-type string | [conditional] The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you don't specify '--sha256' or '--fingerprint'. | -| -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. | -| -h, --help | help for report | -| --newest-commit string | [defaulted] The source commit sha for the newest change in the deployment. (default "HEAD") | -| --oldest-commit string | The source commit sha for the oldest change in the deployment. | -| -p, --pipeline string | The Kosli pipeline 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. | -| --repo-root string | [defaulted] The directory where the source git repository is volume-mounted. (default ".") | -| -s, --sha256 string | [conditional] The SHA256 fingerprint for the artifact. Only required if you don't specify '--artifact-type'. | -| -u, --user-data string | [optional] The path to a JSON file containing additional data you would like to attach to this approval. | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# Report that a file type artifact has been approved for deployment. -# The approval is for the last 5 git commits -kosli pipeline approval report FILE.tgz \ - --api-token yourAPIToken \ - --artifact-type file \ - --description "An optional description for the approval" \ - --newest-commit $(git rev-parse HEAD) \ - --oldest-commit $(git rev-parse HEAD~5) \ - --owner yourOrgName \ - --pipeline yourPipelineName - -# Report that an artifact with a provided fingerprint (sha256) has been approved for deployment. -# The approval is for the last 5 git commits -kosli pipeline approval report \ - --api-token yourAPIToken \ - --description "An optional description for the approval" \ - --newest-commit $(git rev-parse HEAD) \ - --oldest-commit $(git rev-parse HEAD~5) \ - --owner yourOrgName \ - --pipeline yourPipelineName \ - --sha256 yourSha256 - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_approval_request.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_approval_request.md deleted file mode 100644 index 197336413..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_approval_request.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: "kosli pipeline approval request" ---- - -## kosli pipeline approval request - -Request an approval of a deployment of an artifact in Kosli. - -### Synopsis - -Request an approval of a deployment of an artifact in Kosli. -The request should be reviewed in Kosli UI.The artifact SHA256 fingerprint is calculated (based on --artifact-type flag) or alternatively it can be provided directly (with --sha256 flag). - -```shell -kosli pipeline approval request [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -t, --artifact-type string | [conditional] The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you don't specify '--sha256' or '--fingerprint'. | -| -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. | -| -h, --help | help for request | -| --newest-commit string | [defaulted] The source commit sha for the newest change in the deployment. (default "HEAD") | -| --oldest-commit string | The source commit sha for the oldest change in the deployment. | -| -p, --pipeline string | The Kosli pipeline 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. | -| --repo-root string | [defaulted] The directory where the source git repository is volume-mounted. (default ".") | -| -s, --sha256 string | [conditional] The SHA256 fingerprint for the artifact. Only required if you don't specify '--artifact-type'. | -| -u, --user-data string | [optional] The path to a JSON file containing additional data you would like to attach to this approval. | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# Request that a file type artifact needs approval. -# The approval is for the last 5 git commits -kosli pipeline approval request FILE.tgz \ - --api-token yourAPIToken \ - --artifact-type file \ - --description "An optional description for the requested approval" \ - --newest-commit $(git rev-parse HEAD) \ - --oldest-commit $(git rev-parse HEAD~5) \ - --owner yourOrgName \ - --pipeline yourPipelineName - -# Request and approval for an artifact with a provided fingerprint (sha256). -# The approval is for the last 5 git commits -kosli pipeline approval request \ - --api-token yourAPIToken \ - --description "An optional description for the requested approval" \ - --newest-commit $(git rev-parse HEAD) \ - --oldest-commit $(git rev-parse HEAD~5) \ - --owner yourOrgName \ - --pipeline yourPipelineName \ - --sha256 yourSha256 - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_creation.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_creation.md deleted file mode 100644 index 19e340b7c..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_creation.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: "kosli pipeline artifact report creation" ---- - -## kosli pipeline artifact report creation - -Report an artifact creation to a Kosli pipeline. - -### Synopsis - -Report an artifact creation to a Kosli pipeline. -The artifact SHA256 fingerprint is calculated (based on --artifact-type flag) or alternatively it can be provided directly (with --sha256 flag). - -```shell -kosli pipeline artifact report creation {IMAGE-NAME | FILE-PATH | DIR-PATH} [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -t, --artifact-type string | [conditional] The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you don't specify '--sha256' or '--fingerprint'. | -| -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, --description string | [optional] The artifact 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. | -| -g, --git-commit string | The git commit from which the artifact was created. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | -| -h, --help | help for creation | -| -p, --pipeline string | The Kosli pipeline 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. | -| --repo-root string | [defaulted] The directory where the source git repository is volume-mounted. (default ".") | -| -s, --sha256 string | [conditional] The SHA256 fingerprint for the artifact. Only required if you don't specify '--artifact-type'. | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# Report to a Kosli pipeline that a file type artifact has been created -kosli pipeline artifact report creation FILE.tgz \ - --api-token yourApiToken \ - --artifact-type file \ - --build-url https://exampleci.com \ - --commit-url https://github.com/YourOrg/YourProject/commit/yourCommitShaThatThisArtifactWasBuiltFrom \ - --git-commit yourCommitShaThatThisArtifactWasBuiltFrom \ - --owner yourOrgName \ - --pipeline yourPipelineName - -# Report to a Kosli pipeline that an artifact with a provided fingerprint (sha256) has been created -kosli pipeline artifact report creation ANOTHER_FILE.txt \ - --api-token yourApiToken \ - --build-url https://exampleci.com \ - --commit-url https://github.com/YourOrg/YourProject/commit/yourCommitShaThatThisArtifactWasBuiltFrom \ - --git-commit yourCommitShaThatThisArtifactWasBuiltFrom \ - --owner yourOrgName \ - --pipeline yourPipelineName \ - --sha256 yourSha256 - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_evidence_bitbucket-pullrequest.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_evidence_bitbucket-pullrequest.md deleted file mode 100644 index 9e308213c..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_evidence_bitbucket-pullrequest.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: "kosli pipeline artifact report evidence bitbucket-pullrequest" ---- - -## kosli pipeline artifact report evidence bitbucket-pullrequest - -Report a Bitbucket pull request evidence for an artifact in a Kosli pipeline. - -### Synopsis - -Report a Bitbucket pull request evidence for an artifact in a Kosli pipeline. -It checks if a pull request exists for the artifact (based on its git commit) and report the pull-request evidence to the artifact in Kosli. -The artifact SHA256 fingerprint is calculated (based on --artifact-type flag) or alternatively it can be provided directly (with --sha256 flag). - -```shell -kosli pipeline artifact report evidence bitbucket-pullrequest [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -t, --artifact-type string | [conditional] The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you don't specify '--sha256' or '--fingerprint'. | -| --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. | -| --bitbucket-workspace string | Bitbucket workspace ID. | -| -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 ). | -| -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. | -| -f, --fingerprint string | [conditional] The SHA256 fingerprint for the artifact. Only required if you don't specify '--artifact-type'. | -| -h, --help | help for bitbucket-pullrequest | -| -n, --name string | The name of the evidence. | -| -p, --pipeline string | The Kosli pipeline 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. | -| --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 this evidence. | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# report a pull request evidence to kosli for a docker image -kosli pipeline artifact report evidence bitbucket-pullrequest yourDockerImageName \ - --artifact-type docker \ - --build-url https://exampleci.com \ - --name yourEvidenceName \ - --pipeline yourPipelineName \ - --bitbucket-username yourBitbucketUsername \ - --bitbucket-password yourBitbucketPassword \ - --bitbucket-workspace yourBitbucketWorkspace \ - --commit yourArtifactGitCommit \ - --repository yourBitbucketGitRepository \ - --owner yourOrgName \ - --api-token yourAPIToken - -# fail if a pull request does not exist for your artifact -kosli pipeline artifact report evidence bitbucket-pullrequest yourDockerImageName \ - --artifact-type docker \ - --build-url https://exampleci.com \ - --name yourEvidenceName \ - --pipeline yourPipelineName \ - --bitbucket-username yourBitbucketUsername \ - --bitbucket-password yourBitbucketPassword \ - --bitbucket-workspace yourBitbucketWorkspace \ - --commit yourArtifactGitCommit \ - --repository yourBitbucketGitRepository \ - --owner yourOrgName \ - --api-token yourAPIToken \ - --assert - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_evidence_generic.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_evidence_generic.md deleted file mode 100644 index 7d4468744..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_evidence_generic.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: "kosli pipeline artifact report evidence generic" ---- - -## kosli pipeline artifact report evidence generic - -Report a generic evidence to an artifact in a Kosli pipeline. - -### Synopsis - -Report a generic evidence to an artifact in a Kosli pipeline. -The artifact SHA256 fingerprint is calculated (based on --artifact-type flag) or alternatively it can be provided directly (with --sha256 flag). - -```shell -kosli pipeline artifact report evidence generic [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -t, --artifact-type string | [conditional] The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you don't specify '--sha256' or '--fingerprint'. | -| -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. (default true) | -| -d, --description string | [optional] The evidence 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. | -| -f, --fingerprint string | [conditional] The SHA256 fingerprint for the artifact. Only required if you don't specify '--artifact-type'. | -| -h, --help | help for generic | -| -n, --name string | The name of the evidence. | -| -p, --pipeline string | The Kosli pipeline 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. | -| -u, --user-data string | [optional] The path to a JSON file containing additional data you would like to attach to this evidence. | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# report a generic evidence about a pre-built docker image: -kosli pipeline artifact report evidence generic yourDockerImageName \ - --api-token yourAPIToken \ - --artifact-type docker \ - --build-url https://exampleci.com \ - --evidence-type yourEvidenceType \ - --owner yourOrgName \ - --pipeline yourPipelineName - -# report a generic evidence about a directory type artifact: -kosli pipeline artifact report evidence generic /path/to/your/dir \ - --api-token yourAPIToken \ - --artifact-type dir \ - --build-url https://exampleci.com \ - --evidence-type yourEvidenceType \ - --owner yourOrgName \ - --pipeline yourPipelineName - -# report a generic evidence about an artifact with a provided fingerprint (sha256) -kosli pipeline artifact report evidence generic \ - --api-token yourAPIToken \ - --build-url https://exampleci.com \ - --evidence-type yourEvidenceType \ - --owner yourOrgName \ - --pipeline yourPipelineName \ - --sha256 yourSha256 - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_evidence_github-pullrequest.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_evidence_github-pullrequest.md deleted file mode 100644 index f5c88883f..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_evidence_github-pullrequest.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: "kosli pipeline artifact report evidence github-pullrequest" ---- - -## kosli pipeline artifact report evidence github-pullrequest - -Report a Github pull request evidence for an artifact in a Kosli pipeline. - -### Synopsis - -Report a Github pull request evidence for an artifact in a Kosli pipeline. -It checks if a pull request exists for the artifact (based on its git commit) and report the pull-request evidence to the artifact in Kosli. -The artifact SHA256 fingerprint is calculated (based on --artifact-type flag) or alternatively it can be provided directly (with --sha256 flag). - -```shell -kosli pipeline artifact report evidence github-pullrequest [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -t, --artifact-type string | [conditional] The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you don't specify '--sha256' or '--fingerprint'. | -| --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 ). | -| -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. | -| -f, --fingerprint string | [conditional] The SHA256 fingerprint for the artifact. Only required if you don't specify '--artifact-type'. | -| --github-base-url string | [optional] GitHub base URL (only needed for GitHub Enterprise installations). | -| --github-org string | Github organization. (defaulted if you are running in GitHub Actions: https://docs.kosli.com/ci-defaults ). | -| --github-token string | Github token. | -| -h, --help | help for github-pullrequest | -| -n, --name string | The name of the evidence. | -| -p, --pipeline string | The Kosli pipeline 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. | -| --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 this evidence. | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# report a pull request evidence to kosli for a docker image -kosli pipeline artifact report evidence github-pullrequest yourDockerImageName \ - --artifact-type docker \ - --build-url https://exampleci.com \ - --name yourEvidenceName \ - --pipeline yourPipelineName \ - --github-token yourGithubToken \ - --github-org yourGithubOrg \ - --commit yourArtifactGitCommit \ - --repository yourGithubGitRepository \ - --owner yourOrgName \ - --api-token yourAPIToken - -# fail if a pull request does not exist for your artifact -kosli pipeline artifact report evidence github-pullrequest yourDockerImageName \ - --artifact-type docker \ - --build-url https://exampleci.com \ - --name yourEvidenceName \ - --pipeline yourPipelineName \ - --github-token yourGithubToken \ - --github-org yourGithubOrg \ - --commit yourArtifactGitCommit \ - --repository yourGithubGitRepository \ - --owner yourOrgName \ - --api-token yourAPIToken \ - --assert - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_evidence_gitlab-mergerequest.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_evidence_gitlab-mergerequest.md deleted file mode 100644 index 057576a72..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_evidence_gitlab-mergerequest.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: "kosli pipeline artifact report evidence gitlab-mergerequest" ---- - -## kosli pipeline artifact report evidence gitlab-mergerequest - -Report a Gitlab merge request evidence for an artifact in a Kosli pipeline. - -### Synopsis - -Report a Gitlab merge request evidence for an artifact in a Kosli pipeline. -It checks if a merge request exists for the artifact (based on its git commit) and report the merge request evidence to the artifact in Kosli. -The artifact SHA256 fingerprint is calculated (based on --artifact-type flag) or alternatively it can be provided directly (with --sha256 flag). - -```shell -kosli pipeline artifact report evidence gitlab-mergerequest [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -t, --artifact-type string | [conditional] The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you don't specify '--sha256' or '--fingerprint'. | -| --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 ). | -| -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. | -| -f, --fingerprint string | [conditional] The SHA256 fingerprint for the artifact. Only required if you don't specify '--artifact-type'. | -| --gitlab-base-url string | [optional] Gitlab base URL (only needed for on-prem Gitlab installations). | -| --gitlab-org string | Gitlab organization. (defaulted if you are running in Gitlab Pipelines: https://docs.kosli.com/ci-defaults ). | -| --gitlab-token string | Gitlab token. | -| -h, --help | help for gitlab-mergerequest | -| -n, --name string | The name of the evidence. | -| -p, --pipeline string | The Kosli pipeline 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. | -| --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 this evidence. | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# report a merge request evidence to kosli for a docker image -kosli pipeline artifact report evidence gitlab-mergerequest yourDockerImageName \ - --artifact-type docker \ - --build-url https://exampleci.com \ - --name yourEvidenceName \ - --pipeline yourPipelineName \ - --gitlab-token yourGitlabToken \ - --gitlab-org yourGitlabOrg \ - --commit yourArtifactGitCommit \ - --repository yourGithubGitRepository \ - --owner yourOrgName \ - --api-token yourAPIToken - -# report a merge request evidence (from an on-prem Gitlab) to kosli for a docker image -kosli pipeline artifact report evidence gitlab-mergerequest yourDockerImageName \ - --artifact-type docker \ - --build-url https://exampleci.com \ - --name yourEvidenceName \ - --pipeline yourPipelineName \ - --gitlab-base-url https://gitlab.example.org \ - --gitlab-token yourGitlabToken \ - --gitlab-org yourGitlabOrg \ - --commit yourArtifactGitCommit \ - --repository yourGithubGitRepository \ - --owner yourOrgName \ - --api-token yourAPIToken - -# fail if a merge request does not exist for your artifact -kosli pipeline artifact report evidence gitlab-mergerequest yourDockerImageName \ - --artifact-type docker \ - --build-url https://exampleci.com \ - --name yourEvidenceName \ - --pipeline yourPipelineName \ - --gitlab-token yourGitlabToken \ - --gitlab-org yourGitlabOrg \ - --commit yourArtifactGitCommit \ - --repository yourGithubGitRepository \ - --owner yourOrgName \ - --api-token yourAPIToken \ - --assert - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_evidence_junit.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_evidence_junit.md deleted file mode 100644 index cd7252ff4..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_evidence_junit.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: "kosli pipeline artifact report evidence junit" ---- - -## kosli pipeline artifact report evidence junit - -Report JUnit test evidence for an artifact in a Kosli pipeline. - -### Synopsis - -Report JUnit test evidence for an artifact in a Kosli pipeline. -The artifact SHA256 fingerprint is calculated (based on --artifact-type flag) or alternatively it can be provided directly (with --fingerprint flag). - -```shell -kosli pipeline artifact report evidence junit [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -t, --artifact-type string | [conditional] The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you don't specify '--sha256' or '--fingerprint'. | -| -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. | -| -f, --fingerprint string | [conditional] The SHA256 fingerprint of the artifact. Only required if you don't specify '--artifact-type'. | -| -h, --help | help for junit | -| -n, --name string | The name of the evidence. | -| -p, --pipeline string | The Kosli pipeline 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. | -| -R, --results-dir string | [defaulted] The path to a folder with JUnit test results. (default ".") | -| -u, --user-data string | [optional] The path to a JSON file containing additional data you would like to attach to this evidence. | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# report JUnit test evidence about a file artifact: -kosli pipeline artifact report evidence junit FILE.tgz \ - --artifact-type file \ - --name yourEvidenceName \ - --pipeline yourPipelineName \ - --build-url https://exampleci.com \ - --api-token yourAPIToken \ - --owner yourOrgName \ - --results-dir yourFolderWithJUnitResults - -# report JUnit test evidence about an artifact using an available Sha256 digest: -kosli pipeline artifact report evidence junit \ - --fingerprint yourSha256 \ - --name yourEvidenceName \ - --pipeline yourPipelineName \ - --build-url https://exampleci.com \ - --api-token yourAPIToken \ - --owner yourOrgName \ - --results-dir yourFolderWithJUnitResults - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_evidence_snyk.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_evidence_snyk.md deleted file mode 100644 index ba33aa6d6..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_evidence_snyk.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: "kosli pipeline artifact report evidence snyk" ---- - -## kosli pipeline artifact report evidence snyk - -Report Snyk vulnerability scan evidence for an artifact in a Kosli pipeline. - -### Synopsis - -Report Snyk vulnerability scan evidence for an artifact in a Kosli pipeline. -The artifact SHA256 fingerprint is calculated (based on --artifact-type flag) or alternatively it can be provided directly (with --fingerprint flag). - -```shell -kosli pipeline artifact report evidence snyk [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -t, --artifact-type string | [conditional] The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you don't specify '--sha256' or '--fingerprint'. | -| -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. | -| -f, --fingerprint string | [conditional] The SHA256 fingerprint of the artifact. Only required if you don't specify '--artifact-type'. | -| -h, --help | help for snyk | -| -n, --name string | The name of the evidence. | -| -p, --pipeline string | The Kosli pipeline 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. | -| -R, --scan-results string | The path to Snyk scan results Json file. | -| -u, --user-data string | [optional] The path to a JSON file containing additional data you would like to attach to this evidence. | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# report Snyk vulnerability scan evidence about a file artifact: -kosli pipeline artifact report evidence snyk FILE.tgz \ - --artifact-type file \ - --name yourEvidenceName \ - --pipeline yourPipelineName \ - --build-url https://exampleci.com \ - --api-token yourAPIToken \ - --owner yourOrgName \ - --scan-results yourSnykJSONScanResults - -# report Snyk vulnerability scan evidence about an artifact using an available Sha256 digest: -kosli pipeline artifact report evidence snyk \ - --fingerprint yourSha256 \ - --name yourEvidenceName \ - --pipeline yourPipelineName \ - --build-url https://exampleci.com \ - --api-token yourAPIToken \ - --owner yourOrgName \ - --scan-results yourSnykJSONScanResults - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_evidence_test.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_evidence_test.md deleted file mode 100644 index 6b93a915d..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_artifact_report_evidence_test.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: "kosli pipeline artifact report evidence test" ---- - -## kosli pipeline artifact report evidence test - -Report a JUnit test evidence to an artifact in a Kosli pipeline. - -### Synopsis - -Report a JUnit test evidence to an artifact in a Kosli pipeline. -The artifact SHA256 fingerprint is calculated (based on --artifact-type flag) or alternatively it can be provided directly (with --sha256 flag). - -```shell -kosli pipeline artifact report evidence test [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -t, --artifact-type string | [conditional] The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you don't specify '--sha256' or '--fingerprint'. | -| -b, --build-url string | The url of CI pipeline that generated the evidence. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | -| -d, --description string | [optional] The evidence 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, --evidence-type string | The type of evidence being reported. | -| -h, --help | help for test | -| -p, --pipeline string | The Kosli pipeline 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. | -| -R, --results-dir string | [defaulted] The path to a folder with JUnit test results. (default "/data/junit/") | -| -s, --sha256 string | [conditional] The SHA256 fingerprint for the artifact. Only required if you don't specify '--artifact-type'. | -| -u, --user-data string | [optional] The path to a JSON file containing additional data you would like to attach to this evidence. | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# report a JUnit test evidence about a file artifact: -kosli pipeline artifact report evidence test FILE.tgz \ - --artifact-type file \ - --evidence-type yourEvidenceType \ - --pipeline yourPipelineName \ - --build-url https://exampleci.com \ - --api-token yourAPIToken \ - --owner yourOrgName \ - --results-dir yourFolderWithJUnitResults - -# report a JUnit test evidence about an artifact using an available Sha256 digest: -kosli pipeline artifact report evidence test \ - --sha256 yourSha256 \ - --evidence-type yourEvidenceType \ - --pipeline yourPipelineName \ - --build-url https://exampleci.com \ - --api-token yourAPIToken \ - --owner yourOrgName \ - --results-dir yourFolderWithJUnitResults - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_declare.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_declare.md deleted file mode 100644 index f8d558666..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_declare.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: "kosli pipeline declare" ---- - -## kosli pipeline declare - -Create or update a Kosli pipeline. - -### Synopsis - -Create or update a Kosli pipeline. -You can provide a JSON pipefile or specify pipeline parameters in flags. -The pipefile contains the pipeline metadata and compliance policy (template). - -```shell -kosli pipeline declare [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| --description string | [optional] The Kosli pipeline 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 declare | -| --pipefile string | [deprecated] The path to the JSON pipefile. | -| --pipeline string | The name of the pipeline to be created or updated. | -| -t, --template strings | [defaulted] The comma-separated list of required compliance controls names. (default [artifact]) | -| --visibility string | [defaulted] The visibility of the Kosli pipeline. Valid visibilities are [public, private]. (default "private") | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# create/update a Kosli pipeline without a pipefile: -kosli pipeline declare \ - --pipeline yourPipelineName \ - --description yourPipelineDescription \ - --visibility private OR public \ - --template artifact,evidence-type1,evidence-type2 \ - --api-token yourAPIToken \ - --owner yourOrgName - -# create/update a Kosli pipeline with a pipefile (this is a legacy way which will be removed in the future): -kosli pipeline declare \ - --pipefile /path/to/pipefile.json \ - --api-token yourAPIToken \ - --owner yourOrgName - -The pipefile format is: -{ - "name": "yourPipelineName", - "description": "yourPipelineDescription", - "visibility": "public or private", - "template": [ - "artifact", - "evidence-type1", - "evidence-type2" - ] -} - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_inspect.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_inspect.md deleted file mode 100644 index 3587e6d63..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_inspect.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "kosli pipeline inspect" ---- - -## kosli pipeline inspect - -Inspect the metadata of a specific pipeline. - -### Synopsis - -Inspect the metadata of a specific pipeline. - -```shell -kosli pipeline inspect PIPELINE-NAME [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -h, --help | help for inspect | -| -o, --output string | [defaulted] The format of the output. Valid formats are: [table, json]. (default "table") | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_ls.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_ls.md deleted file mode 100644 index b07575ee8..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_pipeline_ls.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "kosli pipeline ls" ---- - -## kosli pipeline ls - -List pipelines for an org. - -### Synopsis - -List pipelines for an org. - -```shell -kosli pipeline ls [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -h, --help | help for ls | -| -o, --output string | [defaulted] The format of the output. Valid formats are: [table, json]. (default "table") | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_search.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_search.md deleted file mode 100644 index 4961da46e..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_search.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "kosli search" ---- - -## kosli search - -Search for a git commit or an artifact fingerprint in Kosli. - -### Synopsis - -Search for a git commit or an artifact fingerprint in Kosli. -You can use short git commit or artifact fingerprint shas, but you must provide at least 5 characters. - -```shell -kosli search GIT-COMMIT|FINGERPRINT [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -h, --help | help for search | -| -o, --output string | [defaulted] The format of the output. Valid formats are: [table, json]. (default "table") | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - -### Examples - -```shell - -# Search for a git commit in Kosli -kosli search YOUR_GIT_COMMIT \ - --api-token yourApiToken \ - --owner yourOrgName - -# Search for an artifact fingerprint in Kosli -kosli search YOUR_FINGERPRINT \ - --api-token yourApiToken \ - --owner yourOrgName - -``` - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_status.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_status.md deleted file mode 100644 index 892d3122e..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_status.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "kosli status" ---- - -## kosli status - -Check the status of Kosli server. - -### Synopsis - -Check the status of Kosli server. -The status is logged and the command always exits with 0 exit code. -If you like to assert the Kosli server status, you can use the --assert flag or the "kosli assert status" command. - -```shell -kosli status [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| --assert | [optional] Exit with non-zero code if Kosli server is not responding. | -| -h, --help | help for status | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - diff --git a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_version.md b/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_version.md deleted file mode 100644 index 6ce902c74..000000000 --- a/docs.kosli.com/content/legacy_ref/v0.1.38/kosli_version.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: "kosli version" ---- - -## kosli version - -Print the version of Kosli CLI. - -### Synopsis - -Print the version of Kosli CLI. -The output will look something like this: -version.BuildInfo{Version:"v0.0.1", GitCommit:"fe51cd1e31e6a202cba7dead9552a6d418ded79a", GitTreeState:"clean", GoVersion:"go1.16.3"} - -- Version is the semantic version of the release. -- GitCommit is the SHA for the commit that this version was built from. -- GitTreeState is "clean" if there are no local code changes when this binary was - built, and "dirty" if the binary was built from locally modified code. -- GoVersion is the version of Go that was used to compile Kosli CLI. - - -```shell -kosli version [flags] -``` - -### Flags -| Flag | Description | -| :--- | :--- | -| -h, --help | help for version | -| -s, --short | [optional] Print only the Kosli CLI version number. | - - -### Options 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. | -| -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | -| -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | -| --owner string | The Kosli user or organization. | - - diff --git a/docs.kosli.com/content/legacy_ref/v2.6.10/_index.md b/docs.kosli.com/content/legacy_ref/v2.6.10/_index.md index 81310ffe9..e8a0ff1c3 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.10/_index.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.10/_index.md @@ -1,7 +1,7 @@ --- title: v2.6.10 bookCollapseSection: true -weight: 601 +weight: 602 --- # v2.6.10 diff --git a/docs.kosli.com/content/legacy_ref/v2.6.11/_index.md b/docs.kosli.com/content/legacy_ref/v2.6.11/_index.md index 37b782fb1..63b5f4126 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.11/_index.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.11/_index.md @@ -1,7 +1,7 @@ --- title: v2.6.11 bookCollapseSection: true -weight: 600 +weight: 601 --- # v2.6.11 diff --git a/docs.kosli.com/content/legacy_ref/v2.6.12/_index.md b/docs.kosli.com/content/legacy_ref/v2.6.12/_index.md new file mode 100644 index 000000000..95a4ad266 --- /dev/null +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/_index.md @@ -0,0 +1,7 @@ +--- +title: v2.6.12 +bookCollapseSection: true +weight: 600 +--- + +# v2.6.12 diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli.md similarity index 87% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli.md index 7ad527e6d..4c367e7a3 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli.md @@ -21,7 +21,7 @@ Setting the API token to DRY_RUN sets the --dry-run flag. | :--- | :--- | | -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. | +| --debug | [optional] Print debug logs to stdout. A boolean flag https://docs.kosli.com/faq/#boolean-flags (default false) | | -h, --help | help for kosli | | -H, --host string | [defaulted] The Kosli endpoint. (default "https://app.kosli.com") | | -r, --max-api-retries int | [defaulted] How many times should API calls be retried when the API host is not reachable. (default 3) | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_allow_artifact.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_allow_artifact.md similarity index 94% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_allow_artifact.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_allow_artifact.md index 218425e25..f1a8b0229 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_allow_artifact.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_allow_artifact.md @@ -34,7 +34,7 @@ kosli allow artifact [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_assert_approval.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_assert_approval.md similarity index 95% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_assert_approval.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_assert_approval.md index 38c315bca..421f5c43e 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_assert_approval.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_assert_approval.md @@ -34,7 +34,7 @@ kosli assert approval [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_assert_artifact.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_assert_artifact.md similarity index 95% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_assert_artifact.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_assert_artifact.md index 9e27e5e43..46951e322 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_assert_artifact.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_assert_artifact.md @@ -33,7 +33,7 @@ kosli assert artifact [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_assert_pullrequest_azure.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_assert_pullrequest_azure.md similarity index 93% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_assert_pullrequest_azure.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_assert_pullrequest_azure.md index 60926fc7e..8b30c0306 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_assert_pullrequest_azure.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_assert_pullrequest_azure.md @@ -32,7 +32,7 @@ kosli assert pullrequest azure [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_assert_pullrequest_bitbucket.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_assert_pullrequest_bitbucket.md similarity index 93% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_assert_pullrequest_bitbucket.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_assert_pullrequest_bitbucket.md index 00a168514..46d617387 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_assert_pullrequest_bitbucket.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_assert_pullrequest_bitbucket.md @@ -32,7 +32,7 @@ kosli assert pullrequest bitbucket [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_assert_pullrequest_github.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_assert_pullrequest_github.md similarity index 93% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_assert_pullrequest_github.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_assert_pullrequest_github.md index 2ee84fe1f..2f22eb567 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_assert_pullrequest_github.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_assert_pullrequest_github.md @@ -32,7 +32,7 @@ kosli assert pullrequest github [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_assert_pullrequest_gitlab.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_assert_pullrequest_gitlab.md similarity index 93% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_assert_pullrequest_gitlab.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_assert_pullrequest_gitlab.md index 7ff29fd3a..da22b33fe 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_assert_pullrequest_gitlab.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_assert_pullrequest_gitlab.md @@ -32,7 +32,7 @@ kosli assert pullrequest gitlab [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_assert_snapshot.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_assert_snapshot.md similarity index 92% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_assert_snapshot.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_assert_snapshot.md index 87d62b83e..e6089acef 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_assert_snapshot.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_assert_snapshot.md @@ -38,7 +38,7 @@ kosli assert snapshot ENVIRONMENT-NAME-OR-EXPRESSION [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_assert_status.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_assert_status.md similarity index 85% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_assert_status.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_assert_status.md index b83056b8b..1cdfff287 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_assert_status.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_assert_status.md @@ -25,7 +25,7 @@ kosli assert status [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_completion.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_completion.md similarity index 93% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_completion.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_completion.md index d9a5e7539..958a7ae6b 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_completion.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_completion.md @@ -71,7 +71,7 @@ kosli completion [bash|zsh|fish|powershell] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_create_audit-trail.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_create_audit-trail.md similarity index 92% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_create_audit-trail.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_create_audit-trail.md index 1f63d8ad8..71a715b9b 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_create_audit-trail.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_create_audit-trail.md @@ -31,7 +31,7 @@ kosli create audit-trail AUDIT-TRAIL-NAME [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_create_environment.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_create_environment.md similarity index 90% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_create_environment.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_create_environment.md index 3066e32bd..0895468cb 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_create_environment.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_create_environment.md @@ -27,7 +27,7 @@ kosli create environment ENVIRONMENT-NAME [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_create_flow.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_create_flow.md similarity index 92% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_create_flow.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_create_flow.md index 6129088cf..ecbf0098d 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_create_flow.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_create_flow.md @@ -29,7 +29,7 @@ kosli create flow FLOW-NAME [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_diff_snapshots.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_diff_snapshots.md similarity index 93% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_diff_snapshots.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_diff_snapshots.md index 7defe985b..56353439c 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_diff_snapshots.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_diff_snapshots.md @@ -32,7 +32,7 @@ kosli diff snapshots SNAPPISH_1 SNAPPISH_2 [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_disable_beta.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_disable_beta.md similarity index 85% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_disable_beta.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_disable_beta.md index 8f88c5432..8edaf9df4 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_disable_beta.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_disable_beta.md @@ -26,7 +26,7 @@ kosli disable beta [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_enable_beta.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_enable_beta.md similarity index 85% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_enable_beta.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_enable_beta.md index eff2092e4..d7f2b7ffa 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_enable_beta.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_enable_beta.md @@ -26,7 +26,7 @@ kosli enable beta [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_expect_deployment.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_expect_deployment.md similarity index 92% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_expect_deployment.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_expect_deployment.md index 3172d609d..2d3550052 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_expect_deployment.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_expect_deployment.md @@ -19,7 +19,7 @@ kosli expect deployment [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | :--- | :--- | | -t, --artifact-type string | [conditional] The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you don't specify '--fingerprint'. | | -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 artifact description. | +| -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. | | -e, --environment string | The environment name. | | -x, --exclude strings | [optional] The comma separated list of directories and files to exclude from fingerprinting. Only applicable for --artifact-type dir. | @@ -37,7 +37,7 @@ kosli expect deployment [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_fingerprint.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_fingerprint.md similarity index 94% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_fingerprint.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_fingerprint.md index df7cef9c5..daa398eaf 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_fingerprint.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_fingerprint.md @@ -40,7 +40,7 @@ kosli fingerprint {IMAGE-NAME | FILE-PATH | DIR-PATH} [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_get_approval.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_get_approval.md similarity index 72% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_get_approval.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_get_approval.md index 76864b23b..16f56dc80 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_get_approval.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_get_approval.md @@ -8,18 +8,17 @@ beta: false ## Synopsis Get an approval from a specified flow. -The expected argument is an expression to specify the approval to get. -It has the format [SEPARATOR][INTEGER_REFERENCE] +EXPRESSION can be specified as follows: +- flowName + - the latest approval to flowName, at the time of the request + - e.g., **creator** +- flowName#N + - the Nth approval, counting from 1 + - e.g., **creator#453** +- flowName~N + - the Nth approval behind the latest, at the time of the request + - e.g., **creator~56** -The expression can be specified as follows: -- flowName~ N'th behind the latest approval -- flowName# approval number N -- flowName the latest approval - -Examples of valid expressions are: -- flow (latest approval) -- flow#10 (approval number 10) -- flow~2 (the third latest approval) ```shell kosli get approval EXPRESSION [flags] @@ -37,7 +36,7 @@ kosli get approval EXPRESSION [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_get_artifact.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_get_artifact.md similarity index 93% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_get_artifact.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_get_artifact.md index 5cf64c0c0..bd186d2ad 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_get_artifact.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_get_artifact.md @@ -41,7 +41,7 @@ kosli get artifact EXPRESSION [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_get_audit-trail.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_get_audit-trail.md similarity index 90% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_get_audit-trail.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_get_audit-trail.md index 739996652..08373486e 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_get_audit-trail.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_get_audit-trail.md @@ -28,7 +28,7 @@ kosli get audit-trail AUDIT-TRAIL-NAME [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_get_deployment.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_get_deployment.md similarity index 72% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_get_deployment.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_get_deployment.md index 2c210c60b..89e7c8b8b 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_get_deployment.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_get_deployment.md @@ -8,10 +8,17 @@ beta: false ## Synopsis Get a deployment from a specified flow. -Expression can be specified as follows: -- flowName~ N'th behind the latest deployment -- flowName# deployment number N -- flowName the latest deployment +EXPRESSION can be specified as follows: +- flowName + - the latest deployment to flowName, at the time of the request + - e.g., **dashboard** +- flowName#N + - the Nth deployment, counting from 1 + - e.g., **dashboard#453** +- flowName~N + - the Nth deployment behind the latest, at the time of the request + - e.g., **dashboard~56** + ```shell kosli get deployment EXPRESSION [flags] @@ -29,7 +36,7 @@ kosli get deployment EXPRESSION [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_get_environment.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_get_environment.md similarity index 87% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_get_environment.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_get_environment.md index a00f4fe29..ded2de08e 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_get_environment.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_get_environment.md @@ -25,7 +25,7 @@ kosli get environment ENVIRONMENT-NAME [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_get_flow.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_get_flow.md similarity index 86% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_get_flow.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_get_flow.md index 2564d996d..e2ad303e2 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_get_flow.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_get_flow.md @@ -25,7 +25,7 @@ kosli get flow FLOW-NAME [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_get_snapshot.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_get_snapshot.md similarity index 66% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_get_snapshot.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_get_snapshot.md index 91a169f42..cbe2c6f75 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_get_snapshot.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_get_snapshot.md @@ -7,13 +7,24 @@ beta: false ## Synopsis -Get a specific environment snapshot. -Specify SNAPPISH by: -- environmentName~ N'th behind the latest snapshot -- environmentName# snapshot number N -- environmentName@{YYYY-MM-DDTHH:MM:SS} snapshot at specific moment in time in UTC -- environmentName@{..ago} snapshot at a relative time -- environmentName the latest snapshot +Get a specified environment snapshot. +ENVIRONMENT-NAME-OR-EXPRESSION can be specified as follows: +- environmentName + - the latest snapshot for environmentName, at the time of the request + - e.g., **prod** +- environmentName#N + - the Nth snapshot, counting from 1 + - e.g., **prod#42** +- environmentName~N + - the Nth snapshot behind the latest, at the time of the request + - e.g., **prod~5** +- environmentName@{YYYY-MM-DDTHH:MM:SS} + - the snapshot at specific moment in time in UTC + - e.g., **prod@{2023-10-02T12:00:00}** +- environmentName@{N..ago} + - the snapshot at a time relative to the time of the request + - e.g., **prod@{2.hours.ago}** + ```shell kosli get snapshot ENVIRONMENT-NAME-OR-EXPRESSION [flags] @@ -31,7 +42,7 @@ kosli get snapshot ENVIRONMENT-NAME-OR-EXPRESSION [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_get_workflow.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_get_workflow.md similarity index 91% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_get_workflow.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_get_workflow.md index 0cca14806..62350ceeb 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_get_workflow.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_get_workflow.md @@ -29,7 +29,7 @@ kosli get workflow ID [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_list_approvals.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_list_approvals.md similarity index 92% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_list_approvals.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_list_approvals.md index d2d4e3ab8..0ba8c3c8e 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_list_approvals.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_list_approvals.md @@ -31,7 +31,7 @@ kosli list approvals [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_list_artifacts.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_list_artifacts.md similarity index 92% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_list_artifacts.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_list_artifacts.md index 01279c888..3cd573238 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_list_artifacts.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_list_artifacts.md @@ -30,7 +30,7 @@ kosli list artifacts [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_list_audit-trails.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_list_audit-trails.md similarity index 90% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_list_audit-trails.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_list_audit-trails.md index 723edc0f8..7d7292770 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_list_audit-trails.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_list_audit-trails.md @@ -28,7 +28,7 @@ kosli list audit-trails [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_list_deployments.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_list_deployments.md similarity index 92% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_list_deployments.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_list_deployments.md index f6712e799..46afaa476 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_list_deployments.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_list_deployments.md @@ -31,7 +31,7 @@ kosli list deployments [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_list_environments.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_list_environments.md similarity index 87% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_list_environments.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_list_environments.md index 32d0bf944..0eeb93c9e 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_list_environments.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_list_environments.md @@ -25,7 +25,7 @@ kosli list environments [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_list_flows.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_list_flows.md similarity index 86% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_list_flows.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_list_flows.md index fba6ddcb4..ee87f055b 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_list_flows.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_list_flows.md @@ -25,7 +25,7 @@ kosli list flows [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_list_snapshots.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_list_snapshots.md similarity index 94% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_list_snapshots.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_list_snapshots.md index da95cd7c8..fee93dcac 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_list_snapshots.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_list_snapshots.md @@ -41,7 +41,7 @@ kosli list snapshots ENV_NAME [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_list_workflows.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_list_workflows.md similarity index 91% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_list_workflows.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_list_workflows.md index 308294087..1826227a5 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_list_workflows.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_list_workflows.md @@ -31,7 +31,7 @@ kosli list workflows [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_log_environment.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_log_environment.md similarity index 94% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_log_environment.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_log_environment.md index 3ad9ab025..73b9ed425 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_log_environment.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_log_environment.md @@ -41,7 +41,7 @@ kosli log environment ENV_NAME [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_rename_environment.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_rename_environment.md similarity index 89% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_rename_environment.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_rename_environment.md index 3fb15b676..815fcd94e 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_rename_environment.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_rename_environment.md @@ -27,7 +27,7 @@ kosli rename environment OLD_NAME NEW_NAME [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_approval.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_approval.md similarity index 96% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_approval.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_approval.md index 1bb54ec3d..fc3c2eac2 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_approval.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_approval.md @@ -38,7 +38,7 @@ kosli report approval [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_artifact.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_artifact.md similarity index 96% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_artifact.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_artifact.md index 59ae47137..a71594d17 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_artifact.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_artifact.md @@ -38,7 +38,7 @@ kosli report artifact {IMAGE-NAME | FILE-PATH | DIR-PATH} [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_artifact_generic.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_artifact_generic.md similarity index 95% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_artifact_generic.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_artifact_generic.md index c30ef9758..ccfec1ccc 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_artifact_generic.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_artifact_generic.md @@ -19,7 +19,7 @@ kosli report evidence artifact generic [IMAGE-NAME | FILE-PATH | DIR-PATH] [flag | :--- | :--- | | -t, --artifact-type string | [conditional] The type of the artifact to calculate its SHA256 fingerprint. One of: [docker, file, dir]. Only required if you don't specify '--fingerprint'. | | -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. (default true) | +| -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. | | -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. | @@ -41,7 +41,7 @@ kosli report evidence artifact generic [IMAGE-NAME | FILE-PATH | DIR-PATH] [flag | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_artifact_junit.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_artifact_junit.md similarity index 96% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_artifact_junit.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_artifact_junit.md index 8851eaf42..fbe038b26 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_artifact_junit.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_artifact_junit.md @@ -41,7 +41,7 @@ kosli report evidence artifact junit [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_artifact_pullrequest_azure.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_artifact_pullrequest_azure.md similarity index 97% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_artifact_pullrequest_azure.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_artifact_pullrequest_azure.md index f14b077ff..c72933167 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_artifact_pullrequest_azure.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_artifact_pullrequest_azure.md @@ -45,7 +45,7 @@ kosli report evidence artifact pullrequest azure [IMAGE-NAME | FILE-PATH | DIR-P | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_artifact_pullrequest_bitbucket.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_artifact_pullrequest_bitbucket.md similarity index 97% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_artifact_pullrequest_bitbucket.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_artifact_pullrequest_bitbucket.md index 0f3800852..4d12130ff 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_artifact_pullrequest_bitbucket.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_artifact_pullrequest_bitbucket.md @@ -45,7 +45,7 @@ kosli report evidence artifact pullrequest bitbucket [IMAGE-NAME | FILE-PATH | D | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_artifact_pullrequest_github.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_artifact_pullrequest_github.md similarity index 97% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_artifact_pullrequest_github.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_artifact_pullrequest_github.md index fe4688145..344bd9645 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_artifact_pullrequest_github.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_artifact_pullrequest_github.md @@ -45,7 +45,7 @@ kosli report evidence artifact pullrequest github [IMAGE-NAME | FILE-PATH | DIR- | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_artifact_pullrequest_gitlab.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_artifact_pullrequest_gitlab.md similarity index 97% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_artifact_pullrequest_gitlab.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_artifact_pullrequest_gitlab.md index 8cab554ef..0428e1958 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_artifact_pullrequest_gitlab.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_artifact_pullrequest_gitlab.md @@ -45,7 +45,7 @@ kosli report evidence artifact pullrequest gitlab [IMAGE-NAME | FILE-PATH | DIR- | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_artifact_snyk.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_artifact_snyk.md similarity index 96% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_artifact_snyk.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_artifact_snyk.md index d0f521a1a..230489424 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_artifact_snyk.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_artifact_snyk.md @@ -41,7 +41,7 @@ kosli report evidence artifact snyk [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_commit_generic.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_commit_generic.md similarity index 93% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_commit_generic.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_commit_generic.md index fd7e86422..b2c879b58 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_commit_generic.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_commit_generic.md @@ -18,7 +18,7 @@ kosli report evidence commit generic [flags] | :--- | :--- | | -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 verify and given evidence. (defaulted in some CIs: https://docs.kosli.com/ci-defaults ). | -| -C, --compliant | [defaulted] Whether the evidence is compliant or not. | +| -C, --compliant | [defaulted] Whether the evidence is compliant or not. A boolean flag https://docs.kosli.com/faq/#boolean-flags | | -d, --description string | [optional] The evidence 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. | | --evidence-fingerprint string | [optional] The SHA256 fingerprint of the evidence file or dir. | @@ -35,7 +35,7 @@ kosli report evidence commit generic [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_commit_jira.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_commit_jira.md similarity index 96% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_commit_jira.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_commit_jira.md index 005b57fef..0e74b8c94 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_commit_jira.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_commit_jira.md @@ -49,7 +49,7 @@ kosli report evidence commit jira [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_commit_junit.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_commit_junit.md similarity index 95% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_commit_junit.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_commit_junit.md index c8537f3ca..61fb16c73 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_commit_junit.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_commit_junit.md @@ -36,7 +36,7 @@ kosli report evidence commit junit [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_commit_pullrequest_azure.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_commit_pullrequest_azure.md similarity index 96% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_commit_pullrequest_azure.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_commit_pullrequest_azure.md index 39ff4af12..ea7860505 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_commit_pullrequest_azure.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_commit_pullrequest_azure.md @@ -39,7 +39,7 @@ kosli report evidence commit pullrequest azure [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_commit_pullrequest_bitbucket.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_commit_pullrequest_bitbucket.md similarity index 96% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_commit_pullrequest_bitbucket.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_commit_pullrequest_bitbucket.md index 2b0828d66..fae699cbe 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_commit_pullrequest_bitbucket.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_commit_pullrequest_bitbucket.md @@ -38,7 +38,7 @@ kosli report evidence commit pullrequest bitbucket [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_commit_pullrequest_github.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_commit_pullrequest_github.md similarity index 96% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_commit_pullrequest_github.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_commit_pullrequest_github.md index 5f2c8e312..02aa202f1 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_commit_pullrequest_github.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_commit_pullrequest_github.md @@ -39,7 +39,7 @@ kosli report evidence commit pullrequest github [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_commit_pullrequest_gitlab.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_commit_pullrequest_gitlab.md similarity index 96% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_commit_pullrequest_gitlab.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_commit_pullrequest_gitlab.md index 9b3155d4b..d2ed3e5ea 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_commit_pullrequest_gitlab.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_commit_pullrequest_gitlab.md @@ -38,7 +38,7 @@ kosli report evidence commit pullrequest gitlab [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_commit_snyk.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_commit_snyk.md similarity index 95% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_commit_snyk.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_commit_snyk.md index 33314add0..edf4882b3 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_commit_snyk.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_commit_snyk.md @@ -36,7 +36,7 @@ kosli report evidence commit snyk [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_workflow.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_workflow.md similarity index 94% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_workflow.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_workflow.md index f4ef06930..79c6bfab7 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_evidence_workflow.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_evidence_workflow.md @@ -35,7 +35,7 @@ kosli report evidence workflow [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_workflow.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_workflow.md similarity index 86% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_workflow.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_workflow.md index 842f45d91..8aad0223d 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_report_workflow.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_report_workflow.md @@ -20,6 +20,7 @@ kosli report workflow [flags] | Flag | Description | | :--- | :--- | | --audit-trail string | The Kosli audit trail name. | +| --description string | [optional] The Kosli Workflow 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 workflow | | --id string | The ID of the workflow. | @@ -30,7 +31,7 @@ kosli report workflow [flags] | :--- | :--- | | -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. | +| --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") | | -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. | @@ -43,6 +44,7 @@ kosli report workflow [flags] # Report to a Kosli audit-trail that a workflow has been created kosli report workflow \ --audit-trail auditTrailName \ + --description yourWorkflowDescription \ --api-token yourAPIToken \ --id yourID \ --org yourOrgName diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_request_approval.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_request_approval.md similarity index 96% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_request_approval.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_request_approval.md index d5e678b07..9f8f58f16 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_request_approval.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_request_approval.md @@ -39,7 +39,7 @@ kosli request approval [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_search.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_search.md similarity index 90% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_search.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_search.md index 4eaa3c788..d483c8da8 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_search.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_search.md @@ -26,7 +26,7 @@ kosli search {GIT-COMMIT | FINGERPRINT} [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_snapshot_docker.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_snapshot_docker.md similarity index 90% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_snapshot_docker.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_snapshot_docker.md index c45781e8f..4183f3309 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_snapshot_docker.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_snapshot_docker.md @@ -28,7 +28,7 @@ kosli snapshot docker ENVIRONMENT-NAME [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_snapshot_ecs.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_snapshot_ecs.md similarity index 95% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_snapshot_ecs.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_snapshot_ecs.md index 6ecd6ebcc..8d00c7247 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_snapshot_ecs.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_snapshot_ecs.md @@ -40,7 +40,7 @@ kosli snapshot ecs ENVIRONMENT-NAME [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_snapshot_k8s.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_snapshot_k8s.md similarity index 95% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_snapshot_k8s.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_snapshot_k8s.md index c5e84ad51..6c3ae1cd3 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_snapshot_k8s.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_snapshot_k8s.md @@ -30,7 +30,7 @@ kosli snapshot k8s ENVIRONMENT-NAME [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_snapshot_lambda.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_snapshot_lambda.md similarity index 96% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_snapshot_lambda.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_snapshot_lambda.md index 9eb73f823..7f9659e46 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_snapshot_lambda.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_snapshot_lambda.md @@ -39,7 +39,7 @@ kosli snapshot lambda ENVIRONMENT-NAME [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_snapshot_s3.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_snapshot_s3.md similarity index 94% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_snapshot_s3.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_snapshot_s3.md index 15ba2de01..f32640df4 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_snapshot_s3.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_snapshot_s3.md @@ -38,7 +38,7 @@ kosli snapshot s3 ENVIRONMENT-NAME [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_snapshot_server.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_snapshot_server.md similarity index 94% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_snapshot_server.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_snapshot_server.md index c90193133..a217a9e04 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_snapshot_server.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_snapshot_server.md @@ -34,7 +34,7 @@ kosli snapshot server ENVIRONMENT-NAME [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_status.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_status.md similarity index 88% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_status.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_status.md index 8951c2bb7..62db610f1 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_status.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_status.md @@ -27,7 +27,7 @@ kosli status [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_version.md b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_version.md similarity index 90% rename from docs.kosli.com/content/legacy_ref/v2.6.7/kosli_version.md rename to docs.kosli.com/content/legacy_ref/v2.6.12/kosli_version.md index beacca4e1..69601f82d 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/kosli_version.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.12/kosli_version.md @@ -34,7 +34,7 @@ kosli version [flags] | :--- | :--- | | -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. | +| --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") | | -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. | diff --git a/docs.kosli.com/content/legacy_ref/v2.6.7/_index.md b/docs.kosli.com/content/legacy_ref/v2.6.7/_index.md deleted file mode 100644 index 28d1926f7..000000000 --- a/docs.kosli.com/content/legacy_ref/v2.6.7/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: v2.6.7 -bookCollapseSection: true -weight: 604 ---- - -# v2.6.7 diff --git a/docs.kosli.com/content/legacy_ref/v2.6.8/_index.md b/docs.kosli.com/content/legacy_ref/v2.6.8/_index.md index e16f8c6e9..0eb377258 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.8/_index.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.8/_index.md @@ -1,7 +1,7 @@ --- title: v2.6.8 bookCollapseSection: true -weight: 603 +weight: 604 --- # v2.6.8 diff --git a/docs.kosli.com/content/legacy_ref/v2.6.9/_index.md b/docs.kosli.com/content/legacy_ref/v2.6.9/_index.md index e891eb139..5ccc29464 100644 --- a/docs.kosli.com/content/legacy_ref/v2.6.9/_index.md +++ b/docs.kosli.com/content/legacy_ref/v2.6.9/_index.md @@ -1,7 +1,7 @@ --- title: v2.6.9 bookCollapseSection: true -weight: 602 +weight: 603 --- # v2.6.9