Skip to content

Commit 384368d

Browse files
sarahmaddoxk8s-ci-robot
authored andcommitted
Clarified the usage reporting guide (kubeflow#1087)
* Clarified usage reporting guide. * Clarified and added section formatting. * Changed word component to application * Changed another "component" to "application"
1 parent 564e460 commit 384368d

File tree

1 file changed

+63
-30
lines changed

1 file changed

+63
-30
lines changed

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

+63-30
Original file line numberDiff line numberDiff line change
@@ -4,49 +4,82 @@ description = "Opting in or out of anonymous usage data reported from Kubeflow"
44
weight = 40
55
+++
66

7-
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 out by doing the following:
7+
When enabled, Kubeflow will report **anonymous** usage data using
8+
[Spartakus](https://github.com/kubernetes-incubator/spartakus), Kubernetes'
9+
reporting tool. Spartakus does not report any personal information.
10+
See the [Spartakus docs](https://github.com/kubernetes-incubator/spartakus) for
11+
more detail.
12+
13+
Allowing usage reporting is entirely voluntary.
14+
15+
{{% alert title="Reporting usage data is one of the most significant contributions you can make to Kubeflow" color="info" %}}
16+
Please consider allowing the reporting of usage data.
17+
The data helps the Kubeflow community to improve the project and helps the many
18+
companies working on Kubeflow justify continued investment.
19+
{{% /alert %}}
20+
21+
## Disable usage reporting on an existing Kubeflow deployment
22+
23+
If you've already deployed Kubeflow, run the following command to disable usage
24+
reporting on your existing deployment. The command removes the
25+
`spartakus-volunteer` application:
926

1027
```bash
11-
# Delete any existing deployments of spartakus
28+
export NAMESPACE=kubeflow
1229
kubectl delete -n ${NAMESPACE} deploy spartakus-volunteer
1330
```
1431

15-
**To disable usage reporting** you need to delete spartakus component.
16-
This command completely deletes any spartakus deployment, while the above
17-
command only restarts spartakus with reportUsage set to `false`
32+
You can run the following command to check for existence of the application:
1833

1934
```bash
20-
kubectl -n ${NAMESPACE} delete deploy -l app=spartakus
35+
kubectl get -n ${NAMESPACE} deploy spartakus-volunteer
2136
```
2237

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.
38+
## Remove usage reporting before deploying Kubeflow
2439

25-
**To prevent Spartakus from being deployed,** do the following before running `kfctl apply`:
40+
The following instructions assume that you plan to use the `kfctl` command-line
41+
tool to deploy Kubeflow, as described in the
42+
[Kubeflow getting-started guides](/docs/started/getting-started/).
2643

27-
- Edit `${KFAPP}/app.yaml`
28-
- Delete the entry in KfDef.Spec.Applications for spartakus
44+
To prevent Spartakus from being deployed, edit your `${KFAPP}/app.yaml`
45+
configuration file before running `kfctl apply`.
46+
(`KFAPP` represents the directory where your Kubeflow configuration is stored
47+
during deployment.)
2948

30-
```
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
43-
```
49+
You need to remove the Spartakus entry from `KfDef.Spec.Applications`. To do
50+
that, find the `applications` section of the YAML file and delete the following
51+
lines:
52+
53+
- kustomizeConfig:
54+
parameters:
55+
- initRequired: true
56+
name: usageId
57+
value: <randomly-generated-id>
58+
- initRequired: true
59+
name: reportUsage
60+
value: "true"
61+
repoRef:
62+
name: manifests
63+
path: common/spartakus
64+
name: spartakus
65+
66+
**Alternatively,** some YAML configuration files may include entries for
67+
`KfDef.Spec.Components` and `KfDef.Spec.ComponentParams` instead of
68+
`KfDef.Spec.Applications`. In this case:
69+
70+
- Find the `componentParams` section of the YAML file and delete the following
71+
lines:
4472

45-
- Delete the entry in KfDef.Spec.ComponentParams for spartakus
73+
spartakus:
74+
- initRequired: true
75+
name: usageId
76+
value: "<randomly-generated-id>"
77+
- initRequired: true
78+
name: reportUsage
79+
value: "true"
4680

47-
* initRequired: true name: usageId value:
48-
* initRequired: true name: reportUsage value:
4981

50-
- Delete the entry in KfDef.Spec.Components for spartakus
82+
- Find the `components` section of the YAML file and delete the following
83+
line:
5184

52-
* spartakus
85+
- spartakus

0 commit comments

Comments
 (0)