Skip to content

Commit ca0bfc3

Browse files
joshistegitbook-bot
authored andcommitted
GITBOOK-127: change request with no subject merged in GitBook
1 parent 1062379 commit ca0bfc3

25 files changed

+114
-87
lines changed

.gitbook/assets/discovery-kit (1).png

26.2 KB
Loading

.gitbook/assets/widget (1).png

30.9 KB
Loading

SUMMARY.md

+60-58
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,79 @@
11
# Table of contents
22

3-
- [Welcome to Steadybit](README.md)
3+
* [Welcome to Steadybit](README.md)
44

55
## Quick Start
66

7-
- [First Steps](quick-start/getting-started.md)
8-
- [Install Agents](quick-start/set-up-agents.md)
9-
- [Run an Experiment](quick-start/run-experiment.md)
10-
- [Deploy Example Application](quick-start/deploy-example-application.md)
7+
* [First Steps](quick-start/getting-started.md)
8+
* [Install Agents](quick-start/set-up-agents.md)
9+
* [Run an Experiment](quick-start/run-experiment.md)
10+
* [Deploy Example Application](quick-start/deploy-example-application.md)
1111

1212
## Concepts
13-
- [Actions](concepts/actions/README.md)
14-
- [Discovery](concepts/discovery/README.md)
15-
- [Query Language](concepts/query-language/README.md)
13+
14+
* [Actions](concepts/actions/README.md)
15+
* [Discovery](concepts/discovery/README.md)
16+
* [Query Language](concepts/query-language/README.md)
1617

1718
## Install and Configure
1819

19-
- [Install Agent](install-and-configure/install-agent/README.md)
20-
- [Architecture](install-and-configure/install-agent/agent-architecture.md)
21-
- [Install on Kubernetes](install-and-configure/install-agent/install-on-kubernetes.md)
22-
- [Install on Linux Hosts](install-and-configure/install-agent/install-on-linux-hosts.md)
23-
- [Install using Docker Compose](install-and-configure/install-agent/install-as-docker-container.md)
24-
- [Install on Amazon ECS](install-and-configure/install-agent/aws-ecs-ec2.md)
25-
- [Extension Discovery](install-and-configure/install-agent/extension-discovery.md)
26-
- [Using Mutual TLS for Extensions](install-and-configure/install-agent/using-mutual-tls-for-extensions.md)
27-
- [Configuration Options](install-and-configure/install-agent/advanced-configuration.md)
28-
- [Install On-Prem Platform](install-and-configure/install-on-prem-platform/README.md)
29-
- [Install on Kubernetes](install-and-configure/install-on-prem-platform/k8s.md)
30-
- [Advanced Agent Authentication](install-and-configure/install-on-prem-platform/advanced-agent-authentication.md)
31-
- [Configuration Options](install-and-configure/install-on-prem-platform/advanced-configuration.md)
32-
- [Maintenance & Incident Support](install-and-configure/install-on-prem-platform/maintenance-and-incident-support.md)
33-
- [Manage Environments](install-and-configure/manage-environments/README.md)
34-
- [Manage Teams and Users](install-and-configure/manage-teams-and-users/README.md)
35-
- [Users](install-and-configure/manage-teams-and-users/users.md)
36-
- [Teams](install-and-configure/manage-teams-and-users/teams.md)
37-
- [Permissions](install-and-configure/manage-teams-and-users/permissions.md)
20+
* [Install Agent](install-and-configure/install-agent/README.md)
21+
* [Architecture](install-and-configure/install-agent/agent-architecture.md)
22+
* [Install on Kubernetes](install-and-configure/install-agent/install-on-kubernetes.md)
23+
* [Install on Linux Hosts](install-and-configure/install-agent/install-on-linux-hosts.md)
24+
* [Install using Docker Compose](install-and-configure/install-agent/install-as-docker-container.md)
25+
* [Install on Amazon ECS](install-and-configure/install-agent/aws-ecs-ec2.md)
26+
* [Extension Discovery](install-and-configure/install-agent/extension-discovery.md)
27+
* [Using Mutual TLS for Extensions](install-and-configure/install-agent/using-mutual-tls-for-extensions.md)
28+
* [Configuration Options](install-and-configure/install-agent/advanced-configuration.md)
29+
* [Install On-Prem Platform](install-and-configure/install-on-prem-platform/README.md)
30+
* [Install on Kubernetes](install-and-configure/install-on-prem-platform/k8s.md)
31+
* [Advanced Agent Authentication](install-and-configure/install-on-prem-platform/advanced-agent-authentication.md)
32+
* [Configuration Options](install-and-configure/install-on-prem-platform/advanced-configuration.md)
33+
* [Maintenance & Incident Support](install-and-configure/install-on-prem-platform/maintenance-and-incident-support.md)
34+
* [Manage Environments](install-and-configure/manage-environments/README.md)
35+
* [Manage Teams and Users](install-and-configure/manage-teams-and-users/README.md)
36+
* [Users](install-and-configure/manage-teams-and-users/users.md)
37+
* [Teams](install-and-configure/manage-teams-and-users/teams.md)
38+
* [Permissions](install-and-configure/manage-teams-and-users/permissions.md)
3839

