Install

Default installation steps for Community Edition, plus first-login and basic operations.

triangle-exclamation
circle-info

Install Community Edition

This installs the Community Edition (CE) control plane on a single CE host. You then onboard one or more hypervisor hosts to run VMs.

circle-info

Read Prerequisites first. Use Custom Installation if you need custom CIDRs or domains.

Outcome

After install, you can:

  • Log in to the web UI

  • Onboard hypervisor hosts

  • Create networks, images, and VMs

  • View metrics in the web UI or Grafana

Timeline

Typical runtime is ~45 minutes. Slow systems or slow registries can push it to ~90 minutes.

  • 5–10 min: system prep and prerequisite checks

  • 10–15 min: K3s cluster creation

  • 20–30 min: PCD services deployment

  • ~5 min: verification and credential output

Deploy the CE host

Run the installer on the CE host as a user with sudo access.

circle-info

By default in Ubuntu, all users in the sudo group have the ability to sudo. Group membership can be validated with the command groups <username> and sudo permissions can be verified with sudo -l -U <username> .

The installer will:

If prerequisite checks fail, use Common Issues. If installation fails, the installer can optionally upload a support bundle.

chevron-rightInstallation examplehashtag

Access the web UI

The installer prints a URL like https://pcd-community.pf9.io. That name must resolve from your browser.

Option 1: Local hosts file (single machine)

Use this for quick testing. Only your computer can resolve the UI URL.

Linux/macOS

Windows

  1. Open Notepad as Administrator.

  2. Open C:\Windows\System32\drivers\etc\hosts.

  3. Add (replace the example IP):

Option 2: Real DNS (team access)

Create A records in your DNS server:

Option 3: Custom domain

Set a custom FQDN during install. See Custom Installation.

Example: pcd.company.local

Log in

Open the UI URL in a browser (the default is pcd-community.pf9.ioarrow-up-right). Accept the self-signed certificate on first visit.

  • Keep Domain as default.

  • Select Use local credentials.

  • Use the credentials printed by the installer.

circle-info

SSO is unavailable until configured. A 404 on SSO login before setup is expected.

Private Cloud Director Community Edition local credentials login screen
Private Cloud Director Community Edition local credentials login screen

Admin credentials and Grafana access

Do not rename the default admin user, [email protected]. Do not change its password.

This account is used internally by Private Cloud Director services.

Create separate users for administrator or self-service access.

circle-exclamation

Next steps

  1. Create a cluster blueprint: Virtualized Cluster Blueprint.

  2. Create a cluster in Infrastructure > Clusters.

  3. Create networking for VMs:

  4. Create VMs: Virtual Machines.


Operations and troubleshooting

chevron-rightValidate the installationhashtag

Your deployment is healthy if both regions show Ready. Ready services should match desired services.

Example output:

chevron-rightRetrieve admin credentialshashtag
chevron-rightLogs and service nameshashtag

Hypervisor host logs

  • /var/log

  • /var/log/pf9

CE host logs

  • /var/log/pf9/fluentbit/ddu.log (JSON; includes Kubernetes pod logs)

You can also use kubectl logs to fetch pod logs.

Hypervisor host services

Service names start with pf9. Examples:

  • pf9-hostagent

  • pf9-imagelibrary

  • pf9-ostackhost

chevron-rightGrafana credentialshashtag

Grafana uses the same admin credentials printed at install time.

Default Grafana URL:

  • https://pcd-community.pf9.io/grafana/login

chevron-rightReset Grafana admin password (advanced)hashtag
triangle-exclamation

The namespace is pcd-community by default. If you customized region naming, use your namespace.

chevron-rightUninstall Community Editionhashtag
chevron-rightExpand an Ubuntu logical volume (LVM)hashtag

If your root filesystem is smaller than the physical volume, expand it.

  1. Find the root device:

  1. Resize the LV (example name shown):

  1. Resize the filesystem:

Troubleshooting

Start with Common Issues.

Optional learning resources

Platform9 YouTube:

Last updated

Was this helpful?