Files
pulse/docs/CLOUD.md
T
pulse-triage[bot] 04429cb42c Keep setup and metrics guidance credential-safe
Replace token arguments, an ignored API_TOKENS bootstrap and plaintext DaemonSet credentials with scoped UI-created tokens, private files and a pre-created Secret. Route hosted installation to the existing private-file flow and retain HTTP errors and encoded resource identities in metrics queries. Exercise copied recipes, failure stops and actual curl requests with synthetic credentials.

Contract-Neutral: Documentation-only private-file setup and metrics access guidance; no runtime, API, entitlement or deployment contract delta.
Change-source: pulse-maintainer
2026-10-01 13:26:10 +01:00

131 lines
5.5 KiB
Markdown

# Pulse Cloud (Hosted)
Pulse Cloud is the hosted version of Pulse. It is a fully managed monitoring instance that runs in the cloud so you don't have to self-host.
Pulse Cloud is for a hosted Pulse instance. Pulse MSP is a separate provider path: the MSP normally runs a Stripe-free provider-hosted control plane with one isolated Pulse runtime per client. Pulse-hosted MSP is available only as a request-assisted option where Pulse operates that provider stack for the MSP.
## How It Works
1. **Sign up** at the Pulse Cloud portal.
2. **Connect your agents** — install the Pulse agent on your infrastructure pointing to your cloud URL.
3. **Monitor** — access your dashboard from any browser or supported Pulse Mobile client.
Each Cloud account gets a dedicated, isolated Pulse instance with its own subdomain (e.g., `yourname.cloud.pulserelay.pro`).
## Features
Pulse Cloud includes everything in the **Pro** plan, plus:
| Feature | Description |
|---|---|
| **Fully managed hosting** | No server to manage, no updates to apply |
| **Automatic updates** | Your instance is always on the latest version |
| **Automatic backups** | Daily encrypted backups with 7-day retention |
| **Dedicated instance** | Your data runs in an isolated container — not shared with other tenants |
| **Wildcard TLS** | HTTPS with auto-renewing certificates |
| **Mobile ready** | Relay is pre-configured for secure Pulse Mobile remote access |
### Cloud Enterprise (Add-On)
For organisations that need internal multi-organization management under one owner:
| Feature | Capability Key |
|---|---|
| Multi-Tenant Mode | `multi_tenant` |
| Multi-User Mode | `multi_user` |
| Hosted Capacity Policy | `unlimited` |
See [Plans & Entitlements](PULSE_PRO.md) for the full feature matrix.
Cloud Enterprise shared-process organizations are for one owner separating internal sites, departments, or environments. They are not the default MSP model for unrelated customer businesses.
## Getting Started
### 1. Create Your Account
Sign up via the Pulse Cloud portal. Your instance is provisioned automatically after checkout.
### 2. Connect Agents
Once your instance is running, open **Settings → Infrastructure → Install on a
host** in your cloud dashboard and choose the target platform and collector
profile. Run the installer on the host being monitored, not inside the hosted
Pulse server.
For manual setup, follow the [private-file installation steps](UNIFIED_AGENT.md#private-file-installation-linux-macos-and-nas)
(or the Windows section in that guide), replacing `https://pulse.example.com`
with your instance's HTTPS address in both the download and install commands.
Save the agent token in a private file and pass only its path with
`--token-file`; never paste a token into command arguments, a URL or a report.
Download the agent installer from your own instance's `/install.sh`, stop if
the download fails, and inspect the saved script before running it. Keep TLS
verification enabled; do not pipe an unchecked response into a privileged shell
or substitute the top-level GitHub server installer.
### 3. Add Proxmox / TrueNAS Connections
Add your Proxmox VE, PBS, PMG, or TrueNAS systems via **Settings → Infrastructure → Platform connections**.
### 4. Set Up Mobile Access
Relay is enabled by default on Cloud instances. Open **Settings → Pulse Mobile** to pair a phone. Pulse Mobile is being retired on 31 March 2027.
## Data & Privacy
- Your monitoring data runs in an **isolated container** — no shared databases.
- Data is stored encrypted at rest.
- Backups are automated and encrypted.
- You can **export** your configuration at any time via **Settings → System → Recovery** and migrate to self-hosted if needed.
- See [Privacy](PRIVACY.md) for full details.
## Billing
Pulse Cloud billing is handled by Stripe. You can manage your subscription from the Cloud portal:
- View current plan and usage
- Update payment method
- Cancel or change plans
## Migrating To/From Cloud
### Self-Hosted → Cloud
1. **Export** from your self-hosted instance: **Settings → System → Recovery → Create Backup**.
2. **Import** into your Cloud instance: **Settings → System → Recovery → Restore Configuration**.
3. Update agent `--url` flags to point to your cloud URL.
### Cloud → Self-Hosted
1. **Export** from Cloud: **Settings → System → Recovery → Create Backup**.
2. Install Pulse on your own server (see [Install Guide](INSTALL.md)).
3. **Import** the backup.
4. Re-activate your license key (if switching to Pro self-hosted).
5. Update agent `--url` flags.
See [Migration Guide](MIGRATION.md) for detailed steps.
## FAQ
### Can I use my own domain?
Custom domain support is planned for a future release. Currently, instances use `*.cloud.pulserelay.pro` subdomains.
### Is my data shared with other users?
No. Each Cloud account runs in a dedicated, isolated container with its own data directory.
### What happens if I cancel?
Your data is retained for 30 days after cancellation. You can export your configuration at any time before deletion.
### Can I switch between Cloud and self-hosted?
Yes. Use the export/import workflow described above. Your monitoring configuration is fully portable.
## See Also
- [Plans & Entitlements](PULSE_PRO.md) — feature comparison across Community, Relay, Pro, legacy Pro+, and Cloud
- [Installation (Self-Hosted)](INSTALL.md) — self-hosted installation guide
- [Relay / Mobile Access](RELAY.md) — relay setup and mobile rollout status (pre-configured on Cloud)
- [Multi-Tenant](MULTI_TENANT.md), Enterprise/internal multi-organization mode