Add parameter to not create additional users on `cloudstack-setup-databases` #9969

lucas-a-martins · 2024-11-25T16:41:26Z

Description

When using the cloudstack-setup-databases command during the database setup process, some additional users are created. Since the standard procedure involves creating and configuring database users prior to the ACS setup, these extra users are not used. Moreover, the additional users created by cloudstack-setup-databases are granted excessive permissions, requiring operators to manually delete them.

This PR introduces a new optional parameter, --skip-users-auto-creation. By using this parameter, ACS will skip the automatic creation of these additional users.

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

Major
Minor

Screenshots (if appropriate):

How Has This Been Tested?

After executing the cloudstack-setup-databases with the new flag, I checked the database users and, as expected, no new users were created. I then repeated the procedure without the new flag, and the extra users were created as usual.

…bases

setup/bindir/cloud-setup-databases.in

codecov · 2024-11-27T13:00:42Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 16.17%. Comparing base (b38ee63) to head (09ec0a9).
Report is 336 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #9969      +/-   ##
============================================
+ Coverage     15.80%   16.17%   +0.36%     
- Complexity    12586    13291     +705     
============================================
  Files          5627     5668      +41     
  Lines        492328   498179    +5851     
  Branches      59692    60290     +598     
============================================
+ Hits          77828    80590    +2762     
- Misses       405977   408567    +2590     
- Partials       8523     9022     +499

Flag	Coverage Δ
uitests	`3.99% <ø> (-0.05%)`	⬇️
unittests	`17.02% <ø> (+0.39%)`	⬆️

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.

setup/bindir/cloud-setup-databases.in

Co-authored-by: dahn <[email protected]>

sureshanaparti · 2024-11-29T13:32:27Z

@blueorangutan package

DaanHoogland · 2024-12-02T08:11:36Z

@blueorangutan package

blueorangutan · 2024-12-02T08:12:03Z

@DaanHoogland a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2024-12-02T09:01:06Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 11676

DaanHoogland · 2024-12-05T14:04:15Z

@blueorangutan package

blueorangutan · 2024-12-05T14:06:04Z

@DaanHoogland a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2024-12-05T15:11:13Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 11728

DaanHoogland · 2024-12-06T08:44:50Z

@blueorangutan test

blueorangutan · 2024-12-06T08:46:04Z

@DaanHoogland a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

blueorangutan · 2024-12-07T01:25:07Z

[SF] Trillian test result (tid-11860)
Environment: kvm-ol8 (x2), Advanced Networking with Mgmt server ol8
Total time taken: 57547 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr9969-t11860-kvm-ol8.zip
Smoke tests completed. 140 look OK, 1 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File
test_01_secure_vm_migration	`Error`	134.24	test_vm_life_cycle.py
test_01_secure_vm_migration	`Error`	134.24	test_vm_life_cycle.py

setup/bindir/cloud-setup-databases.in

DaanHoogland

clgtm

lucas-a-martins · 2025-03-07T16:28:01Z

@blueorangutan package

blueorangutan · 2025-03-07T16:30:03Z

@lucas-a-martins a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2025-03-07T17:34:37Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 12705

lucas-a-martins · 2025-03-07T18:34:25Z

@blueorangutan test

DaanHoogland · 2025-03-09T19:50:19Z

@blueorangutan test

blueorangutan · 2025-03-09T19:52:03Z

@DaanHoogland a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

blueorangutan · 2025-03-10T12:31:02Z

[SF] Trillian test result (tid-12629)
Environment: kvm-ol8 (x2), Advanced Networking with Mgmt server ol8
Total time taken: 57362 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr9969-t12629-kvm-ol8.zip
Smoke tests completed. 140 look OK, 1 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File
ContextSuite context=TestSharedNetworkWithConfigDrive>:setup	`Error`	1521.57	test_network.py

bernardodemarco

LGTM, manually tested in a local environment

Verified that when the --skip-users-auto-creation flag is omitted, the script creates the default users:

Script execution