3940
## Use Steadybit
4041

41-
- [Experiments](use-steadybit/experiments/README.md)
42-
- [Design](use-steadybit/experiments/design.md)
43-
- [Run](use-steadybit/experiments/run.md)
44-
- [Emergency Stop](use-steadybit/experiments/emergencyStop.md)
45-
- [Share](use-steadybit/experiments/share.md)
46-
- [Duplicate](use-steadybit/experiments/duplicate-experiment/README.md)
47-
- [YML Import / Export](use-steadybit/experiments/yml-import-export/README.md)
48-
- [Schedule](use-steadybit/experiments/schedule.md)
49-
- [OpenTelemetry Integration](use-steadybit/experiments/opentelemetry-integration.md)
50-
- [Explorer](use-steadybit/explorer/README.md)
51-
- [Targets](use-steadybit/explorer/targets.md)
52-
- [Landscape](use-steadybit/explorer/landscape.md)
53-
- [Weakspots](use-steadybit/weakspots/README.md)
42+
* [Experiments](use-steadybit/experiments/README.md)
43+
* [Design](use-steadybit/experiments/design.md)
44+
* [Run](use-steadybit/experiments/run.md)
45+
* [Emergency Stop](use-steadybit/experiments/emergencyStop.md)
46+
* [Share](use-steadybit/experiments/share.md)
47+
* [Duplicate](use-steadybit/experiments/duplicate-experiment/README.md)
48+
* [YML Import / Export](use-steadybit/experiments/yml-import-export/README.md)
49+
* [Schedule](use-steadybit/experiments/schedule.md)
50+
* [OpenTelemetry Integration](use-steadybit/experiments/opentelemetry-integration.md)
51+
* [Explorer](use-steadybit/explorer/README.md)
52+
* [Targets](use-steadybit/explorer/targets.md)
53+
* [Landscape](use-steadybit/explorer/landscape.md)
54+
* [Weakspots](use-steadybit/weakspots/README.md)
5455

5556
## Integrate with Steadybit
5657

