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

Update README.md #2438

Closed
wants to merge 1 commit into from
Closed

Update README.md #2438

wants to merge 1 commit into from

Conversation

mabicca
Copy link

@mabicca mabicca commented Dec 15, 2021

Adding note about installing from source not being supported.

Description

Issue #


PR information

  • The title of the PR is clear and informative.
  • There are a small number of commits, each of which has an informative message. This means that previously merged commits do not appear in the history of the PR. For information on cleaning up the commits in your pull request, see this page.
  • If applicable, the PR references the bug/issue that it fixes in the description.
  • New Unit tests were added for the changes made

Quality of Code and Contribution Guidelines

Adding note about installing from source not being supported.
@codecov
Copy link

codecov bot commented Dec 15, 2021

Codecov Report

Merging #2438 (ec122c7) into develop (838b747) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #2438   +/-   ##
========================================
  Coverage    71.66%   71.66%           
========================================
  Files          101      101           
  Lines        14818    14818           
  Branches      2348     2348           
========================================
  Hits         10620    10620           
  Misses        3718     3718           
  Partials       480      480           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 838b747...ec122c7. Read the comment docs.

@@ -106,6 +106,9 @@ You can view more installation options by running:

The agent's log file is kept at `/var/log/waagent.log`.

## NOTE
Installing the waagent from source **is not supported**

Copy link
Member

Choose a reason for hiding this comment

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

I would propose something similar to "Installing from source is meant to be used in advanced scenarios, such as creating a new VM image, and support is very limited (open an issue here and we may be able to provide guidance). Do not install from source while troubleshooting issues with the Agent."

Copy link
Author

Choose a reason for hiding this comment

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

What about we revamp that section to specifically talk about installing from source when creating a new, customized image and explaining that installing from source is not supported on Azure Endorsed Distributions? At least that would be clear in terms of the support in those scenarios where we should leverage the distribution package management.

Copy link
Member

Choose a reason for hiding this comment

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

ok, can you post how it would read?

Copy link
Author

Choose a reason for hiding this comment

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

Sure, could we add a note saying:

Installing the waagent from the source is to be used only for new virtual image creation (custom images) and the support is very limited for those scenarios.

For Endorsed Linux distributions on Azure images, the only supported method of installation is using the distribution's own packaging mechanisms such as apt, yum or zypper.

Copy link
Author

Choose a reason for hiding this comment

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

@narrieta let me know if this is good to update.

Copy link
Author

Choose a reason for hiding this comment

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

@narrieta I know it's been a while, but not sure if we were able to update the README about this?

Copy link
Member

Choose a reason for hiding this comment

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

@mabicca sorry for the delay. Submitted #2941

@narrieta
Copy link
Member

narrieta commented Oct 9, 2023

Replaced by #2941

@narrieta narrieta closed this Oct 9, 2023
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