diff --git a/CHANGELOG.md b/CHANGELOG.md index a3579798a2..a6f884550f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,21 @@ # Changelog +## [0.80.14](https://github.com/kurtosis-tech/kurtosis/compare/0.80.13...0.80.14) (2023-07-24) + + +### Features + +* Add ability to update a running service ([#943](https://github.com/kurtosis-tech/kurtosis/issues/943)) ([42a67f9](https://github.com/kurtosis-tech/kurtosis/commit/42a67f9a3f9d4413f58929867b4e6e61eeeaa25e)) +* added create enclave flow ([#962](https://github.com/kurtosis-tech/kurtosis/issues/962)) ([4c931b8](https://github.com/kurtosis-tech/kurtosis/commit/4c931b882e4298cf8d99d88425b0323576f7baf5)) +* Idempotent run V1 - services can now be live-updated inside an enclave ([#954](https://github.com/kurtosis-tech/kurtosis/issues/954)) ([a6a118d](https://github.com/kurtosis-tech/kurtosis/commit/a6a118d5b6cc0d3560a5e3abdd8b043397efeced)) + + +### Bug Fixes + +* Fix `successfully executed` bug in APIC logs when script fails ([#964](https://github.com/kurtosis-tech/kurtosis/issues/964)) ([32fe63f](https://github.com/kurtosis-tech/kurtosis/commit/32fe63fcb77a8db78b2e1e86be18d3857bfa5fc0)) +* no magic string replacement in python packages ([#966](https://github.com/kurtosis-tech/kurtosis/issues/966)) ([8b0fa62](https://github.com/kurtosis-tech/kurtosis/commit/8b0fa623a2c73ec195e2204da5a8463e016e6833)) +* the old go download ([#958](https://github.com/kurtosis-tech/kurtosis/issues/958)) ([f1b52ca](https://github.com/kurtosis-tech/kurtosis/commit/f1b52ca98215f090a849e626f934ccd341ad91c3)) + ## [0.80.13](https://github.com/kurtosis-tech/kurtosis/compare/0.80.12...0.80.13) (2023-07-20) diff --git a/LICENSE.md b/LICENSE.md index ae2d688622..daf6c73ce4 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.13 +Licensed Work: Kurtosis 0.80.14 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-20 +Change Date: 2027-07-24 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 be98670874..fc86abef66 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.13" + KurtosisVersion = "0.80.14" // !!!!!!!!!!! DO NOT UPDATE! WILL BE MANUALLY UPDATED DURING THE RELEASE PROCESS !!!!!!!!!!!!!!!!!!!!!! ) diff --git a/api/rust/Cargo.toml b/api/rust/Cargo.toml index c8b3cbd973..7b7674c3ac 100644 --- a/api/rust/Cargo.toml +++ b/api/rust/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "kurtosis-sdk" -version = "0.80.13" +version = "0.80.14" license = "BUSL-1.1" description = "Rust SDK for Kurtosis" edition = "2021" diff --git a/api/typescript/package.json b/api/typescript/package.json index f2209df0a2..7fb17a090b 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.13", + "version": "0.80.14", "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 7a58b06670..a509056558 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.13" +export const KURTOSIS_VERSION: string = "0.80.14" // !!!!!!!!!!! DO NOT UPDATE! WILL BE MANUALLY UPDATED DURING THE RELEASE PROCESS !!!!!!!!!!!!!!!!!!!!!! diff --git a/docs/versioned_docs/version-0.80.9/best-practices.md b/docs/versioned_docs/version-0.80.14/best-practices.md similarity index 81% rename from docs/versioned_docs/version-0.80.9/best-practices.md rename to docs/versioned_docs/version-0.80.14/best-practices.md index 25a5d211fb..d582f9d16a 100644 --- a/docs/versioned_docs/version-0.80.9/best-practices.md +++ b/docs/versioned_docs/version-0.80.14/best-practices.md @@ -35,6 +35,19 @@ Kurtosis has three different types of waits. Described here are the three, with - More complex to configure - Cannot be used to short-circuit `Plan.add_services` +Choosing service names in Kurtosis +---------------------------------- +Kurtosis service names implements [RFC-1035](https://datatracker.ietf.org/doc/html/rfc1035), meaning the names of all services must be a valid [RFC-1035 Label Name](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#rfc-1035-label-names). Tactically this means a service name must: + +* contain at most 63 characters +* contain only lowercase alphanumeric characters or '-' +* start with an alphabetic character +* end with an alphanumeric character + +Failure to adhere to the above standards will result in errors when running Kurtosis. + + + [args-concepts-reference]: ./concepts-reference/args.md diff --git a/docs/versioned_docs/version-0.80.9/changelog.md b/docs/versioned_docs/version-0.80.14/changelog.md similarity index 94% rename from docs/versioned_docs/version-0.80.9/changelog.md rename to docs/versioned_docs/version-0.80.14/changelog.md index 4c293051ae..a6f884550f 100644 --- a/docs/versioned_docs/version-0.80.9/changelog.md +++ b/docs/versioned_docs/version-0.80.14/changelog.md @@ -1,5 +1,64 @@ # Changelog +## [0.80.14](https://github.com/kurtosis-tech/kurtosis/compare/0.80.13...0.80.14) (2023-07-24) + + +### Features + +* Add ability to update a running service ([#943](https://github.com/kurtosis-tech/kurtosis/issues/943)) ([42a67f9](https://github.com/kurtosis-tech/kurtosis/commit/42a67f9a3f9d4413f58929867b4e6e61eeeaa25e)) +* added create enclave flow ([#962](https://github.com/kurtosis-tech/kurtosis/issues/962)) ([4c931b8](https://github.com/kurtosis-tech/kurtosis/commit/4c931b882e4298cf8d99d88425b0323576f7baf5)) +* Idempotent run V1 - services can now be live-updated inside an enclave ([#954](https://github.com/kurtosis-tech/kurtosis/issues/954)) ([a6a118d](https://github.com/kurtosis-tech/kurtosis/commit/a6a118d5b6cc0d3560a5e3abdd8b043397efeced)) + + +### Bug Fixes + +* Fix `successfully executed` bug in APIC logs when script fails ([#964](https://github.com/kurtosis-tech/kurtosis/issues/964)) ([32fe63f](https://github.com/kurtosis-tech/kurtosis/commit/32fe63fcb77a8db78b2e1e86be18d3857bfa5fc0)) +* no magic string replacement in python packages ([#966](https://github.com/kurtosis-tech/kurtosis/issues/966)) ([8b0fa62](https://github.com/kurtosis-tech/kurtosis/commit/8b0fa623a2c73ec195e2204da5a8463e016e6833)) +* the old go download ([#958](https://github.com/kurtosis-tech/kurtosis/issues/958)) ([f1b52ca](https://github.com/kurtosis-tech/kurtosis/commit/f1b52ca98215f090a849e626f934ccd341ad91c3)) + +## [0.80.13](https://github.com/kurtosis-tech/kurtosis/compare/0.80.12...0.80.13) (2023-07-20) + + +### Features + +* Add autocomplete for file path of artifact files inspect ([#947](https://github.com/kurtosis-tech/kurtosis/issues/947)) ([f72dfce](https://github.com/kurtosis-tech/kurtosis/commit/f72dfce9b755c37dde849f9047ef4a6ca7e59cb2)) + + +### Bug Fixes + +* broken symlinks on Kurtosis packages ([#944](https://github.com/kurtosis-tech/kurtosis/issues/944)) ([fbb0aee](https://github.com/kurtosis-tech/kurtosis/commit/fbb0aee6edfce4598b0384aebfe71b1e12b9730c)), closes [#846](https://github.com/kurtosis-tech/kurtosis/issues/846) +* improve frontend ([#940](https://github.com/kurtosis-tech/kurtosis/issues/940)) ([36153e2](https://github.com/kurtosis-tech/kurtosis/commit/36153e2c6e3c332508d6071d2f9101f77cfb6295)) +* improved error msg ([#936](https://github.com/kurtosis-tech/kurtosis/issues/936)) ([4f72ae1](https://github.com/kurtosis-tech/kurtosis/commit/4f72ae12409d6ddd8c2e2c6b61770081d9200bde)) + +## [0.80.12](https://github.com/kurtosis-tech/kurtosis/compare/0.80.11...0.80.12) (2023-07-18) + + +### Features + +* Service count can go up to 1024 in Docker backend ([#919](https://github.com/kurtosis-tech/kurtosis/issues/919)) ([e1dfff1](https://github.com/kurtosis-tech/kurtosis/commit/e1dfff119a0b6635e732e0e09de68b56d6af7d63)) + +## [0.80.11](https://github.com/kurtosis-tech/kurtosis/compare/0.80.10...0.80.11) (2023-07-18) + + +### Features + +* Add file artifact inspect API do APIC ([#885](https://github.com/kurtosis-tech/kurtosis/issues/885)) ([7ad8155](https://github.com/kurtosis-tech/kurtosis/commit/7ad81553a8056887e1399649536319922a05bdc1)) +* Add file inspect command to the CLI ([#905](https://github.com/kurtosis-tech/kurtosis/issues/905)) ([bb36a46](https://github.com/kurtosis-tech/kurtosis/commit/bb36a469925c3a8c00a88c0f5a16995088d26548)) +* added run python ([#913](https://github.com/kurtosis-tech/kurtosis/issues/913)) ([365f5cf](https://github.com/kurtosis-tech/kurtosis/commit/365f5cf15399dd0e79f7b82d5ab4ad823def00b5)) +* upload files support relative locators ([#930](https://github.com/kurtosis-tech/kurtosis/issues/930)) ([8d60968](https://github.com/kurtosis-tech/kurtosis/commit/8d609686ce78a72f82455592b48eeab94b44c359)) + + +### Bug Fixes + +* make service labels more restrictive ([#929](https://github.com/kurtosis-tech/kurtosis/issues/929)) ([a8fb599](https://github.com/kurtosis-tech/kurtosis/commit/a8fb5992d0e60bc50efa8585393048c168e878f0)), closes [#928](https://github.com/kurtosis-tech/kurtosis/issues/928) + +## [0.80.10](https://github.com/kurtosis-tech/kurtosis/compare/0.80.9...0.80.10) (2023-07-17) + + +### Features + +* Added enclave pool for improving performance on enclave creation ([#787](https://github.com/kurtosis-tech/kurtosis/issues/787)) ([d6efa43](https://github.com/kurtosis-tech/kurtosis/commit/d6efa435efeb9989de8f20f1d2d80603b7ef6827)) + ## [0.80.9](https://github.com/kurtosis-tech/kurtosis/compare/0.80.8...0.80.9) (2023-07-17) diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/analytics-disable.md b/docs/versioned_docs/version-0.80.14/cli-reference/analytics-disable.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/analytics-disable.md rename to docs/versioned_docs/version-0.80.14/cli-reference/analytics-disable.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/analytics-enable.md b/docs/versioned_docs/version-0.80.14/cli-reference/analytics-enable.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/analytics-enable.md rename to docs/versioned_docs/version-0.80.14/cli-reference/analytics-enable.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/analytics-id.md b/docs/versioned_docs/version-0.80.14/cli-reference/analytics-id.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/analytics-id.md rename to docs/versioned_docs/version-0.80.14/cli-reference/analytics-id.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/clean.md b/docs/versioned_docs/version-0.80.14/cli-reference/clean.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/clean.md rename to docs/versioned_docs/version-0.80.14/cli-reference/clean.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/cluster-get.md b/docs/versioned_docs/version-0.80.14/cli-reference/cluster-get.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/cluster-get.md rename to docs/versioned_docs/version-0.80.14/cli-reference/cluster-get.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/cluster-ls.md b/docs/versioned_docs/version-0.80.14/cli-reference/cluster-ls.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/cluster-ls.md rename to docs/versioned_docs/version-0.80.14/cli-reference/cluster-ls.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/cluster-set.md b/docs/versioned_docs/version-0.80.14/cli-reference/cluster-set.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/cluster-set.md rename to docs/versioned_docs/version-0.80.14/cli-reference/cluster-set.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/completion.md b/docs/versioned_docs/version-0.80.14/cli-reference/completion.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/completion.md rename to docs/versioned_docs/version-0.80.14/cli-reference/completion.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/config-path.md b/docs/versioned_docs/version-0.80.14/cli-reference/config-path.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/config-path.md rename to docs/versioned_docs/version-0.80.14/cli-reference/config-path.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/discord.md b/docs/versioned_docs/version-0.80.14/cli-reference/discord.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/discord.md rename to docs/versioned_docs/version-0.80.14/cli-reference/discord.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/docs.md b/docs/versioned_docs/version-0.80.14/cli-reference/docs.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/docs.md rename to docs/versioned_docs/version-0.80.14/cli-reference/docs.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/dump.md b/docs/versioned_docs/version-0.80.14/cli-reference/dump.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/dump.md rename to docs/versioned_docs/version-0.80.14/cli-reference/dump.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/enclave-add.md b/docs/versioned_docs/version-0.80.14/cli-reference/enclave-add.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/enclave-add.md rename to docs/versioned_docs/version-0.80.14/cli-reference/enclave-add.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/enclave-dump.md b/docs/versioned_docs/version-0.80.14/cli-reference/enclave-dump.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/enclave-dump.md rename to docs/versioned_docs/version-0.80.14/cli-reference/enclave-dump.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/enclave-inspect.md b/docs/versioned_docs/version-0.80.14/cli-reference/enclave-inspect.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/enclave-inspect.md rename to docs/versioned_docs/version-0.80.14/cli-reference/enclave-inspect.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/enclave-ls.md b/docs/versioned_docs/version-0.80.14/cli-reference/enclave-ls.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/enclave-ls.md rename to docs/versioned_docs/version-0.80.14/cli-reference/enclave-ls.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/enclave-rm.md b/docs/versioned_docs/version-0.80.14/cli-reference/enclave-rm.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/enclave-rm.md rename to docs/versioned_docs/version-0.80.14/cli-reference/enclave-rm.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/enclave-stop.md b/docs/versioned_docs/version-0.80.14/cli-reference/enclave-stop.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/enclave-stop.md rename to docs/versioned_docs/version-0.80.14/cli-reference/enclave-stop.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/engine-logs.md b/docs/versioned_docs/version-0.80.14/cli-reference/engine-logs.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/engine-logs.md rename to docs/versioned_docs/version-0.80.14/cli-reference/engine-logs.md diff --git a/docs/versioned_docs/version-0.80.14/cli-reference/engine-restart.md b/docs/versioned_docs/version-0.80.14/cli-reference/engine-restart.md new file mode 100644 index 0000000000..7ed0750d0f --- /dev/null +++ b/docs/versioned_docs/version-0.80.14/cli-reference/engine-restart.md @@ -0,0 +1,18 @@ +--- +title: engine restart +sidebar_label: engine restart +slug: /engine-restart +--- + +The CLI interacts with the Kurtosis engine, which is a very lightweight container. The CLI will start the engine container automatically for you and you should never need to start it manually, but you might need to restart the engine after a CLI upgrade. To do so, run: + +```bash +kurtosis engine restart +``` + +You may optionally pass in the following flags with this command: +* `--log-level`: The level that the started engine should log at. Options include: `panic`, `fatal`, `error`, `warning`, `info`, `debug`, or `trace`. The engine logs at the `info` level by default. +* `--version`: The version (Docker tag) of the Kurtosis engine that should be started. If not set, the engine will start up with the default version. +* `--enclave-pool-size`: The size of the Kurtosis engine enclave pool. The enclave pool is a component of the Kurtosis engine that allows us to create and maintain 'n' number of idle enclaves for future use. This functionality allows to improve the performance for each new creation enclave request. + +CAUTION: The `--enclave-pool-size` flag is only available for Kubernetes. \ No newline at end of file diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/engine-start.md b/docs/versioned_docs/version-0.80.14/cli-reference/engine-start.md similarity index 69% rename from docs/versioned_docs/version-0.80.9/cli-reference/engine-start.md rename to docs/versioned_docs/version-0.80.14/cli-reference/engine-start.md index 6d4c4d1eb0..0c2b428be0 100644 --- a/docs/versioned_docs/version-0.80.9/cli-reference/engine-start.md +++ b/docs/versioned_docs/version-0.80.14/cli-reference/engine-start.md @@ -13,4 +13,7 @@ This command will do nothing if the Kurtosis engine is already running. You may optionally pass in the following flags with this command: * `--log-level`: The level that the started engine should log at. Options include: `panic`, `fatal`, `error`, `warning`, `info`, `debug`, or `trace`. The engine logs at the `info` level by default. -* `--version`: The version (Docker tag) of the Kurtosis engine that should be started. If not set, the engine will start up with the default version. \ No newline at end of file +* `--version`: The version (Docker tag) of the Kurtosis engine that should be started. If not set, the engine will start up with the default version. +* `--enclave-pool-size`: The size of the Kurtosis engine enclave pool. The enclave pool is a component of the Kurtosis engine that allows us to create and maintain 'n' number of idle enclaves for future use. This functionality allows to improve the performance for each new creation enclave request. + +CAUTION: The `--enclave-pool-size` flag is only available for Kubernetes. \ No newline at end of file diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/engine-status.md b/docs/versioned_docs/version-0.80.14/cli-reference/engine-status.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/engine-status.md rename to docs/versioned_docs/version-0.80.14/cli-reference/engine-status.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/engine-stop.md b/docs/versioned_docs/version-0.80.14/cli-reference/engine-stop.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/engine-stop.md rename to docs/versioned_docs/version-0.80.14/cli-reference/engine-stop.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/feedback.md b/docs/versioned_docs/version-0.80.14/cli-reference/feedback.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/feedback.md rename to docs/versioned_docs/version-0.80.14/cli-reference/feedback.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/files-download.md b/docs/versioned_docs/version-0.80.14/cli-reference/files-download.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/files-download.md rename to docs/versioned_docs/version-0.80.14/cli-reference/files-download.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/files-rendertemplate.md b/docs/versioned_docs/version-0.80.14/cli-reference/files-rendertemplate.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/files-rendertemplate.md rename to docs/versioned_docs/version-0.80.14/cli-reference/files-rendertemplate.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/files-storeservice.md b/docs/versioned_docs/version-0.80.14/cli-reference/files-storeservice.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/files-storeservice.md rename to docs/versioned_docs/version-0.80.14/cli-reference/files-storeservice.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/files-storeweb.md b/docs/versioned_docs/version-0.80.14/cli-reference/files-storeweb.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/files-storeweb.md rename to docs/versioned_docs/version-0.80.14/cli-reference/files-storeweb.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/files-upload.md b/docs/versioned_docs/version-0.80.14/cli-reference/files-upload.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/files-upload.md rename to docs/versioned_docs/version-0.80.14/cli-reference/files-upload.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/index.md b/docs/versioned_docs/version-0.80.14/cli-reference/index.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/index.md rename to docs/versioned_docs/version-0.80.14/cli-reference/index.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/port-print.md b/docs/versioned_docs/version-0.80.14/cli-reference/port-print.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/port-print.md rename to docs/versioned_docs/version-0.80.14/cli-reference/port-print.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/run.md b/docs/versioned_docs/version-0.80.14/cli-reference/run.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/run.md rename to docs/versioned_docs/version-0.80.14/cli-reference/run.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/service-add.md b/docs/versioned_docs/version-0.80.14/cli-reference/service-add.md similarity index 86% rename from docs/versioned_docs/version-0.80.9/cli-reference/service-add.md rename to docs/versioned_docs/version-0.80.14/cli-reference/service-add.md index b59caf25f8..6632eab1ec 100644 --- a/docs/versioned_docs/version-0.80.9/cli-reference/service-add.md +++ b/docs/versioned_docs/version-0.80.14/cli-reference/service-add.md @@ -11,7 +11,8 @@ kurtosis service add $THE_ENCLAVE_IDENTIFIER $THE_SERVICE_IDENTIFIER $CONTAINER_ ``` where `$THE_ENCLAVE_IDENTIFIER` and the `$THE_SERVICE_IDENTIFIER` are [resource identifiers](../concepts-reference/resource-identifier.md) for the enclave and service, respectively. -Note, the service identifier needs to be formatted according to RFC 1123. Specifically, 1-63 lowercase alphanumeric characters with dashes and cannot start or end with dashes. +Note, the service identifier needs to be formatted according to RFC 1035. Specifically, 1-63 lowercase alphanumeric characters with dashes and cannot start or end with dashes. Also service names +have to start with a lowercase alphabet. Much like `docker run`, this command has multiple options available to customize the service that's started: diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/service-delete.md b/docs/versioned_docs/version-0.80.14/cli-reference/service-delete.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/service-delete.md rename to docs/versioned_docs/version-0.80.14/cli-reference/service-delete.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/service-exec.md b/docs/versioned_docs/version-0.80.14/cli-reference/service-exec.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/service-exec.md rename to docs/versioned_docs/version-0.80.14/cli-reference/service-exec.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/service-logs.md b/docs/versioned_docs/version-0.80.14/cli-reference/service-logs.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/service-logs.md rename to docs/versioned_docs/version-0.80.14/cli-reference/service-logs.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/service-shell.md b/docs/versioned_docs/version-0.80.14/cli-reference/service-shell.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/service-shell.md rename to docs/versioned_docs/version-0.80.14/cli-reference/service-shell.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/service-start.md b/docs/versioned_docs/version-0.80.14/cli-reference/service-start.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/service-start.md rename to docs/versioned_docs/version-0.80.14/cli-reference/service-start.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/service-stop.md b/docs/versioned_docs/version-0.80.14/cli-reference/service-stop.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/service-stop.md rename to docs/versioned_docs/version-0.80.14/cli-reference/service-stop.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/twitter.md b/docs/versioned_docs/version-0.80.14/cli-reference/twitter.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/twitter.md rename to docs/versioned_docs/version-0.80.14/cli-reference/twitter.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/version.md b/docs/versioned_docs/version-0.80.14/cli-reference/version.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/version.md rename to docs/versioned_docs/version-0.80.14/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.14/cli-reference/web.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/cli-reference/web.md rename to docs/versioned_docs/version-0.80.14/cli-reference/web.md diff --git a/docs/versioned_docs/version-0.80.9/concepts-reference/args.md b/docs/versioned_docs/version-0.80.14/concepts-reference/args.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/concepts-reference/args.md rename to docs/versioned_docs/version-0.80.14/concepts-reference/args.md diff --git a/docs/versioned_docs/version-0.80.9/concepts-reference/enclaves.md b/docs/versioned_docs/version-0.80.14/concepts-reference/enclaves.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/concepts-reference/enclaves.md rename to docs/versioned_docs/version-0.80.14/concepts-reference/enclaves.md diff --git a/docs/versioned_docs/version-0.80.9/concepts-reference/files-artifacts.md b/docs/versioned_docs/version-0.80.14/concepts-reference/files-artifacts.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/concepts-reference/files-artifacts.md rename to docs/versioned_docs/version-0.80.14/concepts-reference/files-artifacts.md diff --git a/docs/versioned_docs/version-0.80.9/concepts-reference/future-references.md b/docs/versioned_docs/version-0.80.14/concepts-reference/future-references.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/concepts-reference/future-references.md rename to docs/versioned_docs/version-0.80.14/concepts-reference/future-references.md diff --git a/docs/versioned_docs/version-0.80.9/concepts-reference/glossary.md b/docs/versioned_docs/version-0.80.14/concepts-reference/glossary.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/concepts-reference/glossary.md rename to docs/versioned_docs/version-0.80.14/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.14/concepts-reference/idempotent-runs.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/concepts-reference/idempotent-runs.md rename to docs/versioned_docs/version-0.80.14/concepts-reference/idempotent-runs.md diff --git a/docs/versioned_docs/version-0.80.9/concepts-reference/kurtosis-yml.md b/docs/versioned_docs/version-0.80.14/concepts-reference/kurtosis-yml.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/concepts-reference/kurtosis-yml.md rename to docs/versioned_docs/version-0.80.14/concepts-reference/kurtosis-yml.md diff --git a/docs/versioned_docs/version-0.80.9/concepts-reference/locators.md b/docs/versioned_docs/version-0.80.14/concepts-reference/locators.md similarity index 64% rename from docs/versioned_docs/version-0.80.9/concepts-reference/locators.md rename to docs/versioned_docs/version-0.80.14/concepts-reference/locators.md index e39a4b005d..f7aa3f0ad2 100644 --- a/docs/versioned_docs/version-0.80.9/concepts-reference/locators.md +++ b/docs/versioned_docs/version-0.80.14/concepts-reference/locators.md @@ -4,10 +4,13 @@ sidebar_label: Locators --- :::info -Locators are a part of the Kurtosis package system. To read about the package system in detail, [see here][how-do-kurtosis-imports-work-explanation]. +Locators are a part of the [Kurtosis packaging system][packages]. To read about the package system in detail, [see here][how-do-kurtosis-imports-work-explanation]. ::: -A locator is a URL-like string used to locate a resource inside [a Kurtosis package][packages]. For example, this locator: +A locator is how resources are identified when being imported in a Starlark script - namely by [`import_module`](../starlark-reference/import-module.md) and [`read_file`](../starlark-reference/read-file.md). There are two types of locators: absolute and relative. + +### Absolute Locators +Absolute locators unambiguously identify a resource using a URL-like syntax. For example, this locator: ``` github.com/package-author/package-repo/path/to/directory-with-kurtosis.yml/some-file.star @@ -15,9 +18,6 @@ github.com/package-author/package-repo/path/to/directory-with-kurtosis.yml/some- references a file inside a GitHub repo called `package-repo`, owned by `package-author`, that lives at the path `/path/to/directory-with-kurtosis.yml/some-file.star` relative to the root of the repo. - -Locators are used for identifying resources that will be used inside a Starlark script - namely by [`import_module`](../starlark-reference/import-module.md) and [`read_file`](../starlark-reference/read-file.md). - :::caution A GitHub URL is **not** a valid locator, because GitHub adds extra `/blob/main` paths to the URL that don't reflect the file's path in the repo. For example, a GitHub URL of: @@ -36,69 +36,71 @@ 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. +### Package Restriction +Any Starlark script that wishes to use external resources must be +a part of a [Kurtosis package][packages]. For example, suppose we had a [Kurtosis package][packages] like so: ``` / - package-repo - main.star - src/ - lib.star + package-repo/ + my-package/ + kurtosis.yml + main.star + helpers/ + random-script.star + not-a-package/ + random-script.star ``` with a `kurtosis.yml` file like so: ```yaml -name: github.com/package-author/package-repo +name: github.com/package-author/package-repo/my-package ``` -The `main.star` can refer to the `lib.star` in both of the following ways - +The `main.star` file would import the `random-script.star` from the `helpers` subdirectory of `my-package` like so: +```python +helpers = import_module("github.com/package-author/package-repo/my-package/helpers/random-script.star") ``` -# 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") +The import statement below will not succeed, because `main.star` cannot import from non-packages. +(see [how import works][how-do-kurtosis-imports-work-explanation] for more information) + +```python +helpers = import_module("github.com/package-author/package-repo/not-a-package/random-script.star") ``` -Any Starlark script that wishes to use external resources must be -a part of a [Kurtosis package][packages]. +### Relative Locators +Relative locators like `./helper.star` are allowed as a short alternative to the full absolute locator. However, a relative locator cannot be used to reference files outside the package. In other words, you cannot use a relative locator to reference files above the directory containing the `kurtosis.yml` file. -For example, suppose we had a [Kurtosis package][packages] like so: +Suppose we had a [Kurtosis package][packages] like so: ``` / - package-repo - my-package - kurtosis.yml - main.star - helpers - random-script.star - not-a-package - random-script.star + package-repo/ + main.star + src/ + lib.star ``` with a `kurtosis.yml` file like so: ```yaml -name: github.com/package-author/package-repo/my-package +name: github.com/package-author/package-repo ``` -The `main.star` file would import the `random-script.star` from the `helpers` subdirectory of `my-package` like so: - -```python -helpers = import_module("github.com/package-author/package-repo/my-package/helpers/random-script.star") -``` +The `main.star` can refer to the `lib.star` file using either relative or absolute imports: -The import statement below will not succeed, this is because `main.star` cannot import from non-packages. -(see [how import works][how-do-kurtosis-imports-work-explanation] for more information) ```python -helpers = import_module("github.com/package-author/package-repo/not-a-package/random-script.star") +# 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") ``` diff --git a/docs/versioned_docs/version-0.80.9/concepts-reference/multi-phase-runs.md b/docs/versioned_docs/version-0.80.14/concepts-reference/multi-phase-runs.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/concepts-reference/multi-phase-runs.md rename to docs/versioned_docs/version-0.80.14/concepts-reference/multi-phase-runs.md diff --git a/docs/versioned_docs/version-0.80.9/concepts-reference/packages.md b/docs/versioned_docs/version-0.80.14/concepts-reference/packages.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/concepts-reference/packages.md rename to docs/versioned_docs/version-0.80.14/concepts-reference/packages.md diff --git a/docs/versioned_docs/version-0.80.9/concepts-reference/plan.md b/docs/versioned_docs/version-0.80.14/concepts-reference/plan.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/concepts-reference/plan.md rename to docs/versioned_docs/version-0.80.14/concepts-reference/plan.md diff --git a/docs/versioned_docs/version-0.80.9/concepts-reference/resource-identifier.md b/docs/versioned_docs/version-0.80.14/concepts-reference/resource-identifier.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/concepts-reference/resource-identifier.md rename to docs/versioned_docs/version-0.80.14/concepts-reference/resource-identifier.md diff --git a/docs/versioned_docs/version-0.80.9/concepts-reference/starlark.md b/docs/versioned_docs/version-0.80.14/concepts-reference/starlark.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/concepts-reference/starlark.md rename to docs/versioned_docs/version-0.80.14/concepts-reference/starlark.md diff --git a/docs/versioned_docs/version-0.80.9/concepts-reference/subnetworks.md b/docs/versioned_docs/version-0.80.14/concepts-reference/subnetworks.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/concepts-reference/subnetworks.md rename to docs/versioned_docs/version-0.80.14/concepts-reference/subnetworks.md diff --git a/docs/versioned_docs/version-0.80.9/explanations/architecture.md b/docs/versioned_docs/version-0.80.14/explanations/architecture.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/explanations/architecture.md rename to docs/versioned_docs/version-0.80.14/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.14/explanations/how-do-idempotent-runs-work.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/explanations/how-do-idempotent-runs-work.md rename to docs/versioned_docs/version-0.80.14/explanations/how-do-idempotent-runs-work.md diff --git a/docs/versioned_docs/version-0.80.9/explanations/how-do-kurtosis-imports-work.md b/docs/versioned_docs/version-0.80.14/explanations/how-do-kurtosis-imports-work.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/explanations/how-do-kurtosis-imports-work.md rename to docs/versioned_docs/version-0.80.14/explanations/how-do-kurtosis-imports-work.md diff --git a/docs/versioned_docs/version-0.80.9/explanations/metrics-philosophy.md b/docs/versioned_docs/version-0.80.14/explanations/metrics-philosophy.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/explanations/metrics-philosophy.md rename to docs/versioned_docs/version-0.80.14/explanations/metrics-philosophy.md diff --git a/docs/versioned_docs/version-0.80.9/explanations/public-and-private-ips-and-ports.md b/docs/versioned_docs/version-0.80.14/explanations/public-and-private-ips-and-ports.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/explanations/public-and-private-ips-and-ports.md rename to docs/versioned_docs/version-0.80.14/explanations/public-and-private-ips-and-ports.md diff --git a/docs/versioned_docs/version-0.80.9/explanations/reusable-environment-definitions.md b/docs/versioned_docs/version-0.80.14/explanations/reusable-environment-definitions.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/explanations/reusable-environment-definitions.md rename to docs/versioned_docs/version-0.80.14/explanations/reusable-environment-definitions.md diff --git a/docs/versioned_docs/version-0.80.9/explanations/why-kurtosis-starlark.md b/docs/versioned_docs/version-0.80.14/explanations/why-kurtosis-starlark.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/explanations/why-kurtosis-starlark.md rename to docs/versioned_docs/version-0.80.14/explanations/why-kurtosis-starlark.md diff --git a/docs/versioned_docs/version-0.80.9/explanations/why-multi-phase-runs.md b/docs/versioned_docs/version-0.80.14/explanations/why-multi-phase-runs.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/explanations/why-multi-phase-runs.md rename to docs/versioned_docs/version-0.80.14/explanations/why-multi-phase-runs.md diff --git a/docs/versioned_docs/version-0.80.9/explanations/why-we-built-kurtosis.md b/docs/versioned_docs/version-0.80.14/explanations/why-we-built-kurtosis.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/explanations/why-we-built-kurtosis.md rename to docs/versioned_docs/version-0.80.14/explanations/why-we-built-kurtosis.md diff --git a/docs/versioned_docs/version-0.80.14/faq.md b/docs/versioned_docs/version-0.80.14/faq.md new file mode 100644 index 0000000000..589dc281f2 --- /dev/null +++ b/docs/versioned_docs/version-0.80.14/faq.md @@ -0,0 +1,17 @@ +--- +title: FAQ +sidebar_label: FAQ +slug: /faq +--- + +Why can't I do X in Starlark? +----------------------------- +Starlark is intended to be a configuration and orchestration language, not a general-purpose programming language. It is excellent at simplicity, readability, and determinism, and terrible at general-purpose programming. We want to use Starlark for what it's good at, while making it easy for you to call down to whatever general-purpose programming you need for more complex logic. + +Therefore, Kurtosis provides: + +- [`plan.run_sh`](./starlark-reference/plan.md#run_sh) for running Bash tasks on a disposable container +- [`plan.run_python`](./starlark-reference/plan.md#run_python) for running Python tasks on a disposable container +- [`plan.exec`](./starlark-reference/plan.md#exec) for running Bash on a service + +All of these let you customize the image to run on, so you can functionally call any code in any language using Kurtosis. diff --git a/docs/versioned_docs/version-0.80.9/guides/adding-command-line-completion.md b/docs/versioned_docs/version-0.80.14/guides/adding-command-line-completion.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/guides/adding-command-line-completion.md rename to docs/versioned_docs/version-0.80.14/guides/adding-command-line-completion.md diff --git a/docs/versioned_docs/version-0.80.9/guides/how-to-local-eth-testnet.md b/docs/versioned_docs/version-0.80.14/guides/how-to-local-eth-testnet.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/guides/how-to-local-eth-testnet.md rename to docs/versioned_docs/version-0.80.14/guides/how-to-local-eth-testnet.md diff --git a/docs/versioned_docs/version-0.80.9/guides/how-to-parameterize-cassandra.md b/docs/versioned_docs/version-0.80.14/guides/how-to-parameterize-cassandra.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/guides/how-to-parameterize-cassandra.md rename to docs/versioned_docs/version-0.80.14/guides/how-to-parameterize-cassandra.md diff --git a/docs/versioned_docs/version-0.80.9/guides/installing-historical-versions.md b/docs/versioned_docs/version-0.80.14/guides/installing-historical-versions.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/guides/installing-historical-versions.md rename to docs/versioned_docs/version-0.80.14/guides/installing-historical-versions.md diff --git a/docs/versioned_docs/version-0.80.9/guides/installing-the-cli.md b/docs/versioned_docs/version-0.80.14/guides/installing-the-cli.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/guides/installing-the-cli.md rename to docs/versioned_docs/version-0.80.14/guides/installing-the-cli.md diff --git a/docs/versioned_docs/version-0.80.9/guides/running-in-ci.md b/docs/versioned_docs/version-0.80.14/guides/running-in-ci.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/guides/running-in-ci.md rename to docs/versioned_docs/version-0.80.14/guides/running-in-ci.md diff --git a/docs/versioned_docs/version-0.80.9/guides/running-in-k8s.md b/docs/versioned_docs/version-0.80.14/guides/running-in-k8s.md similarity index 64% rename from docs/versioned_docs/version-0.80.9/guides/running-in-k8s.md rename to docs/versioned_docs/version-0.80.14/guides/running-in-k8s.md index 37a3c31595..25582bebf0 100644 --- a/docs/versioned_docs/version-0.80.9/guides/running-in-k8s.md +++ b/docs/versioned_docs/version-0.80.14/guides/running-in-k8s.md @@ -6,7 +6,9 @@ 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/) +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/). + +Please note that in order to ensure Kurtosis works the same way over Kubernetes as it does over Docker locally, service names must be a valid [RFC-1035 Label Name](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#rfc-1035-label-names). This means service names must contain: at most 63 characters, only lowercase alphanumeric characters or '-', start with an alphabetic character, and end with an alphanumeric character. I. Create a Kubernetes Cluster ----------------- @@ -38,7 +40,7 @@ III. Add your cluster information to `kurtosis-config.yml` -------------------------------- 1. Open the file located at `"$(kurtosis config path)"`. This should look like `/Users//Library/Application Support/kurtosis/kurtosis-config.yml` on MacOS. -1. Paste the following contents, changing `NAME-OF-YOUR-CLUSTER` to the cluster you created and save: +2. Paste the following contents, changing `NAME-OF-YOUR-CLUSTER` to the cluster you created and save: ```yaml config-version: 2 should-send-metrics: true @@ -70,3 +72,25 @@ 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` ::: + + +V. \[Optional] Activate the enclave pool to accelerate the enclave creation time +-------------------------------- + +This step is optional, but we recommend taking it as it improves the user experience during the enclave creation, specifically regarding speed. + +Creating a new enclave from scratch demands several time-consuming engine tasks and the creation of resources. + +The enclave pool feature was introduced to reduce the time it takes for a user to run a Kurtosis package in the cloud by spinning up the enclaves before they are needed. + +The enclave pool is a functionality of the Kurtosis engine that automatically creates `idle` enclaves, when the engine is started, that are then used whenever users need to create a new enclave (e.g: when running the `kurtosis enclave add` command). + +This mechanism reduces enclave creation time by using a running `idle` enclave when a new enclave is requested from the engine. + +To enable this feature you have to run the following: + +1. Run `kurtosis engine restart --enclave-pool-size {pool-size-number}`. If you already follow the previous step and replace the {pool-size-number} with an integer + +OR + +1. Run `kurtosis engine start --enclave-pool-size {pool-size-number}`. If the engine has not been started yet. diff --git a/docs/versioned_docs/version-0.80.9/guides/simulating-networking-failure.md b/docs/versioned_docs/version-0.80.14/guides/simulating-networking-failure.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/guides/simulating-networking-failure.md rename to docs/versioned_docs/version-0.80.14/guides/simulating-networking-failure.md diff --git a/docs/versioned_docs/version-0.80.9/guides/upgrading-the-cli.md b/docs/versioned_docs/version-0.80.14/guides/upgrading-the-cli.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/guides/upgrading-the-cli.md rename to docs/versioned_docs/version-0.80.14/guides/upgrading-the-cli.md diff --git a/docs/versioned_docs/version-0.80.9/home.md b/docs/versioned_docs/version-0.80.14/home.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/home.md rename to docs/versioned_docs/version-0.80.14/home.md diff --git a/docs/versioned_docs/version-0.80.9/package-index.md b/docs/versioned_docs/version-0.80.14/package-index.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/package-index.md rename to docs/versioned_docs/version-0.80.14/package-index.md diff --git a/docs/versioned_docs/version-0.80.9/quickstart.md b/docs/versioned_docs/version-0.80.14/quickstart.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/quickstart.md rename to docs/versioned_docs/version-0.80.14/quickstart.md diff --git a/docs/versioned_docs/version-0.80.9/sdk.md b/docs/versioned_docs/version-0.80.14/sdk.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/sdk.md rename to docs/versioned_docs/version-0.80.14/sdk.md diff --git a/docs/versioned_docs/version-0.80.9/starlark-reference/args.md b/docs/versioned_docs/version-0.80.14/starlark-reference/args.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/starlark-reference/args.md rename to docs/versioned_docs/version-0.80.14/starlark-reference/args.md diff --git a/docs/versioned_docs/version-0.80.9/starlark-reference/connection-config.md b/docs/versioned_docs/version-0.80.14/starlark-reference/connection-config.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/starlark-reference/connection-config.md rename to docs/versioned_docs/version-0.80.14/starlark-reference/connection-config.md diff --git a/docs/versioned_docs/version-0.80.9/starlark-reference/exec-recipe.md b/docs/versioned_docs/version-0.80.14/starlark-reference/exec-recipe.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/starlark-reference/exec-recipe.md rename to docs/versioned_docs/version-0.80.14/starlark-reference/exec-recipe.md diff --git a/docs/versioned_docs/version-0.80.9/starlark-reference/get-http-request-recipe.md b/docs/versioned_docs/version-0.80.14/starlark-reference/get-http-request-recipe.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/starlark-reference/get-http-request-recipe.md rename to docs/versioned_docs/version-0.80.14/starlark-reference/get-http-request-recipe.md diff --git a/docs/versioned_docs/version-0.80.9/starlark-reference/import-module.md b/docs/versioned_docs/version-0.80.14/starlark-reference/import-module.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/starlark-reference/import-module.md rename to docs/versioned_docs/version-0.80.14/starlark-reference/import-module.md diff --git a/docs/versioned_docs/version-0.80.9/starlark-reference/index.md b/docs/versioned_docs/version-0.80.14/starlark-reference/index.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/starlark-reference/index.md rename to docs/versioned_docs/version-0.80.14/starlark-reference/index.md diff --git a/docs/versioned_docs/version-0.80.9/starlark-reference/kurtosis.md b/docs/versioned_docs/version-0.80.14/starlark-reference/kurtosis.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/starlark-reference/kurtosis.md rename to docs/versioned_docs/version-0.80.14/starlark-reference/kurtosis.md diff --git a/docs/versioned_docs/version-0.80.9/starlark-reference/normal-packet-delay-distribution.md b/docs/versioned_docs/version-0.80.14/starlark-reference/normal-packet-delay-distribution.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/starlark-reference/normal-packet-delay-distribution.md rename to docs/versioned_docs/version-0.80.14/starlark-reference/normal-packet-delay-distribution.md diff --git a/docs/versioned_docs/version-0.80.9/starlark-reference/plan.md b/docs/versioned_docs/version-0.80.14/starlark-reference/plan.md similarity index 88% rename from docs/versioned_docs/version-0.80.9/starlark-reference/plan.md rename to docs/versioned_docs/version-0.80.14/starlark-reference/plan.md index 816c967b2f..741f1f3a47 100644 --- a/docs/versioned_docs/version-0.80.9/starlark-reference/plan.md +++ b/docs/versioned_docs/version-0.80.14/starlark-reference/plan.md @@ -21,8 +21,9 @@ The `add_service` instruction adds a service to the Kurtosis enclave within whic service = plan.add_service( # The service name of the service being created. # The service name is a reference to the service, which can be used in the future to refer to the service. - # Service names of active services are unique per enclave and needs to be formatted according to RFC 1123. + # Service names of active services are unique per enclave and needs to be formatted according to RFC 1035. # Specifically, 1-63 lowercase alphanumeric characters with dashes and cannot start or end with dashes. + # Also service names have to start with a lowercase alphabet. # MANDATORY name = "example-datastore-server-1", @@ -373,6 +374,85 @@ response = plan.request( For more details see [ `jq`'s builtin operators and functions](https://stedolan.github.io/jq/manual/#Builtinoperatorsandfunctions) +run_python +---------- + +The `run_python` instruction executes a one-time execution task. It runs the Python script specified by the mandatory field `run` on an image specified by the optional `image` field. + +```python + result = plan.run_python( + # The Python script to execute as a string + # This will get executed via '/bin/sh -c "python /tmp/python/main.py"'. + # Where `/tmp/python/main.py` is path on the temporary container; + # on which the script is written before it gets run + # MANDATORY + run = """ + import requests + response = requests.get("docs.kurtosis.com") + print(response.status_code) + """, + + # Arguments to be passed t o the Python script defined in `run` + # OPTIONAL (Default: []) + args = [ + some_other_service.ports["http"].url, + ], + + # Packages that the Python script requires which will be installed via `pip` + # OPTIONAL (default: []) + packages = [ + "selenium", + "requests", + ], + + # Image the Python script will be run on + # OPTIONAL (Default: python:3.11-alpine) + image = "python:3.11-alpine", + + # A mapping of path_on_task_where_contents_will_be_mounted -> files_artifact_id_to_mount + # For more information about file artifacts, see below. + # CAUTION: duplicate paths to files or directories to be mounted is not supported, and it will fail + # OPTIONAL (Default: {}) + files = { + "/path/to/file/1": files_artifact_1, + "/path/to/file/2": files_artifact_2, + }, + + # list of paths to directories or files that will be copied to a file artifact + # CAUTION: all the paths in this list must be unique + # OPTIONAL (Default:[]) + store = [ + # copies a file into a file artifact + "/src/kurtosis.txt", + + # copies the entire directory into a file artifact + "/src", + ], + + # The time to allow for the command to complete. If the Python script takes longer than this, + # Kurtosis will kill the script and mark it as failed. + # You may specify a custom wait timeout duration or disable the feature entirely. + # You may specify a custom wait timeout duration with a string: + # wait = "2m" + # Or, you can disable this feature by setting the value to None: + # wait = None + # The feature is enabled by default with a default timeout of 180s + # OPTIONAL (Default: "180s") + wait="180s" + ) + + plan.print(result.code) # returns the future reference to the exit code + plan.print(result.output) # returns the future reference to the output + plan.print(result.file_artifacts) # returns the file artifact names that can be referenced later +``` + +The `files` dictionary argument accepts a key value pair, where `key` is the path where the contents of the artifact will be mounted to and `value` is a [file artifact][files-artifacts-reference] name. + +The instruction returns a `struct` with [future references][future-references-reference] to the ouput and exit code of the Python script, 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:- + run_sh ------------- diff --git a/docs/versioned_docs/version-0.80.9/starlark-reference/port-spec.md b/docs/versioned_docs/version-0.80.14/starlark-reference/port-spec.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/starlark-reference/port-spec.md rename to docs/versioned_docs/version-0.80.14/starlark-reference/port-spec.md diff --git a/docs/versioned_docs/version-0.80.9/starlark-reference/post-http-request-recipe.md b/docs/versioned_docs/version-0.80.14/starlark-reference/post-http-request-recipe.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/starlark-reference/post-http-request-recipe.md rename to docs/versioned_docs/version-0.80.14/starlark-reference/post-http-request-recipe.md diff --git a/docs/versioned_docs/version-0.80.9/starlark-reference/read-file.md b/docs/versioned_docs/version-0.80.14/starlark-reference/read-file.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/starlark-reference/read-file.md rename to docs/versioned_docs/version-0.80.14/starlark-reference/read-file.md diff --git a/docs/versioned_docs/version-0.80.9/starlark-reference/ready-condition.md b/docs/versioned_docs/version-0.80.14/starlark-reference/ready-condition.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/starlark-reference/ready-condition.md rename to docs/versioned_docs/version-0.80.14/starlark-reference/ready-condition.md diff --git a/docs/versioned_docs/version-0.80.9/starlark-reference/service-config.md b/docs/versioned_docs/version-0.80.14/starlark-reference/service-config.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/starlark-reference/service-config.md rename to docs/versioned_docs/version-0.80.14/starlark-reference/service-config.md diff --git a/docs/versioned_docs/version-0.80.9/starlark-reference/service.md b/docs/versioned_docs/version-0.80.14/starlark-reference/service.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/starlark-reference/service.md rename to docs/versioned_docs/version-0.80.14/starlark-reference/service.md diff --git a/docs/versioned_docs/version-0.80.9/starlark-reference/standard-library.md b/docs/versioned_docs/version-0.80.14/starlark-reference/standard-library.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/starlark-reference/standard-library.md rename to docs/versioned_docs/version-0.80.14/starlark-reference/standard-library.md diff --git a/docs/versioned_docs/version-0.80.9/starlark-reference/uniform-packet-delay-distribution.md b/docs/versioned_docs/version-0.80.14/starlark-reference/uniform-packet-delay-distribution.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/starlark-reference/uniform-packet-delay-distribution.md rename to docs/versioned_docs/version-0.80.14/starlark-reference/uniform-packet-delay-distribution.md diff --git a/docs/versioned_docs/version-0.80.9/starlark-reference/update-service-config.md b/docs/versioned_docs/version-0.80.14/starlark-reference/update-service-config.md similarity index 100% rename from docs/versioned_docs/version-0.80.9/starlark-reference/update-service-config.md rename to docs/versioned_docs/version-0.80.14/starlark-reference/update-service-config.md diff --git a/docs/versioned_docs/version-0.80.9/cli-reference/engine-restart.md b/docs/versioned_docs/version-0.80.9/cli-reference/engine-restart.md deleted file mode 100644 index 5d2c0e6879..0000000000 --- a/docs/versioned_docs/version-0.80.9/cli-reference/engine-restart.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: engine restart -sidebar_label: engine restart -slug: /engine-restart ---- - -The CLI interacts with the Kurtosis engine, which is a very lightweight container. The CLI will start the engine container automatically for you and you should never need to start it manually, but you might need to restart the engine after a CLI upgrade. To do so, run: - -```bash -kurtosis engine restart -``` \ No newline at end of file diff --git a/docs/versioned_sidebars/version-0.80.9-sidebars.json b/docs/versioned_sidebars/version-0.80.14-sidebars.json similarity index 99% rename from docs/versioned_sidebars/version-0.80.9-sidebars.json rename to docs/versioned_sidebars/version-0.80.14-sidebars.json index 57ab50ac97..32ce34c9a2 100644 --- a/docs/versioned_sidebars/version-0.80.9-sidebars.json +++ b/docs/versioned_sidebars/version-0.80.14-sidebars.json @@ -71,6 +71,7 @@ ] }, "sdk", + "faq", "best-practices", "package-index", "changelog" diff --git a/docs/versions.json b/docs/versions.json index 498955966f..9af86a10a5 100644 --- a/docs/versions.json +++ b/docs/versions.json @@ -1,9 +1,9 @@ [ + "0.80.14", "0.80.13", "0.80.12", "0.80.11", "0.80.10", - "0.80.9", "0.79.0", "0.78.5", "0.77.4", diff --git a/version.txt b/version.txt index e55c2c8d8f..92f0664607 100644 --- a/version.txt +++ b/version.txt @@ -1 +1 @@ -0.80.13 +0.80.14