[feat] Enable support for encrypted volumes for CSI driver #299

prajwalvathreya · 2024-10-30T15:29:09Z

General:

This PR focuses on enabling support for encrypted volumes for the CSI driver.

It addresses the following tasks:

creating an encrypted volume (region specific)
attaching the volume to a node (region specific)
handling errors in case of mismatch in attaching a volume to a node

Have you removed all sensitive information, including but not limited to access keys and passwords?
Have you checked to ensure there aren't other open or closed Pull Requests for the same bug/feature/question?

Pull Request Guidelines:

Does your submission pass tests?
Have you added tests?
Are you addressing a single feature in this PR?
Are your commits atomic, addressing one change per commit?
Are you following the conventions of the language?
Have you saved your large formatting changes for a different PR, so we can focus on your work?
Have you explained your rationale for why this feature is needed?
Have you linked your PR to an open issue

…ncryption` status

…hile creating the controller server

… create volume request is made

- to check if region allows encryption - prepare the volume creation request with updated params - added helper function `isEncryptionSupported` to dynamically check for regions - updated attach volume operation logic to check if the created volume and the linode it's being attached to is in the same region(only for encrypted volumes this is enforced)

… interface

- removed new storage class and edited pre-existing ones

helm-chart/csi-driver/templates/csi-linode-controller.yaml

helm-chart/csi-driver/values.yaml

…ncryption

- updated functions to use the parameter specified in the template - updated tests to account for the new changes in the function calls

- updated template files to conditionally store parameters in the map

codecov · 2024-11-04T18:18:27Z

Codecov Report

Attention: Patch coverage is 84.28571% with 11 lines in your changes missing coverage. Please review.

Project coverage is 74.79%. Comparing base (c523c92) to head (02a5bd1).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
internal/driver/controllerserver_helper.go	83.58%	8 Missing and 3 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #299      +/-   ##
==========================================
+ Coverage   73.68%   74.79%   +1.10%     
==========================================
  Files          22       22              
  Lines        2356     2396      +40     
==========================================
+ Hits         1736     1792      +56     
+ Misses        522      499      -23     
- Partials       98      105       +7

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Co-authored-by: Evan <[email protected]>

internal/driver/controllerserver_helper.go

helm-chart/csi-driver/templates/linode-block-storage-retain.yaml

helm-chart/csi-driver/templates/linode-block-storage.yaml

helm-chart/csi-driver/values.yaml

internal/driver/controllerserver.go

internal/driver/controllerserver_helper.go

…eys in the map inside the function - set volumeContext to include encryption

- Moved checks for volume encryption into `prepareVolumeParams` - removed redudant volume and linode region checks - updated test cases for the changes that were made

docs/encrypted-drives.md

helm-chart/csi-driver/templates/linode-block-storage-retain.yaml

helm-chart/csi-driver/templates/linode-block-storage.yaml

docs/encrypted-drives.md

internal/driver/controllerserver_helper.go

- added back volume name and size to returns - fixed comments

- added steps to check if encryption is supported in that region

…cases

internal/driver/controllerserver_helper.go

internal/driver/examples/kubernetes/csi-linode-blockstorage-encrypted.yaml

internal/driver/controllerserver_helper_test.go

internal/driver/controllerserver_helper.go

komer3

Great work on this! Looks good to me

prajwalvathreya added 10 commits October 29, 2024 11:54

- updated templates to support volume encryption

eceefc8

- updated main.go to pickup environment variable for setting `volumeE…

071a28b

