Usage Reporting

Out of date

This guide contains outdated information pertaining to Kubeflow 1.0. This guide needs to be updated for Kubeflow 1.1.

When enabled, Kubeflow will report anonymous usage data using Spartakus, Kubernetes’ reporting tool. Spartakus does not report any personal information. See the for more 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 many companies working on Kubeflow justify continued investment.

If you’ve already deployed Kubeflow, run the following command to disable usage reporting on your existing deployment. The command removes 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-line interface to deploy Kubeflow.

This guide refers to the ${CONFIG_FILE}, which is the Kubeflow configuration file in your Kubeflow deployment directory. For example, ${KF_DIR}/kfctl_k8s_istio.v1.1.0.yaml or ${KF_DIR}/kfctl_gcp_iap.v1.0.2.yaml.

To prevent Spartakus from being deployed:

  1. Follow your chosen guide to deploying Kubeflow, but stop before you deploy Kubeflow. For example, see the guide to deploying Kubeflow with kfctl_k8s_istio.

  3. Run the kfctl apply command to deploy Kubeflow:

You need to remove the Spartakus entry from KfDef.Spec.Applications in the file. Find the applications section of the YAML file and delete the following lines:

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

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

  • Find the componentParams section of the YAML file and delete the following lines: