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..19f8356c1d --- /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. + +![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..e69de29bb2