Skip to content

Commit

Permalink
Prepare for v1.2.0 release
Browse files Browse the repository at this point in the history
Signed-off-by: Kornilios Kourtis <[email protected]>
  • Loading branch information
kkourt committed Sep 5, 2024
1 parent a38badb commit dc45886
Show file tree
Hide file tree
Showing 7 changed files with 83 additions and 58 deletions.
55 changes: 8 additions & 47 deletions contrib/upgrade-notes/latest.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,61 +5,22 @@ Depending on your setup, changes listed here might require a manual intervention

* TBD

#### Agent Options
### Agent Options

* TBD

#### Helm Values
### Helm Values

* Tetragon container now uses the gRPC liveness probe by default. To continue using "tetra status" for liveness probe,
specify `tetragon.livenessProbe` Helm value. For example:
```yaml
tetragon:
livenessProbe:
timeoutSeconds: 60
exec:
command:
- tetra
- status
- --server-address
- "54321"
- --retries
- "5"
```
* Deprecated `tetragon.skipCRDCreation` Helm value is removed. Use `crds.installMethod=none` instead.

* `tetragon.ociHookSetup` Helm value is deprecated. Use `tetragon.rthooks` instead.
* TBD

#### TracingPolicy (k8s CRD)
### TracingPolicy (k8s CRD)

* TBD

#### Events (protobuf API)
### Events (protobuf API)

* Sensor managing methods have been deprecated:
* `ListSensors`
* `EnableSensor`
* `DisableSensor`
* `RemoveSensor`
* TBD

#### Metrics
### Metrics

* `tetragon_policyfilter_metrics_total` metric is renamed to `tetragon_policyfilter_operations_total`, and its `op`
label is renamed to `operation`.
* `tetragon_missed_events_total` metric is renamed to `tetragon_bpf_missed_events_total`.
* Metrics related to ring buffer and events queue are renamed:
* `tetragon_ringbuf_perf_event_errors_total` -> `tetragon_observer_ringbuf_errors_total`
* `tetragon_ringbuf_perf_event_received_total` -> `tetragon_observer_ringbuf_events_received_total`
* `tetragon_ringbuf_perf_event_lost_total` -> `tetragon_observer_ringbuf_events_lost_total`
* `tetragon_ringbuf_queue_received_total` -> `tetragon_observer_ringbuf_queue_events_received_total`
* `tetragon_ringbuf_queue_lost_total` -> `tetragon_observer_ringbuf_queue_events_lost_total`
* `tetragon_errors_total{type="process_cache_evicted"}` metric is replaced by `tetragon_process_cache_evicted_total`.
* `tetragon_errors_total{type=~"process_cache_miss_on_get|process_cache_miss_on_remove"}` metrics are replaced by
`tetragon_process_cache_misses_total{operation=~"get|remove"}`.
* `tetragon_event_cache_<entry_type>_errors_total` metrics are replaced by
`tetragon_event_cache_fetch_failures_total{entry_type="<entry_type>"}`.
* `tetragon_event_cache_accesses_total` metric is renamed to `tetragon_event_cache_inserts_total`.
* `tetragon_event_cache_retries_total` metric is renamed to `tetragon_event_cache_fetch_retries_total`.
* `tetragon_errors_total{type="event_missing_process_info"}` metric is replaced by
`tetragon_events_missing_process_info_total`.
* `tetragon_errors_total{type="handler_error"}` metric is removed. Use `tetragon_handler_errors_total` instead.
* TBD
65 changes: 65 additions & 0 deletions contrib/upgrade-notes/v1.2.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
## Upgrade notes

Read the upgrade notes carefully before upgrading Tetragon.
Depending on your setup, changes listed here might require a manual intervention.

* TBD

#### Agent Options

* TBD

#### Helm Values

* Tetragon container now uses the gRPC liveness probe by default. To continue using "tetra status" for liveness probe,
specify `tetragon.livenessProbe` Helm value. For example:
```yaml
tetragon:
livenessProbe:
timeoutSeconds: 60
exec:
command:
- tetra
- status
- --server-address
- "54321"
- --retries
- "5"
```
* Deprecated `tetragon.skipCRDCreation` Helm value is removed. Use `crds.installMethod=none` instead.

