Skip to content

[CLI-BOT] Update on doc pages for CLI commands #5595

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
platformsh-devrel wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −10
Open

[CLI-BOT] Update on doc pages for CLI commands #5595

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions sites/platform/src/administration/cli/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ showTitle: false

<!-- vale off -->

# Upsun CLI (Platform.sh compatibility) 5.10.4
# Upsun CLI (Platform.sh compatibility) 5.10.7

- [Installation](/administration/cli#1-install)
- [Open an issue](https://github.com/platformsh/cli/issues)
Expand Down Expand Up @@ -293,11 +293,11 @@ Static installation

Dump the script to a global completion file and restart your shell:

/home/runner/.cache/platformsh-cli-tmp/legacy-5.10.4/platform.phar completion bash | sudo tee /etc/bash_completion.d/platform.phar
/home/runner/.cache/platformsh-cli-tmp/legacy-5.10.7/platform.phar completion bash | sudo tee /etc/bash_completion.d/platform.phar

Or dump the script to a local file and source it:

/home/runner/.cache/platformsh-cli-tmp/legacy-5.10.4/platform.phar completion bash > completion.sh
/home/runner/.cache/platformsh-cli-tmp/legacy-5.10.7/platform.phar completion bash > completion.sh

# source the file whenever you use the project
source completion.sh
Expand All @@ -310,7 +310,7 @@ Dynamic installation

Add this to the end of your shell configuration file (e.g. "~/.bashrc"):

eval "$(/home/runner/.cache/platformsh-cli-tmp/legacy-5.10.4/platform.phar completion bash)"
eval "$(/home/runner/.cache/platformsh-cli-tmp/legacy-5.10.7/platform.phar completion bash)"

#### Arguments

Expand Down
20 changes: 14 additions & 6 deletions sites/upsun/src/administration/cli/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ showTitle: false

<!-- vale off -->

# Upsun CLI 5.10.4
# Upsun CLI 5.10.7

- [Installation](/administration/cli#1-install)
- [Open an issue](https://github.com/platformsh/cli/issues)
Expand Down Expand Up @@ -296,11 +296,11 @@ Static installation

Dump the script to a global completion file and restart your shell:

/home/runner/.cache/upsun-tmp/legacy-5.10.4/upsun.phar completion bash | sudo tee /etc/bash_completion.d/upsun.phar
/home/runner/.cache/upsun-tmp/legacy-5.10.7/upsun.phar completion bash | sudo tee /etc/bash_completion.d/upsun.phar

Or dump the script to a local file and source it:

/home/runner/.cache/upsun-tmp/legacy-5.10.4/upsun.phar completion bash > completion.sh
/home/runner/.cache/upsun-tmp/legacy-5.10.7/upsun.phar completion bash > completion.sh

# source the file whenever you use the project
source completion.sh
Expand All @@ -313,7 +313,7 @@ Dynamic installation

Add this to the end of your shell configuration file (e.g. "~/.bashrc"):

eval "$(/home/runner/.cache/upsun-tmp/legacy-5.10.4/upsun.phar completion bash)"
eval "$(/home/runner/.cache/upsun-tmp/legacy-5.10.7/upsun.phar completion bash)"

#### Arguments

Expand Down Expand Up @@ -5090,7 +5090,7 @@ upsun resources [-s|--service SERVICE] [--app APP] [--worker WORKER] [--type TYP
The output format: table, csv, tsv, or plain

* `--columns` (`-c`) (expects a value)
Columns to display. Available columns: service*, profile_size*, cpu_type*, cpu*, memory*, disk*, instance_count*, base_memory, memory_ratio, profile, type (* = default columns). The character "+" can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. "a,b,c") and/or whitespace.
Columns to display. Available columns: service*, profile_size*, cpu_type*, cpu*, memory*, disk*, object_storage*, instance_count*, base_memory, memory_ratio, profile, type (* = default columns). The character "+" can be used as a placeholder for the default columns. The % or * characters may be used as a wildcard. Values may be split by commas (e.g. "a,b,c") and/or whitespace.

* `--no-header`
Do not output the table header
Expand All @@ -5102,7 +5102,7 @@ Set the resources of apps and services on an environment
### Usage

```
upsun resources:set [-S|--size SIZE] [-C|--count COUNT] [-D|--disk DISK] [-f|--force] [--dry-run] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait]
upsun resources:set [-S|--size SIZE] [-C|--count COUNT] [-D|--disk DISK] [--object-storage OBJECT-STORAGE] [-f|--force] [--dry-run] [-p|--project PROJECT] [-e|--environment ENVIRONMENT] [-W|--no-wait] [--wait]
```

Configure the resources allocated to apps, workers and services on an environment.
Expand All @@ -5126,6 +5126,9 @@ You can also configure autoscaling by running upsun autoscaling:set
* `--disk` (`-D`) (expects a value)
Set the disk size (in MB) of apps or services. Items are in the format name:value as above. A value of 'default' will use the default size, and 'min' or 'minimum' will use the minimum.

* `--object-storage` (expects a value)
Set the object storage size (in MB) of apps. Items are in the format name:value as above. Only applicable to apps; a value of 0 disables the bucket.

* `--force` (`-f`)
Try to run the update, even if it might exceed your limits

Expand Down Expand Up @@ -5161,6 +5164,11 @@ upsun resources:set --count backend:3
upsun resources:set --disk backend:512,database:2048
```

* Give 524288 MB (512 GB) of object storage to the "backend" app:
```
upsun resources:set --object-storage backend:524288
```

* Set the same profile size for the "backend" and "frontend" apps using a wildcard:
```
upsun resources:set --size '*end:0.1'
Expand Down
Loading