Skip to content
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.

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

ENDOC-675,ENDOC-663 Add notes on resource limits for quickstart and K… #743

Merged
merged 2 commits into from
May 26, 2023
Merged
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
4 changes: 4 additions & 0 deletions vuepress/docs/next/docs/reference/local-tips-and-tricks.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ The namespace will be recreated, preserving the images already pulled, so it's u

**A:** `multipass shell YOUR-VM-NAME`. If you don't provide YOUR-VM-NAME, Multipass will use the default name `primary`, and even launch it for you if it doesn't exist.

**Q: How can I adjust the resources dedicated to my Multipass VM?**

**A:** A quickstart VM installed via the [Getting Started guide](../getting-started/README.md) has a minimal configuration with respect to RAM, CPU, and storage. Additional resources may be needed if multiple bundles or microservices are installed. The VM resources can be modified using your local hypervisor or [through Multipass itself](https://multipass.run/docs/modify-an-instance). Typically the VM will need to be shutdown before modifying its configuration.

**Q: What do I need to do after restarting my laptop?**

**A:** By default, Multipass is installed as a service and will restart automatically. If Multipass isn't running, you'll need to first initialize this service; then you can start your VM via `multipass start YOUR-VM-NAME`. Kubernetes will launch automatically along with any installed pods, including Entando. It can take a few minutes for all of the pods to fully initialize, but you can use `sudo kubectl -n entando get pods --watch` to observe the progress.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@ sidebarDepth: 2

This tutorial describes how to backup an active Entando Identity Management Keycloak instance and restore it in another environment.

## Prerequisites:
## Prerequisites
A Keycloak instance running on Entando with a database management system (DBMS) in the backend. This procedure will not work with an embedded database.

## Create a Backup of Keycloak Realm
1. From the command line, get the pod name of the Keycloak server you wish to back up. In a quickstart environment, the pod name will begin with `default-sso-in-namespace-deployment`.
> **Note:** [Additional memory and/or CPU](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) may be required for the export to run successfully in the Keycloak pod, e.g., 250m CPU and 2G memory. Edit the `default-sso-in-namespace-deployment` to adjust the resource requests and/or limits.

2. Use kubectl to start a bash shell in the pod:
``` bash
Expand All @@ -23,7 +24,7 @@ mkdir -p /tmp/export
```

4. Run the following script to retrieve the data for the Entando realm and save it to a JSON file in the `export` directory. A new Keycloak server will run on a different port (offset=200) to avoid conflicts with the original Entando Keycloak instance.
```
``` bash
/opt/jboss/keycloak/bin/standalone.sh -Djboss.socket.binding.port-offset=200 -Dkeycloak.migration.action=export -Dkeycloak.migration.provider=singleFile -Dkeycloak.migration.realmName=entando -Dkeycloak.migration.usersExportStrategy=DIFFERENT_FILES -Dkeycloak.migration.file=/tmp/export/keycloak-realm.json
```
5. Once the export is complete, press Ctrl+C to stop the process.
Expand Down
4 changes: 4 additions & 0 deletions vuepress/docs/v7.2/docs/reference/local-tips-and-tricks.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ The namespace will be recreated, preserving the images already pulled, so it's u

**A:** `multipass shell YOUR-VM-NAME`. If you don't provide YOUR-VM-NAME, Multipass will use the default name `primary`, and even launch it for you if it doesn't exist.

**Q: How can I adjust the resources dedicated to my Multipass VM?**

**A:** A quickstart VM installed via the [Getting Started guide](../getting-started/README.md) has a minimal configuration with respect to RAM, CPU, and storage. Additional resources may be needed if multiple bundles or microservices are installed. The VM resources can be modified using your local hypervisor or [through Multipass itself](https://multipass.run/docs/modify-an-instance). Typically the VM will need to be shutdown before modifying its configuration.

**Q: What do I need to do after restarting my laptop?**

**A:** By default, Multipass is installed as a service and will restart automatically. If Multipass isn't running, you'll need to first initialize this service; then you can start your VM via `multipass start YOUR-VM-NAME`. Kubernetes will launch automatically along with any installed pods, including Entando. It can take a few minutes for all of the pods to fully initialize, but you can use `sudo kubectl -n entando get pods --watch` to observe the progress.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@ sidebarDepth: 2

This tutorial describes how to backup an active Entando Identity Management Keycloak instance and restore it in another environment.

## Prerequisites:
## Prerequisites
A Keycloak instance running on Entando with a database management system (DBMS) in the backend. This procedure will not work with an embedded database.

## Create a Backup of Keycloak Realm
1. From the command line, get the pod name of the Keycloak server you wish to back up. In a quickstart environment, the pod name will begin with `default-sso-in-namespace-deployment`.
> **Note:** [Additional memory and/or CPU](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) may be required for the export to run successfully in the Keycloak pod, e.g., 250m CPU and 2G memory. Edit the `default-sso-in-namespace-deployment` to adjust the resource requests and/or limits.

2. Use kubectl to start a bash shell in the pod:
``` bash
Expand All @@ -23,7 +24,7 @@ mkdir -p /tmp/export
```

4. Run the following script to retrieve the data for the Entando realm and save it to a JSON file in the `export` directory. A new Keycloak server will run on a different port (offset=200) to avoid conflicts with the original Entando Keycloak instance.
```
``` bash
/opt/jboss/keycloak/bin/standalone.sh -Djboss.socket.binding.port-offset=200 -Dkeycloak.migration.action=export -Dkeycloak.migration.provider=singleFile -Dkeycloak.migration.realmName=entando -Dkeycloak.migration.usersExportStrategy=DIFFERENT_FILES -Dkeycloak.migration.file=/tmp/export/keycloak-realm.json
```
5. Once the export is complete, press Ctrl+C to stop the process.
Expand Down