Skip to content

[DOCS] Install prototype #3855

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

Draft
wants to merge 35 commits into
base: v3
Choose a base branch
from
Draft

[DOCS] Install prototype #3855

wants to merge 35 commits into from

Conversation

catalinaadam
Copy link
Contributor

PMM-0

Link to the Feature Build: SUBMODULES-0

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

  • API Docs updated

If this PR is related to some other PRs in this or other repositories, please provide links to those PRs:

  • Links to related pull requests (optional).

@ademidoff ademidoff temporarily deployed to New_prototype - pmm-doc-3 PR #3855 April 3, 2025 11:58 — with Render Destroyed
@@ -0,0 +1,55 @@
# Set up PMM Client
Copy link
Member

Choose a reason for hiding this comment

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

Q: I could not understand what this file is for :) I sort of see the name, but still don't get the purpose. Placeholder?


For MySQL check the type of host that you have for your database and follow the instructions required to set up PMM Client.

| <small>*Host*</small> | <small>*Recommended set up*</small> | <small>*Other advanced options*</small> |
Copy link
Member

Choose a reason for hiding this comment

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

IMO those captions look far too small and diffucult to read. I'd leave their regular size.


### Operating system
PMM Client is compatible with modern 64-bit Linux distributions on both x86_64 and ARM64 architectures. Supported platforms include current versions of Debian, Ubuntu, CentOS, and Red Hat Enterprise Linux.
Copy link
Member

Choose a reason for hiding this comment

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

Shall we mention Oracle Linux as it's our base OS in docker? Also, shall we say "Red Hat" derivatives instead of mentioning just two?


```sh
docker load -i pmm-server-{{release}}.docker
```

6. [Run the container](index.md#run-docker-container) as if your image is already pulled using your desired method for a storage volume (you can step over any docker pull commands as the image has been pre-staged).
6. [Run the PMM Server container](index.md#run-docker-container) as if your image is already pulled using your desired method for a storage volume. Skip any `docker pull` commands as the image has been pre-staged and available locally.

Choose a reason for hiding this comment

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

🚫 [linkspector] reported by reviewdog 🐶
Cannot reach index.md#run-docker-container Status: 404 Cannot find section: #run-docker-container in file: /home/runner/work/pmm/pmm/documentation/docs/install-pmm/install-pmm-server/deployment-options/docker/index.md.

- Security is a priority and you need rootless container execution
- Your organization has security policies restricting the use of Docker daemon
- You're running in environments where fine-grained permission control is required
- You need SystemD integration for better service management
Copy link
Contributor

Choose a reason for hiding this comment

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

systemd (all lowercase).

```sh
podman network create pmm_default
```
- Set up required system configurations:
Copy link
Contributor

Choose a reason for hiding this comment

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

  • Create the Podman volume for PMM:
    podman volume create pmm-data

```
- Configure Watchtower (if using UI updates) with these security considerations:

- ensure Watchtower is only accessible from within the Docker network or local host to prevent unauthorized access and enhance container security.
Copy link
Contributor

Choose a reason for hiding this comment

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

Use "Podman network" instead of "Docker network".

If you cannot connect to the VM:

- For bridged networking, ensure your host's firewall allows traffic to the VM
- For NAT with port forwarding, connect to your host's IP address with the forwarded port (e.g., https://localhost:8443)

Choose a reason for hiding this comment

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

🚫 [linkspector] reported by reviewdog 🐶
Cannot reach https://localhost:8443 Status: null net::ERR_CONNECTION_REFUSED at https://localhost:8443

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.

5 participants