Install Smartfacts with ldap and Email Service

In this instructions we assume that you deploy Smartfacts into an existing Kubernetes cluster. You need a cluster with at least 3 worker nodes of 2 cpu and 16GB RAM each.

Preparations

Please prepare your infrastructur as described in https://smartfacts.atlassian.net/wiki/spaces/SPD/pages/57180191/Installing+Smartfacts+in+Production#Prepare-your-infrastructure.

Prepare Deployment

Add MID Repository

You will need a username and password to download the helm chart and containers from MID's repository. You will receive username and password from your MID contact or from cops@mid.de.

sudo helm repo add mid-smartfacts https://repo.secure.mid.de/chartrepo/smartfacts --username <USERNAME> --password <PASSWORD>

sudo helm repo update

Provide Certificates and Key as Base64 String

Prerequisite: The complete certificate chain is in a file as base64-encoded x509 certificates. The certificates are contained in the file in the correct order (server certificate at the top, root certificate at the bottom). See Section “Certificates” above in this article.

Save certificate chain as a base64 string:

cat <your certificate chain.crt> | base64 -w0 > chain.crt.base64

Save certificate key as base64 string:

cat <your certificate key.key> | base64 -w0 > key.base64

Customize Values File

Change to your user's home directory on the server and create a new text file values.yaml with the following content:

global:
  domain: "<your-domain>"
  instance: "smartfacts"
  registry: "repo.mid.de"
  repologin: <login provided by MID>
  cert:
    crtFullChain: "<FULL-CHAIN-CERT-BASE64>"
    key: "<CERT-KEY-BASE64>"
  ingress:
    enabled: true
    # if you use nginx as ingress controller please comment in this line:
    #ingressClassType: "nginx" 
  env:
    genoslc:
      tool:
        type: "" # insert "CB" for Codebeamer or "JA" for Jama
        url: ""
  ldap:
    # The url of the ldap server
    url: #TODO
    # The base DN of the ldap
    base_dn: #TODO
    # Group search base
    g_search_base: #TODO
    # User search base
    u_search_base: #TODO
    # The ldap filter, which reduces the results to the relevant users and groups
    search_filter: #TODO
    # The read only user accessing the ldap
    user: #TODO
    # The password of the read-only user accessing the ldap.
    password: #TODO

    # The following section contains the mapping of the ldif attributes in your ldap to the attributes in Smartfacts.
    # The default values stated in the comments are the valid values for an openldap.
    # The values stated in the active fields (not out commented) are the correct values for an Active directory.
    # TODO: Please adopt the values, so that they fit to your ldap / Active directory instance.
    ldif_attributes:
      # The field for the unique id of an object. Default: "entryUUID"
      uniqueid: "objectGUID"
      # Classname of the group object. Default: "groupOfNames"
      classname_group: "group"
      # Classname of the user object. Default: "person"
      #classname_user: "person"

      # The field for the NameID of users. Default: "cn"
      user_nameid: "sAMAccountName"
      # The field for the given name of a user. Default: "givenName"
      #user_first_name: "givenName"
      # The field for the last name of a user. Default: "sn"
      #user_last_name: "sn"
      # The field for the title of a user. Default: "title"
      #user_title: "title"
      # The field for the email of a user. Default: "mail"
      #user_mail: "mail"
      # The field for the telephone number of a user. Default: "telephoneNumber"
      #user_phone: "telephoneNumber"
      # The field for the thumbnail photo of a user. Default: "thumbnailPhoto"
      #user_photo: "thumbnailPhoto"
      # The field for the division of a user. Default: "division"
      #user_division: "division"
      # The field for the company of a user. Default: "company"
      #user_company: "company"
      # The field for the display name of a user. Default: "displayName"
      user_display_name: "cn"

      # The field for the NameID of groups. Default: "cn"
      #group_nameid: "cn"
      # The Field for the full name of a group member. Default: "cn"
      #group_member_full_name: "cn"
      # The field for group members. Default: "member"
      #group_member: "member"
keycloak:
  openldap:
    enabled: false
mailservice:
  enabled: true

Replace the value of the domain property with your domain name.
Replace the placeholder of the crtFullChain property with the content of the file chain.crt.base64.
Replace the placeholder of the key property with the content of the key.base64 file.
Replace all values marked with #TODO with the appropriate values in the ldap section.
Adopt all values that do not suite to your ldap in the ldap section.
Save the values.yaml file.