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

General guidelines, SSH setup options, tips, and examples for setting up the OpenStack environment. #544

Merged
merged 56 commits into from
Mar 10, 2023
Merged

General guidelines, SSH setup options, tips, and examples for setting up the OpenStack environment. #544

merged 56 commits into from
Mar 10, 2023

Conversation

giannidallatorre
Copy link
Contributor

Summary

New users are often not familiar with the networking & configuration requirements to set up an ssh connection with a VM hosted in OpenStack.
Added a specific page in the Tutorial section to address the most important concepts and provide some general information.

Related issue :#543

@giannidallatorre giannidallatorre added the safe for preview Pull request vetted as safe for preview label Nov 11, 2022
@github-actions
Copy link

Documentation preview deployed!

Available at https://docs.egi.eu/documentation/544

@giannidallatorre
An introduction of connecting a local computer to a cloud host via SS…
8d4d9f5 
…H is provided in this page.

General guidelines, SSH setup options, tips, and examples for setting up the OpenStack environment.
@giannidallatorre
Document SSH connection with a VM in OpenStack #543
6fb24b3 
An introduction of connecting a local computer to a cloud host via SSH is provided in this page.
General guidelines, SSH setup options, tips, and examples for setting up the OpenStack environment.
@github-actions
Copy link

Documentation preview deployed!

Available at https://docs.egi.eu/documentation/544

@github-actions
Copy link

Documentation preview deployed!

Available at https://docs.egi.eu/documentation/544

@github-actions
Copy link

Documentation preview deployed!

Available at https://docs.egi.eu/documentation/544

@github-actions
Copy link

Documentation preview deployed!

Available at https://docs.egi.eu/documentation/544

@github-actions
Copy link

Documentation preview deployed!

Available at https://docs.egi.eu/documentation/544

@github-actions
Copy link

Documentation preview deployed!

Available at https://docs.egi.eu/documentation/544

@github-actions
Copy link

Documentation preview deployed!

Available at https://docs.egi.eu/documentation/544

gwarf
gwarf requested changes Nov 15, 2022
View reviewed changes
Copy link
Member

@gwarf gwarf 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've pushed mainly cosmetics changes (using code blocks with language selector, having meaningful titles to URLs, using shorter lines...).
I think this is quite useful information, but it would be good to also link it more with other resources available: we have documentation on using ansible, terraform, a page about using the Infrastructure Manager...
It also relates a bit to #547, but maybe the security-related aspects will better be in a dedicated page.

@github-actions
Copy link

Documentation preview deployed!

Available at https://docs.egi.eu/documentation/544

enolfc
enolfc reviewed Nov 15, 2022
View reviewed changes
Copy link
Contributor

@enolfc enolfc left a comment

Choose a reason for hiding this comment

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

Thanks @giannidallatorre! Some comments added

content/en/users/tutorials/accessing-vm-with-ssh/_index.md Outdated Show resolved Hide resolved
content/en/users/tutorials/accessing-vm-with-ssh/_index.md Show resolved Hide resolved
@giannidallatorre
Copy link
Contributor Author

I think this is quite useful information, but it would be good to also link it more with other resources available: we have documentation on using ansible, terraform, a page about using the Infrastructure Manager... It also relates a bit to #547, but maybe the security-related aspects will better be in a dedicated page.

Sure, feel free to do what you like with the page and thanks for having reviewed and improved it.
I had to write a few emails on the topics and I thought it may be good to collect the info together into a single page and clean it up a bit. So yes I am sure it can be better integrated with the rest of the documentation, I didn't really think about that. I will try to do that, but I need to find some time to improve my local set-up first if I want to contribute more to the documentation. The style policies are quite restrictive and fixing them after a pool request is time-consuming, so I need to check my vim configuration (which is quite dirty) and make the linter and checks work locally.

@gwarf
Copy link
Member

gwarf commented Nov 15, 2022 •
edited
Loading

The style policies are quite restrictive and fixing them after a pool request is time-consuming, so I need to check my vim configuration (which is quite dirty) and make the linter and checks work locally.

