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

fix(README): Document prerequisites and common variables for deployment #1405

Merged
merged 4 commits into from
Oct 12, 2023

Conversation

m-czernek
Copy link
Contributor

What does this PR change?

In this PR, I am documenting:

  • Libvirt prerequisites: this seemed reasonable to me since the section also contains description of installing the terraform-provider-libvirt package
  • Variables: a newcomer to Uyuni probably won't know what CC stands for. Additionally, the images section might be helpful

Copy link
Member

@meaksh meaksh left a comment

Choose a reason for hiding this comment

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

Thanks a lot for these improvements! 🎉

I just made some suggestions that maybe you could consider. Thanks in advance!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@agraul
Copy link
Member

agraul commented Oct 5, 2023

There is also #769 which covers some of the same changes. Maybe we should also take a look at that one.

m-czernek and others added 2 commits October 5, 2023 14:34
Co-authored-by: Pablo Suárez Hernández <[email protected]>
@m-czernek
Copy link
Contributor Author

@agraul I think this PR supersedes changes in #769 , doesn't it? IMO the cc_* variables are necessary for any backend, so it probably doesn't make sense to document them in the libvirt module. Perhaps we can delete the current cc docs in https://github.com/uyuni-project/sumaform/blob/master/backend_modules/libvirt/README.md?

complete the cc_password variable in the base module

@m-czernek m-czernek requested a review from meaksh October 10, 2023 07:03
Copy link
Member

@meaksh meaksh left a comment

Choose a reason for hiding this comment

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

Looks good, thanks!

@m-czernek m-czernek merged commit c9c5535 into uyuni-project:master Oct 12, 2023
2 checks passed
@m-czernek m-czernek deleted the mczernek/readme/improvement branch October 12, 2023 07:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants