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.

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

mark sshPublicKey as optional, docs windows ssh #3241

Merged
merged 1 commit into from
Mar 18, 2023
Merged

mark sshPublicKey as optional, docs windows ssh #3241

merged 1 commit into from
Mar 18, 2023

Conversation

mweibel
Copy link
Contributor

@mweibel mweibel commented Mar 8, 2023

What type of PR is this?
/kind cleanup

What this PR does / why we need it:
windows instances do not have the capability to set a sshPublicKey. It must be done via cloudbase-init.
This change documents this fact and marks the sshPublicKey as optional since it's not required and an empty string (default for string type) is sufficient.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
#3232 is relevant but only partially fixes the issue.

Special notes for your reviewer:
If I remember correctly, marking a required field optional is a backwards compatible change but please do let me know if you'd like to have this handled differently.

TODOs:

  • squashed commits
  • includes documentation
  • adds unit tests

Release note:

mark sshPublicKey optional because windows instances do not support it

@k8s-ci-robot k8s-ci-robot added kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. release-note Denotes a PR that will be considered when it comes time to generate release notes. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Mar 8, 2023
@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Mar 8, 2023
@k8s-ci-robot
Copy link
Contributor

Hi @mweibel. Thanks for your PR.

I'm waiting for a kubernetes-sigs 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 the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Mar 8, 2023
mboersma
mboersma reviewed Mar 8, 2023
View reviewed changes
api/v1beta1/azuremachine_types.go Outdated Show resolved Hide resolved
docs/book/src/topics/windows.md Outdated Show resolved Hide resolved
docs/book/src/topics/windows.md Outdated Show resolved Hide resolved
docs/book/src/topics/windows.md Outdated Show resolved Hide resolved
@mweibel mweibel force-pushed the ssh-public-key-windows branch from 4238b55 to 55b0c4d Compare March 8, 2023 14:18
@mweibel
Copy link
Contributor Author

mweibel commented Mar 8, 2023

thanks @mboersma for the spelling fixes 😊 all fixed as suggested!

@mboersma
Copy link
Contributor

mboersma commented Mar 8, 2023

/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 Mar 8, 2023
@mboersma
Copy link
Contributor

mboersma commented Mar 8, 2023

/assign @jsturtevant

@mweibel mweibel force-pushed the ssh-public-key-windows branch from 55b0c4d to ee39e5a Compare March 11, 2023 10:18
@mweibel
Copy link
Contributor Author

mweibel commented Mar 11, 2023

/retest

still a bit flaky seemingly

@mweibel
Copy link
Contributor Author

mweibel commented Mar 14, 2023

ok tests passed here too now 🎉

jsturtevant
jsturtevant reviewed Mar 14, 2023
View reviewed changes
docs/book/src/topics/windows.md Outdated Show resolved Hide resolved
docs/book/src/topics/windows.md Outdated Show resolved Hide resolved
docs/book/src/topics/windows.md Outdated Show resolved Hide resolved
@mweibel
mark sshPublicKey as optional, docs windows ssh
ed7443c 
windows instances do not have the capability to set a sshPublicKey. It
must be done via cloudbase-init.
This change documents this fact and marks the `sshPublicKey` as optional
since it's not required and an empty string (default for string type) is
sufficient.
@mweibel mweibel force-pushed the ssh-public-key-windows branch from ee39e5a to ed7443c Compare March 16, 2023 09:00
@mweibel
Copy link
Contributor Author

mweibel commented Mar 16, 2023

@jsturtevant PTAL - I rephrased a few things. Let me know if that's better :)

@mweibel
Copy link
Contributor Author

mweibel commented Mar 16, 2023

/retest

ran into #3227

@jsturtevant
Copy link
Contributor

Thanks!
/lgtm

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

LGTM label has been added.

Git tree hash: 4a3dbc478e85391608310f573e9e94eb5fd50250

mboersma
mboersma approved these changes Mar 17, 2023
View reviewed changes
Copy link
Contributor

@mboersma mboersma 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
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mboersma

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 Mar 17, 2023
@CecileRobertMichon
Copy link
Contributor

/retest

1 similar comment
@mweibel
Copy link
Contributor Author

mweibel commented Mar 18, 2023

/retest

@k8s-ci-robot k8s-ci-robot merged commit 016209a into kubernetes-sigs:main Mar 18, 2023
@mweibel mweibel deleted the ssh-public-key-windows branch March 21, 2023 07:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jsturtevant jsturtevant jsturtevant left review comments

@mboersma mboersma mboersma approved these changes

@devigned devigned Awaiting requested review from devigned

@jackfrancis jackfrancis Awaiting requested review from jackfrancis

Assignees

@mboersma mboersma

@jsturtevant jsturtevant

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/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. 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/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@mweibel @k8s-ci-robot @mboersma @jsturtevant @CecileRobertMichon