Skip to content
This repository was archived by the owner on Oct 14, 2020. It is now read-only.

Cleanup Unused / Badly named CRD Attributes#140

Merged
Weltraumschaf merged 4 commits intomasterfrom
crd-cleanup
Oct 12, 2020
Merged

Cleanup Unused / Badly named CRD Attributes#140
Weltraumschaf merged 4 commits intomasterfrom
crd-cleanup

Conversation

@J12934
Copy link
Copy Markdown
Member

@J12934 J12934 commented Oct 12, 2020

While writing docs for the CRDs I found some attributes which weren't ideal:

historyLimit on ScheduledScans:

Inconsistent with Naming on Kubernetes CronJobs. On ChronJobs its called successfulJobsHistoryLimit and failedJobsHistoryLimit. "Our historyLimit currently only applies to successfulJobs Jobs which makes this naming really confusing as the name would suggest it applies to any job.

This change allows us to introduce failedJobsHistoryLimit in the future.

handlesResultsType in the ParseDefinition

This isn't used anymore. Instead the name of the ParseDefinition is used. This PR removes this to avoid confusion.

This is online with the naming of the properties in Kubernetes CronJobs
and allows to introduce a `failedJobsHistoryLimit` with consistent
nameing.
This has been replaced for a while to just use the ParseDefinitions name.
Using the name enables a more direct lookup of the parseType.
@J12934 J12934 added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 12, 2020
@Weltraumschaf Weltraumschaf self-assigned this Oct 12, 2020
@Weltraumschaf Weltraumschaf merged commit 57babac into master Oct 12, 2020
@Weltraumschaf Weltraumschaf deleted the crd-cleanup branch October 12, 2020 15:07
J12934 added a commit to secureCodeBox/documentation that referenced this pull request Oct 13, 2020
@Weltraumschaf Weltraumschaf removed their assignment Oct 21, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants