Improve access credential documentation #779
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR improves the access credential documentation in the VM pages by clarifying that the user must exist before the access credentials will take effect.
- Added a note to specify that credentials only take effect if the associated user already exists.
- Updated documentation in versioned_docs for versions v1.5 and v1.4, as well as in the main docs directory.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| versioned_docs/version-v1.5/vm/access-to-the-vm.md | Added note on user existence requirement for credential activation |
| versioned_docs/version-v1.4/vm/access-to-the-vm.md | Same note update to clarify credentials behavior |
| docs/vm/access-to-the-vm.md | Updated note for consistency regarding pre-existing user requirement |
Comments suppressed due to low confidence (1)
docs/vm/access-to-the-vm.md:72
- This update strengthens the documentation by clarifying credential applicability; verify that similar notes in other parts of the documentation maintain the same terminology.
The user to be added must already exist; otherwise, the credentials will not take effect.
|
ihcsim
reviewed
May 8, 2025
docs/vm/access-to-the-vm.md
Outdated
| @@ -69,6 +69,7 @@ You can inject your access credentials via the Harvester dashboard as below: | |||
| :::note | |||
|
|
|||
| You need to enter the VM to edit password or remove SSH-Key after deleting the credentials from the UI. | |||
| The user to be added must already exist; otherwise, the credentials will not take effect. | |||
There was a problem hiding this comment.
What do you think of combining this with bullet point 3 above?
- Click to add either basic auth credentials or ssh keys. The user to be added must already exist in the guest OS. E.g., if using OpenSUSE, add
opensuseas the user and select your ssh keys.
There was a problem hiding this comment.
Sounds great! Thanks for the comment!
ihcsim
previously approved these changes
May 9, 2025
docs/vm/access-to-the-vm.md
Outdated
| @@ -63,7 +63,7 @@ You can inject your access credentials via the Harvester dashboard as below: | |||
|
|
|||
| 1. Select the VM and click `⋮` button. | |||
| 2. Click the `Edit Config` button and go to the `Access Credentials` tab. | |||
| 3. Click to add either basic auth credentials or ssh keys, (e.g., add `opensuse` as the user and select your ssh keys if your guest OS is OpenSUSE). | |||
| 3. Click to add either basic auth credentials or ssh keys. The user to be added must already exist in the guest OS. E.g., if using OpenSUSE, add `opensuse` as the user and select your ssh keys. | |||
There was a problem hiding this comment.
Suggested change
| 3. Click to add either basic auth credentials or ssh keys. The user to be added must already exist in the guest OS. E.g., if using OpenSUSE, add `opensuse` as the user and select your ssh keys. | |
| 3. Add either basic authentication credentials or SSH keys. | |
| You can only add a user that already exists in the guest operating system. For example, if you are using openSUSE, you can add the user `opensuse` and select SSH keys. |
Signed-off-by: Cooper Tseng <cooper.tseng@suse.com>
jillian-maroket
approved these changes
May 12, 2025
ihcsim
approved these changes
May 12, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem:
The Access Credentials in VM page only takes effect when the user exist, but currently the doc doesn't mention that.
Solution:
Improve the doc
Related Issue(s):
Test plan:
Additional documentation or context