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

Docs: Filling in installation documentation #667

Merged
merged 15 commits into from
Dec 27, 2022
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
2 changes: 0 additions & 2 deletions docs/install/helm-install/red-hat-open-shift.md

This file was deleted.

File renamed without changes.
2 changes: 0 additions & 2 deletions docs/install/vm-install/disa-stig.md

This file was deleted.

2 changes: 2 additions & 0 deletions docs/install/vm-install/dynamic-download.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
## Where is this content?
The Gluu Flex documentation is a work in progress, and this document is currently a draft. Keep an eye on this page for updates.

This upcoming page is for Gluu Flex, an upcoming Gluu product. If you're looking for the Janssen Project installation page, find it [here](https://docs.jans.io/head/admin/install/vm-install/dynamic-download/).
2 changes: 2 additions & 0 deletions docs/install/vm-install/rhel.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
## Where is this content?
The Gluu Flex documentation is a work in progress, and this document is currently a draft. Keep an eye on this page for updates.

This content is for Gluu Flex, an upcoming Gluu product. If you're looking for the Gluu 4 installation page, find it [here](https://gluu.org/docs/gluu-server/4.4/installation-guide/install-rhel/), and if you're looking for the Janssen Project installation page, find it [here](https://docs.jans.io/head/admin/install/vm-install/rhel/).
2 changes: 2 additions & 0 deletions docs/install/vm-install/suse.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
## Where is this content?
The Gluu Flex documentation is a work in progress, and this document is currently a draft. Keep an eye on this page for updates.

This content is for Gluu Flex, an upcoming Gluu product. If you're looking for the Gluu 4 installation page, find it [here](https://gluu.org/docs/gluu-server/4.4/installation-guide/install-suse/), and if you're looking for the Janssen Project installation page, find it [here](https://docs.jans.io/head/admin/install/vm-install/suse/).
77 changes: 75 additions & 2 deletions docs/install/vm-install/ubuntu.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,75 @@
## Where is this content?
The Gluu Flex documentation is a work in progress, and this document is currently a draft. Keep an eye on this page for updates.

# Ubuntu Janssen Installation

Before you install, check the [VM system requirements](vm-requirements.md).

## Supported Versions
- Ubuntu 20.04

## Install the Package

- Download the release package from the Github Gluu Flex [Releases](https://github.com/GluuFederation/flex/releases)

```
wget https://github.com/JanssenProject/jans/releases/download/v5.0.0-4/flex_5.0.0-4.ubuntu20.04_amd64.deb -P ~/
```

- Verify integrity of the downloaded package by verifying published `sha256sum`.

Download `sha256sum` file for the package

```shell
wget https://github.com/JanssenProject/jans/releases/download/v5.0.0-4/flex_5.0.0-4.ubuntu20.04_amd64.deb.sha256sum -P ~/
```

Check the hash if it is matching.

```shell
sha256sum -c flex_5.0.0-4.ubuntu20.04_amd64.deb.sha256sum
```

Output similar to below should confirm the integrity of the downloaded package.

```text
<package-name>: OK
```

- Install the package

```
apt install -y ~/flex_5.0.0-4.ubuntu20.04_amd64.deb
```

## Run the setup script

- Run the setup script in interactive mode:

```
python3 /opt/jans/flex/flex-linux-setup/flex_setup.py
```

See more detailed [instructions](../setup.md) on the setup script if you're confused how to answer any of the questions, for details about command line arguments, or you would prefer to use a properties file instead of interactive mode.

## Ubuntu Janssen Un-Installation

Removing Janssen is a two step process:

1. Delete files installed by Gluu Flex
1. Remove and purge the `jans` package

Use the command below to uninstall the Gluu Flex server

```
python3 /opt/jans/flex/flex-linux-setup/flex_setup.py --remove-flex
```

<!-- I need to add the output when command is run. -->


The command below removes and purges the `jans` package

```
apt-get --purge remove jans
```

<!-- I need to add the output when command is run. -->
79 changes: 77 additions & 2 deletions docs/install/vm-install/vm-requirements.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,77 @@
## Where is this content?
The Gluu Flex documentation is a work in progress, and this document is currently a draft. Keep an eye on this page for updates.
# VM System Requirements

Gluu Flex currently provides packages for these Linux distros:

- Ubuntu (versions: 20.04)
- SUSE (SLES or LEAP) (version: 15)
- RedHat Enterprise Linux (version: 8)

## Hardware Requirements

A single-VM deployment is where all services are running on one server. Although, the requirements can vary based on the size of the data and the required concurrency, the following guidelines can help you plan:

### Development and Test Environments
- 4 GB RAM
- 2 CPU
- 20 GB Disk

### Production Environment Recommendation:
- 8 GB RAM
- 4 CPU
- 4 GB swap space
- 50 GB Disk

## Port Configuration

Gluu Flex requires the following ports to be open for incoming connections.

| Port | Protocol | Notes |
|------|----------|-----------------|
| 443 | TCP | TLS/HTTP |

You may want to use a redirect on port 80 to 443, although it is not required. Of course you will also need some way to login to your server, but that is out of scope of these docs.

Check your server firewall documentation to configure your firewall to allow `https`.

## Hostname / IP Address Configuration

It is recommended that you use a static ip address for Gluu Flex. Your server should also return the hostname for the `hostname` command, it's recommended that you add the hostname to the `/etc/hosts` file.

## File Descriptor Configuration (FD)

Like most database and Internet servers, you must have at least 65k file descriptors. If you don't, your server will hang.

First, check the current file descriptor limit using command below. If the existing FD limit exceeds 65535, then you're good.

```text
# cat /proc/sys/fs/file-max
```

If FD limit is less than 65535 (e.g. 1024), then follow the steps below to increase the value.

1) Set soft and hard limits by adding the following lines in the `/etc/security/limits.conf` file

```text
* soft nofile 65535
* hard nofile 262144
```

2) Add the following lines to `/etc/pam.d/login` if not already present

```text
session required pam_limits.so
```

3) Increase the FD limit in `/proc/sys/fs/file-max`

