Skip to content

Commit f03a67d

Browse files
committed
Modify the out of date guide docs.
1 parent 0f480d3 commit f03a67d

File tree

1 file changed

+22
-18
lines changed

1 file changed

+22
-18
lines changed

content/docs/other-guides/usage-reporting.md

+22-18
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ weight = 40
55
+++
66

77
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.
8-
This is entirely voluntary and you can opt
8+
This is entirely voluntary and you can opt out by doing the following:
99

1010
```
1111
# Delete any existing deployments of spartakus
@@ -20,24 +20,28 @@ command only restarts spartakus with reportUsage set to `false`
2020
kubectl -n ${NAMESPACE} delete deploy -l app=spartakus
2121
```
2222

23-
**Reporting usage data is one of the most significant contributions you can make to Kubeflow; so please consider turning it on.** This data
24-
allows us to improve the project and helps the many companies working on Kubeflow justify continued investment.
23+
**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.
2524

26-
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:
25+
**To prevent Spartakus from being deployed,** do the following before running `kfctl apply`:
26+
- Edit `${KFAPP}/app.yaml`
27+
- Delete the entry in KfDef.Spec.Applications for spartakus
2728

2829
```
29-
apiVersion: v1
30-
data:
31-
usageId: "your usage id"
32-
kind: ConfigMap
33-
metadata:
34-
labels:
35-
kustomize.component: spartakus
36-
name: spartakus-parameters
37-
namespace: kubeflow
38-
```
39-
40-
Then deploy your changes:
41-
```
42-
kubectl apply -f spartakus.yaml`
30+
- kustomizeConfig:
31+
parameters:
32+
- initRequired: true
33+
name: usageId
34+
value: <randomly-generated-id>
35+
- initRequired: true
36+
name: reportUsage
37+
value: "true"
38+
repoRef:
39+
name: manifests
40+
path: common/spartakus
41+
name: spartakus
4342
```
43+
- Delete the entry in KfDef.Spec.ComponentParams for spartakus``` spartakus:
44+
* initRequired: true name: usageId value:
45+
* initRequired: true name: reportUsage value: ```
46+
- Delete the entry in KfDef.Spec.Components for spartakus```
47+
* spartakus```

0 commit comments

Comments
 (0)