From aff62895c6b61989821adeaabd71ad4b735a0baf Mon Sep 17 00:00:00 2001 From: kurtosisbot <89932784+kurtosisbot@users.noreply.github.com> Date: Mon, 17 Jul 2023 11:52:40 -0400 Subject: [PATCH] chore(main): release 0.80.9 (#887) :robot: I have created a release *beep* *boop* --- ## [0.80.9](https://github.com/kurtosis-tech/kurtosis/compare/0.80.8...0.80.9) (2023-07-17) ### Features * added a command that opens the Kurtosis Web UI ([#870](https://github.com/kurtosis-tech/kurtosis/issues/870)) ([5098969](https://github.com/kurtosis-tech/kurtosis/commit/509896934656161002d674fa7c61ccd32c6f899d)) * allow for relative imports from packages ([#891](https://github.com/kurtosis-tech/kurtosis/issues/891)) ([42bedab](https://github.com/kurtosis-tech/kurtosis/commit/42bedab9d45e4988f019dea7ccb2985f058e8199)) * Autocomplete file artifact name on download ([#910](https://github.com/kurtosis-tech/kurtosis/issues/910)) ([2cedd08](https://github.com/kurtosis-tech/kurtosis/commit/2cedd0802a8595c3b299cb844fb42e3495991114)) * Make output directory optional for files download ([#909](https://github.com/kurtosis-tech/kurtosis/issues/909)) ([2543d9a](https://github.com/kurtosis-tech/kurtosis/commit/2543d9ad9c68b86c1c1f09137ca60ddfce785b22)) * Starlark package arguments will be parsed as a deep Struct when `"_kurtosis_parser": "struct"` is passed in the arguments JSON ([#884](https://github.com/kurtosis-tech/kurtosis/issues/884)) ([39ec8c2](https://github.com/kurtosis-tech/kurtosis/commit/39ec8c2d4a867420a76119523eb302dc652adb9b)) ### Bug Fixes * fixed the log and file artifact issue ([#890](https://github.com/kurtosis-tech/kurtosis/issues/890)) ([7f7fe7b](https://github.com/kurtosis-tech/kurtosis/commit/7f7fe7b2d5dc91ddaa8b088129c5be8de0d9f396)) * pinned go version to 1.19.10 for now ([#907](https://github.com/kurtosis-tech/kurtosis/issues/907)) ([847a37c](https://github.com/kurtosis-tech/kurtosis/commit/847a37c756b50588a567459956f49fcd26d99c28)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). --------- Co-authored-by: kurtosisbot --- CHANGELOG.md | 18 ++++ LICENSE.md | 4 +- .../kurtosis_version/kurtosis_version.go | 2 +- api/rust/Cargo.toml | 2 +- api/typescript/package.json | 2 +- .../src/kurtosis_version/kurtosis_version.ts | 2 +- .../best-practices.md | 0 .../changelog.md | 60 ++++++++++++++ .../cli-reference/analytics-disable.md | 0 .../cli-reference/analytics-enable.md | 0 .../cli-reference/analytics-id.md | 0 .../cli-reference/clean.md | 0 .../cli-reference/cluster-get.md | 0 .../cli-reference/cluster-ls.md | 0 .../cli-reference/cluster-set.md | 0 .../cli-reference/completion.md | 0 .../cli-reference/config-path.md | 0 .../cli-reference/discord.md | 0 .../cli-reference/docs.md | 0 .../cli-reference/dump.md | 0 .../cli-reference/enclave-add.md | 0 .../cli-reference/enclave-dump.md | 0 .../cli-reference/enclave-inspect.md | 0 .../cli-reference/enclave-ls.md | 0 .../cli-reference/enclave-rm.md | 0 .../cli-reference/enclave-stop.md | 0 .../cli-reference/engine-logs.md | 0 .../cli-reference/engine-restart.md | 0 .../cli-reference/engine-start.md | 0 .../cli-reference/engine-status.md | 0 .../cli-reference/engine-stop.md | 0 .../cli-reference/feedback.md | 0 .../cli-reference/files-download.md | 0 .../cli-reference/files-rendertemplate.md | 0 .../cli-reference/files-storeservice.md | 0 .../cli-reference/files-storeweb.md | 0 .../cli-reference/files-upload.md | 0 .../cli-reference/index.md | 0 .../cli-reference/port-print.md | 0 .../cli-reference/run.md} | 22 ++++- .../cli-reference/service-add.md | 0 .../cli-reference/service-delete.md | 0 .../cli-reference/service-exec.md | 0 .../cli-reference/service-logs.md | 0 .../cli-reference/service-shell.md | 0 .../cli-reference/service-start.md | 0 .../cli-reference/service-stop.md | 0 .../cli-reference/twitter.md | 0 .../cli-reference/version.md | 0 .../version-0.80.9/cli-reference/web.md | 11 +++ .../concepts-reference/args.md | 10 +-- .../concepts-reference/enclaves.md | 0 .../concepts-reference/files-artifacts.md | 0 .../concepts-reference/future-references.md | 0 .../concepts-reference/glossary.md | 0 .../concepts-reference/idempotent-runs.md | 20 +++++ .../concepts-reference/kurtosis-yml.md | 0 .../concepts-reference/locators.md | 31 ++++++- .../concepts-reference/multi-phase-runs.md | 0 .../concepts-reference/packages.md | 2 +- .../concepts-reference/plan.md | 0 .../concepts-reference/resource-identifier.md | 0 .../concepts-reference/starlark.md | 0 .../concepts-reference/subnetworks.md | 0 .../explanations/architecture.md | 0 .../how-do-idempotent-runs-work.md | 82 +++++++++++++++++++ .../how-do-kurtosis-imports-work.md | 0 .../explanations/metrics-philosophy.md | 0 .../public-and-private-ips-and-ports.md | 0 .../reusable-environment-definitions.md | 0 .../explanations/why-kurtosis-starlark.md | 0 .../explanations/why-multi-phase-runs.md | 0 .../explanations/why-we-built-kurtosis.md | 0 .../guides/adding-command-line-completion.md | 0 .../guides/how-to-local-eth-testnet.md | 6 +- .../guides/how-to-parameterize-cassandra.md | 0 .../guides/installing-historical-versions.md | 0 .../guides/installing-the-cli.md | 0 .../guides/running-in-ci.md | 0 .../guides/running-in-k8s.md | 19 +++-- .../guides/simulating-networking-failure.md | 0 .../guides/upgrading-the-cli.md | 0 .../home.md | 2 +- .../package-index.md | 0 .../quickstart.md | 2 +- .../{version-0.80.4 => version-0.80.9}/sdk.md | 0 .../starlark-reference/args.md | 0 .../starlark-reference/connection-config.md | 0 .../starlark-reference/exec-recipe.md | 0 .../get-http-request-recipe.md | 0 .../starlark-reference/import-module.md | 0 .../starlark-reference/index.md | 0 .../starlark-reference/kurtosis.md | 0 .../normal-packet-delay-distribution.md | 0 .../starlark-reference/plan.md | 8 +- .../starlark-reference/port-spec.md | 0 .../post-http-request-recipe.md | 0 .../starlark-reference/read-file.md | 0 .../starlark-reference/ready-condition.md | 0 .../starlark-reference/service-config.md | 0 .../starlark-reference/service.md | 0 .../starlark-reference/standard-library.md | 0 .../uniform-packet-delay-distribution.md | 0 .../update-service-config.md | 0 ...bars.json => version-0.80.9-sidebars.json} | 0 docs/versions.json | 2 +- version.txt | 2 +- 107 files changed, 270 insertions(+), 39 deletions(-) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/best-practices.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/changelog.md (93%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/analytics-disable.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/analytics-enable.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/analytics-id.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/clean.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/cluster-get.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/cluster-ls.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/cluster-set.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/completion.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/config-path.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/discord.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/docs.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/dump.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/enclave-add.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/enclave-dump.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/enclave-inspect.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/enclave-ls.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/enclave-rm.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/enclave-stop.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/engine-logs.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/engine-restart.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/engine-start.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/engine-status.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/engine-stop.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/feedback.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/files-download.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/files-rendertemplate.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/files-storeservice.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/files-storeweb.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/files-upload.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/index.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/port-print.md (100%) rename docs/versioned_docs/{version-0.80.4/cli-reference/run-starlark.md => version-0.80.9/cli-reference/run.md} (74%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/service-add.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/service-delete.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/service-exec.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/service-logs.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/service-shell.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/service-start.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/service-stop.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/twitter.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/cli-reference/version.md (100%) create mode 100644 docs/versioned_docs/version-0.80.9/cli-reference/web.md rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/concepts-reference/args.md (67%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/concepts-reference/enclaves.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/concepts-reference/files-artifacts.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/concepts-reference/future-references.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/concepts-reference/glossary.md (100%) create mode 100644 docs/versioned_docs/version-0.80.9/concepts-reference/idempotent-runs.md rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/concepts-reference/kurtosis-yml.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/concepts-reference/locators.md (75%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/concepts-reference/multi-phase-runs.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/concepts-reference/packages.md (99%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/concepts-reference/plan.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/concepts-reference/resource-identifier.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/concepts-reference/starlark.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/concepts-reference/subnetworks.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/explanations/architecture.md (100%) create mode 100644 docs/versioned_docs/version-0.80.9/explanations/how-do-idempotent-runs-work.md rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/explanations/how-do-kurtosis-imports-work.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/explanations/metrics-philosophy.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/explanations/public-and-private-ips-and-ports.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/explanations/reusable-environment-definitions.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/explanations/why-kurtosis-starlark.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/explanations/why-multi-phase-runs.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/explanations/why-we-built-kurtosis.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/guides/adding-command-line-completion.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/guides/how-to-local-eth-testnet.md (96%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/guides/how-to-parameterize-cassandra.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/guides/installing-historical-versions.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/guides/installing-the-cli.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/guides/running-in-ci.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/guides/running-in-k8s.md (62%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/guides/simulating-networking-failure.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/guides/upgrading-the-cli.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/home.md (98%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/package-index.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/quickstart.md (99%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/sdk.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/starlark-reference/args.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/starlark-reference/connection-config.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/starlark-reference/exec-recipe.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/starlark-reference/get-http-request-recipe.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/starlark-reference/import-module.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/starlark-reference/index.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/starlark-reference/kurtosis.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/starlark-reference/normal-packet-delay-distribution.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/starlark-reference/plan.md (98%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/starlark-reference/port-spec.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/starlark-reference/post-http-request-recipe.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/starlark-reference/read-file.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/starlark-reference/ready-condition.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/starlark-reference/service-config.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/starlark-reference/service.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/starlark-reference/standard-library.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/starlark-reference/uniform-packet-delay-distribution.md (100%) rename docs/versioned_docs/{version-0.80.4 => version-0.80.9}/starlark-reference/update-service-config.md (100%) rename docs/versioned_sidebars/{version-0.80.4-sidebars.json => version-0.80.9-sidebars.json} (100%) diff --git a/CHANGELOG.md b/CHANGELOG.md index 962b9c4498..4c293051ae 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,23 @@ # Changelog +## [0.80.9](https://github.com/kurtosis-tech/kurtosis/compare/0.80.8...0.80.9) (2023-07-17) + + +### Features + +* added a command that opens the Kurtosis Web UI ([#870](https://github.com/kurtosis-tech/kurtosis/issues/870)) ([5098969](https://github.com/kurtosis-tech/kurtosis/commit/509896934656161002d674fa7c61ccd32c6f899d)) +* allow for relative imports from packages ([#891](https://github.com/kurtosis-tech/kurtosis/issues/891)) ([42bedab](https://github.com/kurtosis-tech/kurtosis/commit/42bedab9d45e4988f019dea7ccb2985f058e8199)) +* Autocomplete file artifact name on download ([#910](https://github.com/kurtosis-tech/kurtosis/issues/910)) ([2cedd08](https://github.com/kurtosis-tech/kurtosis/commit/2cedd0802a8595c3b299cb844fb42e3495991114)) +* Make output directory optional for files download ([#909](https://github.com/kurtosis-tech/kurtosis/issues/909)) ([2543d9a](https://github.com/kurtosis-tech/kurtosis/commit/2543d9ad9c68b86c1c1f09137ca60ddfce785b22)) +* Starlark package arguments will be parsed as a deep Struct when `"_kurtosis_parser": "struct"` is passed in the arguments JSON ([#884](https://github.com/kurtosis-tech/kurtosis/issues/884)) ([39ec8c2](https://github.com/kurtosis-tech/kurtosis/commit/39ec8c2d4a867420a76119523eb302dc652adb9b)) +* updated golang api sdk to 1.19 ([#908](https://github.com/kurtosis-tech/kurtosis/issues/908)) ([fabbb1c](https://github.com/kurtosis-tech/kurtosis/commit/fabbb1cde6b827ef2255bf184356b2f8a3ba9fbf)) + + +### Bug Fixes + +* fixed the log and file artifact issue ([#890](https://github.com/kurtosis-tech/kurtosis/issues/890)) ([7f7fe7b](https://github.com/kurtosis-tech/kurtosis/commit/7f7fe7b2d5dc91ddaa8b088129c5be8de0d9f396)) +* pinned go version to 1.19.10 for now ([#907](https://github.com/kurtosis-tech/kurtosis/issues/907)) ([847a37c](https://github.com/kurtosis-tech/kurtosis/commit/847a37c756b50588a567459956f49fcd26d99c28)) + ## [0.80.8](https://github.com/kurtosis-tech/kurtosis/compare/0.80.7...0.80.8) (2023-07-11) diff --git a/LICENSE.md b/LICENSE.md index cfe8801cae..6482c4b775 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -3,7 +3,7 @@ Business Source License 1.1 Parameters Licensor: Kurtosis Technologies, Inc. -Licensed Work: Kurtosis 0.80.8 +Licensed Work: Kurtosis 0.80.9 The Licensed Work is (c) 2023 Kurtosis Technologies, Inc. Additional Use Grant: You may make use of the Licensed Work, provided that you may not use the Licensed Work for an Environment Orchestration Service. @@ -12,7 +12,7 @@ you may not use the Licensed Work for an Environment Orchestration Service. allows third parties (other than your employees and contractors) to create distributed system environments. -Change Date: 2027-07-11 +Change Date: 2027-07-17 Change License: AGPLv3 (GNU Affero General Public License Version 3) diff --git a/api/golang/kurtosis_version/kurtosis_version.go b/api/golang/kurtosis_version/kurtosis_version.go index 121e40e34f..c040a84a60 100644 --- a/api/golang/kurtosis_version/kurtosis_version.go +++ b/api/golang/kurtosis_version/kurtosis_version.go @@ -9,6 +9,6 @@ const ( // !!!!!!!!!!! DO NOT UPDATE! WILL BE MANUALLY UPDATED DURING THE RELEASE PROCESS !!!!!!!!!!!!!!!!!!!!!! // This is necessary so that Kurt Core consumers will know if they're compatible with the currently-running // API container - KurtosisVersion = "0.80.8" + KurtosisVersion = "0.80.9" // !!!!!!!!!!! DO NOT UPDATE! WILL BE MANUALLY UPDATED DURING THE RELEASE PROCESS !!!!!!!!!!!!!!!!!!!!!! ) diff --git a/api/rust/Cargo.toml b/api/rust/Cargo.toml index 347638bc17..820a7e6d46 100644 --- a/api/rust/Cargo.toml +++ b/api/rust/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "kurtosis-sdk" -version = "0.80.8" +version = "0.80.9" license = "BUSL-1.1" description = "Rust SDK for Kurtosis" edition = "2021" diff --git a/api/typescript/package.json b/api/typescript/package.json index 58964c76a5..b78d4473b0 100644 --- a/api/typescript/package.json +++ b/api/typescript/package.json @@ -1,7 +1,7 @@ { "name": "kurtosis-sdk", "//": "NOTE: DO NOT UPDATE THIS VERSION MANUALLY - IT WILL BE UPDATED DURING THE RELEASE PROCESS!", - "version": "0.80.8", + "version": "0.80.9", "main": "./build/index", "description": "This repo contains a Typescript client for communicating with the Kurtosis Engine server, which is responsible for creating, managing and destroying Kurtosis Enclaves.", "types": "./build/index", diff --git a/api/typescript/src/kurtosis_version/kurtosis_version.ts b/api/typescript/src/kurtosis_version/kurtosis_version.ts index c18cd5f63e..48537443a1 100644 --- a/api/typescript/src/kurtosis_version/kurtosis_version.ts +++ b/api/typescript/src/kurtosis_version/kurtosis_version.ts @@ -1,5 +1,5 @@ // !!!!!!!!!!! DO NOT UPDATE! WILL BE MANUALLY UPDATED DURING THE RELEASE PROCESS !!!!!!!!!!!!!!!!!!!!!! // This is necessary so that Kurt Core consumers (e.g. modules) will know if they're compatible with the currently-running // API container -export const KURTOSIS_VERSION: string = "0.80.8" +export const KURTOSIS_VERSION: string = "0.80.9" // !!!!!!!!!!! DO NOT UPDATE! WILL BE MANUALLY UPDATED DURING THE RELEASE PROCESS !!!!!!!!!!!!!!!!!!!!!! diff --git a/docs/versioned_docs/version-0.80.4/best-practices.md b/docs/versioned_docs/version-0.80.9/best-practices.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/best-practices.md rename to docs/versioned_docs/version-0.80.9/best-practices.md diff --git a/docs/versioned_docs/version-0.80.4/changelog.md b/docs/versioned_docs/version-0.80.9/changelog.md similarity index 93% rename from docs/versioned_docs/version-0.80.4/changelog.md rename to docs/versioned_docs/version-0.80.9/changelog.md index dbf449349f..4c293051ae 100644 --- a/docs/versioned_docs/version-0.80.4/changelog.md +++ b/docs/versioned_docs/version-0.80.9/changelog.md @@ -1,5 +1,65 @@ # Changelog +## [0.80.9](https://github.com/kurtosis-tech/kurtosis/compare/0.80.8...0.80.9) (2023-07-17) + + +### Features + +* added a command that opens the Kurtosis Web UI ([#870](https://github.com/kurtosis-tech/kurtosis/issues/870)) ([5098969](https://github.com/kurtosis-tech/kurtosis/commit/509896934656161002d674fa7c61ccd32c6f899d)) +* allow for relative imports from packages ([#891](https://github.com/kurtosis-tech/kurtosis/issues/891)) ([42bedab](https://github.com/kurtosis-tech/kurtosis/commit/42bedab9d45e4988f019dea7ccb2985f058e8199)) +* Autocomplete file artifact name on download ([#910](https://github.com/kurtosis-tech/kurtosis/issues/910)) ([2cedd08](https://github.com/kurtosis-tech/kurtosis/commit/2cedd0802a8595c3b299cb844fb42e3495991114)) +* Make output directory optional for files download ([#909](https://github.com/kurtosis-tech/kurtosis/issues/909)) ([2543d9a](https://github.com/kurtosis-tech/kurtosis/commit/2543d9ad9c68b86c1c1f09137ca60ddfce785b22)) +* Starlark package arguments will be parsed as a deep Struct when `"_kurtosis_parser": "struct"` is passed in the arguments JSON ([#884](https://github.com/kurtosis-tech/kurtosis/issues/884)) ([39ec8c2](https://github.com/kurtosis-tech/kurtosis/commit/39ec8c2d4a867420a76119523eb302dc652adb9b)) +* updated golang api sdk to 1.19 ([#908](https://github.com/kurtosis-tech/kurtosis/issues/908)) ([fabbb1c](https://github.com/kurtosis-tech/kurtosis/commit/fabbb1cde6b827ef2255bf184356b2f8a3ba9fbf)) + + +### Bug Fixes + +* fixed the log and file artifact issue ([#890](https://github.com/kurtosis-tech/kurtosis/issues/890)) ([7f7fe7b](https://github.com/kurtosis-tech/kurtosis/commit/7f7fe7b2d5dc91ddaa8b088129c5be8de0d9f396)) +* pinned go version to 1.19.10 for now ([#907](https://github.com/kurtosis-tech/kurtosis/issues/907)) ([847a37c](https://github.com/kurtosis-tech/kurtosis/commit/847a37c756b50588a567459956f49fcd26d99c28)) + +## [0.80.8](https://github.com/kurtosis-tech/kurtosis/compare/0.80.7...0.80.8) (2023-07-11) + + +### Features + +* auto assign docs issue to karla ([#834](https://github.com/kurtosis-tech/kurtosis/issues/834)) ([7d0a245](https://github.com/kurtosis-tech/kurtosis/commit/7d0a245fcac4043ab5b780248080b4832b1b0cfe)) +* exposing kurtosis frontend v0 ([#833](https://github.com/kurtosis-tech/kurtosis/issues/833)) ([110e910](https://github.com/kurtosis-tech/kurtosis/commit/110e9100ddc69244e7c317ab1e979e15de9f8863)) +* Make Run also accept argument other than args dict ([#859](https://github.com/kurtosis-tech/kurtosis/issues/859)) ([9fce411](https://github.com/kurtosis-tech/kurtosis/commit/9fce4112764dfdb135e066e2f54b954f79664b50)) + + +### Bug Fixes + +* fixed the output for port print ([#816](https://github.com/kurtosis-tech/kurtosis/issues/816)) ([ede32e7](https://github.com/kurtosis-tech/kurtosis/commit/ede32e795b77387d46ba49e37a6ccc0947fba79a)) + +## [0.80.7](https://github.com/kurtosis-tech/kurtosis/compare/0.80.6...0.80.7) (2023-07-05) + + +### Bug Fixes + +* Remove existing package directory if it already exists in APIC ([#818](https://github.com/kurtosis-tech/kurtosis/issues/818)) ([4027485](https://github.com/kurtosis-tech/kurtosis/commit/4027485d20917729eb1271387be1317af89ff025)) + +## [0.80.6](https://github.com/kurtosis-tech/kurtosis/compare/0.80.5...0.80.6) (2023-07-04) + + +### Features + +* Invert USE_INSTRUCTIONS_CACHING feature flag ([#800](https://github.com/kurtosis-tech/kurtosis/issues/800)) ([9a358db](https://github.com/kurtosis-tech/kurtosis/commit/9a358db49d4d222db4c45de62c70e190c6fa7c12)) + + +### Bug Fixes + +* fallback to the amd64 image if there's a failure for arm64 image not existing ([#814](https://github.com/kurtosis-tech/kurtosis/issues/814)) ([9cc1033](https://github.com/kurtosis-tech/kurtosis/commit/9cc10332fd67dbe060b883296c7efe5284130b12)) + +## [0.80.5](https://github.com/kurtosis-tech/kurtosis/compare/0.80.4...0.80.5) (2023-06-30) + + +### Bug Fixes + +* Fix TS proto bindings ([#797](https://github.com/kurtosis-tech/kurtosis/issues/797)) ([7958dba](https://github.com/kurtosis-tech/kurtosis/commit/7958dba5cec3dfb09eb69f24785d33dbd94051d6)) +* make dry run return the right return value ([#795](https://github.com/kurtosis-tech/kurtosis/issues/795)) ([be5f6e7](https://github.com/kurtosis-tech/kurtosis/commit/be5f6e75229a3887dc84c7a139aebe84b09fc77d)) +* More informative logging for instructions caching ([#785](https://github.com/kurtosis-tech/kurtosis/issues/785)) ([376ac8c](https://github.com/kurtosis-tech/kurtosis/commit/376ac8ceb7085a744c5cf84756b5d2c72a2577f7)) + ## [0.80.4](https://github.com/kurtosis-tech/kurtosis/compare/0.80.3...0.80.4) (2023-06-28) diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/analytics-disable.md b/docs/versioned_docs/version-0.80.9/cli-reference/analytics-disable.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/analytics-disable.md rename to docs/versioned_docs/version-0.80.9/cli-reference/analytics-disable.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/analytics-enable.md b/docs/versioned_docs/version-0.80.9/cli-reference/analytics-enable.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/analytics-enable.md rename to docs/versioned_docs/version-0.80.9/cli-reference/analytics-enable.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/analytics-id.md b/docs/versioned_docs/version-0.80.9/cli-reference/analytics-id.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/analytics-id.md rename to docs/versioned_docs/version-0.80.9/cli-reference/analytics-id.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/clean.md b/docs/versioned_docs/version-0.80.9/cli-reference/clean.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/clean.md rename to docs/versioned_docs/version-0.80.9/cli-reference/clean.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/cluster-get.md b/docs/versioned_docs/version-0.80.9/cli-reference/cluster-get.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/cluster-get.md rename to docs/versioned_docs/version-0.80.9/cli-reference/cluster-get.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/cluster-ls.md b/docs/versioned_docs/version-0.80.9/cli-reference/cluster-ls.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/cluster-ls.md rename to docs/versioned_docs/version-0.80.9/cli-reference/cluster-ls.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/cluster-set.md b/docs/versioned_docs/version-0.80.9/cli-reference/cluster-set.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/cluster-set.md rename to docs/versioned_docs/version-0.80.9/cli-reference/cluster-set.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/completion.md b/docs/versioned_docs/version-0.80.9/cli-reference/completion.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/completion.md rename to docs/versioned_docs/version-0.80.9/cli-reference/completion.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/config-path.md b/docs/versioned_docs/version-0.80.9/cli-reference/config-path.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/config-path.md rename to docs/versioned_docs/version-0.80.9/cli-reference/config-path.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/discord.md b/docs/versioned_docs/version-0.80.9/cli-reference/discord.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/discord.md rename to docs/versioned_docs/version-0.80.9/cli-reference/discord.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/docs.md b/docs/versioned_docs/version-0.80.9/cli-reference/docs.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/docs.md rename to docs/versioned_docs/version-0.80.9/cli-reference/docs.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/dump.md b/docs/versioned_docs/version-0.80.9/cli-reference/dump.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/dump.md rename to docs/versioned_docs/version-0.80.9/cli-reference/dump.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/enclave-add.md b/docs/versioned_docs/version-0.80.9/cli-reference/enclave-add.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/enclave-add.md rename to docs/versioned_docs/version-0.80.9/cli-reference/enclave-add.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/enclave-dump.md b/docs/versioned_docs/version-0.80.9/cli-reference/enclave-dump.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/enclave-dump.md rename to docs/versioned_docs/version-0.80.9/cli-reference/enclave-dump.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/enclave-inspect.md b/docs/versioned_docs/version-0.80.9/cli-reference/enclave-inspect.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/enclave-inspect.md rename to docs/versioned_docs/version-0.80.9/cli-reference/enclave-inspect.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/enclave-ls.md b/docs/versioned_docs/version-0.80.9/cli-reference/enclave-ls.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/enclave-ls.md rename to docs/versioned_docs/version-0.80.9/cli-reference/enclave-ls.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/enclave-rm.md b/docs/versioned_docs/version-0.80.9/cli-reference/enclave-rm.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/enclave-rm.md rename to docs/versioned_docs/version-0.80.9/cli-reference/enclave-rm.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/enclave-stop.md b/docs/versioned_docs/version-0.80.9/cli-reference/enclave-stop.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/enclave-stop.md rename to docs/versioned_docs/version-0.80.9/cli-reference/enclave-stop.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/engine-logs.md b/docs/versioned_docs/version-0.80.9/cli-reference/engine-logs.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/engine-logs.md rename to docs/versioned_docs/version-0.80.9/cli-reference/engine-logs.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/engine-restart.md b/docs/versioned_docs/version-0.80.9/cli-reference/engine-restart.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/engine-restart.md rename to docs/versioned_docs/version-0.80.9/cli-reference/engine-restart.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/engine-start.md b/docs/versioned_docs/version-0.80.9/cli-reference/engine-start.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/engine-start.md rename to docs/versioned_docs/version-0.80.9/cli-reference/engine-start.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/engine-status.md b/docs/versioned_docs/version-0.80.9/cli-reference/engine-status.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/engine-status.md rename to docs/versioned_docs/version-0.80.9/cli-reference/engine-status.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/engine-stop.md b/docs/versioned_docs/version-0.80.9/cli-reference/engine-stop.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/engine-stop.md rename to docs/versioned_docs/version-0.80.9/cli-reference/engine-stop.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/feedback.md b/docs/versioned_docs/version-0.80.9/cli-reference/feedback.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/feedback.md rename to docs/versioned_docs/version-0.80.9/cli-reference/feedback.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/files-download.md b/docs/versioned_docs/version-0.80.9/cli-reference/files-download.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/files-download.md rename to docs/versioned_docs/version-0.80.9/cli-reference/files-download.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/files-rendertemplate.md b/docs/versioned_docs/version-0.80.9/cli-reference/files-rendertemplate.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/files-rendertemplate.md rename to docs/versioned_docs/version-0.80.9/cli-reference/files-rendertemplate.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/files-storeservice.md b/docs/versioned_docs/version-0.80.9/cli-reference/files-storeservice.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/files-storeservice.md rename to docs/versioned_docs/version-0.80.9/cli-reference/files-storeservice.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/files-storeweb.md b/docs/versioned_docs/version-0.80.9/cli-reference/files-storeweb.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/files-storeweb.md rename to docs/versioned_docs/version-0.80.9/cli-reference/files-storeweb.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/files-upload.md b/docs/versioned_docs/version-0.80.9/cli-reference/files-upload.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/files-upload.md rename to docs/versioned_docs/version-0.80.9/cli-reference/files-upload.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/index.md b/docs/versioned_docs/version-0.80.9/cli-reference/index.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/index.md rename to docs/versioned_docs/version-0.80.9/cli-reference/index.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/port-print.md b/docs/versioned_docs/version-0.80.9/cli-reference/port-print.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/port-print.md rename to docs/versioned_docs/version-0.80.9/cli-reference/port-print.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/run-starlark.md b/docs/versioned_docs/version-0.80.9/cli-reference/run.md similarity index 74% rename from docs/versioned_docs/version-0.80.4/cli-reference/run-starlark.md rename to docs/versioned_docs/version-0.80.9/cli-reference/run.md index b9d27deaf3..4160382ade 100644 --- a/docs/versioned_docs/version-0.80.4/cli-reference/run-starlark.md +++ b/docs/versioned_docs/version-0.80.9/cli-reference/run.md @@ -1,7 +1,7 @@ --- title: run sidebar_label: run -slug: /run-starlark +slug: /run --- Kurtosis can be used to run a Starlark script or a [runnable package](../concepts-reference/packages.md) in an enclave. @@ -66,9 +66,23 @@ This command has options available to customize its execution: 1. The `--parallelism` flag can be used to specify to what degree of parallelism certain commands can be run. For example: if the script contains an [`add_services`][add-services-reference] instruction and is run with `--parallelism 100`, up to 100 services will be run at one time. 1. The `--enclave` flag can be used to instruct Kurtosis to run the script inside the specified enclave or create a new enclave (with the given enclave [identifier](../concepts-reference/resource-identifier.md)) if one does not exist. If this flag is not used, Kurtosis will create a new enclave with an auto-generated name, and run the script or package inside it. 1. The `--with-subnetworks` flag can be used to enable [subnetwork capabilties](../concepts-reference/subnetworks.md) within the specified enclave that the script or package is instructed to run within. This flag is false by default. -1. The `--verbosity` flag can be used to set the verbosity of the command output. The options include `BRIEF`, `DETAILED`, or `EXECUTABLE`. If unset, this flag defaults to `BRIEF` for a concise and explicit output. Use `DETAILED` to display the exhaustive list of arguments for each command. Meanwhile, `EXECUTABLE` will generate executable Starlark instructions. -1. The `--main-file` flag can be used to set the main file filepath, the "main" file is a file for the main method (i.e. the package's entrypoint) which will be executed first; the filepath has to be relative to the package's root. The default value is 'main.star'. This flag is only used for running packages. Example: if your main file is located in a path like this `github.com/my-org/my-package/src/internal/my-file.star` you should set `src/internal/my-file.star` as the relative path. -1. The `--main-function-name` flag can be used to set the main function name, which will be executed first as the entrypoint of the package or the module. The default value is 'run'. +1. The `--verbosity` flag can be used to set the verbosity of the command output. The options include `BRIEF`, `DETAILED`, or `EXECUTABLE`. If unset, this flag defaults to `BRIEF` for a concise and explicit output. Use `DETAILED` to display the exhaustive list of arguments for each command. Meanwhile, `EXECUTABLE` will generate executable Starlark instructions. +1. The `--main-function-name` flag can be used to set the name of the main entrypoint Starlark function that will be called to start the run. The default value is `run`, meaning Starlark will look for a function called `run` in the main file defined by the `--main-file` flag. Regardless of the function, Kurtosis expects the main function to have a parameter called `plan` into which Kurtosis will inject [the Kurtosis plan](../concepts-reference/plan.md). + + For example: + + To run the `start_node` function in a `main.star` file, simple use: + ```bash + kurtosis run main.star --main-function-name start_node + ``` + + Where `start_node` is a function defined in `main.star` like so: + ```python + # --------------- main.star -------------------- + def start_node(plan, args): + # your code + ``` +1. The `--main-file` flag sets the main file in which Kurtosis looks for the main function defined via the `--main-function-name` flag. This can be thought of as the entrypoint file. This flag takes a filepath **relative to the package's root**, and defaults to `main.star`. This flag is only used for running packages. For example, if your package is `github.com/my-org/my-package` but your main file is located in subdirectories like `github.com/my-org/my-package/src/internal/my-file.star`, you should set this flag like `--main-file src/internal/my-file.star`. 1. The `--experimental` flag can be used to enable experimental or incubating features. Please reach out to Kurtosis team if you wish to try any of those. Example of using setting the --main-function-name flag diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/service-add.md b/docs/versioned_docs/version-0.80.9/cli-reference/service-add.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/service-add.md rename to docs/versioned_docs/version-0.80.9/cli-reference/service-add.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/service-delete.md b/docs/versioned_docs/version-0.80.9/cli-reference/service-delete.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/service-delete.md rename to docs/versioned_docs/version-0.80.9/cli-reference/service-delete.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/service-exec.md b/docs/versioned_docs/version-0.80.9/cli-reference/service-exec.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/service-exec.md rename to docs/versioned_docs/version-0.80.9/cli-reference/service-exec.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/service-logs.md b/docs/versioned_docs/version-0.80.9/cli-reference/service-logs.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/service-logs.md rename to docs/versioned_docs/version-0.80.9/cli-reference/service-logs.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/service-shell.md b/docs/versioned_docs/version-0.80.9/cli-reference/service-shell.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/service-shell.md rename to docs/versioned_docs/version-0.80.9/cli-reference/service-shell.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/service-start.md b/docs/versioned_docs/version-0.80.9/cli-reference/service-start.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/service-start.md rename to docs/versioned_docs/version-0.80.9/cli-reference/service-start.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/service-stop.md b/docs/versioned_docs/version-0.80.9/cli-reference/service-stop.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/service-stop.md rename to docs/versioned_docs/version-0.80.9/cli-reference/service-stop.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/twitter.md b/docs/versioned_docs/version-0.80.9/cli-reference/twitter.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/twitter.md rename to docs/versioned_docs/version-0.80.9/cli-reference/twitter.md diff --git a/docs/versioned_docs/version-0.80.4/cli-reference/version.md b/docs/versioned_docs/version-0.80.9/cli-reference/version.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/cli-reference/version.md rename to docs/versioned_docs/version-0.80.9/cli-reference/version.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/web.md b/docs/versioned_docs/version-0.80.9/cli-reference/web.md new file mode 100644 index 0000000000..04b037eb23 --- /dev/null +++ b/docs/versioned_docs/version-0.80.9/cli-reference/web.md @@ -0,0 +1,11 @@ +--- +title: web(beta) +sidebar_label: web(beta) +slug: /web +--- + +The following command can be used to open the Kurtosis Web UI. This feature is currently in beta. + +```bash +kurtosis web +``` diff --git a/docs/versioned_docs/version-0.80.4/concepts-reference/args.md b/docs/versioned_docs/version-0.80.9/concepts-reference/args.md similarity index 67% rename from docs/versioned_docs/version-0.80.4/concepts-reference/args.md rename to docs/versioned_docs/version-0.80.9/concepts-reference/args.md index 684c757c51..399e3c1524 100644 --- a/docs/versioned_docs/version-0.80.4/concepts-reference/args.md +++ b/docs/versioned_docs/version-0.80.9/concepts-reference/args.md @@ -14,7 +14,7 @@ def run(plan): to: ```python -def run(plan, args) +def run(plan, some_other_param, some_parameter="Default value") ``` Then pass JSON-serialized arg values to `kurtosis run` in the CLI. For example: @@ -25,13 +25,5 @@ kurtosis run github.com/USERNAME/REPO '{"some_parameter":"some_value","some_othe Kurtosis will automatically JSON-deserialize the JSON string, and then pass it in to the `run` function in Starlark. -The JSON passed in via the command line will be deserialized to a dictionary in Starlark (_not_ a `struct`). So to access the args above, your `main.star` might look like: - -```python -def run(plan, args): - plan.print("some_parameter value: " + args["some_parameter"]) - plan.print("some_other_param value: " + args["some_other_param"]) -``` - [packages-reference]: ./packages.md diff --git a/docs/versioned_docs/version-0.80.4/concepts-reference/enclaves.md b/docs/versioned_docs/version-0.80.9/concepts-reference/enclaves.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/concepts-reference/enclaves.md rename to docs/versioned_docs/version-0.80.9/concepts-reference/enclaves.md diff --git a/docs/versioned_docs/version-0.80.4/concepts-reference/files-artifacts.md b/docs/versioned_docs/version-0.80.9/concepts-reference/files-artifacts.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/concepts-reference/files-artifacts.md rename to docs/versioned_docs/version-0.80.9/concepts-reference/files-artifacts.md diff --git a/docs/versioned_docs/version-0.80.4/concepts-reference/future-references.md b/docs/versioned_docs/version-0.80.9/concepts-reference/future-references.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/concepts-reference/future-references.md rename to docs/versioned_docs/version-0.80.9/concepts-reference/future-references.md diff --git a/docs/versioned_docs/version-0.80.4/concepts-reference/glossary.md b/docs/versioned_docs/version-0.80.9/concepts-reference/glossary.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/concepts-reference/glossary.md rename to docs/versioned_docs/version-0.80.9/concepts-reference/glossary.md diff --git a/docs/versioned_docs/version-0.80.9/concepts-reference/idempotent-runs.md b/docs/versioned_docs/version-0.80.9/concepts-reference/idempotent-runs.md new file mode 100644 index 0000000000..eb70508db2 --- /dev/null +++ b/docs/versioned_docs/version-0.80.9/concepts-reference/idempotent-runs.md @@ -0,0 +1,20 @@ +--- +title: Idempotent Runs +sidebar_label: Idempotent Runs +--- + +Idempotent runs refers to Kurtosis' ability to make calls of [`kurtosis run`](../cli-reference/run.md) against an [enclave][enclaves] idempotent, meaning that the [plan](./plan.md) being submitted via `kurtosis run` is a declarative state of how the enclave should look and Kurtosis makes it so regardless of the current state of the enclave. In plain English, this means that Kurtosis will diff the plan being submitted via `kurtosis run` against what already exists in the enclave, and make only the changes necessary to get to the desired state. + + +This has several uses: + +- **Speed:** when you're running a large [Starlark](./starlark.md) script or package and a step near the end has a bug, you don't want to start over from scratch with a fresh enclave and redo all the previous steps. Idempotent runs allows you to simply fix your bug and resubmit, and Kurtosis will skip all the steps that have already been run. +- **Eternal environments:** eternal environments like shared Dev or Staging are instantiated at their start (Day 0), and then receive a constant updates into the future (Days 1+). In order for these environments to live in Kurtosis, Kurtosis needs to be able to handle Days 1+. Idempotent runs allow this, as you to simply update your Starlark script and Kurtosis updates the environment in the enclave to match. +- **GitOps:** the best DevOps companies in the world use Git to manage changes to environments: each commit updates the environment. This requires idempotency (what happens if the deploy fails for a transient reason? what happens if you need to revert a commit?). Kurtosis' idempotent runs pave the way for a native GitOps experience inside of Kurtosis itself, where the environment infrastructure-as-code is the Starlark itself. + +Kurtosis is able to do this because of its [multi-phase approach to running Starlark](./multi-phase-runs.md). Kurtosis constructs an abstract representation of the system you want before running anything (much like Terraform), so Kurtosis can compare the current state of the enclave to the desired state of the enclave and skip any unnecessary changes. + +To read in much more detail about how idempotent runs work, see [here](../explanations/how-do-idempotent-runs-work.md). + + +[enclaves]: ./enclaves.md diff --git a/docs/versioned_docs/version-0.80.4/concepts-reference/kurtosis-yml.md b/docs/versioned_docs/version-0.80.9/concepts-reference/kurtosis-yml.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/concepts-reference/kurtosis-yml.md rename to docs/versioned_docs/version-0.80.9/concepts-reference/kurtosis-yml.md diff --git a/docs/versioned_docs/version-0.80.4/concepts-reference/locators.md b/docs/versioned_docs/version-0.80.9/concepts-reference/locators.md similarity index 75% rename from docs/versioned_docs/version-0.80.4/concepts-reference/locators.md rename to docs/versioned_docs/version-0.80.9/concepts-reference/locators.md index fe97d222f3..e39a4b005d 100644 --- a/docs/versioned_docs/version-0.80.4/concepts-reference/locators.md +++ b/docs/versioned_docs/version-0.80.9/concepts-reference/locators.md @@ -36,11 +36,38 @@ github.com/kurtosis-tech/kurtosis/starlark/test.star Only locators pointing to public GitHub repositories are currently allowed. ::: +Relative Locators are supported but the relative locator needs to be inside the package. Relative locators are relative to the file being interpreted. For a Starlark script to reference a local file (i.e. one that lives next to in the filesystem), the Starlark script must use the name of the package that it lives inside. + +For example, suppose we had a [Kurtosis package][packages] like so: + +``` +/ + package-repo + main.star + src/ + lib.star +``` + +with a `kurtosis.yml` file like so: + +```yaml +name: github.com/package-author/package-repo +``` + +The `main.star` can refer to the `lib.star` in both of the following ways + + +``` +# valid relative import +lib_via_relative_import = import_module("./src/lib.star") + +# valid absolute import +lib_via_absolute_import = import_module("github.com/kurtosis-tech/package-repo/src/lib.star") +``` + Any Starlark script that wishes to use external resources must be a part of a [Kurtosis package][packages]. -All locators are absolute; "relative" locators do not exist. For a Starlark script to reference a local file (i.e. one that lives next to in the filesystem), the Starlark script must use the name of the package that it lives inside. - For example, suppose we had a [Kurtosis package][packages] like so: ``` diff --git a/docs/versioned_docs/version-0.80.4/concepts-reference/multi-phase-runs.md b/docs/versioned_docs/version-0.80.9/concepts-reference/multi-phase-runs.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/concepts-reference/multi-phase-runs.md rename to docs/versioned_docs/version-0.80.9/concepts-reference/multi-phase-runs.md diff --git a/docs/versioned_docs/version-0.80.4/concepts-reference/packages.md b/docs/versioned_docs/version-0.80.9/concepts-reference/packages.md similarity index 99% rename from docs/versioned_docs/version-0.80.4/concepts-reference/packages.md rename to docs/versioned_docs/version-0.80.9/concepts-reference/packages.md index d257d342f3..c0819fe8cb 100644 --- a/docs/versioned_docs/version-0.80.4/concepts-reference/packages.md +++ b/docs/versioned_docs/version-0.80.9/concepts-reference/packages.md @@ -59,7 +59,7 @@ A Kurtosis package that has a `main.star` file next to its `kurtosis.yml` file i ```python def run(plan): - print("Hello, world.") + plan.print("Hello, world.") ``` :::info diff --git a/docs/versioned_docs/version-0.80.4/concepts-reference/plan.md b/docs/versioned_docs/version-0.80.9/concepts-reference/plan.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/concepts-reference/plan.md rename to docs/versioned_docs/version-0.80.9/concepts-reference/plan.md diff --git a/docs/versioned_docs/version-0.80.4/concepts-reference/resource-identifier.md b/docs/versioned_docs/version-0.80.9/concepts-reference/resource-identifier.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/concepts-reference/resource-identifier.md rename to docs/versioned_docs/version-0.80.9/concepts-reference/resource-identifier.md diff --git a/docs/versioned_docs/version-0.80.4/concepts-reference/starlark.md b/docs/versioned_docs/version-0.80.9/concepts-reference/starlark.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/concepts-reference/starlark.md rename to docs/versioned_docs/version-0.80.9/concepts-reference/starlark.md diff --git a/docs/versioned_docs/version-0.80.4/concepts-reference/subnetworks.md b/docs/versioned_docs/version-0.80.9/concepts-reference/subnetworks.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/concepts-reference/subnetworks.md rename to docs/versioned_docs/version-0.80.9/concepts-reference/subnetworks.md diff --git a/docs/versioned_docs/version-0.80.4/explanations/architecture.md b/docs/versioned_docs/version-0.80.9/explanations/architecture.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/explanations/architecture.md rename to docs/versioned_docs/version-0.80.9/explanations/architecture.md diff --git a/docs/versioned_docs/version-0.80.9/explanations/how-do-idempotent-runs-work.md b/docs/versioned_docs/version-0.80.9/explanations/how-do-idempotent-runs-work.md new file mode 100644 index 0000000000..5a13faa149 --- /dev/null +++ b/docs/versioned_docs/version-0.80.9/explanations/how-do-idempotent-runs-work.md @@ -0,0 +1,82 @@ +--- +title: How do idempotent runs work? +sidebar_label: Idempotent Runs +--- + +Background +---------- +:::tip +To learn about what idempotent runs are in Kurtosis and the motivation behind this feature, go [here][idempotent-run-concept-reference]. +::: + +When running the `kurtosis run` command, you may notice the following message get printed: +```console +SKIPPED - This instruction has already been run in this enclave +``` +The reason this happens is because Kurtosis will optimize each run of a Starlark package based on what has already been run in a given enclave, thus reducing execution time and resources. + +This means when you try to run the exact same package twice in a row, Kurtosis will skip all the instructions for the second run because they were already executed in the first run. + +:::info +This feature is still experimental and can be deactivated by adding `--experimental NO_INSTRUCTIONS_CACHING` parameter to the `kurtosis run` command. +::: + +How it works +------------ + +#### Definitions + +The __enclave plan__ is defined as the sequence of Starlark instructions that were previously executed inside a given enclave. Meanwhile, the __submitted plan__ is defined as the set of instructions generated by interpreting the package before it gets executed. + +Within a plan, whether it be an _enclave_ or _submitted_ plan, Kurtosis considers a given instruction `instruction_2` to be dependent on another instruction `instruction_1` if and only if `instruction_2` is sequenced to take place _after_ `instruction_1` in the plan's instruction sequence. + + + +Two instructions are said to be _equivalent_ if and only if their Starlark representations are strictly equal. + +#### Criteria to skip an instruction +Kurtosis uses the following heuristic to determine which parts of a plan to skip in order to optimize runs: + +1. Any instruction from the _submitted plan_ that is executed inside the enclave is appended to the _enclave plan_ +1. For any given instruction from the _submitted plan_, it is effectively skipped (i.e. not executed) if: + 1. There exists one instruction in the *enclave plan* that is equivalent to this instruction in the _enclave plan_(called the _matched instruction_ below) + 1. And if at least ONE of the following assertions is true: + 1. There is no direct dependent instruction for the given instruction in the _submitted plan_. Put it simply, it is the last instruction of the _submitted plan_. + 1. There is no direct dependent instruction for the _matched instruction_ in the _enclave plan_. Put it simply, the _matched instruction_ is the last instruction of the _enclave plan_. + 1. The sequence of direct dependent instructions for the _matched instruction_ in the _enclave plan_ is a _prefix_ of the sequence of direct dependent instructions of the _instruction_ from the _submitted plan_. + +Examples +-------- + +#### Case of a _submitted plan_ being disjoint from the _enclave plan_ +No instruction get skipped, all instructions from the _submitted plan_ are appended to the _enclave plan_. + +![disjoint-plans.png](/img/explanations/starlark-idempotent-run/disjoint-plans.png) + +#### Case of a _submitted plan_ being a sub-sequence of the _enclave plan_ +All instructions from the _submitted plan_ are skipped because they were all present in the _enclave plan_ (therefore +already executed inside this enclave). + +![sub-sequence-plan.png](/img/explanations/starlark-idempotent-run/sub-sequence-plan.png) + +#### Case of a _submitted plan_ partially overlapping the _enclave plan_ +The overlapping instructions from the _submitted plan_ are skipped but the new ones (i.e. non-overlapping ones) are +executed and appended to the _enclave plan_. + +![overlapping-plan.png](/img/explanations/starlark-idempotent-run/overlapping-plan.png) + +#### Case of a _submitted plan_ incompatible with the _enclave plan_ +Even though there are overlapping instructions in the _submitted plan_, the sequence of instructions itself is +incompatible with the _enclave plan_ because there exist at least one dependent instruction in the _enclave plan_ that +is not in the _submitted plan_. Kurtosis cannot optimize the _submitted plan_, and therefore falls back to the naive +behaviour of considering the _submitted plan_ as a sequence of new instructions. + +![incompatible-plans.png](/img/explanations/starlark-idempotent-run/incompatible-plans.png) + +Note that in this case, it is possible (and even likely) the execution of the submitted plan will fail. In the example +above, execution will fail because instruction 1 is an `add_service` instruction and a service cannot be added +twice within the same enclave. + + +[idempotent-run-concept-reference]: ../concepts-reference/idempotent-runs.md + diff --git a/docs/versioned_docs/version-0.80.4/explanations/how-do-kurtosis-imports-work.md b/docs/versioned_docs/version-0.80.9/explanations/how-do-kurtosis-imports-work.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/explanations/how-do-kurtosis-imports-work.md rename to docs/versioned_docs/version-0.80.9/explanations/how-do-kurtosis-imports-work.md diff --git a/docs/versioned_docs/version-0.80.4/explanations/metrics-philosophy.md b/docs/versioned_docs/version-0.80.9/explanations/metrics-philosophy.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/explanations/metrics-philosophy.md rename to docs/versioned_docs/version-0.80.9/explanations/metrics-philosophy.md diff --git a/docs/versioned_docs/version-0.80.4/explanations/public-and-private-ips-and-ports.md b/docs/versioned_docs/version-0.80.9/explanations/public-and-private-ips-and-ports.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/explanations/public-and-private-ips-and-ports.md rename to docs/versioned_docs/version-0.80.9/explanations/public-and-private-ips-and-ports.md diff --git a/docs/versioned_docs/version-0.80.4/explanations/reusable-environment-definitions.md b/docs/versioned_docs/version-0.80.9/explanations/reusable-environment-definitions.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/explanations/reusable-environment-definitions.md rename to docs/versioned_docs/version-0.80.9/explanations/reusable-environment-definitions.md diff --git a/docs/versioned_docs/version-0.80.4/explanations/why-kurtosis-starlark.md b/docs/versioned_docs/version-0.80.9/explanations/why-kurtosis-starlark.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/explanations/why-kurtosis-starlark.md rename to docs/versioned_docs/version-0.80.9/explanations/why-kurtosis-starlark.md diff --git a/docs/versioned_docs/version-0.80.4/explanations/why-multi-phase-runs.md b/docs/versioned_docs/version-0.80.9/explanations/why-multi-phase-runs.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/explanations/why-multi-phase-runs.md rename to docs/versioned_docs/version-0.80.9/explanations/why-multi-phase-runs.md diff --git a/docs/versioned_docs/version-0.80.4/explanations/why-we-built-kurtosis.md b/docs/versioned_docs/version-0.80.9/explanations/why-we-built-kurtosis.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/explanations/why-we-built-kurtosis.md rename to docs/versioned_docs/version-0.80.9/explanations/why-we-built-kurtosis.md diff --git a/docs/versioned_docs/version-0.80.4/guides/adding-command-line-completion.md b/docs/versioned_docs/version-0.80.9/guides/adding-command-line-completion.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/guides/adding-command-line-completion.md rename to docs/versioned_docs/version-0.80.9/guides/adding-command-line-completion.md diff --git a/docs/versioned_docs/version-0.80.4/guides/how-to-local-eth-testnet.md b/docs/versioned_docs/version-0.80.9/guides/how-to-local-eth-testnet.md similarity index 96% rename from docs/versioned_docs/version-0.80.4/guides/how-to-local-eth-testnet.md rename to docs/versioned_docs/version-0.80.9/guides/how-to-local-eth-testnet.md index 2fcc5d1dee..d10777c52f 100644 --- a/docs/versioned_docs/version-0.80.4/guides/how-to-local-eth-testnet.md +++ b/docs/versioned_docs/version-0.80.9/guides/how-to-local-eth-testnet.md @@ -26,7 +26,7 @@ In this guide, the Kurtosis eth-network-package spins up a local Ethereum testne Before you proceed, make sure you have: * [Installed and started the Docker engine](https://docs.kurtosis.com/next/install#i-install--start-docker) on your local machine * [Installed the Kurtosis CLI](https://docs.kurtosis.com/next/install#ii-install-the-cli) (or upgraded it to the latest release, if you already have the CLI installed) -* Installed[Node.js](https://nodejs.org/en), [yarn](https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable), and [npx](https://www.npmjs.com/package/npx) (for your dApp environment) +* Installed [Node.js](https://nodejs.org/en), [yarn](https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable), and [npx](https://www.npmjs.com/package/npx) (for your dApp environment) ## Instantiating a local Ethereum testnet @@ -102,11 +102,11 @@ The [smart-contract-example](https://github.com/kurtosis-tech/awesome-kurtosis/t * [`contracts/`](https://github.com/kurtosis-tech/awesome-kurtosis/tree/main/smart-contract-example/contracts) contains a few simple smart contracts for a Blackjack dApp * [`scripts/`](https://github.com/kurtosis-tech/awesome-kurtosis/tree/main/smart-contract-example/scripts) contains a script to deploy a token contract to your local Ethereum network * [`test/`](https://github.com/kurtosis-tech/awesome-kurtosis/tree/main/smart-contract-example/test) contains a simple .js test for your token contract to confirm each player in our Blackjack dApp has 1000 minted for them -* []`hardhat.config.ts`](https://github.com/kurtosis-tech/awesome-kurtosis/blob/main/smart-contract-example/hardhat.config.ts) configures your Hardhat setup +* [`hardhat.config.ts`](https://github.com/kurtosis-tech/awesome-kurtosis/blob/main/smart-contract-example/hardhat.config.ts) configures your Hardhat setup ### Configure Hardhat to use the local testnet -WWith your dApp development environment set up, you will now connect Hardhat to use the local Ethereum testnet generated using Kurtosis. To accomplish this, replace `<$YOUR_PORT>` in the `localnet` struct in your `hardhat.config.ts` config file with the port of the rpc uri output from any `el-client-` service. In this sample case, the port would be `64248`. Your port will be different. +With your dApp development environment set up, you will now connect Hardhat to use the local Ethereum testnet generated using Kurtosis. To accomplish this, replace `<$YOUR_PORT>` in the `localnet` struct in your `hardhat.config.ts` config file with the port of the rpc uri output from any `el-client-` service. In this sample case, the port would be `64248`. Your port will be different. Example in `hardhat.config.ts`: ```typescript diff --git a/docs/versioned_docs/version-0.80.4/guides/how-to-parameterize-cassandra.md b/docs/versioned_docs/version-0.80.9/guides/how-to-parameterize-cassandra.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/guides/how-to-parameterize-cassandra.md rename to docs/versioned_docs/version-0.80.9/guides/how-to-parameterize-cassandra.md diff --git a/docs/versioned_docs/version-0.80.4/guides/installing-historical-versions.md b/docs/versioned_docs/version-0.80.9/guides/installing-historical-versions.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/guides/installing-historical-versions.md rename to docs/versioned_docs/version-0.80.9/guides/installing-historical-versions.md diff --git a/docs/versioned_docs/version-0.80.4/guides/installing-the-cli.md b/docs/versioned_docs/version-0.80.9/guides/installing-the-cli.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/guides/installing-the-cli.md rename to docs/versioned_docs/version-0.80.9/guides/installing-the-cli.md diff --git a/docs/versioned_docs/version-0.80.4/guides/running-in-ci.md b/docs/versioned_docs/version-0.80.9/guides/running-in-ci.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/guides/running-in-ci.md rename to docs/versioned_docs/version-0.80.9/guides/running-in-ci.md diff --git a/docs/versioned_docs/version-0.80.4/guides/running-in-k8s.md b/docs/versioned_docs/version-0.80.9/guides/running-in-k8s.md similarity index 62% rename from docs/versioned_docs/version-0.80.4/guides/running-in-k8s.md rename to docs/versioned_docs/version-0.80.9/guides/running-in-k8s.md index fc9ae2a751..37a3c31595 100644 --- a/docs/versioned_docs/version-0.80.4/guides/running-in-k8s.md +++ b/docs/versioned_docs/version-0.80.9/guides/running-in-k8s.md @@ -6,14 +6,19 @@ slug: /k8s This guide assumes that you have [Kurtosis installed](./installing-the-cli.md). +If you would like more information on Kubernetes and how to set up, run and manage a cluster check out these offical [docs](https://kubernetes.io/docs/home/) + I. Create a Kubernetes Cluster ----------------- -There are severals diferent ways to deploy a Kubernetes cluster: +There are many diferent ways to get a Kubernetes cluster (roughly ordered easiest to hardest): -1. Deploy it on an onprem cluster and manage the machine provisioning yourself -1. Deploy it on the cloud, managing the Kubernetes nodes on cloud instances yourself (e.g. EC2, AVM, GCE, etc) -1. Deploy it on a managed Kuberenetes cluster, managing scaling and configurations yourself (e.g. EKS, AKS, GKE) +- Use [Kubernetes provided with Docker Desktop](https://docs.docker.com/desktop/kubernetes/) +- Install [Minikube](https://github.com/kubernetes/minikube) +- Use [k3s](https://k3s.io/) +- Deploy it on an onprem cluster and manage the machine provisioning yourself +- Deploy it on the cloud, managing the Kubernetes nodes on cloud instances yourself (e.g. EC2, AVM, GCE, etc) +- Deploy it on a managed Kuberenetes cluster, managing scaling and configurations yourself (e.g. EKS, AKS, GKE) :::tip Kurtosis Kloud Early Access If you're looking to run a stress-free "Kurtosis on Kubernetes in the cloud", look no further! We're excited to launch an early access offering for [Kurtosis Kloud](https://mp2k8nqxxgj.typeform.com/to/U1HcXT1H). Once you [sign up](https://mp2k8nqxxgj.typeform.com/to/U1HcXT1H), we'll reach out to you with the next steps. @@ -25,8 +30,8 @@ II. Add you Kubernetes Cluster credentials to your `kubeconfig` This step will depend highly on how your cluster was created. But generally you will need to either: -1. Manually edit the `kubeconfig` file to contain cluster and authentication data. For more information, see [Kubernetes docs](https://kubernetes.io/docs/tasks/access-application-cluster/configure-access-multiple-clusters/). -1. Use your cloud provider's CLI to automatically edit the `kubeconfig` file so that it contains your cluster and authentication data. For example, you if you are using Amazon's managed Kubernetes service (called EKS), [this tutorial](https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html) is comprehensive. +- Manually edit the `kubeconfig` file to contain cluster and authentication data. For more information, see [Kubernetes docs](https://kubernetes.io/docs/tasks/access-application-cluster/configure-access-multiple-clusters/). +- Use your cloud provider's CLI to automatically edit the `kubeconfig` file so that it contains your cluster and authentication data. For example, you if you are using Amazon's managed Kubernetes service (called EKS), [this tutorial](https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html) is comprehensive. III. Add your cluster information to `kurtosis-config.yml` @@ -64,4 +69,4 @@ Done! Now you can run any Kurtosis command or package just like if you were doin :::tip Kurtosis Kloud Early Access To switch back to using Kurtosis locally, simply use: `kurtosis cluster set docker` -::: \ No newline at end of file +::: diff --git a/docs/versioned_docs/version-0.80.4/guides/simulating-networking-failure.md b/docs/versioned_docs/version-0.80.9/guides/simulating-networking-failure.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/guides/simulating-networking-failure.md rename to docs/versioned_docs/version-0.80.9/guides/simulating-networking-failure.md diff --git a/docs/versioned_docs/version-0.80.4/guides/upgrading-the-cli.md b/docs/versioned_docs/version-0.80.9/guides/upgrading-the-cli.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/guides/upgrading-the-cli.md rename to docs/versioned_docs/version-0.80.9/guides/upgrading-the-cli.md diff --git a/docs/versioned_docs/version-0.80.4/home.md b/docs/versioned_docs/version-0.80.9/home.md similarity index 98% rename from docs/versioned_docs/version-0.80.4/home.md rename to docs/versioned_docs/version-0.80.9/home.md index 93ef700316..6701727eb8 100644 --- a/docs/versioned_docs/version-0.80.4/home.md +++ b/docs/versioned_docs/version-0.80.9/home.md @@ -35,7 +35,7 @@ In Kurtosis, test environments have these properties: - Enable debugging and investigation of problems live, as they're happening in your test environment - Manage file dependencies to ensure complete portability of test environments across different test runs and backends -#### Try out Kurtosis now +## Try out Kurtosis now Try Kurtosis now with our [quickstart](./quickstart.md). diff --git a/docs/versioned_docs/version-0.80.4/package-index.md b/docs/versioned_docs/version-0.80.9/package-index.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/package-index.md rename to docs/versioned_docs/version-0.80.9/package-index.md diff --git a/docs/versioned_docs/version-0.80.4/quickstart.md b/docs/versioned_docs/version-0.80.9/quickstart.md similarity index 99% rename from docs/versioned_docs/version-0.80.4/quickstart.md rename to docs/versioned_docs/version-0.80.9/quickstart.md index 169ca1a93e..b31849f68c 100644 --- a/docs/versioned_docs/version-0.80.4/quickstart.md +++ b/docs/versioned_docs/version-0.80.9/quickstart.md @@ -928,7 +928,7 @@ Thank you for trying our quickstart. We hope you enjoyed it. [cli-reference]: /cli -[kurtosis-run-reference]: ./cli-reference/run-starlark.md +[kurtosis-run-reference]: ./cli-reference/run.md [kurtosis-clean-reference]: ./cli-reference/clean.md [kurtosis-enclave-inspect-reference]: ./cli-reference/enclave-inspect.md [kurtosis-files-upload-reference]: ./cli-reference/files-upload.md diff --git a/docs/versioned_docs/version-0.80.4/sdk.md b/docs/versioned_docs/version-0.80.9/sdk.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/sdk.md rename to docs/versioned_docs/version-0.80.9/sdk.md diff --git a/docs/versioned_docs/version-0.80.4/starlark-reference/args.md b/docs/versioned_docs/version-0.80.9/starlark-reference/args.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/starlark-reference/args.md rename to docs/versioned_docs/version-0.80.9/starlark-reference/args.md diff --git a/docs/versioned_docs/version-0.80.4/starlark-reference/connection-config.md b/docs/versioned_docs/version-0.80.9/starlark-reference/connection-config.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/starlark-reference/connection-config.md rename to docs/versioned_docs/version-0.80.9/starlark-reference/connection-config.md diff --git a/docs/versioned_docs/version-0.80.4/starlark-reference/exec-recipe.md b/docs/versioned_docs/version-0.80.9/starlark-reference/exec-recipe.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/starlark-reference/exec-recipe.md rename to docs/versioned_docs/version-0.80.9/starlark-reference/exec-recipe.md diff --git a/docs/versioned_docs/version-0.80.4/starlark-reference/get-http-request-recipe.md b/docs/versioned_docs/version-0.80.9/starlark-reference/get-http-request-recipe.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/starlark-reference/get-http-request-recipe.md rename to docs/versioned_docs/version-0.80.9/starlark-reference/get-http-request-recipe.md diff --git a/docs/versioned_docs/version-0.80.4/starlark-reference/import-module.md b/docs/versioned_docs/version-0.80.9/starlark-reference/import-module.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/starlark-reference/import-module.md rename to docs/versioned_docs/version-0.80.9/starlark-reference/import-module.md diff --git a/docs/versioned_docs/version-0.80.4/starlark-reference/index.md b/docs/versioned_docs/version-0.80.9/starlark-reference/index.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/starlark-reference/index.md rename to docs/versioned_docs/version-0.80.9/starlark-reference/index.md diff --git a/docs/versioned_docs/version-0.80.4/starlark-reference/kurtosis.md b/docs/versioned_docs/version-0.80.9/starlark-reference/kurtosis.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/starlark-reference/kurtosis.md rename to docs/versioned_docs/version-0.80.9/starlark-reference/kurtosis.md diff --git a/docs/versioned_docs/version-0.80.4/starlark-reference/normal-packet-delay-distribution.md b/docs/versioned_docs/version-0.80.9/starlark-reference/normal-packet-delay-distribution.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/starlark-reference/normal-packet-delay-distribution.md rename to docs/versioned_docs/version-0.80.9/starlark-reference/normal-packet-delay-distribution.md diff --git a/docs/versioned_docs/version-0.80.4/starlark-reference/plan.md b/docs/versioned_docs/version-0.80.9/starlark-reference/plan.md similarity index 98% rename from docs/versioned_docs/version-0.80.4/starlark-reference/plan.md rename to docs/versioned_docs/version-0.80.9/starlark-reference/plan.md index 710bc39dbe..816c967b2f 100644 --- a/docs/versioned_docs/version-0.80.4/starlark-reference/plan.md +++ b/docs/versioned_docs/version-0.80.9/starlark-reference/plan.md @@ -432,7 +432,7 @@ The `files` dictionary argument accepts a key value pair, where `key` is the pat The instruction returns a `struct` with [future references][future-references-reference] to the ouput and exit code of the command, alongside with future-reference to the file artifact names that were generated. * `result.output` is a future reference to the output of the command * `result.code` is a future reference to the exit code - * `result.files_artifacts` is a future reference to the names of the file artifacts that were generated and can be used by the `files` property of `ServiceConfig` or `run_sh` instruction. An example is shown below:- + * `result.files_artifacts` is a future reference to the names of the file artifacts that were generated and can be used by the `files` property of `ServiceConfig` or `run_sh` instruction. An example is shown below:- ```python @@ -440,7 +440,9 @@ The instruction returns a `struct` with [future references][future-references-re run = "mkdir -p task && cd task && echo kurtosis > test.txt", store = [ "/task", - "/task/test.txt", + # using '*' will only copy the contents of the parent directory and not the directory itself to file artifact + # in this case, only test.txt will be stored and task directory will be ignored + "/task/*", ], ... ) @@ -685,7 +687,7 @@ plan.print(recipe_result["code"]) [stop-service]: #stop_service [wait]: #wait -[cli-run-reference]: ../cli-reference/run-starlark.md +[cli-run-reference]: ../cli-reference/run.md [files-artifacts-reference]: ../concepts-reference/files-artifacts.md [future-references-reference]: ../concepts-reference/future-references.md diff --git a/docs/versioned_docs/version-0.80.4/starlark-reference/port-spec.md b/docs/versioned_docs/version-0.80.9/starlark-reference/port-spec.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/starlark-reference/port-spec.md rename to docs/versioned_docs/version-0.80.9/starlark-reference/port-spec.md diff --git a/docs/versioned_docs/version-0.80.4/starlark-reference/post-http-request-recipe.md b/docs/versioned_docs/version-0.80.9/starlark-reference/post-http-request-recipe.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/starlark-reference/post-http-request-recipe.md rename to docs/versioned_docs/version-0.80.9/starlark-reference/post-http-request-recipe.md diff --git a/docs/versioned_docs/version-0.80.4/starlark-reference/read-file.md b/docs/versioned_docs/version-0.80.9/starlark-reference/read-file.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/starlark-reference/read-file.md rename to docs/versioned_docs/version-0.80.9/starlark-reference/read-file.md diff --git a/docs/versioned_docs/version-0.80.4/starlark-reference/ready-condition.md b/docs/versioned_docs/version-0.80.9/starlark-reference/ready-condition.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/starlark-reference/ready-condition.md rename to docs/versioned_docs/version-0.80.9/starlark-reference/ready-condition.md diff --git a/docs/versioned_docs/version-0.80.4/starlark-reference/service-config.md b/docs/versioned_docs/version-0.80.9/starlark-reference/service-config.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/starlark-reference/service-config.md rename to docs/versioned_docs/version-0.80.9/starlark-reference/service-config.md diff --git a/docs/versioned_docs/version-0.80.4/starlark-reference/service.md b/docs/versioned_docs/version-0.80.9/starlark-reference/service.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/starlark-reference/service.md rename to docs/versioned_docs/version-0.80.9/starlark-reference/service.md diff --git a/docs/versioned_docs/version-0.80.4/starlark-reference/standard-library.md b/docs/versioned_docs/version-0.80.9/starlark-reference/standard-library.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/starlark-reference/standard-library.md rename to docs/versioned_docs/version-0.80.9/starlark-reference/standard-library.md diff --git a/docs/versioned_docs/version-0.80.4/starlark-reference/uniform-packet-delay-distribution.md b/docs/versioned_docs/version-0.80.9/starlark-reference/uniform-packet-delay-distribution.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/starlark-reference/uniform-packet-delay-distribution.md rename to docs/versioned_docs/version-0.80.9/starlark-reference/uniform-packet-delay-distribution.md diff --git a/docs/versioned_docs/version-0.80.4/starlark-reference/update-service-config.md b/docs/versioned_docs/version-0.80.9/starlark-reference/update-service-config.md similarity index 100% rename from docs/versioned_docs/version-0.80.4/starlark-reference/update-service-config.md rename to docs/versioned_docs/version-0.80.9/starlark-reference/update-service-config.md diff --git a/docs/versioned_sidebars/version-0.80.4-sidebars.json b/docs/versioned_sidebars/version-0.80.9-sidebars.json similarity index 100% rename from docs/versioned_sidebars/version-0.80.4-sidebars.json rename to docs/versioned_sidebars/version-0.80.9-sidebars.json diff --git a/docs/versions.json b/docs/versions.json index 9a3a4b28cb..f3cffcbe03 100644 --- a/docs/versions.json +++ b/docs/versions.json @@ -1,9 +1,9 @@ [ + "0.80.9", "0.80.8", "0.80.7", "0.80.6", "0.80.5", - "0.80.4", "0.79.0", "0.78.5", "0.77.4", diff --git a/version.txt b/version.txt index 66f4a9a168..033fca35c8 100644 --- a/version.txt +++ b/version.txt @@ -1 +1 @@ -0.80.8 +0.80.9