Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions documentation/docs/11-telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ sidebar_label: Telemetry
title: "secureCodeBox Telemetry Data"
---

:::warning Telemetry removed in secureCodeBox 5.9.0
Telemetry collection was removed from the secureCodeBox Operator in release 5.9.0. The limited use of the collected data did not justify continued data collection or the effort of maintaining the telemetry backend.

The telemetry backend is being shut down and the DNS record for `telemetry.securecodebox.io` will be removed. secureCodeBox operators older than 5.9.0 with telemetry enabled will continue attempting to submit telemetry every 24 hours and log a failed submission after the DNS record is removed. This does not affect scans or the operator's normal operation. Upgrade to 5.9.0 or later to prevent the attempted requests.

The remaining content on this page is retained temporarily as historical documentation and will be removed in a future release.
:::

The secureCodeBox Operator collects and submits anonymized data to give the development team a vague overview on how much the secureCodeBox is actually used.

## Datapoints Collected:
Expand Down
6 changes: 0 additions & 6 deletions documentation/docs/contributing/local-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,12 +163,6 @@ secureCodeBox Operator Deployed 🚀
The operator can orchestrate the execution of various security scanning tools inside of your cluster.
You can find a list of all officially supported scanners here: https://www.securecodebox.io/
The website also lists other integrations, like persisting scan results to DefectDojo or Elasticsearch.

