Skip to content

Enable your VEE and prof service classes

This page explains how to enable the VEE and PROF service classes from the kxs-utilities package using manifest.yaml overrides.

The VEE and PROF service classes are included in the kxs-utilities package. The VEE service class is required in all implementations; the PROF service class, on the other hand, is only required if you use either historical or class estimation methods.

Note

The VEE and PROF service classes are currently implemented as single threaded processes and do not support multiple services (that is, quantities > 1 in manifest.yaml).

  1. Make a copy of manifest.yaml and place it in the appropriate overlay directory. Set the num for VEE to 1. If you require the PROF service class in your implementation, set the num to 0 (deactivated) for PROF.
  2. Delete the remaining service class records in manifest.yaml. They are not required at the override level. This produces a manifest.yaml override showing the VEE and PROF entries:

    services:
       sc: VEE
       num: 1
       sc: PROF
       num: 0
    
  3. If you require the PROF service class in your implementation, make a second copy of manifest.yaml and place it in the appropriate overlay directory. For this service class, set the num to 1:

    services:
       sc: PROF
       num: 1
    
  4. Delete the remaining service class records in manifest.yaml.

This setup will ensure that one VEE and one PROF process run at all times when starting a node.

Next steps