```text
echo 65535 > /proc/sys/fs/file-max**
```

4) Use the `ulimit` command to set the FD limit to the hard limit specified in `/etc/security/limits.conf`. If setting to hard limit doesn't work, then try to set it to the soft limit.

```text
ulimit -n 262144
```

5) Restart the system
18 changes: 8 additions & 10 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -110,23 +110,21 @@ nav:
- 'Overview': 'README.md'
- 'Installation':
- 'install/README.md'
- 'VM Installation':
- 'install/vm-install/README.md'
- 'VM Requirements': 'install/vm-install/vm-requirements.md'
- 'Ubuntu': 'install/vm-install/ubuntu.md'
- 'RHEL': 'install/vm-install/rhel.md'
- 'Suse': 'install/vm-install/suse.md'
- 'FIPS DISA STIG': 'install/vm-install/disa-stig.md'
- 'Dynamic Download': 'install/vm-install/dynamic-download.md'
- 'Helm Deployments':
- 'install/helm-install/README.md'
- 'Local Kubernetes Cluster': 'install/helm-install/local.md'
- 'Amazon EKS': 'install/helm-install/amazon-eks.md'
- 'Google GKE': 'install/helm-install/google-gke.md'
- 'Digital Ocean DOK': 'install/helm-install/digitalocean-dok.md'
- 'Microsoft Azure AKS': 'install/helm-install/microsoft-azure.md'
- 'Red Hat Open Shift': 'install/helm-install/red-hat-open-shift.md'
- 'Using Rancher Marketplace': 'install/helm-install/rancher.md'
- 'VM Installation':
- 'install/vm-install/README.md'
- 'VM Requirements': 'install/vm-install/vm-requirements.md'
- 'Ubuntu': 'install/vm-install/ubuntu.md'
- 'RHEL': 'install/vm-install/rhel.md'
- 'Suse': 'install/vm-install/suse.md'
- 'Dynamic Download': 'install/vm-install/dynamic-download.md'
- 'Setup Script': 'install/setup.md'
- 'Administration':
- 'Admin UI':
- 'admin-ui/README.md'
Expand Down