…ncryption` status

- updated driver.go to pass environment variable volumeEncryption w…

f5bbd7f

…hile creating the controller server

- updated controllerserver.go to use variable volumeEncryption when…

739f91a

… create volume request is made

- updated linode_client.go to have ListRegion function as part of the…

1ac170a

… interface

- fixed lint errors

a6f2c6d

- mock files generated after running make generate-mock

57d7288

- added comments to driver_test.go

15110b6

- updated helm charts to allow encryption

c6e8212

- removed new storage class and edited pre-existing ones

prajwalvathreya changed the title ~~volume-encryption~~ [feat] Enable support for encrypted volumes for CSI driver Oct 31, 2024

Merge branch 'main' into volume-encryption

09ca3af

eljohnson92 reviewed Oct 31, 2024

View reviewed changes

helm-chart/csi-driver/templates/csi-linode-controller.yaml Outdated Show resolved Hide resolved

eljohnson92 reviewed Oct 31, 2024

View reviewed changes

helm-chart/csi-driver/values.yaml Outdated Show resolved Hide resolved

prajwalvathreya added 6 commits November 1, 2024 14:09

- fixed CI errors in controllerserver_helper_test.go

a6c8358

Merge remote-tracking branch 'origin/volume-encryption' into volume-e…

11a596c

…ncryption

- removed environment variable VOLUME_ENCRYPTION

0ab93ad

- updated functions to use the parameter specified in the template - updated tests to account for the new changes in the function calls

- updated URL target in controllerserver_helper.go

2b4973a

- updated template files to conditionally store parameters in the map

- added log to check encryption status

9b74ea8

- added log to check encryption status

58dc736

prajwalvathreya and others added 4 commits November 4, 2024 13:21

- added log to check encryption status

7e01533

- added log to check encryption status

da1e8f1

- removed logging statements used for testing

5fd1358

Updated comment in values.yaml on the volumeEncryption variable

20ebc2a

Co-authored-by: Evan <[email protected]>

eljohnson92 reviewed Nov 5, 2024

View reviewed changes

internal/driver/controllerserver_helper.go Outdated Show resolved Hide resolved

prajwalvathreya added 2 commits November 5, 2024 13:06

- added unit tests for testing encryption related functions

3bcf4ae

- refactored ListRegions to GetRegion

ecfd939

prajwalvathreya marked this pull request as ready for review November 5, 2024 19:31

prajwalvathreya requested a review from a team as a code owner November 5, 2024 19:31

komer3 reviewed Nov 5, 2024

View reviewed changes

prajwalvathreya added 7 commits November 6, 2024 10:51

- changed templated to not create parameters map by default

3152804

- refactored function to just take req.GetParameters() and handle k…

ccf359a

…eys in the map inside the function - set volumeContext to include encryption

- fixed lint error in values.yaml

d6b935b

- updated createAndWaitForVolume call to take in map

3592d21

- Moved checks for volume encryption into `prepareVolumeParams` - removed redudant volume and linode region checks - updated test cases for the changes that were made

- added additional test cases for prepareparams and createvolumecontext

0569170

- reverted helm template files for default storage options

681e2d0

- updated documentation on how to use encryption

01023b5

komer3 reviewed Nov 8, 2024

View reviewed changes

prajwalvathreya added 9 commits November 8, 2024 12:09

- added new lines at the end of template files

f11c229

- removed encryption variable comments

2b3e4df

- returned err

2935055

- added back volume name and size to returns - fixed comments

- removed annotations

5f1c306

- added steps to check if encryption is supported in that region

- updated documentation with table of contents

345e7f1

- removed volumeEncryption from createVolumeContext

2beb183

- removed volumeEncryption from createVolumeContext and updated test …

c24ce38

…cases

- added example for encrypted blockstorage volume

e0c16b1

- updated pod name in example

c38e0e8

komer3 reviewed Nov 12, 2024

View reviewed changes

internal/driver/controllerserver_helper.go Outdated Show resolved Hide resolved

internal/driver/examples/kubernetes/csi-linode-blockstorage-encrypted.yaml Outdated Show resolved Hide resolved

prajwalvathreya and others added 3 commits November 12, 2024 14:39

- added new line to example yaml

b1caf89

- optimized prepareparams for volume request to handle region

10e2e3d

Merge branch 'main' into volume-encryption

8f67953

komer3 reviewed Nov 13, 2024

View reviewed changes

internal/driver/controllerserver_helper.go Outdated Show resolved Hide resolved

komer3 reviewed Nov 13, 2024

View reviewed changes

internal/driver/controllerserver_helper.go Outdated Show resolved Hide resolved

prajwalvathreya added 3 commits November 13, 2024 11:06

- updated logs and fixed lint errors

58819f1

- added return to fix linting issue in safe_mounter_test.go

6e530f5

- fixing lint errors in controllerserver_test.go

02a5bd1

komer3 approved these changes Nov 13, 2024

View reviewed changes

prajwalvathreya merged commit c31c62d into main Nov 13, 2024
10 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[feat] Enable support for encrypted volumes for CSI driver #299

[feat] Enable support for encrypted volumes for CSI driver #299

prajwalvathreya commented Oct 30, 2024 •

edited

Loading

codecov bot commented Nov 4, 2024 •

edited

Loading

komer3 left a comment

[feat] Enable support for encrypted volumes for CSI driver #299

[feat] Enable support for encrypted volumes for CSI driver #299

Conversation

prajwalvathreya commented Oct 30, 2024 • edited Loading

General:

Pull Request Guidelines:

codecov bot commented Nov 4, 2024 • edited Loading

Codecov Report

komer3 left a comment

Choose a reason for hiding this comment

prajwalvathreya commented Oct 30, 2024 •

edited

Loading

codecov bot commented Nov 4, 2024 •

edited

Loading