Skip to content

Commit

Permalink
docs(system-requirements): update values centrally (#8122)
Browse files Browse the repository at this point in the history 
Signed-off-by: Amro Misbah <amromisba7@gmail.com>
Co-authored-by: Mohammad Abudayyeh <47318409+moabu@users.noreply.github.com>
  • Loading branch information
@misba7 @moabu
misba7 and moabu committed Mar 28, 2024
1 parent fd4a16d commit d87e913
Show file tree
Hide file tree
Showing 6 changed files with 42 additions and 74 deletions.
22 changes: 1 addition & 21 deletions docs/admin/install/helm-install/amazon-eks.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,27 +12,7 @@ tags:

## System Requirements

The resources may be set to the minimum as below:

- 8 GiB RAM
- 8 CPU cores
- 50GB hard-disk

Use the listing below for detailed estimation of minimum required resources. Table contains the default resources recommendations per service. Depending on the use of each service the resources needs may be increase or decrease.

| Service | CPU Unit | RAM | Disk Space | Processor Type | Required |
|-------------------|----------|-------|------------|----------------|------------------------------------|
| Auth server | 2.5 | 2.5GB | N/A | 64 Bit | Yes |
| LDAP (OpenDJ) | 1.5 | 2GB | 10GB | 64 Bit | Only if couchbase is not installed |
| fido2 | 0.5 | 0.5GB | N/A | 64 Bit | No |
| scim | 1.0 | 1.0GB | N/A | 64 Bit | No |
| config - job | 0.5 | 0.5GB | N/A | 64 Bit | Yes on fresh installs |
| persistence - job | 0.5 | 0.5GB | N/A | 64 Bit | Yes on fresh installs |
| nginx | 1 | 1GB | N/A | 64 Bit | Yes if not ALB |
| auth-key-rotation | 0.3 | 0.3GB | N/A | 64 Bit | No [Strongly recommended] |
| config-api | 1 | 1GB | N/A | 64 Bit | No |

Releases of images are in style 1.0.0-beta.0, 1.0.0-0
{% include "includes/cn-system-requirements.md" %}

## Initial Setup

Expand Down
24 changes: 2 additions & 22 deletions docs/admin/install/helm-install/google-gke.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,27 +12,7 @@ tags:

## System Requirements

The resources may be set to the minimum as below:

- 8 GiB RAM
- 8 CPU cores
- 50GB hard-disk

Use the listing below for detailed estimation of minimum required resources. Table contains the default resources recommendations per service. Depending on the use of each service the resources needs may be increase or decrease.

| Service | CPU Unit | RAM | Disk Space | Processor Type | Required |
|-------------------|----------|-------|------------|----------------|------------------------------------|
| Auth server | 2.5 | 2.5GB | N/A | 64 Bit | Yes |
| LDAP (OpenDJ) | 1.5 | 2GB | 10GB | 64 Bit | Only if couchbase is not installed |
| fido2 | 0.5 | 0.5GB | N/A | 64 Bit | No |
| scim | 1.0 | 1.0GB | N/A | 64 Bit | No |
| config - job | 0.5 | 0.5GB | N/A | 64 Bit | Yes on fresh installs |
| persistence - job | 0.5 | 0.5GB | N/A | 64 Bit | Yes on fresh installs |
| nginx | 1 | 1GB | N/A | 64 Bit | Yes if not ALB |
| auth-key-rotation | 0.3 | 0.3GB | N/A | 64 Bit | No [Strongly recommended] |
| config-api | 1 | 1GB | N/A | 64 Bit | No |

Releases of images are in style 1.0.0-beta.0, 1.0.0-0
{% include "includes/cn-system-requirements.md" %}

## Initial Setup

Expand All @@ -49,7 +29,7 @@ Releases of images are in style 1.0.0-beta.0, 1.0.0-0
6. Create cluster using a command such as the following example:

```
gcloud container clusters create janssen-cluster --num-nodes 2 --machine-type e2-highcpu-8 --zone us-west1-a
gcloud container clusters create janssen-cluster --num-nodes 2 --machine-type e2-standard-4 --zone us-west1-a
```
You can adjust `num-nodes` and `machine-type` as per your desired cluster size

Expand Down
23 changes: 13 additions & 10 deletions docs/admin/install/helm-install/local.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,29 +11,32 @@ tags:

For local deployments like `minikube` and `MicroK8s` or cloud installations in demo mode, resources may be set to the minimum as below:

- 8GB RAM
- 8 GB RAM
- 4 CPU cores
- 50GB hard-disk
- 50 GB hard-disk

Use the listing below for detailed estimation of minimum required resources. Table contains the default resources recommendations per service. Depending on the use of each service the resources needs may be increase or decrease.
Use the listing below for detailed estimation of minimum required resources. Table contains the default resources recommendations per service. Depending on the use of each service the resources needs may increase or decrease.

| Service | CPU Unit | RAM | Disk Space | Processor Type | Required |
|-------------------|----------|-------|------------|----------------|------------------------------------|
| Auth server | 2.5 | 2.5GB | N/A | 64 Bit | Yes |
| LDAP (OpenDJ) | 1.5 | 2GB | 10GB | 64 Bit | Only if couchbase is not installed |
| LDAP (OpenDJ) | 1.5 | 2GB | 10GB | 64 Bit | Only if Couchbase/SQL not installed|
| fido2 | 0.5 | 0.5GB | N/A | 64 Bit | No |
| scim | 1.0 | 1.0GB | N/A | 64 Bit | No |
| config - job | 0.5 | 0.5GB | N/A | 64 Bit | Yes on fresh installs |
| persistence - job | 0.5 | 0.5GB | N/A | 64 Bit | Yes on fresh installs |
| nginx | 1 | 1GB | N/A | 64 Bit | Yes if not ALB |
| scim | 1 | 1GB | N/A | 64 Bit | No |
| config - job | 0.3 | 0.3GB | N/A | 64 Bit | Yes on fresh installs |
| persistence - job | 0.3 | 0.3GB | N/A | 64 Bit | Yes on fresh installs |
| nginx | 1 | 1GB | N/A | 64 Bit | Yes ALB/Istio not used |
| auth-key-rotation | 0.3 | 0.3GB | N/A | 64 Bit | No [Strongly recommended] |
| config-api | 1 | 1GB | N/A | 64 Bit | No |
| casa | 0.5 | 0.5GB | N/A | 64 Bit | No |
| link | 0.5 | 1GB | N/A | 64 Bit | No |
| saml | 0.5 | 1GB | N/A | 64 Bit | No |

Releases of images are in style 1.0.0-beta.0, 1.0.0-0

## Installation Steps

Start a fresh Ubuntu `18.04`/`20.04`/`22.04` 4 CPU, 8 GB RAM, and 50GB SSD VM with ports `443` and `80` open. Then execute the following
Start a fresh Ubuntu `18.04`/`20.04`/`22.04` VM with ports `443` and `80` open. Then execute the following:

```bash
sudo su -
Expand All @@ -44,7 +47,7 @@ wget https://raw.githubusercontent.com/JanssenProject/jans/vreplace-janssen-vers

This will install Docker, Microk8s, Helm and Janssen with the default settings that can be found inside [values.yaml](https://github.com/JanssenProject/jans/blob/main/charts/janssen/values.yaml).

The installer will automatically add a record to your hosts record in the VM but if you want access the endpoints outside the VM you must map the `ip` of the instance running ubuntu to the FQDN you provided and then access the endpoints at your browser such in the example in the table below.
The installer will automatically add a record to your hosts record in the VM but if you want to access the endpoints outside the VM you must map the `ip` of the instance running Ubuntu to the FQDN you provided and then access the endpoints at your browser such in the example in the table below.

| Service | Example endpoint |
| ----------- |---------------------------------------------------------------|
Expand Down
22 changes: 1 addition & 21 deletions docs/admin/install/helm-install/microsoft-azure.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,27 +12,7 @@ tags:

## System Requirements

The resources may be set to the minimum as below:

- 8 GiB RAM
- 8 CPU cores
- 50GB hard-disk

Use the listing below for detailed estimation of minimum required resources. Table contains the default resources recommendations per service. Depending on the use of each service the resources needs may be increase or decrease.

| Service | CPU Unit | RAM | Disk Space | Processor Type | Required |
|-------------------|----------|-------|------------|----------------|------------------------------------|
| Auth server | 2.5 | 2.5GB | N/A | 64 Bit | Yes |
| LDAP (OpenDJ) | 1.5 | 2GB | 10GB | 64 Bit | Only if couchbase is not installed |
| fido2 | 0.5 | 0.5GB | N/A | 64 Bit | No |
| scim | 1.0 | 1.0GB | N/A | 64 Bit | No |
| config - job | 0.5 | 0.5GB | N/A | 64 Bit | Yes on fresh installs |
| persistence - job | 0.5 | 0.5GB | N/A | 64 Bit | Yes on fresh installs |
| nginx | 1 | 1GB | N/A | 64 Bit | Yes if not ALB |
| auth-key-rotation | 0.3 | 0.3GB | N/A | 64 Bit | No [Strongly recommended] |
| config-api | 1 | 1GB | N/A | 64 Bit | No |

Releases of images are in style 1.0.0-beta.0, 1.0.0-0
{% include "includes/cn-system-requirements.md" %}

## Initial Setup

Expand Down
24 changes: 24 additions & 0 deletions docs/includes/cn-system-requirements.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
The resources may be set minimally to the below:

- 8-12 GB RAM based on the services deployed
- 8-10 CPU cores based on the services deployed
- 50GB hard-disk

Use the listing below for detailed estimation of minimum required resources. Table contains the default resources recommendations per service. Depending on the use of each service the resources needs may be increased or decreased.

| Service | CPU Unit | RAM | Disk Space | Processor Type | Required |
|-------------------|----------|-------|------------|----------------|------------------------------------|
| Auth server | 2.5 | 2.5GB | N/A | 64 Bit | Yes |
| LDAP (OpenDJ) | 1.5 | 2GB | 10GB | 64 Bit | Only if Couchbase/SQL not installed|
| fido2 | 0.5 | 0.5GB | N/A | 64 Bit | No |
| scim | 1 | 1GB | N/A | 64 Bit | No |
| config - job | 0.3 | 0.3GB | N/A | 64 Bit | Yes on fresh installs |
| persistence - job | 0.3 | 0.3GB | N/A | 64 Bit | Yes on fresh installs |
| nginx | 1 | 1GB | N/A | 64 Bit | Yes ALB/Istio not used |
| auth-key-rotation | 0.3 | 0.3GB | N/A | 64 Bit | No [Strongly recommended] |
| config-api | 1 | 1GB | N/A | 64 Bit | No |
| casa | 0.5 | 0.5GB | N/A | 64 Bit | No |
| link | 0.5 | 1GB | N/A | 64 Bit | No |
| saml | 0.5 | 1GB | N/A | 64 Bit | No |

Releases of images are in style 1.0.0-beta.0, 1.0.0-0
1 change: 1 addition & 0 deletions mkdocs.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -456,6 +456,7 @@ nav:
- 'Adding authentication methods': 'casa/developer/add-authn-methods.md'
- User Guide: 'casa/user-guide.md'
plugins:
- include-markdown
- tags
- search
- exclude-search:
Expand Down

0 comments on commit d87e913

Please sign in to comment.