Installing Smartfacts for Proof of Concepts

To test Smartfacts in your infrastructure, you can perform an internal PoC installation. These pages describe the procedure to perform such an internal PoC installation.

Restrictions of a PoC deployment

To simplify the installation process, the following restrictions apply to a PoC installation:

  • If you don't have a Kubernetes Cluster available, the installation can be performed on a single Linux server with a single-node Kubernetes cluster using k3s. If you do have a Kubernetes cluster, the installation can be performed on this cluster.

  • Smartfacts will not connect to any identity provider. In the PoC you will work with dummy usershat are provisioned in advance.

  • Smartfacts will not send emails to users.

All other functionality will be usable as in a later production deployment.

General steps

For installing as Smartfacts PoC instance perform the following steps.

  1. Prepare your infrastructure

  2. Get access to container and chart registry

  3. Install Smartfacts

Prepare your infrastructure

Provide a Server

Please provide a server that meets the following requirements:

  • CPU:

    • x64 / AMD64 processor - ARM based servers will not work

    • Minimum: 6 Cores

  • RAM: minimum 32 GB

  • Hard disk: minimum 150 GB

    Most of the data will be stored under /var/lib/rancher/k3s

  • Operating System: Linux

    All Linux distributions running K3s can be used.

    If you are using a Red Hat / CentOS Linux, please perform these preparations:

    • It is recommended to turn off firewalld:

      systemctl disable firewalld --now

    • If enabled, it is required to disable nm-cloud-setup and reboot the node:

      systemctl disable nm-cloud-setup.service nm-cloud-setup.timer

      reboot

  • The user performing the installation will need sudo privileges

  • The server must be connected to the internet

Create the DNS entries for Smartfacts Server and Subdomains

Set up DNS entries for the following FQDNs

  • <Server-FQDN>

  • smartfacts.<Server-FQDN>

  • camp.<Server-FQDN>

  • identity.<Server-FQDN>

  • genoslc.<Server-FQDN>

  • genoslc-jama.<Server-FQDN> (if you connect to Jama using OSLC)

  • genoslc-codebeamer.<Server-FQDN> (if you connect to Codebeamer using OSLC)

Create an X.509 Certificate

Create the certificates according to the instructions on Creating and testing the Certificates for Smartfacts.

Get credentials and Smartfacts license

Please contact cops@mid.de. We will send you credentials for accessing our container & chart registry and a PoC license.

Install Smartfacts

We recommend that your server can directly acces our container and chart repository. In this case follow the instructions for a PoC Deployment on Kubernetes with use of Keycloak as OIDC provider.

If your server does not have internet acces, follow the instracionts for a Deployment on Kubernetes without Internet Connection.