Usage Reporting

Opting in or out of anonymous usage data reported from Kubeflow

When enabled, Kubeflow will report anonymous usage data usingSpartakus, Kubernetes’reporting tool. Spartakus does not report any personal information.See the Spartakus docs formore detail.

Allowing usage reporting is entirely voluntary.

Reporting usage data is one of the most significant contributions you can make to Kubeflow

Please consider allowing the reporting of usage data.The data helps the Kubeflow community to improve the project and helps the manycompanies working on Kubeflow justify continued investment.

Disable usage reporting on an existing Kubeflow deployment

If you’ve already deployed Kubeflow, run the following command to disable usagereporting on your existing deployment. The command removes thespartakus-volunteer application:

  1. export NAMESPACE=kubeflow
  2. kubectl delete -n ${NAMESPACE} deploy spartakus-volunteer

You can run the following command to check for existence of the application:

  1. kubectl get -n ${NAMESPACE} deploy spartakus-volunteer

Remove usage reporting before deploying Kubeflow

The following instructions assume that you plan to use the kfctl command-linetool to deploy Kubeflow, as described in theKubeflow getting-started guides.

To prevent Spartakus from being deployed, edit your ${KFAPP}/app.yamlconfiguration file before running kfctl apply.(KFAPP represents the directory where your Kubeflow configuration is storedduring deployment.)

You need to remove the Spartakus entry from KfDef.Spec.Applications. To dothat, find the applications section of the YAML file and delete the followinglines:

  1. - kustomizeConfig:
  2. parameters:
  3. - initRequired: true
  4. name: usageId
  5. value: <randomly-generated-id>
  6. - initRequired: true
  7. name: reportUsage
  8. value: "true"
  9. repoRef:
  10. name: manifests
  11. path: common/spartakus
  12. name: spartakus

Alternatively, some YAML configuration files may include entries forKfDef.Spec.Components and KfDef.Spec.ComponentParams instead ofKfDef.Spec.Applications. In this case:

  • Find the componentParams section of the YAML file and delete the followinglines:
  1. spartakus:
  2. - initRequired: true
  3. name: usageId
  4. value: "<randomly-generated-id>"
  5. - initRequired: true
  6. name: reportUsage
  7. value: "true"
  • Find the components section of the YAML file and delete the followingline:
  1. - spartakus