root@cloudstack:~# cloudstack-setup-databases scc:[email protected] --deploy-as=a:scc -i 192.168.122.200
Mysql user name:scc                                                             [ OK ]
Mysql user password:******                                                      [ OK ]
Mysql server ip:192.168.122.200                                                 [ OK ]
Mysql server port:3306                                                          [ OK ]
Mysql root user name:a                                                          [ OK ]
Mysql root user password:******                                                 [ OK ]
Using specified cluster management server node IP 192.168.122.200               [ OK ]
Checking Cloud database files ...                                               [ OK ]
Checking local machine hostname ...                                             [ OK ]
Checking SELinux setup ...                                                      [ OK ]
Preparing /etc/cloudstack/management/db.properties                              [ OK ]
Applying /usr/share/cloudstack-management/setup/create-database.sql             [ OK ]
Applying /usr/share/cloudstack-management/setup/create-schema.sql               [ OK ]
Applying /usr/share/cloudstack-management/setup/create-database-premium.sql     [ OK ]
Applying /usr/share/cloudstack-management/setup/create-schema-premium.sql       [ OK ]
Applying /usr/share/cloudstack-management/setup/server-setup.sql                [ OK ]
Applying /usr/share/cloudstack-management/setup/templates.sql                   [ OK ]
Processing encryption ...                                                       [ OK ]
Finalizing setup ...                                                            [ OK ]

CloudStack has successfully initialized database, you can check your database configuration in /etc/cloudstack/management/db.properties

DB users

MariaDB [(none)]> select user,host from mysql.user;
+-------------+---------------+
| User        | Host          |
+-------------+---------------+
| scc         | %             |
| a           | 192.168.122.% |
| scc         | 192.168.122.% |
| mariadb.sys | localhost     |
| mysql       | localhost     |
| root        | localhost     |
| scc         | localhost     |
+-------------+---------------+
7 rows in set (0.001 sec)

Verified that when the flag is specified, the default users are not created:

Script execution

root@cloudstack:~# cloudstack-setup-databases scc:[email protected] --deploy-as=a:scc -i 192.168.122.200 --skip-users-auto-creation
Mysql user name:scc                                                             [ OK ]
Mysql user password:******                                                      [ OK ]
Mysql server ip:192.168.122.200                                                 [ OK ]
Mysql server port:3306                                                          [ OK ]
Mysql root user name:a                                                          [ OK ]
Mysql root user password:******                                                 [ OK ]
Using specified cluster management server node IP 192.168.122.200               [ OK ]
Checking Cloud database files ...                                               [ OK ]
Checking local machine hostname ...                                             [ OK ]
Checking SELinux setup ...                                                      [ OK ]
Preparing /etc/cloudstack/management/db.properties                              [ OK ]
Applying /usr/share/cloudstack-management/setup/create-database.sql             [ OK ]
Applying /usr/share/cloudstack-management/setup/create-schema.sql               [ OK ]
Applying /usr/share/cloudstack-management/setup/create-database-premium.sql     [ OK ]
Applying /usr/share/cloudstack-management/setup/create-schema-premium.sql       [ OK ]
Applying /usr/share/cloudstack-management/setup/server-setup.sql                [ OK ]
Applying /usr/share/cloudstack-management/setup/templates.sql                   [ OK ]
Processing encryption ...                                                       [ OK ]
Finalizing setup ...                                                            [ OK ]

CloudStack has successfully initialized database, you can check your database configuration in /etc/cloudstack/management/db.properties

DB users

MariaDB [(none)]> select user,host from mysql.user;
+-------------+---------------+
| User        | Host          |
+-------------+---------------+
| a           | 192.168.122.% |
| scc         | 192.168.122.% |
| mariadb.sys | localhost     |
| mysql       | localhost     |
| root        | localhost     |
+-------------+---------------+
5 rows in set (0.001 sec)

bernardodemarco · 2025-04-07T18:31:26Z

[SF] Trillian test result (tid-12629) Environment: kvm-ol8 (x2), Advanced Networking with Mgmt server ol8 Total time taken: 57362 seconds Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr9969-t12629-kvm-ol8.zip Smoke tests completed. 140 look OK, 1 have errors, 0 did not run Only failed and skipped tests results shown below:

Test Result Time (s) Test File
ContextSuite context=TestSharedNetworkWithConfigDrive>:setup Error 1521.57 test_network.py

