Migrate allowed annotations to Kubernetes recommended syntax

[saschagrunert]

CRI-O is not following Kubernetes conventions for annotations. See https://kubernetes.io/docs/reference/labels-annotations-taints/ for what actual Kubernetes annotations look like. This means we could either migrate to the new style or solve the issue for future annotations by enforcing conventions (using docs?).

Refers to: #7779, kubernetes/website#45121 (comment)

Migrating the annotations will require a conversion as well as deprecation phase. We did the same some time ago for our metrics, which are still in deprecation:

cri-o/server/metrics/metrics.go

Lines 70 to 83 in 7d47844

	metricOperations *prometheus.CounterVec // Deprecated: in favour of metricOperationsTotal
	metricOperationsLatency *prometheus.GaugeVec // Deprecated: in favour of metricOperationsLatencySeconds
	metricOperationsLatencyTotal *prometheus.SummaryVec // Deprecated: in favour of metricOperationsLatencySecondsTotal
	metricOperationsErrors *prometheus.CounterVec // Deprecated: in favour of metricOperationsErrorsTotal
	metricImagePullsByDigest *prometheus.CounterVec // Deprecated: in favour of metricImagePullsBytesTotal
	metricImagePullsByName *prometheus.CounterVec // Deprecated: in favour of metricImagePullsBytesTotal
	metricImagePullsByNameSkipped *prometheus.CounterVec // Deprecated: in favour of metricImagePullsSkippedBytesTotal
	metricImagePullsFailures *prometheus.CounterVec // Deprecated: in favour of metricImagePullsFailureTotal
	metricImagePullsSuccesses *prometheus.CounterVec // Deprecated: in favour of metricImagePullsSuccessTotal
	metricImagePullsLayerSize prometheus.Histogram
	metricImageLayerReuse *prometheus.CounterVec // Deprecated: in favour of metricImageLayerReuseTotal
	metricContainersEventsDropped prometheus.Counter
	metricContainersOOMTotal prometheus.Counter
	metricContainersOOM *prometheus.CounterVec // Deprecated: in favour of metricContainersOOMCountTotal

[amitamrutiya]

Hey @saschagrunert, Can I work on this issue if it's not urgent? As a beginner with cri-o, I may need some days to fix this issue.

[saschagrunert]

@amitamrutiya2210, yes, but let's wait for consensus with other @cri-o/cri-o-maintainers first before starting to work on this topic.

[haircommander]

yeah for this one I'd be fine just adding ones that are within style guidelines, marking the others as deprecated. I don't think we need a config field like we did for the metrics.

[kwilczynski]

/help
/good-first-issue

[openshift-ci]

@kwilczynski:
This request has been marked as suitable for new contributors.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-good-first-issue command.

In response to this:

/help
/good-first-issue

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[amitamrutiya]

Hello everyone, I'd like to take a shot at resolving this issue.
/assign

[kwilczynski]

Related:

• Rename seccomp profile annotation to seccomp-profile.kubernetes.cri-o.io #7779

There is a review comment there that might be useful.

[amitamrutiya]

To deprecate the current annotation, we need to declare new variables with updated annotations. I'm seeking suggestions on the variable naming convention for both deprecated and new annotations.

Here's an approach I've considered for naming the variables:

// UsernsMode is the user namespace mode to use
// Deprecated: in favor of UsernsModeAnnotationV2 
UsernsModeAnnotation = "io.kubernetes.cri-o.userns-mode"

// New: UsernsMode is the user namespace mode to use
UsernsModeAnnotationV2 = "userns-mode.kubernetes.crio-o.io"

This approach is what I've thought of to address this issue. I welcome any suggestions or insights you may have regarding this approach. Your input would be greatly appreciated.

Note: Utilizing this approach would require adding a significant amount of code to ensure functionality is available for both the new and deprecated versions.

[kwilczynski]

/assign saschagrunert
/assign haircommander
/assign kwilczynski