Skip to content

Commit

Permalink
docs: correct README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Oleksandr Dzhychko committed Jan 15, 2024
1 parent 162a7f8 commit c9e44c4
Showing 1 changed file with 24 additions and 24 deletions.
48 changes: 24 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,33 +55,13 @@ This Helm chart is tightly coupled and has to be developed in together with [Mod
./helm/install.sh
```

## Additional Configuration

### Admin password

After Modelix is deployed, make sure to change the password of the admin account.
- Open http://localhost/admin/master/console/#/realms/master/users
- The default password for the user **admin** is **modelix**.
- Navigate to Edit > Credentials > Reset Password
- Enter a new password and disable *Temporary*

### Node Pools

If you are using a cloud provider that supports auto-scaling create a separate node pool for the MPS instances.
Add a taint "**workspace-client**" with the value "**true**" and the type "**NoExecute**".
This taint ensures that the pool can be scaled down after Modelix stopped the MPS instances
and the nodes don't keep running because some other small pod was scheduled to them.

An MPS instances with a lot of languages and plugins can require ~8 GB of memory.
16 GB of memory for a node is a reasonable size.

### Making changes to [Modelix Workspace components](https://github.com/modelix/modelix.workspaces)

1. Follow the instructions in [Modelix Workspace components](https://github.com/modelix/modelix.workspaces) to build OCI images with local changes. TODO Olekz link sub page
1. Follow the [instructions in Modelix Workspace components](https://github.com/modelix/modelix.workspaces?tab=readme-ov-file#development) to build OCI images with local changes.

2. Update the `modelixWorkspacesVersion` in [versions.properties](versions.properties) to the version of the locally built images.
You can find out the version in the labels of the newly built images or in the `workspaces-version.txt` in your locally checked out [Modelix Workspace components](https://github.com/modelix/modelix.workspaces)
where you build the images in.
You can find out the version in the labels of the newly built images or in the `workspaces-version.txt` in your locally checked out [Modelix Workspace components](https://github.com/modelix/modelix.workspaces)
where you build the images in.
The versions.properties would the look like:
```properties
# Modelix core version.
Expand All @@ -97,4 +77,24 @@ An MPS instances with a lot of languages and plugins can require ~8 GB of memory
4. Install the Helm chart with the changed images:
```shell
./helm/install.sh
```
```

## Additional Configuration

### Admin password

After Modelix is deployed, make sure to change the password of the admin account.
- Open http://localhost/admin/master/console/#/realms/master/users
- The default password for the user **admin** is **modelix**.
- Navigate to Edit > Credentials > Reset Password
- Enter a new password and disable *Temporary*

### Node Pools

If you are using a cloud provider that supports auto-scaling create a separate node pool for the MPS instances.
Add a taint "**workspace-client**" with the value "**true**" and the type "**NoExecute**".
This taint ensures that the pool can be scaled down after Modelix stopped the MPS instances
and the nodes don't keep running because some other small pod was scheduled to them.

An MPS instances with a lot of languages and plugins can require ~8 GB of memory.
16 GB of memory for a node is a reasonable size.

0 comments on commit c9e44c4

Please sign in to comment.