Skip to content
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

Add support for Persistent Volumes #1284

Merged

Conversation

kaisoz
Copy link
Contributor

@kaisoz kaisoz commented May 8, 2023

Description

This PR adds support for PersistentVolumes as stated in #1283

TODOs

Read the Gruntwork contribution guidelines.

  • Update the docs.
  • Run the relevant tests successfully, including pre-commit checks.
  • Ensure any 3rd party code adheres with our license policy or delete this line if its not applicable.
  • Include release notes. If this PR is backward incompatible, include a migration guide.

Release Notes (draft)

  • Added PersistentVolume functions.
  • Added PersistentVolumeNotInStatus struct.

Migration Guide

There aren`t backward incompatible changes


// IsPersistentVolume returns true if the given PersistentVolume is available
func IsPersistentVolumeAvailable(pv *corev1.PersistentVolume) bool {
return pv != nil && pv.Status.Phase == corev1.VolumeAvailable
Copy link
Member

Choose a reason for hiding this comment

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

I was wondering if should be checked for corev1.VolumeBound / corev1.VolumeReleased?
Can be use-cases when is required to check already bound PV

Copy link
Contributor Author

Choose a reason for hiding this comment

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

My initial intention was to have a generic WaitForPersistentVolumeInPhase which would receive the Phase to wait for. Then I would have smaller wrapper functions for each state.

However, at the end, and due to our requirements, I just implemented the 'Available' one, with the idea of implementing the others when I needed them.

I could implement the whole thing now though

Copy link
Contributor Author

Choose a reason for hiding this comment

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

FWIW, the next PR, which will be for PersistentVolumeClaims, has a function which waits for the bound state

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the review @denis256 , I'll address the comments. What about this one? Is it enough with what I have or you prefer me to implement other checks?

Copy link
Member

Choose a reason for hiding this comment

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

I think will be helpful to have a function that can get status as argument

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

I replaced the wait and test functions to check the 'available' status for generic ones which receive the status phase. I've named the status argument pvStatusPhase to make clear the relationship between the status and the type of argument the functions receive (corev1.PersistentVolumePhase, which is what's compared).

I think there's no need to add smaller wrapper functions for each phase since the generic functions are clear enough. Adding the functions would make the module unnecessarily long since there're 5 possible status phases (which means 10 extra functions).

Waiting for you comments 😊

@kaisoz
Copy link
Contributor Author

kaisoz commented May 8, 2023

Hi!

I think that the failed tests are not related to my changes, are they? Is there anything else I need to fix that I missed?

@denis256
Copy link
Member

denis256 commented May 9, 2023

Failing tests aren't related to implemented changes

@kaisoz kaisoz force-pushed the add-k8s-persistent-volume-support branch from 2b1b965 to 98ab07c Compare May 10, 2023 07:07
@denis256 denis256 merged commit bf85889 into gruntwork-io:master May 10, 2023
2 of 3 checks passed
@kaisoz kaisoz deleted the add-k8s-persistent-volume-support branch May 10, 2023 19:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants