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

documenting the user ssh key agent #6444

Merged

Conversation

moadqassem
Copy link
Member

What this PR does / why we need it:
Documenting the user ssh key agent for having a better understanding about the functionality if the user ssh key

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #6430

Disable/Enable User ssh key agent 

@kubermatic-bot kubermatic-bot added release-note Denotes a PR that will be considered when it comes time to generate release notes. dco-signoff: yes Denotes that all commits in the pull request have the valid DCO signoff message. labels Jan 22, 2021
@kubermatic-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: moadqassem

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

@kubermatic-bot kubermatic-bot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jan 22, 2021
@moadqassem moadqassem force-pushed the documenting-user-ssh-key-agent branch from f525c1a to 16d2c5c Compare January 22, 2021 15:32
Comment on lines 12 to 13
The agent is deployed to the user clusters by default and it is not possible to change whether to deploy it or not once the cluster
has been created. If users decide to disable the agent, they should take care of adding ssh keys to the worker nodes by themselves.
Copy link
Contributor

Choose a reason for hiding this comment

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

The most interesting question that will come up in half a year is "WHY can this not be changed after the creation?" -- can you describe the reasons or point the reader to where they can find out more?

has been created. If users decide to disable the agent, they should take care of adding ssh keys to the worker nodes by themselves.

**Note:**
During the user cluster creation steps(at the second step), the users have the possibility to add a user ssh key and it is not effected
Copy link
Contributor

Choose a reason for hiding this comment

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

affected

Copy link
Contributor

@xrstf xrstf left a comment

Choose a reason for hiding this comment

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

Minor stuff

Signed-off-by: Moath Qasim <moad.qassem@gmail.com>
@moadqassem moadqassem force-pushed the documenting-user-ssh-key-agent branch from 16d2c5c to 3b2c496 Compare January 25, 2021 12:29
@xrstf
Copy link
Contributor

xrstf commented Jan 26, 2021

/lgtm

@kubermatic-bot kubermatic-bot added the lgtm Indicates that a PR is ready to be merged. label Jan 26, 2021
@kubermatic-bot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 0a8f96d25fa7fc9c59951c59a07521c9dbe36a1d

@kubermatic-bot kubermatic-bot merged commit eb28cc5 into kubermatic:master Jan 26, 2021
@moadqassem moadqassem deleted the documenting-user-ssh-key-agent branch March 22, 2022 15:59
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. dco-signoff: yes Denotes that all commits in the pull request have the valid DCO signoff message. lgtm Indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document KKP UserSSHKey agent
3 participants