Versions Compared

Version Old Version 44 New Version 45
Changes made by

Cornelius Wachinger

Rene Beckert

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Setup the Kubernetes Environment

You need a Kubernetes cluster to deploy Smartfacts in. If you already have a Kubernetes infrastructure on AWS, GCP or Azure, you can use this.

Note

Please make sure that an ingress controller of nginx or Traefik is installed.

If you don’t have a Kubernetes infrastructure you can set up a single node cluster at a vm. The following section will describe how to set zu such a cluster.

Install k3s

Code Block
curl -sfL https://get.k3s.io | sh -

...

For more information see: https://rancher.com/docs/k3s/latest/en/quick-start

Install helm

Code Block
curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 && chmod 700 get_helm.sh && ./get_helm.sh

For more information see: https://helm.sh/docs/intro/install

Set Link to Cluster Configuration

Code Block
sudo mkdir -p /root/.kube
sudo ln -s /etc/rancher/k3s/k3s.yaml /root/.kube/config

...

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

    Code Block
    global:
  domain: "<your-domain>"
  instance: "smartfacts-poc"
  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" 
spa:
  cspConf:
    externalUrls: "" # space separated list of your tool urls (IBM Jazz, Jama, Codebeamer)
plugin:
  importPlugins: true # "true" for first installation, "false" for minor updates will speed up the update process a lot
genoslc:
  enabled: true # Set to false if you want to use Smartfacts only (no OSLC connection to itger tools). In this case you cann skip the rest of this "genoslc" section.
  env:
    authorizationUri: "<Authorization URL of identity provider>"
    tokenUri: "<Token URI of identity provider>"
    userInfoUri: "<UserInfo URI of identity provider>"
    trsEnabled: false # Set to true if you use Smartfacts as data source for a link index
    configuration:
      # Give a list of up to 5 usernames of users which will have the administration right to change settings in Smartfacts.
      # At leas one administrator user must be stated here.
      administrators: 
        - <administrator1> # replace this value with the username of the person who should configure the oauth10a information for the OSLC Connector for Smartfacts
      # key used to encrypt the oauth10a configuration data
      oauth10aEncryptionKey: "" # define the key which is used to encrypt the oauth10a informatininformation in the database
mailservice:
  enabled: false

  • Replace the value of the domain property with your domain name.

  • Replace the value of the repologin property with the value provided from MID.

  • 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 the placeholder for the externalUrls property with the URL of your Jama or Codebeamer instance. If you connect multiple instance delement the URLs with a space.

  • Replace the placeholder <administrator1> with the username of the person who should configure the oauth10a information for the OSLC Connector for Smartfacts. If you connect to an OIDC provider this is the value of the preferred_username attribute.
    In PoC installations the value is “acm”

  • Replace the placeholder in authorizationUri, tokenUri and userInfoUri with the appropriate URLs of your identity provider instance

  • Save the values.yaml file.

...