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:

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

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

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-lineinterface to deploy Kubeflow.

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

To prevent Spartakus from being deployed:

• Follow your chosen guide to deploying Kubeflow, but stop before you deployKubeflow. For example, see the guide todeploying Kubeflow with kfctl_k8s_istio.
• When you reach thesetup and deploy step,skip the kfctl apply command and run the kfctl build commandinstead, as described in the above guide. Now you can edit the configurationfiles before deploying Kubeflow.

• Edit your ${CONFIG_FILE} file as described below.

• Run the kfctl apply command to deploy Kubeflow:

cd ${KF_DIR}
kfctl apply -V -f ${CONFIG_FILE}

Removing Spartakus from your configuration

You need to remove the Spartakus entry from KfDef.Spec.Applications inthe ${CONFIG_FILE} file. Find the applications section of the YAMLfile and delete the following lines:

- kustomizeConfig:
    parameters:
    - initRequired: true
      name: usageId
      value: <randomly-generated-id>
    - initRequired: true
      name: reportUsage
      value: "true"
    repoRef:
      name: manifests
      path: common/spartakus
  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:

spartakus:
- initRequired: true
  name: usageId
  value: "<randomly-generated-id>"
- initRequired: true
  name: reportUsage
  value: "true"

• Find the components section of the YAML file and delete the followingline:

- spartakus

Feedback

Was this page helpful?

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.

Last modified 24.10.2019: Fixed and parameterised local config file names (#1275) (e0528a1f)