Skip to content

Commit efc82c4

Browse files
committed
Added context into the cloud documentation
1 parent e2eae17 commit efc82c4

File tree

2 files changed

+75
-8
lines changed

2 files changed

+75
-8
lines changed

config.toml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,17 @@ hasChildren = true
216216
url = "connectivity/zoho"
217217
weight = 15
218218

219+
[[menu.main]]
220+
weight = 4
221+
name = "Cloud"
222+
hasChildren = true
223+
224+
[[menu.main]]
225+
parent = "Cloud"
226+
name = "Usage"
227+
url = "cloud/usage"
228+
weight = 1
229+
219230
[params]
220231
logo = "logo-web.svg"
221232
logo_white = "logo-web.svg"

content/cloud/usage/_index.en.md

Lines changed: 64 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,35 +7,91 @@ draft: true
77
Gyroscops also allows you to have your satellites stored in the cloud.
88

99
Thanks to the cloud executable provided by the package `php-etl/satellite`,
10-
you can manage your satellites quickly and easily.
10+
you can manage your satellites quickly and easily thanks to command lines.
11+
12+
## Requirements
13+
14+
Before you start, make sure you have installed the utility in your project.
15+
16+
If you haven't already done so, simply run this command:
17+
18+
```shell
19+
composer require php-etl/satellite:'*'
20+
```
1121

1222
## Login to the API
1323

14-
The first thing you need to do is connect to the Cloud API. Without this first step, you won't be able to do anything.
24+
The `login` command is used to establish a connection with the Gyroscops API, allowing access to the various functionalities.
25+
Before executing this command, make sure you have the necessary identification information to hand.
1526

1627
```shell
1728
bin/cloud login
1829
```
1930

2031
> The service may ask you to select your organization and your workspace.
2132
22-
To see the arguments and options expected by the command, you can run the command :
33+
### Options
34+
- `-u`, `--url`: Base URL of the cloud instance [default: "https://app.gyroscops.com"]
35+
- `--beta`: Shortcut to set the cloud instance to https://beta.gyroscops.com
36+
- `--ssl`|`--no-ssl`: Enable or disable SSL
37+
- `--help`: Display help for the given command
38+
39+
See the following sections of this documentation for details of the various commands.
40+
41+
## Create your satellite
42+
43+
The `create` command is used to create a satellite associated with your account.
2344

2445
```shell
25-
bin/cloud login --help
46+
php bin/cloud create <path/to/satellite.yaml>
2647
```
2748

28-
## Create your satellite
49+
### Options
50+
- `-u`, `--url`: Base URL of the cloud instance [default: "https://app.gyroscops.com"]
51+
- `--beta`: Shortcut to set the cloud instance to https://beta.gyroscops.com
52+
- `--ssl`|`--no-ssl`: Enable or disable SSL
53+
- `--help`: Display help for the given command
54+
55+
Once you have created your satellite, you can access its configuration from the interface by following these steps:
56+
57+
- Open your favourite web browser
58+
- Enter the following URL in the address bar: https://app.gyroscops.com (or https://beta.gyroscops.com)
59+
- Log in with your credentials
60+
61+
## Update your satellite
62+
63+
The `update` command is used to update a given satellite.
2964

3065
```shell
31-
php bin/cloud create path/to/satellite.yaml
66+
php bin/cloud update <path/to/satellite.yaml>
3267
```
3368

34-
Once done, you will be able to control your satellite execution through the Gyroscops Cloud interface.
69+
### Options
70+
- `-u`, `--url`: Base URL of the cloud instance [default: "https://app.gyroscops.com"]
71+
- `--beta`: Shortcut to set the cloud instance to https://beta.gyroscops.com
72+
- `--ssl`|`--no-ssl`: Enable or disable SSL
73+
- `--help`: Display help for the given command
74+
75+
## Remove your satellite
76+
77+
The `remove` command is used to remove a given satellite.
78+
79+
```shell
80+
php bin/cloud update <path/to/satellite.yaml>
81+
```
82+
83+
### Options
84+
- `-u`, `--url`: Base URL of the cloud instance [default: "https://app.gyroscops.com"]
85+
- `--beta`: Shortcut to set the cloud instance to https://beta.gyroscops.com
86+
- `--ssl`|`--no-ssl`: Enable or disable SSL
87+
- `--help`: Display help for the given command
3588

3689
## Other commands
3790

38-
To see the list of other commands available, you can run the following command:
91+
In addition to the main commands we have already explored, this command line utility offers a number of additional features.
92+
These commands can be useful in a variety of situations.
93+
94+
For a list of these commands, use the following command:
3995

4096
```shell
4197
bin/cloud list

0 commit comments

Comments
 (0)