Skip to content

Commit 1a863f4

Browse files
xauthuleik8s-ci-robot
authored andcommitted
Modify the out of date guide docs. (kubeflow#1085)
1 parent 5248a15 commit 1a863f4

File tree

1 file changed

+28
-19
lines changed

1 file changed

+28
-19
lines changed

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

+28-19
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ 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

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

19-
```
19+
```bash
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`:
2726

28-
```
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-
```
27+
- Edit `${KFAPP}/app.yaml`
28+
- Delete the entry in KfDef.Spec.Applications for spartakus
3929

40-
Then deploy your changes:
4130
```
42-
kubectl apply -f spartakus.yaml`
31+
- kustomizeConfig:
32+
parameters:
33+
- initRequired: true
34+
name: usageId
35+
value: <randomly-generated-id>
36+
- initRequired: true
37+
name: reportUsage
38+
value: "true"
39+
repoRef:
40+
name: manifests
41+
path: common/spartakus
42+
name: spartakus
4343
```
44+
45+
- Delete the entry in KfDef.Spec.ComponentParams for spartakus
46+
47+
* initRequired: true name: usageId value:
48+
* initRequired: true name: reportUsage value:
49+
50+
- Delete the entry in KfDef.Spec.Components for spartakus
51+
52+
* spartakus

0 commit comments

Comments
 (0)