-
Notifications
You must be signed in to change notification settings - Fork 58
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add docs about kurtosis gateway (#1558)
## 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
Showing
2 changed files
with
13 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters