Skip to content

Conversation

@Imvedansh
Copy link
Contributor

Description

This PR updates INSTALL.md to include essential setup commands for first-time contributors, ensuring a smoother installation process and reducing setup errors.
Changes:

Added mysql_secure_installation to improve MySQL security.
Included steps for setting up the CloudStack UI (npm install, npm build, npm start).
Clarified the requirement to set CS_URL=http://localhost:8080/client in .env.local for API communication.
Explicitly mentioned that the management server runs at http://localhost:5050/.

These improvements will make onboarding easier and reduce setup issues.
#10590
Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)
build/CI

test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity
Feature/Enhancement Scale

Minor

Major

Bug Severity

BLOCKER
Critical
Major
Minor

Trivial

Screenshots :

Screenshot from 2025-03-20 18-22-45

How Has This Been Tested?

Followed the updated steps on a fresh Ubuntu 22.04.5 environment.
Ensured the UI builds successfully and connects to the management server.
Verified mysql_secure_installation improves security settings.
Confirmed the management server is accessible at http://localhost:5050/.

How did you try to break this feature and the system with this change?

Tested installation without mysql_secure_installation to confirm the security risk.
Omitted CS_URL in .env.local and verified API connection failure.
Attempted to start the UI without installing dependencies to confirm issues.

@boring-cyborg
Copy link

boring-cyborg bot commented Mar 20, 2025

Congratulations on your first Pull Request and welcome to the Apache CloudStack community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/cloudstack/blob/main/CONTRIBUTING.md)
Here are some useful points:

Copy link
Contributor

@Pearl1594 Pearl1594 left a comment

Choose a reason for hiding this comment

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

@Pearl1594 Pearl1594 added this to the 4.21.0 milestone Mar 21, 2025
@DaanHoogland
Copy link
Contributor

LGTM. Should we remove this line though https://github.com/apache/cloudstack/pull/10593/files#diff-09b140a43ebfdd8dbec31ce72cafffd15164d2860fd390692a030bcb932b54a0R92?

yes and probably edit the line above as well.

Open the following URL on your browser to access the Management Server UI:

should read something like

To access the Management Server UI, follow the following procedure:

@codecov
Copy link

codecov bot commented Mar 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 16.30%. Comparing base (a521985) to head (85ea65e).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##               main   #10593   +/-   ##
=========================================
  Coverage     16.29%   16.30%           
  Complexity    13438    13438           
=========================================
  Files          5674     5674           
  Lines        499213   499213           
  Branches      60367    60367           
=========================================
+ Hits          81371    81375    +4     
+ Misses       408772   408768    -4     
  Partials       9070     9070           
Flag Coverage Δ
uitests 3.99% <ø> (ø)
unittests 17.16% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@DaanHoogland DaanHoogland linked an issue Mar 24, 2025 that may be closed by this pull request
@Imvedansh
Copy link
Contributor Author

@Pearl1594 @DaanHoogland
I agree, Thank you for noticing
Made the changes as well

@DaanHoogland DaanHoogland reopened this Mar 25, 2025
@DaanHoogland DaanHoogland merged commit 8a338ea into apache:main Mar 25, 2025
29 of 49 checks passed
@boring-cyborg
Copy link

boring-cyborg bot commented Mar 25, 2025

Awesome work, congrats on your first merged pull request!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

No open projects
Status: Done

Development

Successfully merging this pull request may close these issues.

Missing ClousStack UI Setup commands in Install.md

4 participants