You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Sep 17, 2022. It is now read-only.
Upsert will create a new suite in APId cloudcontaining all the transactions defined in `apid.yaml` in the current directory. If a suite with the specified name exists it will replace it instead.
4
+
5
+
It can optionally take a path to the config via the `-c` or `--config` flag. To get familiar with the syntax of a config file, see [here](../../cloud.md)
6
+
7
+
## Details
8
+
9
+
Suites in APId cloud use the same syntax as the locally ran configs, thus it is really easy to upload your existing tests with one command. The only difference is that you'll need to provide a couple of extra top level values - `schedule` and a list of `locations`. These are needed so APId knows when and where to execute your suite. You can learn more about these in the config [Reference](../reference/README.md) section.
10
+
11
+
## Flags
12
+
13
+
| Flag | Short | Required | Default | Description |
| schedule | string | no; yes for cloud | A [valid cron expression](https://en.wikipedia.org/wiki/Cron#CRON_expression)|
15
-
16
-
We support `?``/``*``,``-` as well as the standard macros `@yearly``@annually``@monthly``@weekly``@daily``@midnight``@hourly``@every <duration>` (`<duration>` is a sequence of numbers with time units: "ns", "us", "ms", "s", "m", "h") |
15
+
16
+
We support `?``/``*``,``-` as well as the standard macros `@yearly``@annually``@monthly``@weekly``@daily``@midnight``@hourly``@every <duration>` (`<duration>` is a sequence of numbers with time units: "ns", "us", "ms", "s", "m", "h") |
17
17
18
18
All times will be interpreted in GMT+0.
19
19
@@ -34,15 +34,30 @@ configs (suites) from a directory and multiple files contain `locations`, it's n
34
34
set of locations will be used. It's not a problem if they are the same.
Copy file name to clipboardExpand all lines: docs/cloud/README.md
+12-23Lines changed: 12 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,30 +2,21 @@
2
2
3
3
Besides being able to run your tests from your local machine, APId also has the functionality to run from around the world. This functionality is powered by the APId cloud offering.
4
4
5
-
## How it works
5
+
## Scheduled execution
6
6
7
-
The cloud offering works pretty much the same way. You need to define your transactions, as you would with the CLI, and then using the APId CLI issue a `remote` command. This works as follows:
7
+
This is the most powerful mode of APId cloud. It allows you to define a set of checks, upload them and let us run them on a predefined schedule and from predefined locations for you! You'll get a notification as soon as when we detect something went wrong with your API!
8
8
9
-
- The CLI reads the transactions from the specified directory or file, as per ususal
10
-
- It will execute each transaction, sending the necessary `STEP` information to the cloud for remote execution
11
-
- It will wait for each `STEP` result to come back and continue with the other steps and transactions
9
+
-[more information](cloud.md)
12
10
13
-
One major benefit of this workflow is that all the interpolation is done locally (on the machine running the CLI), thus you have control over the environment it runs in. This means you can invoke any custom executables.
11
+
## On demand remote execution
14
12
15
-
## Usage
13
+
The remote execution offering works pretty much the same way. You need to define your transactions, as you would with the CLI, and then using the APId CLI issue a `remote` command.
16
14
17
-
In order to use the power of the cloud you will need a personal access key. To generate one, you will have to:
18
-
19
-
- Head over to https://www.getapid.com and sign up
20
-
- Go to the dashboard and create a new access key
21
-
22
-
Once you have your key you will need to [install the APId CLI](../installation/cli.md) (if you haven't already) or use our [official docker image](../installation/docker.md).
23
-
24
-
A reference on how use the CLI after installation for remote execution can be found [here](../cli/remote.md).
15
+
-[more information](remote.md)
25
16
26
17
## Regions
27
18
28
-
APId cloud runs in multiple regions worldwide. Below is a list of the current ones. The default region is set to Washington.
19
+
APId cloud runs in multiple regions worldwide. Below is a list of the current ones.
29
20
30
21
| Region Name | Location |
31
22
| :----------- | :------------ |
@@ -40,17 +31,15 @@ APId cloud runs in multiple regions worldwide. Below is a list of the current on
40
31
| frankfurt | Frankfurt |
41
32
| saopaulo | Sao Paulo |
42
33
43
-
## Timeouts
44
-
45
-
The execution timeout is set to 30 seconds. If your API does not respond within that time an error is returned.
46
-
47
34
## Billing
48
35
49
-
We've tried making the billing model as simple as possible. Each account has a quota of units they can use each month for running their tests on the cloud infrastructure.
36
+
We've tried making the billing model as simple as possible. Each account has a free tier quota of units they can use each month for running their tests on the cloud infrastructure, after which there is a flat fee for each unit used.
37
+
38
+
Each unit corresponds to 100ms of execution time.
50
39
51
-
Each unit corresponds to 100ms of execution time of a step - thus the response time of the API for each step.
40
+
In case of on demand remote execution, you will be billed separately for every step.
52
41
53
-
You are not billed for any interpolation or step preparation (which is done on the machine you're running the CLI on).
42
+
When using scheduled execution you're billed for the whole duration of the suite execution.
Scheduled execution works pretty much the same way. You need to define your transactions, as you would with the CLI, and then using the APId CLI upload them to APId cloud. This works as follows:
4
+
5
+
- The CLI reads the transactions from the specified directory or file, as per ususal\
6
+
- The CLI will marshal the transactions and upload them to the APId cloud with the provided suite name. A suite is a bundle of transactions that will be executed together.
7
+
- APId cloud will read the configuration you've uploaded and will execute the transactions from each of the specified locations as per the schedule.
8
+
9
+
There are some caveats in doing this, mainly that shell commands DO NOT work, since, well, it's a remote machine.
10
+
11
+
## Usage
12
+
13
+
In order to use the power of the cloud you will need a personal access key. To generate one, you will have to:
14
+
15
+
- Head over to https://console.getapid.com and sign up
16
+
- Go to the settings page and create a new access key
17
+
18
+
Once you have your key you will need to [install the APId CLI](../installation/cli.md) (if you haven't already) or use our [official docker image](../installation/docker.md).
19
+
20
+
A reference on how use the CLI after installation for uploading suites can be found [here](../cli/cloud/upload.md).
The remote execution offering works pretty much the same way. You need to define your transactions, as you would with the CLI, and then using the APId CLI issue a `remote` command. This works as follows:
4
+
5
+
- The CLI reads the transactions from the specified directory or file, as per ususal
6
+
- It will execute each transaction, sending the necessary `STEP` information to the cloud for remote execution
7
+
- It will wait for each `STEP` result to come back and continue with the other steps and transactions
8
+
9
+
One major benefit of this workflow is that all the interpolation is done locally (on the machine running the CLI), thus you have control over the environment it runs in. This means you can invoke any custom executables.
10
+
11
+
## Usage
12
+
13
+
In order to use the power of the cloud you will need a personal access key. To generate one, you will have to:
14
+
15
+
- Head over to https://console.getapid.com and sign up
16
+
- Go to the dashboard and create a new access key
17
+
18
+
Once you have your key you will need to [install the APId CLI](../installation/cli.md) (if you haven't already) or use our [official docker image](../installation/docker.md).
19
+
20
+
A reference on how use the CLI after installation for remote execution can be found [here](../cli/remote.md).
21
+
22
+
## Regions
23
+
24
+
APId cloud runs in multiple regions worldwide. Below is a list of the current ones. The default region is set to Washington.
25
+
26
+
| Region Name | Location |
27
+
| :----------- | :------------ |
28
+
| montreal | Montreal |
29
+
| washington | Washington |
30
+
| sanfrancisco | San Francisco |
31
+
| mumbai | Mumbai |
32
+
| tokyo | Tokyo |
33
+
| sydney | Sydney |
34
+
| dublin | Dublin |
35
+
| stockholm | Stockholm |
36
+
| frankfurt | Frankfurt |
37
+
| saopaulo | Sao Paulo |
38
+
39
+
## Timeouts
40
+
41
+
The execution timeout is set to 30 seconds. If your API does not respond within that time an error is returned.
42
+
43
+
## Billing
44
+
45
+
We've tried making the billing model as simple as possible. Each account has a quota of units they can use each month for running their tests on the cloud infrastructure.
46
+
47
+
Each unit corresponds to 100ms of execution time of a step - thus the response time of the API for each step.
48
+
49
+
You are not billed for any interpolation or step preparation (which is done on the machine you're running the CLI on).
0 commit comments