Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/ibexa_cloud/ddev_and_ibexa_cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Two ways are available to run an [[= product_name_cloud =]] project locally with
!!! note

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

## With Ibexa Cloud add-ons

Expand Down
1 change: 1 addition & 0 deletions docs/ibexa_cloud/ibexa_cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ month_change: false
[[= cards([
"ibexa_cloud/ibexa_cloud_guide",
"ibexa_cloud/install_on_ibexa_cloud",
"ibexa_cloud/ibexa_cloud_cli",
"ibexa_cloud/environment_variables",
"ibexa_cloud/ddev_and_ibexa_cloud",
], columns=3) =]]
64 changes: 64 additions & 0 deletions docs/ibexa_cloud/ibexa_cloud_cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
description: Use the [[= product_name_cloud =]] CLI to manage your I[[= product_name_cloud =]] projects from the command line.

Check failure on line 2 in docs/ibexa_cloud/ibexa_cloud_cli.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ibexa_cloud/ibexa_cloud_cli.md#L2

[Ibexa.Spellcheck] Did you really mean 'product_name_cloud'?
Raw output
{"message": "[Ibexa.Spellcheck] Did you really mean 'product_name_cloud'?", "location": {"path": "docs/ibexa_cloud/ibexa_cloud_cli.md", "range": {"start": {"line": 2, "column": 26}}}, "severity": "ERROR"}

Check failure on line 2 in docs/ibexa_cloud/ibexa_cloud_cli.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ibexa_cloud/ibexa_cloud_cli.md#L2

[Ibexa.Spellcheck] Did you really mean 'product_name_cloud'?
Raw output
{"message": "[Ibexa.Spellcheck] Did you really mean 'product_name_cloud'?", "location": {"path": "docs/ibexa_cloud/ibexa_cloud_cli.md", "range": {"start": {"line": 2, "column": 73}}}, "severity": "ERROR"}
month_change: true
---

# [[= product_name_cloud =]] CLI

Check notice on line 6 in docs/ibexa_cloud/ibexa_cloud_cli.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ibexa_cloud/ibexa_cloud_cli.md#L6

[Ibexa.SentenceCapitalizationInHeadings] Use sentence-style capitalization in headings
Raw output
{"message": "[Ibexa.SentenceCapitalizationInHeadings] Use sentence-style capitalization in headings", "location": {"path": "docs/ibexa_cloud/ibexa_cloud_cli.md", "range": {"start": {"line": 6, "column": 1}}}, "severity": "INFO"}

