proxmox-mirrors/proxmox-offline-mirror
1
0
Fork 0
mirror of https://git.proxmox.com/git/proxmox-offline-mirror synced 2025-04-28 15:24:24 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: offline-keys: improve read- and understandabilty

Browse Source 
By rephasing certain parts and splitting long sentences into smaller
ones.

Also changing "licensing server" to "subscription server".

Signed-off-by: Aaron Lauterer <a.lauterer@proxmox.com>
This commit is contained in:
Aaron Lauterer 2022-09-09 12:28:37 +02:00 committed by Thomas Lamprecht
parent a1bae05459
commit 07fae362b6
1 changed files with 21 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
docs/offline-keys.rst
View File

@ -1,14 +1,14 @@
Offline Subscription Keys
=========================
When using ``proxmox-offline-mirror`` with a corresponding Proxmox Offline Mirror subscription key,
it is possible to update subscription information for air-gapped systems, or those without access
to the public internet.
The ``proxmox-offline-mirror`` tool can be used to manage subscription keys for air-gapped systems
or systems that cannot access the public internet. To use this functionality, you need a
subscription key for Proxmox Offline Mirror itself.
The offline mirror tool will take care of registering the subscription keys in the Proxmox shop,
which then responds with a signed data blob, if the key is valid. The signed response can then get
exported to a offline medium and used to set the subscription key in a Proxmox project, without any
need for an internet connection on the host itself.
The offline mirror tool will take care of registering the subscription keys in the Proxmox shop. If
the key is valid, it will get a signed data blob in response. The signed response can then be
exported to an offline medium to transfer and set the subscription key in a Proxmox solution,
without any need for an internet connection on the host itself.
Setup Offline Mirror Key
------------------------
@ -16,16 +16,17 @@ Setup Offline Mirror Key
First, add the `pom-<keyid>` mirror key using ``proxmox-offline-mirror key add-mirror-key <key>``.
This command will activate the subscription of the mirroring system.
.. note:: You can acquire a Promxox Offline Mirror Subscription key by contacting
<sales@proxmox.com>. If the majority of your Proxmox VE, Proxmox Backup Server or
Proxmox Mail Gateway hosts got standard or premium subscriptions you may be elligible for free
offline mirroring subscription, in that case also write a mail to <sales@proxmox.com> for details.
.. note:: To purchase a subscription key for Proxmox Offline Mirror, please contact
<sales@proxmox.com>. If you already have a Standard or Premium subscription for the majority of
your Proxmox VE, Proxmox Backup Server or Proxmox Mail Gateway hosts, you may be eligible for a
free Offline Mirror subscription. In that case, please email <sales@proxmox.com> to
get more details.
Gather Server IDs
-----------------
Next, gather the server IDs of the systems that shall be set up for offline keys. That information
is visible in the subscription panel of each host, or using the CLI like:
Next, gather the server IDs of the systems that will be set up for offline keys. You can see the
server ID in the subscription panel of each host, or by using the CLI with the following commands:
- ``pvesubscription get`` for Proxmox VE
@ -36,18 +37,19 @@ is visible in the subscription panel of each host, or using the CLI like:
Register & Refresh Keys
-----------------------
.. note:: Configuring an active product subscription key (*as well as* a Proxmox Offline Mirror
subscription) is required for ``proxmox-offline-mirror`` to be able to access and mirror a
product's enterprise repository.
.. note:: To be able to access and mirror a product's enterprise repository,
``proxmox-offline-mirror`` requires that both, an active product subscription key and a Proxmox
Offline Mirror subscription is configured.
Register the hosts with the systems's server IDs and subscription keys using
Register the hosts with their subscription keys and server IDs using
``proxmox-offline-mirror key add``, for example:
.. code-block:: console
proxmox-offline-mirror key add pve2p-12345... ABCDEF0123...
By default, this command will fetch updated subscription information from Proxmox licensing servers.
By default, this command will fetch the updated subscription information from the Proxmox
subscription servers.
You can refresh the subscription information for a single (``--key XX``) or all configured keys
using ``proxmox-offline-mirror key refresh``.
@ -57,5 +59,5 @@ Deploy Keys
The subscription information is transferred to a medium (see :ref:`sync_medium`) and can then be
activated on the offline system with either ``proxmox-apt-repo offline-key`` or ``proxmox-apt-repo
setup``. This process must be repeated at least once a year or before the nextduedate of the
setup``. This process must be repeated at least once a year or before the next due date of the
subscription key is reached, whichever comes first.