Skip to content

Autostart CSI proxy on boot #194

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 1 commit into from
Jan 19, 2022
Merged

Autostart CSI proxy on boot #194

merged 1 commit into from
Jan 19, 2022

Conversation

pradeep-hegde
Copy link
Contributor

What type of PR is this?
/kind documentation

What this PR does / why we need it:
This PR will fix the issue of CSI proxy not starting automatically when the Windows node is restarted.

Before this PR, the Startup type of CSI proxy was set to manual by default.

PS C:\Users\Administrator> Get-Service csiproxy | select -property Status,Name,DisplayName,StartType

 Status Name     DisplayName StartType
 ------ ----     ----------- ---------
Running csiproxy csiproxy       Manual

If the windows node is rebooted, the CSI proxy was not started.

PS C:\Users\Administrator> get-service csiproxy

Status   Name               DisplayName
------   ----               -----------
Stopped  csiproxy           csiproxy

After this PR, CSI proxy startup type is set to automatic on boot.

PS C:\Users\Administrator> Get-Service csiproxy | select -property Status,Name,DisplayName,StartType

 Status Name     DisplayName StartType
 ------ ----     ----------- ---------
Running csiproxy csiproxy    Automatic

Which issue(s) this PR fixes:

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

Autostart CSI proxy on boot

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/documentation Categorizes issue or PR as related to documentation. labels Jan 16, 2022
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jan 16, 2022
@k8s-ci-robot
Copy link
Contributor

Welcome @pradeep-hegde!

It looks like this is your first PR to kubernetes-csi/csi-proxy 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-csi/csi-proxy has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

Hi @pradeep-hegde. Thanks for your PR.

I'm waiting for a kubernetes-csi member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jan 16, 2022
@ggriffiths
Copy link
Member

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jan 18, 2022
mauriciopoppe
mauriciopoppe reviewed Jan 18, 2022
View reviewed changes
scripts/sync-csi-proxy.ps1
@@ -13,7 +13,7 @@ Copy-Item -Path "C:\Users\$env:UserName\csi-proxy.exe" -Destination "C:\etc\kube

# restart the csiproxy service
$flags = "-v=5 -windows-service -log_file=C:\etc\kubernetes\logs\csi-proxy.log -logtostderr=false"
sc.exe create csiproxy binPath= "C:\etc\kubernetes\node\bin\csi-proxy.exe $flags"
sc.exe create csiproxy start= "auto" binPath= "C:\etc\kubernetes\node\bin\csi-proxy.exe $flags"
Copy link
Member

Choose a reason for hiding this comment

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

I've recently removed this file in #190, I'll keep an eye on this PR if it gets merged before that one to use this flag in the new file too

mauriciopoppe
mauriciopoppe reviewed Jan 18, 2022
View reviewed changes
README.md
@@ -51,7 +51,7 @@ On successful execution of `make build`, the output binary `csi-proxy.exe` will
csi-proxy.exe can be installed and run as binary or run as a Windows service on each Windows node. See the following as an example to run CSI Proxy as a web service.
```
$flags = "-windows-service -log_file=C:\etc\kubernetes\logs\csi-proxy.log -logtostderr=false"
Copy link
Member

Choose a reason for hiding this comment

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

If the node is created with kube-up.sh from the kubernetes/kubernetes repo I believe that https://github.com/kubernetes/kubernetes/blob/master/cluster/gce/windows/k8s-node-setup.psm1#L449-L459 will redo the setup and start CSI Proxy again if the node is restarted

After this change we'd need to do the setup only once and then on reboot it'd be started automatically, is my understanding of the setup being done only once correct?

Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like https://github.com/kubernetes/kubernetes/blob/master/cluster/gce/windows/k8s-node-setup.psm1#L449-L459 is independent of the ps1 script but it can certainly use the same strategy.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should a new PR be sent for this repo similar to this change?

Copy link
Member

Choose a reason for hiding this comment

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

not really, it was more of a general question about in which scenarios we would need to put this flag in a prod environment, the kube-up.sh script are only used to create dev clusters and e2e clusters

@pradeep-hegde
Copy link
Contributor Author

/assign @andyzhangx

andyzhangx
andyzhangx approved these changes Jan 19, 2022
View reviewed changes
Copy link
Member

@andyzhangx andyzhangx left a comment

Choose a reason for hiding this comment

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

/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 Jan 19, 2022
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: andyzhangx, pradeep-hegde

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 Jan 19, 2022
@k8s-ci-robot k8s-ci-robot merged commit a0148fe into kubernetes-csi:master Jan 19, 2022
@pradeep-hegde pradeep-hegde deleted the pradeep-hegde-csi-proxy-doc branch January 24, 2022 05:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mauriciopoppe mauriciopoppe mauriciopoppe left review comments

@ddebroy ddebroy ddebroy left review comments

@andyzhangx andyzhangx andyzhangx approved these changes

@ggriffiths ggriffiths Awaiting requested review from ggriffiths

@kkmsft kkmsft Awaiting requested review from kkmsft

Assignees

@andyzhangx andyzhangx

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@pradeep-hegde @k8s-ci-robot @ggriffiths @mauriciopoppe @andyzhangx @ddebroy