Skip to content

Commit c184c1e

Browse files
Added dedicated page for Ibexa Cloud CLI (#3198)
* Added dedicated page for Ibexa Cloud CLI * Selfreview * Wording * Review feedback * Selfreview * Apply suggestions from code review Co-authored-by: julitafalcondusza <117284672+julitafalcondusza@users.noreply.github.com> * Fixed redirect --------- Co-authored-by: julitafalcondusza <117284672+julitafalcondusza@users.noreply.github.com>
1 parent 260b6a4 commit c184c1e

5 files changed

Lines changed: 86 additions & 8 deletions

File tree

docs/ibexa_cloud/ddev_and_ibexa_cloud.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Two ways are available to run an [[= product_name_cloud =]] project locally with
1313
!!! note
1414

1515
The following examples use [[[= product_name_cloud =]] CLI (`ibexa_cloud`)](https://cli.ibexa.co/).
16+
For more information and examples, see [[[= product_name_cloud =]] CLI](ibexa_cloud_cli.md).
1617

1718
## With Ibexa Cloud add-ons
1819

docs/ibexa_cloud/ibexa_cloud.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ month_change: false
1111
[[= cards([
1212
"ibexa_cloud/ibexa_cloud_guide",
1313
"ibexa_cloud/install_on_ibexa_cloud",
14+
"ibexa_cloud/ibexa_cloud_cli",
1415
"ibexa_cloud/environment_variables",
1516
"ibexa_cloud/ddev_and_ibexa_cloud",
1617
], columns=3) =]]
Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
description: Use the [[= product_name_cloud =]] CLI to manage your I[[= product_name_cloud =]] projects from the command line.
3+
month_change: true
4+
---
5+
6+
# [[= product_name_cloud =]] CLI
7+
8+
The [[= product_name_cloud =]] CLI (`ibexa_cloud`) is a command-line tool for managing your [[= product_name_cloud =]] projects.
9+
It's based on the [Upsun CLI](https://developer.upsun.com/cli) and shares the same commands.
10+
11+
## Installation
12+
13+
Follow the installation instructions at [cli.ibexa.cloud](https://cli.ibexa.cloud/).
14+
15+
After installation, authenticate with your [[= product_name_cloud =]] account:
16+
17+
```bash
18+
ibexa_cloud auth:browser-login
19+
```
20+
21+
## Command reference
22+
23+
To get started, try the following commands:
24+
25+
- `ibexa_cloud list` lists all available commands
26+
- `ibexa_cloud ssh` opens an SSH session to the current environment, or executes a command remotely
27+
- `ibexa_cloud log` reads an environment's logs
28+
- `ibexa_cloud rel` shows an environment's service relationships
29+
- `ibexa_cloud var` lists environment variables
30+
31+
To get help and see usage examples for any command, run:
32+
33+
```bash
34+
ibexa_cloud <command> --help
35+
```
36+
37+
For the full list of available commands, run `ibexa_cloud list` or see the [Upsun CLI reference](https://developer.upsun.com/cli/reference).
38+
In all examples, replace `upsun` with `ibexa_cloud`.
39+
40+
## Examples
41+
42+
### Run a SQL script
43+
44+
To execute a SQL upgrade script on a [[= product_name_cloud =]] environment, pass it to `ibexa_cloud sql`:
45+
46+
=== "MySQL"
47+
48+
```bash
49+
ibexa_cloud sql < vendor/ibexa/installer/upgrade/db/mysql/ibexa-x.x.x-to-x.x.y.sql
50+
```
51+
52+
=== "PostgreSQL"
53+
54+
```bash
55+
ibexa_cloud sql < vendor/ibexa/installer/upgrade/db/postgresql/ibexa-x.x.x-to-x.x.y.sql
56+
```
57+
58+
### Connect with a SQL client
59+
60+
To connect to the database using any SQL client, start SSH tunnels to all services (database, Redis, Solr, and others except Varnish) by running the following command in the project directory:
61+
62+
```bash
63+
ibexa_cloud tunnel:open
64+
```
65+
66+
The command outputs connection details for each service, for example:
67+
68+
``` shell-session
69+
SSH tunnel opened to database at: mysql://user:<PASSWORD>@127.0.0.1:30000/main
70+
```
71+
72+
Use the displayed host, port, database name, username, and password to configure your SQL client.
73+
74+
When you're done, close the tunnels:
75+
76+
```bash
77+
ibexa_cloud tunnel:close
78+
```

docs/ibexa_cloud/install_on_ibexa_cloud.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description: Install and configure Ibexa DXP to run in cloud using Ibexa Cloud.
2+
description: Install and configure Ibexa DXP to run in cloud using [[= product_name_cloud =]].
33
month_change: false
44
---
55

@@ -82,6 +82,8 @@ In **Settings** (top right gear icon) -> **Project Settings** -> **Variables** -
8282

8383
### Composer authentication using the CLI command
8484

85+
Use [[[= product_name_cloud =]] CLI](ibexa_cloud_cli.md) to create the variable:
86+
8587
```bash
8688
ibexa_cloud variable:create --level project --name env:COMPOSER_AUTH \
8789
--json true --visible-runtime false --sensitive true --visible-build true \
@@ -111,11 +113,6 @@ Modify this password after the installation, for example, by using [data migrati
111113

112114
!!! caution
113115

114-
Don't use Upsun CLI (`upsun`), instead, use the [[[= product_name_cloud =]] CLI (`ibexa_cloud`)](https://cli.ibexa.cloud/).
115-
116-
To install [[= product_name_cloud =]] CLI, follow https://cli.ibexa.cloud/ "Installation instructions".
117-
118-
[[= product_name_cloud =]] CLI and Upsun CLI share the same commands and the [same documentation](https://fixed.docs.upsun.com/administration/cli.html#3-use), but you have to replace `upsun` with `ibexa_cloud`.
116+
Don't use Upsun CLI (`upsun`), instead, use the [[[= product_name_cloud =]] CLI (`ibexa_cloud`)](https://cli.ibexa.cloud/) instead.
119117

120-
If you have previously set up an alias to use Upsun CLI with [[= product_name_cloud =]], it's outdated.
121-
Remove the alias and install [[= product_name_cloud =]] CLI instead.
118+
For more information, see [[[= product_name_cloud =]] CLI](ibexa_cloud_cli.md).

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -863,6 +863,7 @@ nav:
863863
- Ibexa Cloud: ibexa_cloud/ibexa_cloud.md
864864
- Ibexa Cloud guide: ibexa_cloud/ibexa_cloud_guide.md
865865
- Install on Ibexa Cloud: ibexa_cloud/install_on_ibexa_cloud.md
866+
- Ibexa Cloud CLI: ibexa_cloud/ibexa_cloud_cli.md
866867
- Environment variables: ibexa_cloud/environment_variables.md
867868
- DDEV and Ibexa Cloud: ibexa_cloud/ddev_and_ibexa_cloud.md
868869
- Infrastructure and maintenance:

0 commit comments

Comments
 (0)