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 blog article to announce Secret references in NodeExpandVolume #33979

Merged
merged 1 commit into from
Sep 7, 2022

Conversation

humblec
Copy link
Contributor

@humblec humblec commented May 27, 2022

Ref# KEP: kubernetes/enhancements#3173
Implementation: kubernetes/kubernetes#105963

Signed-off-by: Humble Chirammal hchiramm@redhat.com

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 27, 2022
@k8s-ci-robot k8s-ci-robot added the area/blog Issues or PRs related to the Kubernetes Blog subproject label May 27, 2022
@k8s-ci-robot k8s-ci-robot requested a review from sftim May 27, 2022 04:17
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels May 27, 2022
@netlify
Copy link

netlify bot commented May 27, 2022

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 37b77be
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/63173cbba092e800084f6dae
😎 Deploy Preview https://deploy-preview-33979--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@humblec
Copy link
Contributor Author

humblec commented May 27, 2022

Cc @sftim @xing-yang @zhucan

Copy link
Member

@Sea-n Sea-n left a comment

Choose a reason for hiding this comment

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

Here is some questions and format fixes.

content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
sftim
sftim previously requested changes May 29, 2022
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

Thanks for getting this draft in early! I hope this feedback helps.

content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
@sftim
Copy link
Contributor

sftim commented May 31, 2022

/retitle Add blog article to announce Secret references in NodeExpandVolume

@k8s-ci-robot k8s-ci-robot changed the title Add csi nodeexpandsecret blog article Add blog article to announce Secret references in NodeExpandVolume May 31, 2022
@humblec humblec force-pushed the node-expand-1.25 branch 2 times, most recently from e65390f to ce3e5f2 Compare May 31, 2022 13:06
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

Thanks! Here's a bit more feedback.

content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
@bradtopol
Copy link
Contributor

Assigning @sftim since he is already engaged on this.
/assign @sftim

@Sea-n
Copy link
Member

Sea-n commented Jul 21, 2022

Hey @humblec,

It's been a while since last update, would you like to address issues in the previous comments so that we can move forward?

@humblec
Copy link
Contributor Author

humblec commented Jul 22, 2022

Hey @humblec,

It's been a while since last update, would you like to address issues in the previous comments so that we can move forward?

Indeed.. Just got busy with other PRs . I have accommodated all the comments from your and @sftim 's review.. thanks a lot!!
Ptal.. 👍

@humblec humblec requested review from sftim and Sea-n July 22, 2022 08:15
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

Thanks. I have a few suggestions for the article to tidy it up.

content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
parameters:
csi.storage.k8s.io/node-expand-secret-name: test-secret # the name of the Secret
csi.storage.k8s.io/node-expand-secret-namespace: default # the namespace that the Secret is in
provisioner: hostpath.csi.k8s.io
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this provisioner actually work with NodeExpandVolume secret references?

(if not, maybe make up a fictional provisioner, eg blockstorage.cloudprovider.example?)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yeah.. the hostpath output and logs are from real testing. should be fine. 👍

Copy link
Contributor

Choose a reason for hiding this comment

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

How does the hostPath provisioner actually use these secrets? If it ignores them, that's maybe not an ideal example.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

actually this feature is from the kubernetes csi client to push the secrets to the CSI driver as part of the NodeExpandVolume call.. The hostPath provisioner is a CSI driver who get those as shown in the example.. in that sense, it looks fine to me keep the current version as an example .. @sftim

Copy link
Contributor Author

Choose a reason for hiding this comment

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

if really needed I can replace the string hostpath to hostpath-example or something similar.. please let me know wdyt @sftim

Copy link
Contributor

Choose a reason for hiding this comment

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

Could you explain in a bit more detail (to reviewers, not readers) how a cluster admin works out what they put into test-secret? If I changed the contents of that Secret to have empty strings as the values, would it still work?

If so, then we're not really illustrating things end-to-end. Yes, the feature from the KEP is implemented, but the reader cares about the end-to-end story. They're less interested in seeing an integration test that proves that the secret reference gets to the CSI driver.

Is blockstorage.cloudprovider.example a plausible CSI driver name / reference? If it is, how about using that?

Copy link
Contributor Author

@humblec humblec Jul 25, 2022

Choose a reason for hiding this comment

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

@sftim the nodeExpandSecret follow the same convention or rules of other similar secrets ( for ex: node stage, publish, controller expand) in the SC as described here
https://kubernetes-csi.github.io/docs/secrets-and-credentials-storage-class.html. The secret values will be sent to the CSI driver and if the credentials are correct to connect or perform the requested operation it will work otherwise fail.

Is blockstorage.cloudprovider.example a plausible CSI driver name / reference? If it is, how about using that?

Sure, I have changed the provisioner name to above.. it sound fine to have above as a pluasible CSI driver name..
ptal.. thanks.

content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
content/en/blog/_posts/2022-04-19-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
@humblec
Copy link
Contributor Author

humblec commented Jul 25, 2022

Cc @xing-yang

@humblec humblec requested review from sftim and Sea-n and removed request for sftim August 31, 2022 07:36
@humblec humblec requested review from sftim and removed request for Sea-n September 2, 2022 04:38
@humblec
Copy link
Contributor Author

humblec commented Sep 5, 2022

It would be appreciated if we can get final reviews on this PR !

@sftim
Copy link
Contributor

sftim commented Sep 5, 2022

We (blog team) would like a lightweight tech review on this from SIG Storage (optionally also SIG Auth) folks, to make sure there's no obvious technical inaccuracy.
I'm sure that there isn't @humblec but it's nice to have that reassurance.

The article LGTM from a content / writing perspective.

@humblec could you find someone from SIG Storage to check that preview?

@humblec
Copy link
Contributor Author

humblec commented Sep 5, 2022

We (blog team) would like a lightweight tech review on this from SIG Storage (optionally also SIG Auth) folks, to make sure there's no obvious technical inaccuracy. I'm sure that there isn't @humblec but it's nice to have that reassurance.

The article LGTM from a content / writing perspective.

Thanks @sftim 👍

@humblec could you find someone from SIG Storage to check that preview?

Sure, let me find/get review from SIG Storage.
@xing-yang considering you have reviewed this PR, can you please review the preview/final version?

@humblec humblec requested review from xing-yang and Sea-n and removed request for sftim, xing-yang and Sea-n September 5, 2022 15:36
@xing-yang
Copy link
Contributor

I added one comment. Otherwise, it looks good to me.

@humblec
Copy link
Contributor Author

humblec commented Sep 6, 2022

I added one comment. Otherwise, it looks good to me.

addressed the same .. Thanks

Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

That last fix wasn't right, I'm afraid.

content/en/blog/_posts/2022-09-21-csi-nodeexpandsecret.md Outdated Show resolved Hide resolved
Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
@humblec
Copy link
Contributor Author

humblec commented Sep 6, 2022

That last fix wasn't right, I'm afraid.

I have reformatted as suggested.. thanks 👍

@sftim
Copy link
Contributor

sftim commented Sep 7, 2022

Thanks

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 7, 2022
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: b51ee65e1affc5d78012fc27552d7b2b78c241cb

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sftim

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

The pull request process is described 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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 7, 2022
@k8s-ci-robot k8s-ci-robot merged commit 4b43dac into kubernetes:main Sep 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/blog Issues or PRs related to the Kubernetes Blog subproject cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

7 participants