free-pmx-no-subscription(1)

Synopsis

free-pmx-no-subscription [LIST]

List

pve|pbs|ceph: Perform setup of specific no-subscription repository, disable default one (if present).

With no list provided, presence of existing default repository list(s) will be taken as an indication which list(s) to set up.

Configuration

Files

/etc/free-pmx/no-subscription.conf: Shared configuration file is sourced via a shell script. File can be pre-created before package install to avoid default behaviour during first install.
/etc/os-release: Comes with standard Proxmox/Debian install and contains operating system identification data. It is used to determine Debian release codename to set up the correct repositories.

Options

All option names are uppercase, values lowercase. There must NO WHITESPACE between option name, = sign and the assigned value.

FREE_PMX_NO_SUBSCRIPTION=VALUE

Determines when and how the repository lists are set up.

auto: Lists are set up upon install and whenever brought in via Proxmox package install.
manual: Lists can ONLY be set up by invoking the command.
prohibit: Lists will NOT be set up and the command invocation will reject setup.

FREE_PMX_CEPH=VALUE

Actual Ceph release name, e.g. quincy, reef, squid.

Operation

When not invoked with explicit LIST, default list file names - not contents - are used to detect which list(s) to set up. Original lists are disabled by appending .disabled suffix to their names. New lists (with no-subscription as part of their file name) are created UNLESS the files already exist.

Default lists

The recognised default list files under /etc/apt/sources.list.d directory that determine which list to set up (when invoked with no LIST specified):

pve-enterprise.list
pbs-enterprise.list
ceph.list

No-subscription lists

The new list files that can be created under /etc/apt/sources.list.d directory:

pve-no-subscription.list
pbs-no-subscription.list
ceph-no-subscription.list

Proxmox release key

Proxmox release key is checked for presence in:

/etc/apt/trusted.gpg.d/proxmox-release-<debian_release_codename>.gpg

If not present, it is retrieved from: https://enterprise.proxmox.com/debian/

Exit status

0

Success. Includes scenarios, such as:

setup is probibited by configuration; or
default lists are missing; or
no-subscription lists are already setup; or
no candidate lists were found to determine which ones to set up.

1

Failure. Issues encountered during setup, such as:

invalid argument provided; or
no system release name could be determined; or
only some of the candidate lists could be set up.

Notes

The command can be used on plain Debian installs without Proxmox packages installed - with explicit LIST indicating which Proxmox product repository list to set up - before proceeding with the actual Proxmox product installation. It will retrieve the correct Proxmox release key and set up the repository list as requested.

free-pmx-no-subscription(1) Manual Page

Name