Skip to content

Add one-step PMM client installer script and UI integration#5250

Draft
theTibi wants to merge 6 commits intov3from
one_step_install
Draft

Add one-step PMM client installer script and UI integration#5250
theTibi wants to merge 6 commits intov3from
one_step_install

Conversation

@theTibi
Copy link
Copy Markdown
Contributor

@theTibi theTibi commented Apr 14, 2026

  • Introduced a new script install-pmm-client.sh for streamlined installation of the PMM client.
  • Updated Ansible tasks to copy the installer script to the appropriate directory.
  • Enhanced documentation with a new section for one-step installation from the UI.
  • Added a new Install Client page in the UI for generating installation commands.
  • Integrated navigation for the new Install Client page within the application.

This update simplifies the PMM client installation process and improves user experience through the UI.

PMM-0

Link to the Feature Build: SUBMODULES-0

If this PR adds, removes or alters one or more API endpoints, please review and update the relevant API documentation as well:

  • API Docs updated

If this PR is related to other PRs, contributions, or ongoing work in this or other repositories, please reference them here:

  • Links to related work items (optional).

- Introduced a new script `install-pmm-client.sh` for streamlined installation of the PMM client.
- Updated Ansible tasks to copy the installer script to the appropriate directory.
- Enhanced documentation with a new section for one-step installation from the UI.
- Added a new Install Client page in the UI for generating installation commands.
- Integrated navigation for the new Install Client page within the application.

This update simplifies the PMM client installation process and improves user experience through the UI.
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 14, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 47.54%. Comparing base (910cc77) to head (690c7de).
⚠️ Report is 26 commits behind head on v3.

Additional details and impacted files
@@            Coverage Diff             @@
##               v3    #5250      +/-   ##
==========================================
- Coverage   47.76%   47.54%   -0.23%     
==========================================
  Files         410      411       +1     
  Lines       41967    42052      +85     
==========================================
- Hits        20047    19992      -55     
- Misses      19943    20021      +78     
- Partials     1977     2039      +62     
Flag Coverage Δ
admin 35.80% <ø> (ø)
agent 53.04% <ø> (-0.21%) ⬇️
managed 47.44% <ø> (-0.28%) ⬇️
vmproxy 72.09% <ø> (ø)

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.

theTibi added 5 commits April 14, 2026 23:03
- Cleaned up import statements in `accesscontrol_grpc.pb.go` and `actions_grpc.pb.go` by removing unnecessary blank lines.
- Updated `accesscontrol.pb.go` and `actions.pb.go` to reorder import statements for consistency.
- Added validation checks in `accesscontrol.pb.validate.go` and `advisors.pb.validate.go` to ensure proper handling of optional fields.
- Introduced new Swagger JSON files for `accesscontrol` and `actions` APIs to enhance API documentation.
- Improved formatting and organization of code across multiple files for better readability and maintainability.

These changes enhance the overall structure and documentation of the API, making it easier for developers to understand and use.
- Simplified the implementation of the createNodeInstallToken function by directly returning the response data from the API call.
- Removed unnecessary parameters in the API post method for cleaner code.

These changes enhance code readability and maintainability.
- Modified `install-pmm-client.sh` to enhance command options for node registration and configuration, including clearer error messages and improved handling of non-interactive installations.
- Updated the UI to set `insecureTLS` to true by default and adjusted related tests to reflect this change.
- Refactored command building logic in `InstallClientPage.utils.ts` to streamline the installation command generation, ensuring proper handling of flags and environment variables.

These changes improve the installation process and user experience for the PMM client.
- Simplified the OS detection logic by removing unnecessary cases for various Linux distributions.
- Updated the error message to clearly specify the supported 64-bit Linux distributions: Debian, Ubuntu (DEB) and RHEL, Oracle Linux, Amazon Linux (RPM).

These changes enhance the clarity and maintainability of the installation script.
- Updated the default credentials mode to 'env' for improved security during installation.
- Enhanced user guidance in the UI regarding the use of environment variables and flags for database credentials.
- Added new helper text to clarify the limitations of using curl with the installation script.
- Modified the command generation logic to include database environment variables when applicable, improving the handling of optional database fields in both prompt and env modes.
- Updated tests to ensure correct behavior when optional database fields are provided.

These changes improve the user experience and security of the PMM client installation process.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants