Skip to content

Commit

Permalink
Merge branch 'main' into tedi/tasklogs
Browse files Browse the repository at this point in the history
  • Loading branch information
tedim52 committed Jun 21, 2024
2 parents 27eb4d1 + f662d45 commit 0750012
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/docs/api-reference/starlark-reference/plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
1 change: 1 addition & 0 deletions docs/docs/get-started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

<!--------------------------- Advanced Concepts ------------------------------------>
[architecture-explanation]: ../advanced-concepts/architecture.md
Expand Down
25 changes: 25 additions & 0 deletions docs/docs/guides/self-cloud-hosting.md
Original file line number Diff line number Diff line change
@@ -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.<your domain>.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 `*.<subdomain>` since the service port URLs format is `port-service-enclave.<subdomain>`. 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 <subdomain name> <username> <password>
```
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0750012

Please sign in to comment.