Skip to content

Commit

Permalink
Modify the out of date guide docs. (kubeflow#1085)
Browse files Browse the repository at this point in the history
  • Loading branch information
xauthulei authored and k8s-ci-robot committed Aug 17, 2019
1 parent 5248a15 commit 1a863f4
Showing 1 changed file with 28 additions and 19 deletions.
47 changes: 28 additions & 19 deletions content/docs/other-guides/usage-reporting.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ weight = 40
+++

When enabled, Kubeflow will report **anonymous** usage data using [spartakus](https://github.com/kubernetes-incubator/spartakus), Kubernetes' reporting tool. Spartakus **does not report any personal information**. See [here](https://github.com/kubernetes-incubator/spartakus) for more detail.
This is entirely voluntary and you can opt
This is entirely voluntary and you can opt out by doing the following:

```
```bash
# Delete any existing deployments of spartakus
kubectl delete -n ${NAMESPACE} deploy spartakus-volunteer
```
Expand All @@ -16,28 +16,37 @@ kubectl delete -n ${NAMESPACE} deploy spartakus-volunteer
This command completely deletes any spartakus deployment, while the above
command only restarts spartakus with reportUsage set to `false`

```
```bash
kubectl -n ${NAMESPACE} delete deploy -l app=spartakus
```

**Reporting usage data is one of the most significant contributions you can make to Kubeflow; so please consider turning it on.** This data
allows us to improve the project and helps the many companies working on Kubeflow justify continued investment.
**Reporting usage data is one of the most significant contributions you can make to Kubeflow; so please consider turning it on.** This data allows us to improve the project and helps the many companies working on Kubeflow justify continued investment.

You can improve the quality of the data by giving each Kubeflow deployment a unique id by editing `spartakus.yaml` in your `KF_APP` directory:
**To prevent Spartakus from being deployed,** do the following before running `kfctl apply`:

```
apiVersion: v1
data:
usageId: "your usage id"
kind: ConfigMap
metadata:
labels:
kustomize.component: spartakus
name: spartakus-parameters
namespace: kubeflow
```
- Edit `${KFAPP}/app.yaml`
- Delete the entry in KfDef.Spec.Applications for spartakus

Then deploy your changes:
```
kubectl apply -f spartakus.yaml`
- kustomizeConfig:
parameters:
- initRequired: true
name: usageId
value: <randomly-generated-id>
- initRequired: true
name: reportUsage
value: "true"
repoRef:
name: manifests
path: common/spartakus
name: spartakus
```

- Delete the entry in KfDef.Spec.ComponentParams for spartakus

* initRequired: true name: usageId value:
* initRequired: true name: reportUsage value:

- Delete the entry in KfDef.Spec.Components for spartakus

* spartakus

0 comments on commit 1a863f4

Please sign in to comment.