From c9e44c4c9f4ee2a26e9b9e7ee68727be58f5cb19 Mon Sep 17 00:00:00 2001 From: Oleksandr Dzhychko Date: Mon, 15 Jan 2024 07:04:27 +0100 Subject: [PATCH] docs: correct README.md --- README.md | 48 ++++++++++++++++++++++++------------------------ 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 098f483..4509cba 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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 - ``` \ No newline at end of file + ``` + +## 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. \ No newline at end of file