The operator send out regular telemetry pings to a central service.
This lets us, the secureCodeBox team, get a grasp on how much the secureCodeBox is used.
The submitted data is chosen to be as anonymous as possible.
You can find a complete report of the data submitted and links to the source-code at: https://www.securecodebox.io/docs/telemetry
The first ping is send one hour after the install, you can prevent this by upgrading the chart and setting `telemetryEnabled` to `false`.
```

:::note
Expand Down
5 changes: 0 additions & 5 deletions documentation/docs/contributing/project-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,11 @@ Under the topic "project management" we describe how we do the organizational st
- We have registerded one domain (`securecodebox.io`) which is sponsored by [iteratec][iteratec].
- The DNS cone is managed via [iteratec][iteratec] [Azure Portal](https://portal.azure.com/) by the _admin-team_.
- The website [https://www.securecodebox.io] is hosted on [Netlify](https://app.netlify.com/).
- We have a [Hetzner](https://www.hetzner.com/) VM sponsored by [iteratec][iteratec] to host the Helm charts and telemetry server.

### Domains

We use these full qualified domain names:

- For our [telemetry](https://www.securecodebox.io/docs/telemetry):
- telemetry.chase.securecodebox.io -> telemetry.securecodebox.io
- Backward compatibility: Was the old address. Old installations use this one.
- telemetry.securecodebox.io -> sky.securecodebox.io
- For our main website:
- www.securecodebox.io -> docs-securecodebox.netlify.app

Expand Down
1 change: 0 additions & 1 deletion operator/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ RUN go mod download
COPY main.go main.go
COPY apis/ apis/
COPY controllers/ controllers/
COPY internal/ internal/
COPY utils/ utils/

# Build
Expand Down
1 change: 0 additions & 1 deletion operator/docs/README.ArtifactHub.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,6 @@ helm install securecodebox-operator oci://ghcr.io/securecodebox/helm/operator
| serviceAccount.annotations | object | `{}` | Annotations of the serviceAccount the operator uses to talk to the k8s api |
| serviceAccount.labels | object | `{}` | Labels of the serviceAccount the operator uses to talk to the k8s api |
| serviceAccount.name | string | `"securecodebox-operator"` | Name of the serviceAccount the operator uses to talk to the k8s api |
| telemetryEnabled | bool | `true` | The Operator sends anonymous telemetry data, to give the team an overview how much the secureCodeBox is used. Find out more at https://www.securecodebox.io/telemetry |

## Contributing

Expand Down
123 changes: 0 additions & 123 deletions operator/internal/telemetry/telemetry.go

This file was deleted.

5 changes: 0 additions & 5 deletions operator/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ import (
executionv1 "github.com/secureCodeBox/secureCodeBox/operator/apis/execution/v1"
executioncontrollers "github.com/secureCodeBox/secureCodeBox/operator/controllers/execution"
scancontroller "github.com/secureCodeBox/secureCodeBox/operator/controllers/execution/scans"
"github.com/secureCodeBox/secureCodeBox/operator/internal/telemetry"
//+kubebuilder:scaffold:imports
)

Expand Down Expand Up @@ -112,10 +111,6 @@ func main() {
os.Exit(1)
}

if enabled, ok := os.LookupEnv("TELEMETRY_ENABLED"); ok && enabled == "true" {
go telemetry.Loop(mgr.GetClient(), ctrl.Log.WithName("telemetry"))
}

setupLog.Info("starting manager")
if err := mgr.Start(ctrl.SetupSignalHandler()); err != nil {
setupLog.Error(err, "problem running manager")
Expand Down
10 changes: 0 additions & 10 deletions operator/templates/NOTES.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,3 @@ secureCodeBox Operator Deployed 🚀
The operator can orchestrate the execution of various security scanning tools inside of your cluster.
You can find a list of all officially supported scanners here: https://www.securecodebox.io/
The website also lists other integrations, like persisting scan results to DefectDojo or Elasticsearch.

{{ if .Values.telemetryEnabled -}}
The operator send out regular telemetry pings to a central service.
This lets us, the secureCodeBox team, get a grasp on how much the secureCodeBox is used.
The submitted data is chosen to be as anonymous as possible.
You can find a complete report of the data submitted and links to the source-code at: https://www.securecodebox.io/docs/telemetry
The first ping is send one hour after the install, you can prevent this by upgrading the chart and setting `telemetryEnabled` to `false`.
{{ else -}}
Telemetry data collection has been disabled.
{{ end -}}
2 changes: 0 additions & 2 deletions operator/templates/manager/manager.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,6 @@ spec:
readinessProbe:
{{- toYaml .Values.probes.readiness | nindent 12 }}
env:
- name: TELEMETRY_ENABLED
value: {{ .Values.telemetryEnabled | quote }}
- name: VERSION
value: {{ .Chart.Version | quote }}
# TODO: integrate with cert manager and auto gen a cert for minio
Expand Down
8 changes: 2 additions & 6 deletions operator/tests/__snapshot__/operator_test.yaml.snap
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
matches the snapshot:
1: |
raw: "secureCodeBox Operator Deployed \U0001F680\n\nThe operator can orchestrate the execution of various security scanning tools inside of your cluster.\nYou can find a list of all officially supported scanners here: https://www.securecodebox.io/\nThe website also lists other integrations, like persisting scan results to DefectDojo or Elasticsearch.\n\nThe operator send out regular telemetry pings to a central service.\nThis lets us, the secureCodeBox team, get a grasp on how much the secureCodeBox is used.\nThe submitted data is chosen to be as anonymous as possible.\nYou can find a complete report of the data submitted and links to the source-code at: https://www.securecodebox.io/docs/telemetry\nThe first ping is send one hour after the install, you can prevent this by upgrading the chart and setting `telemetryEnabled` to `false`.\n"
raw: "secureCodeBox Operator Deployed \U0001F680\n\nThe operator can orchestrate the execution of various security scanning tools inside of your cluster.\nYou can find a list of all officially supported scanners here: https://www.securecodebox.io/\nThe website also lists other integrations, like persisting scan results to DefectDojo or Elasticsearch.\n"
2: |
apiVersion: v1
kind: Service
Expand Down Expand Up @@ -42,8 +42,6 @@ matches the snapshot:
command:
- /manager
env:
- name: TELEMETRY_ENABLED
value: "true"
- name: VERSION
value: 0.0.0
- name: S3_USE_SSL
Expand Down Expand Up @@ -739,7 +737,7 @@ matches the snapshot:
name: securecodebox-operator
properly-renders-the-service-monitor-when-enabled:
1: |
raw: "secureCodeBox Operator Deployed \U0001F680\n\nThe operator can orchestrate the execution of various security scanning tools inside of your cluster.\nYou can find a list of all officially supported scanners here: https://www.securecodebox.io/\nThe website also lists other integrations, like persisting scan results to DefectDojo or Elasticsearch.\n\nThe operator send out regular telemetry pings to a central service.\nThis lets us, the secureCodeBox team, get a grasp on how much the secureCodeBox is used.\nThe submitted data is chosen to be as anonymous as possible.\nYou can find a complete report of the data submitted and links to the source-code at: https://www.securecodebox.io/docs/telemetry\nThe first ping is send one hour after the install, you can prevent this by upgrading the chart and setting `telemetryEnabled` to `false`.\n"
raw: "secureCodeBox Operator Deployed \U0001F680\n\nThe operator can orchestrate the execution of various security scanning tools inside of your cluster.\nYou can find a list of all officially supported scanners here: https://www.securecodebox.io/\nThe website also lists other integrations, like persisting scan results to DefectDojo or Elasticsearch.\n"
2: |
apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
Expand Down Expand Up @@ -794,8 +792,6 @@ properly-renders-the-service-monitor-when-enabled:
command:
- /manager
env:
- name: TELEMETRY_ENABLED
value: "true"
- name: VERSION
value: 0.0.0
- name: S3_USE_SSL
Expand Down
3 changes: 0 additions & 3 deletions operator/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@
# This is a YAML-formatted file.
# Declare variables to be passed into your templates.

# telemetryEnabled -- The Operator sends anonymous telemetry data, to give the team an overview how much the secureCodeBox is used. Find out more at https://www.securecodebox.io/telemetry
telemetryEnabled: true

# -- The cluster domain to use when building the in-cluster Minio endpoint (`<release>-minio.<namespace>.svc.<clusterDomain>`). Override this if your cluster uses a custom domain instead of the Kubernetes default `cluster.local`.
clusterDomain: cluster.local

Expand Down
Loading