Signals Data Factory - How to add a new ingress definition in Signals Inventa

Keywords: Signals Inventa, Signals Data Factory

Details:

In Signals Inventa, multiple URLs can be configured to point to the same Signals Data Factory system. This is achieved by configuring multiple ingress definitions in Kubernetes cluster that hosts Signals Data Factory.

For example, initial set up could use URL https://signals-local.example.com/. If a group of external users would like to access the same environment using a different URL, for example, https://signals-external.example.com/, the following configuration steps will need to be completed in order to add this new ingress definition:

1. Create a new workspace using the spm utility:

  ./spm -e "create-workspace-host -workspace-name sdf signals-external.example.com"

2. Create a new ingress definition:

• View ingress in the system:

kubectl get ingress

• Retrieve the existing ingress and save it as backup:

kubectl get ingress sdf-cs-signals-nginx-ingress -o yaml > ingress-example-backup

• Make a copy of the current configuration and call it, for example, sdf-cs-signals-nginx-ingress-external:

cp ingress-example-backup sdf-cs-signals-nginx-ingress-external

• Open the external ingress (vi sdf-cs-signals-nginx-ingress-external) and update the highlighted fields:

apiVersion: extensions/v1beta1
kind: Ingress
metadata:
  annotations:
    kubernetes.io/ingress.class: nginx
    nginx.ingress.kubernetes.io/proxy-body-size: 5000000m
    nginx.ingress.kubernetes.io/proxy-buffering: "off"
    nginx.ingress.kubernetes.io/proxy-connect-timeout: "600"
    nginx.ingress.kubernetes.io/proxy-read-timeout: "600"
    nginx.ingress.kubernetes.io/proxy-request-buffering: "off"
    nginx.ingress.kubernetes.io/proxy-send-timeout: "600"
name: sdf-cs-signals-nginx-ingress-external
  namespace: default
spec:
  rules:
  -host: signals-external.example.com
    http:
      paths:
      - backend:
          serviceName: sdf-cs-signals-nginx
          servicePort: 80
  tls:
  -hosts:
    - signals-external.example.com
    secretName: signals-sdf
status:
  loadBalancer:
    ingress:
    - ip: x.x.x.x
    - ip: x.x.x.x
    - ip: x.x.x.x

Apply the ingress:

kubectl apply -f ingress-sld-example

Now the system can be accessed using both URLs. However, you will need to ensure that you create users specific to each URL. You can’t access both URLs using the same username. There is a database in the backend that maintains a list of users associated with each URL.

Note: There are situations where an upgrade or some specific feature enablement in SDF that updates the ingress module will lead to the loss of custom changes you have made. So, you will need to redo all the steps above (except the workspace creation). One specific activity that could lead to this is SAML integration, for example, which will cause the system to drop the external URL ingress definition. In this case, one will have to execute these same steps to get it up and running again.