* `tetragon.ociHookSetup` Helm value is deprecated. Use `tetragon.rthooks` instead.

#### TracingPolicy (k8s CRD)

* TBD

#### Events (protobuf API)

* Sensor managing methods have been deprecated:
* `ListSensors`
* `EnableSensor`
* `DisableSensor`
* `RemoveSensor`

#### Metrics

* `tetragon_policyfilter_metrics_total` metric is renamed to `tetragon_policyfilter_operations_total`, and its `op`
label is renamed to `operation`.
* `tetragon_missed_events_total` metric is renamed to `tetragon_bpf_missed_events_total`.
* Metrics related to ring buffer and events queue are renamed:
* `tetragon_ringbuf_perf_event_errors_total` -> `tetragon_observer_ringbuf_errors_total`
* `tetragon_ringbuf_perf_event_received_total` -> `tetragon_observer_ringbuf_events_received_total`
* `tetragon_ringbuf_perf_event_lost_total` -> `tetragon_observer_ringbuf_events_lost_total`
* `tetragon_ringbuf_queue_received_total` -> `tetragon_observer_ringbuf_queue_events_received_total`
* `tetragon_ringbuf_queue_lost_total` -> `tetragon_observer_ringbuf_queue_events_lost_total`
* `tetragon_errors_total{type="process_cache_evicted"}` metric is replaced by `tetragon_process_cache_evicted_total`.
* `tetragon_errors_total{type=~"process_cache_miss_on_get|process_cache_miss_on_remove"}` metrics are replaced by
`tetragon_process_cache_misses_total{operation=~"get|remove"}`.
* `tetragon_event_cache_<entry_type>_errors_total` metrics are replaced by
`tetragon_event_cache_fetch_failures_total{entry_type="<entry_type>"}`.
* `tetragon_event_cache_accesses_total` metric is renamed to `tetragon_event_cache_inserts_total`.
* `tetragon_event_cache_retries_total` metric is renamed to `tetragon_event_cache_fetch_retries_total`.
* `tetragon_errors_total{type="event_missing_process_info"}` metric is replaced by
`tetragon_events_missing_process_info_total`.
* `tetragon_errors_total{type="handler_error"}` metric is removed. Use `tetragon_handler_errors_total` instead.
2 changes: 1 addition & 1 deletion docs/config/_default/hugo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ demo_app_url = "https://raw.githubusercontent.com/cilium/cilium/v1.15.3/examples
# Used in the "version-banner" partial to display a version number for the
# current doc set.
# renovate: datasource=docker depName=quay.io/cilium/tetragon
version = "v1.1.2"
version = "v1.2.0"

[params.search.algolia]
appId = "UI18HE156K"
Expand Down
4 changes: 2 additions & 2 deletions docs/content/en/docs/reference/helm-chart.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions install/kubernetes/tetragon/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ apiVersion: v2
name: tetragon
description: Helm chart for Tetragon
type: application
version: 1.1.0
version: 1.2.0
# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
# follow Semantic Versioning. They should reflect the version the application is using.
appVersion: 1.1.0
appVersion: 1.2.0
6 changes: 3 additions & 3 deletions install/kubernetes/tetragon/README.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 2 additions & 3 deletions install/kubernetes/tetragon/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ tetragon:
image:
override: ~
repository: quay.io/cilium/tetragon
tag: v1.1.2
tag: v1.2.0
resources: {}
extraArgs: {}
extraEnv: []
Expand Down Expand Up @@ -268,7 +268,7 @@ tetragonOperator:
image:
override: ~
repository: quay.io/cilium/tetragon-operator
tag: v1.1.2
tag: v1.2.0
pullPolicy: IfNotPresent
# -- Extra volumes for the Tetragon Operator Deployment.
extraVolumes: []
Expand Down Expand Up @@ -340,7 +340,6 @@ crds:
# default doesn't perform CRD downgrades. These can be configured in tetragonOperator section.
# The "helm" method always installs all CRDs for the chart version.
installMethod: "operator"

# -- Method for installing Tetagon rthooks (tetragon-rthooks) daemonset
# The tetragon-rthooks daemonset is responsible for installing run-time hooks on the host.
# See: https://tetragon.io/docs/concepts/runtime-hooks
Expand Down

0 comments on commit dc45886

Please sign in to comment.