Yes, if you are using vim/neovim, a proper vim configuration is really helping a lot, mine (beware there are many plugins and it's also customised for my own env/desires) is managed using vim-plug and automatically running prettier on files I'm editing, so it's very convenient to get all the basic formatting done when saving a file. It's relying on ALE, cf https://prettier.io/docs/en/vim.html#alehttpsgithubcomdense-analysisale.
See also https://docs.egi.eu/about/contributing/style/#automating-formatting-and-checking

@github-actions
Copy link

Documentation preview deployed!

Available at https://docs.egi.eu/documentation/544

@github-actions
Copy link

github-actions bot commented Jan 9, 2023

Documentation preview deployed!

Available at https://docs.egi.eu/documentation/544

@gwarf
Copy link
Member

gwarf commented Jan 9, 2023

The last broken link to be fixed seems to be https://www.egi.eu/federation/data-centres/, and we should have a new URL soon.

enolfc
enolfc reviewed Mar 6, 2023
View reviewed changes
Copy link
Contributor

@enolfc enolfc left a comment

Choose a reason for hiding this comment

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

It's mixing some fixes in URLs (move to https) with actual content, which it's not my favourite thing to do

The ssh part is ok, @thebe14 where are you with the reorg? I wouldn't like to have merges that complicate even more that work

content/en/users/tutorials/accessing-vm-with-ssh/_index.md Outdated Show resolved Hide resolved
content/en/users/tutorials/accessing-vm-with-ssh/_index.md Outdated Show resolved Hide resolved
@github-actions
Copy link

github-actions bot commented Mar 7, 2023

Documentation preview deployed!

Available at https://docs.egi.eu/documentation/544

1 similar comment
@github-actions
Copy link

github-actions bot commented Mar 7, 2023

Documentation preview deployed!

Available at https://docs.egi.eu/documentation/544

@github-actions
Copy link

github-actions bot commented Mar 8, 2023

Documentation preview deployed!

Available at https://docs.egi.eu/documentation/544

enolfc
enolfc approved these changes Mar 8, 2023
View reviewed changes
Copy link
Contributor

@enolfc enolfc left a comment

Choose a reason for hiding this comment

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

👍 Let's have this merged

@enolfc
Copy link
Contributor

enolfc commented Mar 8, 2023

@glarocca @sebastian-luna-valero can you check this one?

sebastian-luna-valero
sebastian-luna-valero approved these changes Mar 9, 2023
View reviewed changes
Copy link
Member

@sebastian-luna-valero sebastian-luna-valero left a comment

Choose a reason for hiding this comment

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

Thanks!

LGTM, but suggested a few changes.

content/en/users/tutorials/accessing-vm-with-ssh/_index.md Outdated Show resolved Hide resolved
content/en/users/tutorials/accessing-vm-with-ssh/_index.md Show resolved Hide resolved
content/en/users/tutorials/accessing-vm-with-ssh/_index.md Outdated Show resolved Hide resolved
content/en/users/tutorials/accessing-vm-with-ssh/_index.md Outdated Show resolved Hide resolved
content/en/users/tutorials/accessing-vm-with-ssh/_index.md Outdated Show resolved Hide resolved
content/en/users/tutorials/accessing-vm-with-ssh/_index.md Outdated Show resolved Hide resolved
@github-actions

This comment has been minimized.

Sign in to view
@github-actions

This comment has been minimized.

Sign in to view
@github-actions

This comment has been minimized.

Sign in to view
@github-actions

This comment has been minimized.

Sign in to view
@github-actions
Copy link

Documentation preview deployed!

Available at https://docs.egi.eu/documentation/544

@github-actions
Copy link

Documentation preview deployed!

Available at https://docs.egi.eu/documentation/544

@github-actions
Copy link

Documentation preview deployed!

Available at https://docs.egi.eu/documentation/544

@gwarf gwarf merged commit 02a0488 into main Mar 10, 2023
@gwarf gwarf deleted the accessing_vm_with_ssh branch March 10, 2023 09:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gwarf gwarf gwarf approved these changes

@enolfc enolfc enolfc approved these changes

@sebastian-luna-valero sebastian-luna-valero sebastian-luna-valero approved these changes

@paolini78 paolini78 paolini78 approved these changes

@glarocca glarocca Awaiting requested review from glarocca glarocca is a code owner

@andrea-manzi andrea-manzi Awaiting requested review from andrea-manzi andrea-manzi is a code owner

@vardizzo-lab vardizzo-lab Awaiting requested review from vardizzo-lab vardizzo-lab is a code owner

Assignees

@enolfc enolfc

Labels
safe for preview Pull request vetted as safe for preview
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@giannidallatorre @gwarf @enolfc @sebastian-luna-valero @paolini78