diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml index 8f61386ea9..887b46711e 100644 --- a/.github/workflows/release-please.yml +++ b/.github/workflows/release-please.yml @@ -17,8 +17,8 @@ jobs: token: "${{ secrets.RELEASER_TOKEN }}" release-type: simple package-name: kurtosis - bump-minor-pre-major: true - bump-patch-for-minor-pre-major: true + bump-minor-pre-major: false + bump-patch-for-minor-pre-major: false # Our CI, Docker Images, Kurtosis-SDK bumps all depend on # non v tags include-v-in-tag: false diff --git a/MAINTAINERS.md b/MAINTAINERS.md new file mode 100644 index 0000000000..af8ec791ad --- /dev/null +++ b/MAINTAINERS.md @@ -0,0 +1,15 @@ +# Maintainers + +This document lists the individuals who are responsible for maintaining and contributing to the development of this project. + +## Core Maintainers + +- [Gyanendra Mishra](https://github.com/h4ck3rk3y) - Software Engineer @KurtosisTech +- [Tedi Mitiku](https://github.com/tedim52) - Software Engineer @KurtosisTech +- [Dan Park](https://github.com/chunha-park) - BD/Product Marketing @KurtosisTech +- [Barnabas Busa](https://github.com/barnabasbusa) - Dev Ops @Ethereum Foundation +- [Parithosh Jayanthi](https://github.com/parithosh) - Dev Ops @Ethereum Foundation +- [John Hilliard](https://github.com/praetoriansentry) - Dev Tools @Polygon Labs +- [Léo Vincent](https://github.com/leovct) - Dev Tools @Polygon Labs + +For any inquiries or questions regarding the project, please contact one of the core maintainers listed above. diff --git a/docs/docs/api-reference/starlark-reference/plan.md b/docs/docs/api-reference/starlark-reference/plan.md index 72f079d07b..47cf3e2408 100644 --- a/docs/docs/api-reference/starlark-reference/plan.md +++ b/docs/docs/api-reference/starlark-reference/plan.md @@ -613,6 +613,10 @@ The `run_sh` instruction executes a one-time execution task. It runs the bash co # MANDATORY run = "mkdir -p kurtosis && echo $(ls)", + # The name of the container, as a string + # OPTIONAL (Default: task--UUID) + name = "curl-job" + # Image the command will be run on # OPTIONAL (Default: badouralix/curl-jq) image = "badouralix/curl-jq", diff --git a/docs/docs/get-started/quickstart.md b/docs/docs/get-started/quickstart.md index 19c4edcba9..2883575698 100644 --- a/docs/docs/get-started/quickstart.md +++ b/docs/docs/get-started/quickstart.md @@ -206,6 +206,7 @@ Now that you've use the Kurtosis CLI to run a package, inspect the resulting env [write-your-first-package]: ../get-started/write-your-first-package.md [running-in-k8s]: ../guides/running-in-k8s.md [running-docker-compose]: ../guides/running-docker-compose.md +[self-cloud-hosting]: ../guides/self-cloud-hosting.md [architecture-explanation]: ../advanced-concepts/architecture.md diff --git a/docs/docs/guides/self-cloud-hosting.md b/docs/docs/guides/self-cloud-hosting.md new file mode 100644 index 0000000000..339e3e7d15 --- /dev/null +++ b/docs/docs/guides/self-cloud-hosting.md @@ -0,0 +1,25 @@ +--- +title: Running Kurtosis in your own Cloud +sidebar_label: Running in your own Cloud +slug: /self-hosting +sidebar_position: 14 +--- + +This guide will help you set up Kurtosis in your own cloud and exposing it using one of your subdomains e.g. `kurtosis..com` + +I. Prerequisites +----------------- + +1. Public facing gateway (e.g. AWS ALB) supporting the Kurtosis subdomain with certificate. The certificate should support the subdomain name and a wildcard subdomain prefix `*.` since the service port URLs format is `port-service-enclave.`. The gateway should terminate TLS. +2. Host running Ubuntu to install and configure Kurtosis on. The host should be on a private subnet receiving traffic from the Gateway on port 80. Healthchecks should use the `/status` URL. + +![self-hosting-overview](/img/guides/self-hosting-overview.png) + +II. Kurtosis Installation +----------------- + +We provide an install script setting up Docker, Nginx and Kurtosis. The script takes as arguments your subdomain name, a username and password for HTTP basic authentication. + +```bash +curl -s https://raw.githubusercontent.com/kurtosis-tech/kurtosis-cloud-config/main/self-hosting-setup.sh | bash -s +``` diff --git a/docs/static/img/guides/self-hosting-overview.png b/docs/static/img/guides/self-hosting-overview.png new file mode 100644 index 0000000000..54453a6ae1 Binary files /dev/null and b/docs/static/img/guides/self-hosting-overview.png differ diff --git a/enclave-manager/web/yarn.lock b/enclave-manager/web/yarn.lock index 50eaa5ad46..faa3722883 100644 --- a/enclave-manager/web/yarn.lock +++ b/enclave-manager/web/yarn.lock @@ -15937,14 +15937,14 @@ write-pkg@^4.0.0: write-json-file "^3.2.0" ws@^7.4.6: - version "7.5.9" - resolved "https://registry.yarnpkg.com/ws/-/ws-7.5.9.tgz#54fa7db29f4c7cec68b1ddd3a89de099942bb591" - integrity sha512-F+P9Jil7UiSKSkppIiD94dN07AwvFixvLIj1Og1Rl9GGMuNipJnV9JzjD6XuqmAeiswGvUmNLjr5cFuXwNS77Q== + version "7.5.10" + resolved "https://registry.yarnpkg.com/ws/-/ws-7.5.10.tgz#58b5c20dc281633f6c19113f39b349bd8bd558d9" + integrity sha512-+dbF1tHwZpXcbOJdVOkzLDxZP1ailvSxM6ZweXTegylPny803bFhA+vqBYw4s31NSAk4S2Qz+AKXK9a4wkdjcQ== ws@^8.13.0: - version "8.15.0" - resolved "https://registry.yarnpkg.com/ws/-/ws-8.15.0.tgz#db080a279260c5f532fc668d461b8346efdfcf86" - integrity sha512-H/Z3H55mrcrgjFwI+5jKavgXvwQLtfPCUEp6pi35VhoB0pfcHnSoyuTzkBEZpzq49g1193CUEwIvmsjcotenYw== + version "8.17.1" + resolved "https://registry.yarnpkg.com/ws/-/ws-8.17.1.tgz#9293da530bb548febc95371d90f9c878727d919b" + integrity sha512-6XQFvXTkbfUOZOKKILFG1PDK2NDQs4azKQl26T0YS5CxqWLgXajbPZ+h4gZekJyRqFU8pvnbAbbs/3TgRPy+GQ== xml-name-validator@^3.0.0: version "3.0.0"