Skip to content

Commit

Permalink
k8s helm install docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kuzxnia committed Mar 17, 2024
1 parent fb58513 commit 3160dcb
Show file tree
Hide file tree
Showing 5 changed files with 97 additions and 43 deletions.
40 changes: 40 additions & 0 deletions docs/cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
hide:
- navigation
---





### CLI usage

```
$ loadbot
A command-line database workload driver
Usage:
lbot [command]
Agent Commands:
start-agent Start lbot-agent
Driver Commands:
config Config
progress Watch stress test
start Start stress test
stop Stopping stress test
Additional Commands:
completion Generate the autocompletion script for the specified shell
help Help about any command
Flags:
-u, --agent-uri string loadbot agent uri (default: 127.0.0.1:1234) (default "127.0.0.1:1234")
-h, --help help for lbot
--log-format string log format, must be one of: json, fancy (default "fancy")
--log-level string log level, must be one of: trace, debug, info, warn, error, fatal, panic (default "info")
-v, --version version for lbot
Use "lbot [command] --help" for more information about a command.
```
5 changes: 0 additions & 5 deletions docs/cli/loadbot.md

This file was deleted.

51 changes: 51 additions & 0 deletions docs/getting_started/k8s-orchiestration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@

You can run your workload locally, from remote servers, or directly on a Kubernetes cluster. However, deploying your workload on Kubernetes offers several advantages, including:

- Easy Scaling: Kubernetes enables you to scale your workload effortlessly by adjusting the number of replicas or utilizing features like Horizontal Pod Autoscaler.

- Resource Management: Kubernetes provides robust resource management capabilities, allowing you to efficiently allocate and manage resources such as CPU and memory for your workload. You can overwrite default values using `helm-set` flag.


### Installation
To install your workload using Loadbot on a Kubernetes cluster, you can use the following command:

```bash
loadbot install \
--context dev \
--namespace default \
--helm-set workload.replicas=2 \
--workload-config config.json \
myworkload

```

### Uninstall
To uninstall your workload from the Kubernetes cluster, you can use the following command:

```bash
loadbot uninstall \
--context dev \
--namespace default \
myworkload

```

### Upgrade
To upgrade your workload on the Kubernetes cluster, you can use the following command:

```bash
loadbot upgrade \
--context dev \
--namespace default \
--helm-set workload.replicas=2 \
--workload-config config.json \
myworkload

```

### List
To list the workloads deployed on the Kubernetes cluster, you can use the following command:

```bash
loadbot list --context dev --namespace default
```
34 changes: 1 addition & 33 deletions docs/getting_started/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ loadbot start-agent -f config_file.json

2. Start and watch the workload using the loadbot client:
```bash
loadbot start --progress
loadbot start-agent --progress
Job "My first job" |██████████████████████████████████████████████████████████████████| 30/30S 50RPS 1509REQ
```

Expand Down Expand Up @@ -59,35 +59,3 @@ For more information on defining [jobs](https://kuzxnia.github.io/loadbot/loadbo
}

```

### CLI usage

```
$ loadbot
A command-line database workload driver

Usage:
lbot [command]

Agent Commands:
start-agent Start lbot-agent

Driver Commands:
config Config
progress Watch stress test
start Start stress test
stop Stopping stress test

Additional Commands:
completion Generate the autocompletion script for the specified shell
help Help about any command

Flags:
-u, --agent-uri string loadbot agent uri (default: 127.0.0.1:1234) (default "127.0.0.1:1234")
-h, --help help for lbot
--log-format string log format, must be one of: json, fancy (default "fancy")
--log-level string log level, must be one of: trace, debug, info, warn, error, fatal, panic (default "info")
-v, --version version for lbot

Use "lbot [command] --help" for more information about a command.
```
10 changes: 5 additions & 5 deletions mkdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,12 @@ nav:
# - Intro: getting_started/intro.md
- Install Guide: getting_started/install.md
- Quick Start: getting_started/quick-start.md
- How it works: getting_started/how-it-works.md
- Multi instance: getting_started/multi-instance.md
- K8S orchiestration: getting_started/k8s-orchiestration.md
# - How it works: getting_started/how-it-works.md
# - Distributed workload: getting_started/multi-instance.md
- K8S: getting_started/k8s-orchiestration.md

- Command Line Usage:
- cli/loadbot.md
# - Command Line Usage:
# - cli.md

- Configuration:
- setup/index.md
Expand Down

0 comments on commit 3160dcb

Please sign in to comment.