Skip to content

Commit

Permalink
Update documentation for Scaled Components
Browse files Browse the repository at this point in the history
  • Loading branch information
Richard87 committed Sep 17, 2024
1 parent a250723 commit 3858b25
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 9 deletions.
24 changes: 16 additions & 8 deletions public-site/docs/docs/topic-radix-cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,11 +160,15 @@ An option `job` of commands `create`, `get logs` is replaced with `pipeline-job`
rx get logs component -a your-app-name -e your-env-name --component your-component-name -p
```
#### Start, stop, restart
* Stop, start or restart a Radix application component
* Stop, Scale, reset or restart a Radix application component
```shell
rx stop component --application your-app-name --environment your-env-name --component your-component-name
rx start component -a your-app-name -e your-env-name --component your-component-name
rx stop component --application your-app-name --environment your-env-name --component your-component-name # does the same as scale to 0 replicas
rx scale component -a your-app-name -e your-env-name --component your-component-name --replicas "0 - 20"
rx scale component -a your-app-name -e your-env-name --component your-component-name --reset # reset manually scaled or stopped component
rx restart component -a your-app-name -e your-env-name --component your-component-name
# Depreceated: replaced by `rx scale component -a your-app-name -e your-env-name -n your-component-name --reset`
rx start -a your-app-name -e your-env-name -n your-component-name
```
* Stop, start or restart all components in a Radix application environment
```shell
Expand All @@ -179,11 +183,15 @@ An option `job` of commands `create`, `get logs` is replaced with `pipeline-job`
rx restart application -a your-app-name
```
#### Scale replicas
* Scale up or down Radix application component replicas. Allowed values between "0" and "20" (value "0" is an equivalent of the command `rx stop`). Scaling can be useful for tuning the resource configuration to figure out what amount of replicas affect performance of an application and particular need of CPU and memory. After re-deployment, start or restart, scaled component gets replicas, specified in the `radixconfig.yaml`, "1" if not specified, or set by [horizontal scaling](https://radix.equinor.com/radix-config/index.md#environmentconfig)
```shell
rx scale --application your-app-name --environment your-env-name --component web-app --replicas 2
rx scale -a your-app-name -e your-env-name --component web-app -r 2
```
* Scale up or down Radix application component replicas. Allowed values between "0" and "20" (value "0" is an equivalent of the command `rx stop`). Scaling can be useful for tuning the resource configuration to figure out what amount of replicas affect performance of an application and particular need of CPU and memory.
```bash
rx scale component --application your-app-name --environment your-env-name --component web-app --replicas 2
rx scale component --application your-app-name --environment your-env-name --component web-app --reset
```
:::info
This scale will persist after re-deployment, so remember to reset the component when you are finished.
After reset, scaled component gets replicas specified in the `radixconfig.yaml`, "1" if not specified, or set by [horizontal scaling](https://radix.equinor.com/radix-config/index.md#environmentconfig)
:::
#### Manage components
* Set a value of a component secret (runtime secret)
```shell
Expand Down
8 changes: 8 additions & 0 deletions public-site/docs/docs/topic-releases/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ title: What's new

## 2024

### 2024-09-17 Manual Component Scaling

A new Scaling feature has been added to Radix Web Console and to RX, while also supports overriding any automatic scaling. Any manually scaled components (even scaled to 0, ie. Stopped) will retain the custom scaled untill its been reset, even across new deployments.

Start component has now been deprecated and should be replaced with reset-scale (both in the radix-api and in rx cli, and will be removed after August 2025).

![reset-scaled-component.png](reset-scaled-component.png)

### 2024-07-10 Custom batch status in Radix scheduled jobs
Radix now supports an optional custom rules defining a [batch status](/radix-config/index.md#batchstatusrules) by batch job statuses. If rules are not set or none of them matching, the base (previously defined) rules are applied.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 4 additions & 1 deletion public-site/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,10 @@ const config: Config = {
prism: {
theme: prismThemes.oceanicNext,
darkTheme: prismThemes.oceanicNext,
additionalLanguages: ['docker']
additionalLanguages: [
'docker',
'bash', // also includes shell and sh styles
]
},
} satisfies Preset.ThemeConfig,
themes: [
Expand Down

0 comments on commit 3858b25

Please sign in to comment.