57-
- [Extensions](integrate-with-steadybit/extensions/README.md)
58-
- [Anatomy of an Extension](integrate-with-steadybit/extensions/anatomy-of-an-extension.md)
59-
- [Available Extensions](integrate-with-steadybit/extensions/available-extensions.md)
60-
- [Extension Installation](integrate-with-steadybit/extensions/extension-installation.md)
61-
- [Extension Kits](integrate-with-steadybit/extensions/extension-kits.md)
62-
- [API](integrate-with-steadybit/api.md)
63-
- [Interactive API Documentation](https://platform.steadybit.com/api/swagger)
64-
- [CLI](integrate-with-steadybit/cli.md)
65-
- [Badges](integrate-with-steadybit/badges.md)
66-
- [Webhooks](integrate-with-steadybit/webhooks/README.md)
67-
- [Custom Webhooks](integrate-with-steadybit/webhooks/custom-webhooks.md)
68-
- [Preflight Webhooks](integrate-with-steadybit/webhooks/preflight-webhooks.md)
69-
- [Slack Notifications](integrate-with-steadybit/slack-notifications.md)
70-
- [Audit Log](integrate-with-steadybit/audit-log.md)
58+
* [Extensions](integrate-with-steadybit/extensions/README.md)
59+
* [Anatomy of an Extension](integrate-with-steadybit/extensions/anatomy-of-an-extension.md)
60+
* [Available Extensions](integrate-with-steadybit/extensions/available-extensions.md)
61+
* [Extension Installation](integrate-with-steadybit/extensions/extension-installation.md)
62+
* [Extension Kits](integrate-with-steadybit/extensions/extension-kits.md)
63+
* [API](integrate-with-steadybit/api.md)
64+
* [Interactive API Documentation](https://platform.steadybit.com/api/swagger)
65+
* [CLI](integrate-with-steadybit/cli.md)
66+
* [Badges](integrate-with-steadybit/badges.md)
67+
* [Webhooks](integrate-with-steadybit/webhooks/README.md)
68+
* [Custom Webhooks](integrate-with-steadybit/webhooks/custom-webhooks.md)
69+
* [Preflight Webhooks](integrate-with-steadybit/webhooks/preflight-webhooks.md)
70+
* [Slack Notifications](integrate-with-steadybit/slack-notifications.md)
71+
* [Audit Log](integrate-with-steadybit/audit-log.md)
7172

7273
## Troubleshooting
7374

74-
- [Overview](troubleshooting/README.md)
75-
- [Extension](troubleshooting/extension.md)
76-
- [Agent](troubleshooting/agent.md)
77-
- [On-Prem Platform](troubleshooting/on-prem-platform.md)
75+
* [Overview](troubleshooting/README.md)
76+
* [Extension](troubleshooting/extension.md)
77+
* [Agent](troubleshooting/agent.md)
78+
* [Migrating From the Outpost Agent](troubleshooting/migrating-from-the-outpost-agent.md)
79+
* [On-Prem Platform](troubleshooting/on-prem-platform.md)

integrate-with-steadybit/extensions/extension-kits.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ You can learn more about ActionKit through its [GitHub repository](https://githu
1717

1818
## DiscoveryKit
1919

20-
<figure><img src="../../.gitbook/assets/discovery-kit.png" alt="DiscoveryKit logo depicting the text discovery kit and a radar dish icon"><figcaption><p>DiscoveryKit logo depicting the text discovery kit and a radar dish icon</p></figcaption></figure>
20+
<figure><img src="../../.gitbook/assets/discovery-kit (1).png" alt="DiscoveryKit logo depicting the text discovery kit and a radar dish icon"><figcaption><p>DiscoveryKit logo depicting the text discovery kit and a radar dish icon</p></figcaption></figure>
2121

2222
The Steadybit DiscoveryKit enables the extension of Steadybit with new discovery capabilities. For example, DiscoveryKit can be used to author open/closed source discoveries for:
2323

120 KB
Loading
120 KB
Loading
120 KB
Loading
120 KB
Loading
120 KB
Loading
120 KB
Loading
120 KB
Loading
120 KB
Loading
383 KB
Loading
383 KB
Loading
406 KB
Loading
406 KB
Loading
490 KB
Loading
490 KB
Loading
454 KB
Loading
454 KB
Loading
454 KB
Loading

quick-start/run-experiment.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -24,25 +24,25 @@ To do that, we start by creating a new experiment via our Wizard, which guides u
2424

2525
First step is to give our experiment a meaningful name and define the environment where to be executed. We choose the `Online Shop DEV` environment to get access to everything Steadybit has discovered for our demo online shop.
2626

27-
![Create experiment step 2](<run-experiment-step2.png>)
27+
![Create experiment step 2](<run-experiment-step2 (2).png>)
2828

2929
### Step 3 - Select Attack
3030

3131
Going to the next step, we can choose the attack. We want to simulate unavailability of the `hot-deals` container by isolating it from others. Therefore, we choose the attack "blackhole" on network level.
3232

33-
![Create experiment step 3](<run-experiment-step3.png>)
33+
![Create experiment step 3](<run-experiment-step3 (2).png>)
3434

3535
### Step 4 - Select Targets
3636

3737
In the next step we can define our target. Since our target of our experiment is a container running in Kubernetes, we select Container by the attribute `k8s.container.name`. Doing that, our experiment will be reusable even after container restarts.
3838

39-
![Create experiment step 4](<run-experiment-step4.png>)
39+
![Create experiment step 4](<run-experiment-step4 (2).png>)
4040

4141
### Step 5 - Set Impact and Attack Radius
4242

4343
Last but not least: We can define how large our impact is. When having a scaled system you may want to start with a small attack radius first - affecting only one container and not all replicas.
4444

45-
![Create experiment step 5](<run-experiment-step5.png>)
45+
![Create experiment step 5](<run-experiment-step5 (3).png>)
4646

4747
### Step 6 - Save Experiment
4848

@@ -58,7 +58,7 @@ Before running the experiment make sure to have the `/products`-endpoint open in
5858

5959
When hitting the "run experiment"-button you see the Steadybit run window.
6060

61-
![Run experiment - run window](<run-experiment-run2.png>)
61+
![Run experiment - run window](<run-experiment-run2 (8).png>)
6262

6363
You should notice that the `/products`-endpoint will not work while `hot-deals` is unavailable. This is not desirable as there are other products which could have been browsed by the customers of the online shop. You can improve this behavior by adding appropriate fallbacks or scaling the services.
6464

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Migrating From the Outpost Agent
2+
3+
## Helm Chart
4+
5+
We replaced the `steadybit-outpost` chart with the `steadybit-agent` chart. While the charts are structurally the same, this is not a drop-in replacement, as some defaults and prefixes change:
6+
7+
* The default container image is now `steadybit/agent`
8+
* All `outpost.*` values were renamed to `agent.*`
9+
* The sample command provided in the platform in the platform now suggests the `steadybit-agent` namespace.
10+
11+
For migrating:
12+
13+
1. Remove the old Helm release using `helm uninstall`
14+
2. Update your custom values to use the `agent.*` instead `outpost.*` of the prefix
15+
3. Install the new Helm chart using `helm install`
16+
17+
## Docker
18+
19+
The [https://get.steadybit.com/outpost.sh](https://get.steadybit.com/outpost.sh) was renamed to [https://get.steadybit.com/agent.sh](https://get.steadybit.com/agent.sh). The scripts are structurally identical but refer to the new `steadybit/agent` container image.&#x20;
20+
21+
For migrating: &#x20;
22+
23+
1. stop and remove the running containers&#x20;
24+
2. Install using the new `agent.sh`
25+
26+
## Linux Packages
27+
28+
The [https://get.steadybit.com/outpost-linux.sh](https://get.steadybit.com/outpost-linux.sh) was renamed to [https://get.steadybit.com/agent-linux.sh](https://get.steadybit.com/agent-linux.sh)[. ](https://get.steadybit.com/agent-linux.sh)The scripts are structurally identical but now install the steadybit-agent packages, and the configuration is located in `/etc/steadybit/agent.`
29+
30+
For migrating:
31+
32+
1. Remove the old `steadybit-outpost` packages using the system package manager
33+
2. Move the configuration using `sudo mv /etc/steadybit/outpost /etc/steadybit/agent`
34+
3. Install the new `steadybit-agent` package using your system package manager

use-steadybit/experiments/design.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -33,19 +33,19 @@ The wizard guides you step by step through the creation of the experiment. It co
3333

3434
1. **Define Experiment** First things first: Define the basic elements of the experiments like name, hypothesis and environment (see above).
3535

36-
![Create Experiment - Step 1: Define](<../../quick-start/run-experiment-step2.png>)
36+
![Create Experiment - Step 1: Define](<../../quick-start/run-experiment-step2 (2).png>)
3737

3838
1. **Select Attack** Now you are ready to choose a suitable attack from one of the available catgories to match your hypothesis. Choose the attack with the desired effect. If needed, you are able to provide additional settings for the attack. However, the defaults are usual a good way to go. To learn more about attacks, check out our [learn-attacks-section in the docs](../../concepts/actions/).
3939

40-
![Create Experiment - Step 2: Attack](<../../quick-start/run-experiment-step3.png>)
40+
![Create Experiment - Step 2: Attack](<../../quick-start/run-experiment-step3 (2).png>)
4141

4242
1. **Select Target** You can now select your desired targets by attributes where you can use the [discovery data](../../concepts/discovery/) to specify them with a dynamically evaluated query. Since these attributes are discovered by the agents and can change from one moment to the next, it is wise to choose stable attributes. Good examples are labels, namespaces or symbolic names - whereas a unique identifier of targets (like the container id) are usually a bad idea. When the experiment is due to be executed those attributes are resolved into a concrete set of targets to be attacked. You can use the "show targets" button next to the query to evaluate it's effect and preview matching targets.
4343

44-
![Create Experiment - Step 3: Targets](<../../quick-start/run-experiment-step4.png>)
44+
![Create Experiment - Step 3: Targets](<../../quick-start/run-experiment-step4 (2).png>)
4545

4646
1. **Impact and Attack Radius** You can limit your impact by defining an attack radius. It is a best practices to start easy and not by attacking your entire target selection. Therefore, specify the attack radius as a percentage or fixed number - limiting the amount of maximum affected e.g. hosts or containers. Even so, 100% is a valid value - but you need to be explicit about that.
4747

48-
![Create Experiment - Step 4: Impact Radius](<../../quick-start/run-experiment-step5.png>)
48+
![Create Experiment - Step 4: Impact Radius](<../../quick-start/run-experiment-step5 (3).png>)
4949

5050
After saving the experiment you are ready to [run it directly](./#run) or extend it using our editor (see blank experiment).
5151

0 commit comments

Comments
 (0)