Skip to content

Commit e2eae17

Browse files
committed
Changed the location of the cloud doc + added more details
1 parent 31987ca commit e2eae17

File tree

2 files changed

+42
-23
lines changed

2 files changed

+42
-23
lines changed

content/cloud/usage/_index.en.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: "Usage"
3+
date: 2024-01-12T14:52:40+01:00
4+
draft: true
5+
---
6+
7+
Gyroscops also allows you to have your satellites stored in the cloud.
8+
9+
Thanks to the cloud executable provided by the package `php-etl/satellite`,
10+
you can manage your satellites quickly and easily.
11+
12+
## Login to the API
13+
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.
15+
16+
```shell
17+
bin/cloud login
18+
```
19+
20+
> The service may ask you to select your organization and your workspace.
21+
22+
To see the arguments and options expected by the command, you can run the command :
23+
24+
```shell
25+
bin/cloud login --help
26+
```
27+
28+
## Create your satellite
29+
30+
```shell
31+
php bin/cloud create path/to/satellite.yaml
32+
```
33+
34+
Once done, you will be able to control your satellite execution through the Gyroscops Cloud interface.
35+
36+
## Other commands
37+
38+
To see the list of other commands available, you can run the following command:
39+
40+
```shell
41+
bin/cloud list
42+
```

content/core-concept/satellite/_index.en.md

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ weight: 1
1919
- [Configuration formats](#configuration-formats)
2020
- Building
2121
- [Building locally](#build-your-satellite-locally)
22-
- [Building through Gyroscops Cloud](#send-your-satellite-to-gyroscops-cloud)
2322
- [Migration from version 0.2 and earlier](#migration-from-version-02-and-earlier)
2423
- [Importing external files](#importing-external-configuration-files)
2524

@@ -376,28 +375,6 @@ If you selected the [Filesystem variant](#using-the-file-system), you can now ex
376375
* For a Pipeline: `bin/satellite run:pipeline build/`
377376
* For a Workflow: `bin/satellite run:workflow build/`
378377

379-
### Send your satellite to Gyroscops Cloud
380-
381-
If you are using Gyroscops Cloud, you can push your satellite configuration to the service.
382-
383-
You will need to authenticate to the service before sending your satellites.
384-
385-
```shell
386-
bin/cloud login [email protected] # authenticate as [email protected]
387-
```
388-
389-
> The service may ask you to select your organization and your workspace.
390-
391-
```shell
392-
# Either use the satellite.yaml file in the current working directory
393-
php bin/cloud create
394-
395-
# or specify the path to the yaml file
396-
php bin/cloud create path/to/satellite.yaml
397-
```
398-
399-
Once done, you will be able to control your satellite execution through the Gyroscops Cloud interface.
400-
401378
## Migration from version 0.2 and earlier
402379

403380
If you are using a configuration for satellite prior to version 0.3, you should migrate your files ot the updated version.

0 commit comments

Comments
 (0)