-
Notifications
You must be signed in to change notification settings - Fork 3.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: deprecations metric #13735
feat: deprecations metric #13735
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -102,6 +102,7 @@ PVCs | |
Peixuan | ||
Ploomber | ||
Postgres | ||
PriorityClass | ||
RCs | ||
Roadmap | ||
RoleBinding | ||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,75 @@ | ||||||
# Deprecations | ||||||
|
||||||
Sometimes a feature of Argo Workflows is deprecated. | ||||||
You should stop using a deprecated feature as it may be removed in a future minor or major release of Argo Workflows. | ||||||
|
||||||
To determine if you are using a deprecated feature the [`deprecated_feature`](metrics.md#deprecated_feature) metric can help. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It would definitely be good to have a version annotation for this metric too, as people will see this page, try to use it, and not realize that it's not available in older versions, and perhaps even think they're in the clear because of that. |
||||||
This metric will go up for each use of a deprecated feature by the workflow controller. | ||||||
This means it may go up once or many times for a single event. | ||||||
If the number is going up the feature is still in use by your system. | ||||||
If the metric is not present or no longer increasing are no longer using the monitored deprecated features. | ||||||
|
||||||
## `cronworkflow schedule` | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I would name these for their respective features so that they are easily correlated, and then perhaps have a "> This page isn't specific to the metric though, it's just named "Deprecations" in general as well, so it can reference it but should be its own independent page as well There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It would also be good to link to the feature page for each of these which will have more details and examples |
||||||
|
||||||
The spec field `schedule` which takes a single value is replaced by `schedules` which takes a list. | ||||||
To update this replace the `schedule` with `schedules` as in the following example | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Colons are also missing in prior to all the examples, which are conventionally (and gramatically) used when describing an example in the docs |
||||||
|
||||||
```yaml | ||||||
spec: | ||||||
schedule: "30 1 * * *" | ||||||
``` | ||||||
is replaced with | ||||||
```yaml | ||||||
spec: | ||||||
schedules: | ||||||
- "30 1 * * *" | ||||||
Comment on lines
+19
to
+27
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These examples would likely be easier to understand quickly with a ```diff, i.e.: - schedule: "30 1 * * *"
+ schedules:
+ - "30 1 * * *" |
||||||
``` | ||||||
## `synchronization mutex` | ||||||
|
||||||
The synchronization field `mutex` which takes a single value is replaced by `mutexes` which takes a list. | ||||||
To update this replace `mutex` with `mutexes` as in the following example | ||||||
|
||||||
```yaml | ||||||
synchronization: | ||||||
mutex: | ||||||
name: foobar | ||||||
``` | ||||||
|
||||||
is replaced with | ||||||
|
||||||
```yaml | ||||||
synchronization: | ||||||
mutexes: | ||||||
- name: foobar | ||||||
``` | ||||||
|
||||||
## `synchronization semaphore` | ||||||
|
||||||
The synchronization field `semaphore` which takes a single value is replaced by `semaphores` which takes a list. | ||||||
To update this replace `semaphore` with `semaphores` as in the following example | ||||||
|
||||||
```yaml | ||||||
synchronization: | ||||||
semaphore: | ||||||
configMapKeyRef: | ||||||
name: my-config | ||||||
key: workflow | ||||||
``` | ||||||
|
||||||
is replaced with | ||||||
|
||||||
```yaml | ||||||
synchronization: | ||||||
semaphores: | ||||||
- configMapKeyRef: | ||||||
name: my-config | ||||||
key: workflow | ||||||
``` | ||||||
|
||||||
## `workflow podpriority` | ||||||
|
||||||
The Workflow spec field `podPriority` which takes a numeric value is deprecated and `podPriorityClassName` should be used instead. | ||||||
To update this you will need a [PriorityClass](https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/#priorityclass) in your cluster and refer to that using `podPriorityClassName`. |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -248,6 +248,7 @@ nav: | |
- offloading-large-workflows.md | ||
- workflow-archive.md | ||
- metrics.md | ||
- deprecations.md | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'd put this next to Same as the "New features" page we discussed in the Contributor Meeting, having it per version and matching up with the upgrading guide will make it easier to follow. EDIT: See also #13739 (comment) Although arguably deprecations should be part of the upgrading guide. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
I see this has been done in #13757 now |
||
- workflow-executors.md | ||
- workflow-restrictions.md | ||
- sidecar-injection.md | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similarly to above, I would put all the H2 headings here a under a 3.6 version heading so that the upgrading guide could reference it per version. With no versions on this page, it's hard to understand when something was deprecated, and some of these also reference features that are only available in newer versions
As we have already had users attempt to use 3.5 and 3.6 features in older versions when there were no version annotations (#13645 as one example), I could definitely see users reading this, seeing the deprecation, trying the new syntax, and then getting a syntax error and raising an issue.