Skip to content

Commit 30b7e91

Browse files
committed
Modify the out of date guide docs.
1 parent a8d9887 commit 30b7e91

File tree

1 file changed

+30
-20
lines changed

1 file changed

+30
-20
lines changed

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

+30-20
Original file line numberDiff line numberDiff line change
@@ -20,24 +20,34 @@ 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.
25-
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:
27-
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-
```
39-
40-
Then deploy your changes:
41-
```
42-
kubectl apply -f spartakus.yaml`
23+
**To prevent Spartakus from being deployed; users should do the following before running `kfctl apply`**
24+
- Edit ${KFAPP}/app.yaml
25+
- Delete the entry in KfDef.Spec.Applications for spartakus
26+
```
27+
- kustomizeConfig:
28+
parameters:
29+
- initRequired: true
30+
name: usageId
31+
value: <randomly-generated-id>
32+
- initRequired: true
33+
name: reportUsage
34+
value: "true"
35+
repoRef:
36+
name: manifests
37+
path: common/spartakus
38+
name: spartakus
39+
```
40+
- Delete the entry in KfDef.Spec.ComponentParams for spartakus
41+
```
42+
spartakus:
43+
- initRequired: true
44+
name: usageId
45+
value: <randomly-generated-id>
46+
- initRequired: true
47+
name: reportUsage
48+
value: "true"
49+
```
50+
- Delete the entry in KfDef.Spec.Components for spartakus
51+
```
52+
- spartakus
4353
```

0 commit comments

Comments
 (0)