Skip to content

Commit

Permalink
docs: add docs about kurtosis gateway (#1558)
Browse files Browse the repository at this point in the history
## Description:
This pull request adds docs for the `kurtosis gateway` command - a
previously undocumented command necessary for interaction with
kurtosis-on-k8s set ups.

## Is this change user facing?
YES

## References (if applicable):
  • Loading branch information
leeederek authored Oct 13, 2023
1 parent ccff275 commit 4cc93bf
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
11 changes: 11 additions & 0 deletions docs/docs/cli-reference/gateway.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: gateway
sidebar_label: gateway
slug: /gateway
---

The Kurtosis gateway command is exclusively for use with Kubernetes backends and is intended to be a command you invoke before interacting with a remote Kurtosis engine deployed on a Kubernetes clsuter. Assuming you have configured your `kurtosis-config.yml` file to work with your Kubernetes cluster [guide here](../guides/running-in-k8s.md), then this command will start a local "gateway" to connect your local machine to your remote Kubernetes cluster, enabling you to interact with the remote Kurtosis engine that lives on that cluster.

```console
kurtosis gateway
```
4 changes: 2 additions & 2 deletions docs/docs/guides/running-in-k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ kurtosis-clusters:
IV. Configure Kurtosis
--------------------------------
1. Run `kurtosis cluster set cloud`. This will start the engine remotely.
1. *In another terminal*, run `kurtosis gateway`. This will act as a middle man between your computer's ports and your services deployed on Kubernetes ports and has to stay running as a separate proccess.
1. Run `kurtosis cluster set cloud`. This will start the engine remotely. See the CLI reference for more information about `kurtosis cluster` commands [here](../cli-reference/cluster-set.md).
1. *In another terminal*, run [`kurtosis gateway`](../cli-reference/gateway.md). This will act as a middle man between your computer's ports and your services deployed on Kubernetes ports and has to stay running as a separate proccess.

Done! Now you can run any Kurtosis command or package just like if you were doing it locally.

Expand Down

0 comments on commit 4cc93bf

Please sign in to comment.