The [[= product_name_cloud =]] CLI (`ibexa_cloud`) is a command-line tool for managing your [[= product_name_cloud =]] projects.
It is based on the [Upsun CLI](https://docs.upsun.com/administration/cli.html) and shares the same commands.

Check notice on line 9 in docs/ibexa_cloud/ibexa_cloud_cli.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ibexa_cloud/ibexa_cloud_cli.md#L9

[Ibexa.Passive] Try to avoid passive tense, when possible.
Raw output
{"message": "[Ibexa.Passive] Try to avoid passive tense, when possible.", "location": {"path": "docs/ibexa_cloud/ibexa_cloud_cli.md", "range": {"start": {"line": 9, "column": 4}}}, "severity": "INFO"}

## Installation

Follow the installation instructions at [cli.ibexa.cloud](https://cli.ibexa.cloud/).

After installation, authenticate with your [[= product_name_cloud =]] account:

```bash
ibexa_cloud auth:browser-login
```

## Command reference

For the full list of available commands, see the [Upsun CLI reference](https://developer.upsun.com/cli/reference).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For the full list of available commands, see the [Upsun CLI reference](https://developer.upsun.com/cli/reference).
For the full list of available commands, run `ibexa_cloud list` or see the [Upsun CLI reference](https://developer.upsun.com/cli/reference).

Replace `upsun` with `ibexa_cloud` in all examples.

## Examples

### Run a SQL script

Check notice on line 28 in docs/ibexa_cloud/ibexa_cloud_cli.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ibexa_cloud/ibexa_cloud_cli.md#L28

[Ibexa.SentenceCapitalizationInHeadings] Use sentence-style capitalization in headings
Raw output
{"message": "[Ibexa.SentenceCapitalizationInHeadings] Use sentence-style capitalization in headings", "location": {"path": "docs/ibexa_cloud/ibexa_cloud_cli.md", "range": {"start": {"line": 28, "column": 5}}}, "severity": "INFO"}

Check notice on line 28 in docs/ibexa_cloud/ibexa_cloud_cli.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ibexa_cloud/ibexa_cloud_cli.md#L28

[Ibexa.ArticlesInHeadings] Avoid articles in headings.
Raw output
{"message": "[Ibexa.ArticlesInHeadings] Avoid articles in headings.", "location": {"path": "docs/ibexa_cloud/ibexa_cloud_cli.md", "range": {"start": {"line": 28, "column": 9}}}, "severity": "INFO"}

To execute a SQL upgrade script on a [[= product_name_cloud =]] environment, pass it to `ibexa_cloud sql`:

=== "MySQL"

```bash
ibexa_cloud sql < vendor/ibexa/installer/upgrade/db/mysql/ibexa-x.x.x-to-x.x.y.sql
```

=== "PostgreSQL"

```bash
ibexa_cloud sql < vendor/ibexa/installer/upgrade/db/postgresql/ibexa-x.x.x-to-x.x.y.sql
```

### Connect with a SQL client

Check notice on line 44 in docs/ibexa_cloud/ibexa_cloud_cli.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ibexa_cloud/ibexa_cloud_cli.md#L44

[Ibexa.ArticlesInHeadings] Avoid articles in headings.
Raw output
{"message": "[Ibexa.ArticlesInHeadings] Avoid articles in headings.", "location": {"path": "docs/ibexa_cloud/ibexa_cloud_cli.md", "range": {"start": {"line": 44, "column": 18}}}, "severity": "INFO"}

To connect to the database using any SQL client, start a SSH tunnel by running the following command in the project directory:

Check notice on line 46 in docs/ibexa_cloud/ibexa_cloud_cli.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ibexa_cloud/ibexa_cloud_cli.md#L46

[Ibexa.ByUsing] Prefer 'by using' or 'with' to plain 'using'.
Raw output
{"message": "[Ibexa.ByUsing] Prefer 'by using' or 'with' to plain 'using'.", "location": {"path": "docs/ibexa_cloud/ibexa_cloud_cli.md", "range": {"start": {"line": 46, "column": 19}}}, "severity": "INFO"}

```bash
ibexa_cloud tunnel:open
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just so we are clear.. This will open a ssh tunnel to all services (db, redis, solr etc), not only to the DB.
Maybe that should be pointed out?

Only execption I know how is varnish if you have that.. No tunnel to varnish will be estabilished

```

The command outputs connection details, for example:

``` shell-session
SSH tunnel opened to database at: mysql://user:<PASSWORD>@127.0.0.1:30000/main
```

Use the displayed host, port, database name, username, and password to configure your SQL client.

When you're done, close the tunnel:

```bash
ibexa_cloud tunnel:close
```
13 changes: 5 additions & 8 deletions docs/ibexa_cloud/install_on_ibexa_cloud.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: Install and configure Ibexa DXP to run in cloud using Ibexa Cloud.
description: Install and configure Ibexa DXP to run in cloud using [[= product_name_cloud =]].

Check failure on line 2 in docs/ibexa_cloud/install_on_ibexa_cloud.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ibexa_cloud/install_on_ibexa_cloud.md#L2

[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'
Raw output
{"message": "[Ibexa.VariablesGlobal] Use global variable '[[= product_name_base =]]' instead of 'Ibexa'", "location": {"path": "docs/ibexa_cloud/install_on_ibexa_cloud.md", "range": {"start": {"line": 2, "column": 36}}}, "severity": "ERROR"}

Check notice on line 2 in docs/ibexa_cloud/install_on_ibexa_cloud.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ibexa_cloud/install_on_ibexa_cloud.md#L2

[Ibexa.ByUsing] Prefer 'by using' or 'with' to plain 'using'.
Raw output
{"message": "[Ibexa.ByUsing] Prefer 'by using' or 'with' to plain 'using'.", "location": {"path": "docs/ibexa_cloud/install_on_ibexa_cloud.md", "range": {"start": {"line": 2, "column": 56}}}, "severity": "INFO"}

Check failure on line 2 in docs/ibexa_cloud/install_on_ibexa_cloud.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/ibexa_cloud/install_on_ibexa_cloud.md#L2

[Ibexa.Spellcheck] Did you really mean 'product_name_cloud'?
Raw output
{"message": "[Ibexa.Spellcheck] Did you really mean 'product_name_cloud'?", "location": {"path": "docs/ibexa_cloud/install_on_ibexa_cloud.md", "range": {"start": {"line": 2, "column": 72}}}, "severity": "ERROR"}
month_change: false
---

Expand Down Expand Up @@ -82,6 +82,8 @@

### Composer authentication using the CLI command

Use [Ibexa Cloud CLI](ibexa_cloud_cli.md) to create the variable:

```bash
ibexa_cloud variable:create --level project --name env:COMPOSER_AUTH \
--json true --visible-runtime false --sensitive true --visible-build true \
Expand Down Expand Up @@ -111,11 +113,6 @@

!!! caution

Don't use Upsun CLI (`upsun`), instead, use the [[[= product_name_cloud =]] CLI (`ibexa_cloud`)](https://cli.ibexa.cloud/).

To install [[= product_name_cloud =]] CLI, follow https://cli.ibexa.cloud/ "Installation instructions".

[[= 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`.
Don't use Upsun CLI (`upsun`), instead, use the [[[= product_name_cloud =]] CLI (`ibexa_cloud`)](https://cli.ibexa.cloud/) instead.

If you have previously set up an alias to use Upsun CLI with [[= product_name_cloud =]], it's outdated.
Remove the alias and install [[= product_name_cloud =]] CLI instead.
For more information, see [[[= product_name_cloud =]] CLI](ibexa_cloud_cli.md).
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -853,6 +853,7 @@ nav:
- Ibexa Cloud: ibexa_cloud/ibexa_cloud.md
- Ibexa Cloud guide: ibexa_cloud/ibexa_cloud_guide.md
- Install on Ibexa Cloud: ibexa_cloud/install_on_ibexa_cloud.md
- Ibexa Cloud CLI: ibexa_cloud/ibexa_cloud_cli.md
- Environment variables: ibexa_cloud/environment_variables.md
- DDEV and Ibexa Cloud: ibexa_cloud/ddev_and_ibexa_cloud.md
- Infrastructure and maintenance:
Expand Down
Loading