Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add cloud cli commands #1557

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

docs: add cloud cli commands #1557

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
84ff867
docs: add cloud cli commands
leeederek Oct 13, 2023
97ab2e1
clarify that its 1 instance per api key
leeederek Oct 13, 2023
ac3ec37
double a
omar711 Oct 16, 2023
76699e7
double a
omar711 Oct 16, 2023
5898e60
double a
omar711 Oct 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/docs/cli-reference/cloud-add.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: cloud add
sidebar_label: cloud add
slug: /cloud-add
---

This command is used to create a new Kurtosis Cloud instance under your Cloud account. This command requires you to have a a Kurtosis Cloud API key. To sign up for a new Kurtosis Cloud account and to get your Kurotsis Cloud API key, visit [Kurtosis Cloud](https://cloud.kurtosis.com) and head on over to the "Connect" section and follow the instructions.

```console
kurtosis cloud add
```

:::note
Only certain users with elevated permissions are allowed to create more than 1 Kurtosis Cloud instance.
leeederek marked this conversation as resolved.
Show resolved Hide resolved
:::
15 changes: 15 additions & 0 deletions docs/docs/cli-reference/cloud-load.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: cloud load
sidebar_label: cloud load
slug: /cloud-load
---

This command will connect your local machine to the given remote Kurtosis Cloud instance. This command requires you to have a a Kurtosis Cloud API key. To sign up for a new Kurtosis Cloud account and to get your Kurotsis Cloud API key, visit [Kurtosis Cloud](https://cloud.kurtosis.com) and head on over to the "Connect" section and follow the instructions.

```
kurtosis cloud load $YOUR_CLOUD_INSTANCE_ID
```

:::note
You can find our Cloud Instance ID on the ["Connect" page on Kurtosis Cloud](https://cloud.kurtosis.com/connect).
:::
15 changes: 15 additions & 0 deletions docs/docs/cli-reference/cloud-unload.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: cloud unload
sidebar_label: cloud unload
slug: /cloud-unload
---

This command will disconnect your local machine from the given remote Kurtosis Cloud instance and will switch you back to using your local Kurtosis engine. This command requires you to have a a Kurtosis Cloud API key. To sign up for a new Kurtosis Cloud account and to get your Kurotsis Cloud API key, visit [Kurtosis Cloud](https://cloud.kurtosis.com) and head on over to the "Connect" section and follow the instructions.

```
kurtosis cloud unload $YOUR_CLOUD_INSTANCE_ID
```

:::note
You can find our Cloud Instance ID on the ["Connect" page on Kurtosis Cloud](https://cloud.kurtosis.com/connect).
:::
2 changes: 1 addition & 1 deletion docs/docs/guides/running-in-kurtosis-cloud.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ slug: /cloud
sidebar_position: 7
---

Kurtosis Cloud is a fully managed cloud offering and accompanying self-service workflows for a stress-free, easy way to deploy test and dev environments, that live as long as you need them to, directly onto remote infrastructure. By logging into our [cloud portal](https://cloud.kurtosis.com), a cloud instance will be provisioned to run your test and dev enclaves.
Kurtosis Cloud is a fully managed cloud service that provides self-service workflows, allowing for an easy and stress-free deployment of test and dev environments directly onto remote infrastructure. These environments can persist for as long as you require. By logging into our [cloud portal](https://cloud.kurtosis.com), a cloud instance will be provisioned to run your test and dev enclaves.

You can interact with your enclaves using the UI (or the [CLI](./installing-the-cli.md#ii-install-the-cli) for more advanced use cases).

Expand Down