The CI error does not seem to be related

Add parameter to not create additional users on cloudstack-setup-data…

f06f5a8

…bases

sureshanaparti reviewed Nov 27, 2024

View reviewed changes

setup/bindir/cloud-setup-databases.in Outdated Show resolved Hide resolved

DaanHoogland reviewed Nov 28, 2024

View reviewed changes

setup/bindir/cloud-setup-databases.in Outdated Show resolved Hide resolved

apply dahn's suggestion

ce658e5

Co-authored-by: dahn <[email protected]>

sureshanaparti added the status:needs-testing label Nov 29, 2024

sureshanaparti added this to the 4.21.0 milestone Nov 29, 2024

sureshanaparti approved these changes Nov 29, 2024

View reviewed changes

apache deleted a comment from blueorangutan Dec 5, 2024

Fix --skip-users-auto-creation flag

42c6e7a

DaanHoogland reviewed Feb 14, 2025

View reviewed changes

setup/bindir/cloud-setup-databases.in Outdated Show resolved Hide resolved

Change to not remove IF and END IF

09ec0a9

lucas-a-martins requested a review from DaanHoogland March 6, 2025 18:03

DaanHoogland approved these changes Mar 7, 2025

View reviewed changes

bernardodemarco approved these changes Apr 7, 2025

View reviewed changes

bernardodemarco added status:ready-for-merge and removed status:needs-testing labels Apr 7, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add parameter to not create additional users on `cloudstack-setup-databases` #9969

Add parameter to not create additional users on `cloudstack-setup-databases` #9969

lucas-a-martins commented Nov 25, 2024

codecov bot commented Nov 27, 2024 •

edited

Loading

sureshanaparti commented Nov 29, 2024

DaanHoogland commented Dec 2, 2024

blueorangutan commented Dec 2, 2024

blueorangutan commented Dec 2, 2024

DaanHoogland commented Dec 5, 2024

blueorangutan commented Dec 5, 2024

blueorangutan commented Dec 5, 2024

DaanHoogland commented Dec 6, 2024

blueorangutan commented Dec 6, 2024

blueorangutan commented Dec 7, 2024

DaanHoogland left a comment

lucas-a-martins commented Mar 7, 2025

blueorangutan commented Mar 7, 2025

blueorangutan commented Mar 7, 2025

lucas-a-martins commented Mar 7, 2025

DaanHoogland commented Mar 9, 2025

blueorangutan commented Mar 9, 2025

blueorangutan commented Mar 10, 2025

bernardodemarco left a comment

bernardodemarco commented Apr 7, 2025

Add parameter to not create additional users on cloudstack-setup-databases #9969

Are you sure you want to change the base?

Add parameter to not create additional users on cloudstack-setup-databases #9969

Conversation

lucas-a-martins commented Nov 25, 2024

Description

Types of changes

Feature/Enhancement Scale

Screenshots (if appropriate):

How Has This Been Tested?

codecov bot commented Nov 27, 2024 • edited Loading

Codecov Report

sureshanaparti commented Nov 29, 2024

DaanHoogland commented Dec 2, 2024

blueorangutan commented Dec 2, 2024

blueorangutan commented Dec 2, 2024

DaanHoogland commented Dec 5, 2024

blueorangutan commented Dec 5, 2024

blueorangutan commented Dec 5, 2024

DaanHoogland commented Dec 6, 2024

blueorangutan commented Dec 6, 2024

blueorangutan commented Dec 7, 2024

DaanHoogland left a comment

Choose a reason for hiding this comment

lucas-a-martins commented Mar 7, 2025

blueorangutan commented Mar 7, 2025

blueorangutan commented Mar 7, 2025

lucas-a-martins commented Mar 7, 2025

DaanHoogland commented Mar 9, 2025

blueorangutan commented Mar 9, 2025

blueorangutan commented Mar 10, 2025

bernardodemarco left a comment

Choose a reason for hiding this comment

bernardodemarco commented Apr 7, 2025

Add parameter to not create additional users on `cloudstack-setup-databases` #9969

Add parameter to not create additional users on `cloudstack-setup-databases` #9969

codecov bot commented Nov 27, 2024 •

edited

Loading