Skip to content

Add field to DevWorkspace to allow customizing any pod fields in deployment. #872

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Sep 19, 2022
Merged

Add field to DevWorkspace to allow customizing any pod fields in deployment. #872

merged 4 commits into from
Sep 19, 2022

Conversation

amisevsk
Copy link
Contributor

What does this PR do?:

Add support for specifying overrides to pod fields in DevWorkspaces. This PR is a draft for discussion.

The added pods field in the DevWorkspace CRD supports all fields copy-pasted from the pod spec itself, omitting containers and initContainers. In the future it may be worth automating the generation of this field from the pod spec directly.

Containers are omitted as

  1. The CRD yaml size is dramatically increased if they are included, as it brings a lot of fields and documentation
  2. It's not clear whether it should be supported, as many of those fields are already in the container component.

This changes adds 100KB to the DevWorkspace CRDs.

Which issue(s) this PR fixes:

Closes #860

PR acceptance criteria:

Testing and documentation do not need to be complete in order for this PR to be approved. We just need to ensure tracking issues are opened.

  • Open new test/doc issues under the devfile/api repo
  • Check each criteria if:
  • There is a separate tracking issue. Add the issue link under the criteria
    or
  • test/doc updates are made as part of this PR
  • If unchecked, explain why it's not needed

How to test changes / Special notes to the reviewer:

@amisevsk amisevsk requested a review from l0rd June 13, 2022 22:53
@amisevsk amisevsk mentioned this pull request Jun 13, 2022
Closed
3 tasks
@amisevsk amisevsk changed the title Pod spec override Add field to DevWorkspace to allow customizing any pod fields in deployment. Jun 14, 2022
@amisevsk amisevsk force-pushed the pod-spec-override branch 2 times, most recently from 411ae8d to 2ebe99d Compare June 16, 2022 21:51
@amisevsk amisevsk marked this pull request as ready for review July 22, 2022 21:40
@openshift-ci openshift-ci bot added the lgtm label Jul 27, 2022
l0rd
l0rd reviewed Jul 27, 2022
View reviewed changes
Copy link
Contributor

@l0rd l0rd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have approved the PR although the pods field could be renamed as discussed in #860 (comment).

@amisevsk amisevsk force-pushed the pod-spec-override branch from 2ebe99d to b7f6e40 Compare July 27, 2022 20:29
@openshift-ci openshift-ci bot removed the lgtm label Jul 27, 2022
@amisevsk
Copy link
Contributor Author

Updated field name to podSpecOverride as suggested. We can decide if it should apply to Kubernetes components down the line.

@openshift-ci openshift-ci bot added the lgtm label Jul 31, 2022
@openshift-ci
Copy link

openshift-ci bot commented Jul 31, 2022

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: amisevsk, l0rd

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@amisevsk
Add field to DevWorkspace to allow overriding Pod spec (devfile#860)
9e159db 
Add field `podSpecOverride` to the DevWorkspace spec (but not Devfile or
DevWorkspaceTemplate) that allows specifying arbitrary fields on any
pods created for the DevWorkspace.

Signed-off-by: Angel Misevski <amisevsk@redhat.com>
@amisevsk
Fix potential nil error in generator
0cbf260 
Fix potential nil error in generator if attempting to update JSON schema
for a field that has the 'endpoints' property but isn't a
ContainerComponent (e.g. a Pod spec).

Signed-off-by: Angel Misevski <amisevsk@redhat.com>
@amisevsk
Duplicate metadata fields for pods spec override
66a50c0 
Controller-gen cannot generate embedded metadata fields, resulting in
those fields deserializing to empty objects. In order to embed metadata
in a CRD, it is necessary to duplicate metadata fields where
appropriate.

See issue: kubernetes-sigs/controller-tools#385
for details

Signed-off-by: Angel Misevski <amisevsk@redhat.com>
@amisevsk
Regenerate DevWorkspace schemas and CRDs to include podSpecOverride f…
8a26991 
…ield

Signed-off-by: Angel Misevski <amisevsk@redhat.com>
@openshift-ci openshift-ci bot removed the lgtm label Sep 19, 2022
@openshift-ci
Copy link

openshift-ci bot commented Sep 19, 2022

New changes are detected. LGTM label has been removed.

@codecov-commenter
Copy link

codecov-commenter commented Sep 19, 2022 •
edited by codecov bot
Loading

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

@amisevsk amisevsk merged commit 31045fa into devfile:main Sep 19, 2022
@amisevsk amisevsk deleted the pod-spec-override branch September 19, 2022 17:50
@amisevsk amisevsk mentioned this pull request Sep 28, 2022
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@l0rd l0rd l0rd approved these changes

@yangcao77 yangcao77 Awaiting requested review from yangcao77

@johnmcollier johnmcollier Awaiting requested review from johnmcollier

Assignees

@l0rd l0rd

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Allow DevWorkspace CR to specify pod spec overrides
4 participants
@amisevsk @codecov-commenter @l0rd @openshift-merge-robot