Controls/gitea-pages
0
2
Fork 0
Code Pull Requests Actions Activity

cleanup documentation nomachine

Browse Source
This commit is contained in:
ebner
2024-11-13 16:52:30 +01:00
parent 5252af6dee
commit 19423d4426
7 changed files with 0 additions and 297 deletions
Download Patch File Download Diff File Expand all files Collapse all files
engineering-guide/puppet/profiles/nomachine.rst
-45
View File
@@ -1,45 +0,0 @@
``profile::nomachine``
=======================
Installs and configures a NoMachine server. i
This is the main class. It will configure several settings (license, service), but also
depending on the ``$nomachine_profile`` setting (defined from hiera with
``hiera('nomachine::profile')``), it will trigger different configurations according to
its profile type.
Dependencies
------------
``profile::nomachine`` is invoked from the ``role::base``. In order to be able to install
NoMachine, you must setup the following setting in hiera: ``base::enable_nomachine: true``
Parameters
----------
================== =========================================== =============================
**Name** **Type** **Default**
------------------ ------------------------------------------- -----------------------------
$nomachine_profile Enum['desktop', 'terminal', 'workstation' ] *No default. Must be defined*
================== =========================================== =============================
``nomachine_profile``
~~~~~~~~~~~~~~~~~~~~~
This is the NoMachine profile type. Depending on the profile type, it will call a different
sub-profile:
- ``desktop``:
profile::nomachine::desktop
- ``terminal``:
profile::nomachine::terminal
- ``workstation``:
profile::nomachine::workstation
Each type contains its own specific settings and packages.
engineering-guide/puppet/profiles/nomachine/desktop.rst
-55
View File
@@ -1,55 +0,0 @@
``profile::nomachine::desktop``
===============================
This is a sub-class for ``profile::nomachine``.
Installs and configures NoMachine with profile type ``desktop``.
Dependencies
------------
This is part of the ``profile::nomachine``.
Parameters
----------
==================================== ========= ========================================================================================================================================================================================
**Name** **Type** **Default**
------------------------------------ --------- ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
$nomachine_version String ``hiera('nomachine::desktop::version')``
$server_EnableUPnP String ``hiera('nomachine::desktop::server::EnableUPnP', 'NX')``
$server_ConnectionsLimit Integer ``hiera('nomachine::desktop::server::ConnectionsLimit', 20)``
$server_ConnectionsUserLimit Integer ``hiera('nomachine::desktop::server::ConnectionsUserLimit', 20)``
$server_VirtualDesktopMode Integer ``hiera('nomachine::desktop::server::VirtualDesktopMode', 2)``
$server_VirtualDesktopsLimit Integer ``hiera('nomachine::desktop::server::VirtualDesktopsLimit', 20)``
$server_VirtualDesktopsUserLimit Integer ``hiera('nomachine::desktop::server::VirtualDesktopsUserLimit', 20)``
$server_SSHAuthorizedKeys String ``hiera('nomachine::desktop::server::SSHAuthorizedKeys', 'authorized_keys')``
$server_PhysicalDesktopAuthorization Integer ``hiera('nomachine::desktop::server::PhysicalDesktopAuthorization', 0)``
$server_PhysicalDesktopMode Integer ``hiera('nomachine::desktop::server::PhysicalDesktopMode', 1)``
$server_PhysicalDesktopSharing Integer ``hiera('nomachine::desktop::server::PhysicalDesktopSharing', 1)``
$server_EnableNetworkBroadcast Integer ``hiera('nomachine::desktop::server::EnableNetworkBroadcast', 1)``
$server_AvailableSessionTypes String ``hiera('nomachine::desktop::server::AvailableSessionTypes', 'physical-desktop,shadow')``
$node_DefaultDesktopCommand String ``hiera('nomachine::desktop::node::DefaultDesktopCommand', '"/etc/X11/xinit/Xsession \'gnome-session --session=gnome\'"')``
$node_AvailableSessionTypes String ``hiera('nomachine::desktop::node::AvailableSessionTypes', 'unix-remote,unix-console,unix-default,unix-application,physical-desktop,shadow,unix-xsession-default,unix-gnome,unix-xdm')``
$node_EnableSmartcardSharing Integer ``hiera('nomachine::desktop::node::EnableSmartcardSharing', 1)``
$node_AudioInterface String ``hiera('nomachine::desktop::node::AudioInterface', 'disabled')``
$node_EnableCUPSSupport Integer ``hiera('nomachine::desktop::node::EnableCUPSSupport', 1)``
$node_ClientConnectionMethods String ``hiera('nomachine::desktop::node::ClientConnectionMethods', 'NX,SSH')``
$node_DisplayServerThreads String ``hiera('nomachine::desktop::node::DisplayServerThreads', 'auto')``
$node_DisplayEncoderThreads String ``hiera('nomachine::desktop::node::DisplayEncoderThreads', 'auto')``
==================================== ========= ========================================================================================================================================================================================
``nomachine_version``
~~~~~~~~~~~~~~~~~~~~~
This parameters must be defined. Please see ``common.yaml`` for checking the default value.
``server_*``
~~~~~~~~~~~~
``$server_*`` paremeters are customizable settings for the NoMachine ``server.cfg`` configuration file. Please refer to NoMachine official documentation for more information.
``node_*``
~~~~~~~~~~
``$node_*`` paremeters are customizable settings for the NoMachine ``node.cfg`` configuration file. Please refer to NoMachine official documentation for more information.
engineering-guide/puppet/profiles/nomachine/license.rst
-45
View File
@@ -1,45 +0,0 @@
``profile::nomachine::license``
===============================
This is a sub-class for ``profile::nomachine``.
Installs and configures NoMachine server and node licenses to a specific directory (default ``/etc/NX``).
When licenses are updated, it triggers the activation of the new NoMachine licenses and it deploys them in ``/usr/NX/etc``.
Dependencies
------------
This is part of the ``profile::nomachine``.
Parameters
----------
=========================== ========== ================================================================================================
**Name** **Type** **Default**
--------------------------- ---------- ------------------------------------------------------------------------------------------------
$nomachine_license_location String ``hiera('nomachine::license::location', '/etc/NX')``. Defaults to ``/etc/NX``
$nomachine_license_server String ``hiera("nomachine::license::server::$hostname")``. Must be defined and encrypyed with ``eyaml``
$nomachine_license_node String ``hiera("nomachine::license::node::$hostname")``. Must be defined and encrypyed with ``eyaml``
=========================== ========== ================================================================================================
``nomachine_license_location``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Defaults to ``/etc/NX``. Will be a temporary location for ``node.lic`` and ``server.lic``. **You must avoid to setup ``/usr/NX/etc``**
as the ``nomachine_license_location``. Can be defined in Hiera as ``nomachine::license::location``.
``nomachine_license_server``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
``eyaml`` encrypted ``server.lic``. Must be defined in hiera as ``nomachine::license::server::$hostname``, where ``$hostname`` is the
host shortname of the NoMachine server (equivalent to run ``hostname -s`` from command line).
For more information about encryption with ``eyaml``, please refer to http://linux-infra.gitpages.psi.ch/admin-guide/puppet/hiera.html#secret-values
``nomachine_license_node``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
``eyaml`` encrypted ``node.lic``. Must be defined in hiera as ``nomachine::license::node::$hostname``, where ``$hostname`` is the
host shortname of the NoMachine server (equivalent to run ``hostname -s`` from command line).
For more information about encryption with ``eyaml``, please refer to http://linux-infra.gitpages.psi.ch/admin-guide/puppet/hiera.html#secret-values
engineering-guide/puppet/profiles/nomachine/repository.rst
-20
View File
@@ -1,20 +0,0 @@
``profile::nomachine::repository``
==================================
This is a sub-class for ``profile::nomachine``.
This class just installs and configures a NoMachine repository. Is a very basic class with
no configurable options.
Dependencies
------------
This is part of the ``profile::nomachine``.
Parameters
----------
================== =========================================== =============================
**Name** **Type** **Default**
------------------ ------------------------------------------- -----------------------------
================== =========================================== =============================
engineering-guide/puppet/profiles/nomachine/service.rst
-20
View File
@@ -1,20 +0,0 @@
``profile::nomachine::service``
===============================
This is a sub-class for ``profile::nomachine``.
This class just installs and configures a NoMachine service. Is a very basic class with
no configurable options.
Dependencies
------------
This is part of the ``profile::nomachine``.
Parameters
----------
================== =========================================== =============================
**Name** **Type** **Default**
------------------ ------------------------------------------- -----------------------------
================== =========================================== =============================
engineering-guide/puppet/profiles/nomachine/terminal.rst
-56
View File
@@ -1,56 +0,0 @@
``profile::nomachine::terminal``
================================
This is a sub-class for ``profile::nomachine``.
Installs and configures NoMachine with profile type ``terminal``.
Dependencies
------------
This is part of the ``profile::nomachine``.
Parameters
----------
==================================== ========= ===========================================================================================================================================================================================
**Name** **Type** **Default**
------------------------------------ --------- -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
$nomachine_version String ``hiera('nomachine::terminal::version')``. This is mandatory. See ``common.yaml`` for default value.
$server_EnableUPnP String ``hiera('nomachine::terminal::server::EnableUPnP', 'none')``
$server_ConnectionsLimit Integer ``hiera('nomachine::terminal::server::ConnectionsLimit', 200)``
$server_ConnectionsUserLimit Integer ``hiera('nomachine::terminal::server::ConnectionsUserLimit', 2)``
$server_DisconnectedSessionExpiry Integer ``hiera('nomachine::terminal::server::DisconnectedSessionExpiry', 0)``
$server_VirtualDesktopMode Integer ``hiera('nomachine::terminal::server::VirtualDesktopMode', 0)``
$server_VirtualDesktopsLimit Integer ``hiera('nomachine::terminal::server::VirtualDesktopsLimit', 300)``
$server_VirtualDesktopsUserLimit Integer ``hiera('nomachine::terminal::server::VirtualDesktopsUserLimit', 2)``
$server_SSHAuthorizedKeys String ``hiera('nomachine::terminal::server::SSHAuthorizedKeys', 'authorized_keys')``
$server_PhysicalDesktopAuthorization Integer ``hiera('nomachine::terminal::server::PhysicalDesktopAuthorization', 1)``
$server_PhysicalDesktopMode Integer ``hiera('nomachine::terminal::server::PhysicalDesktopMode', 2)``
$server_PhysicalDesktopSharing Integer ``hiera('nomachine::terminal::server::PhysicalDesktopSharing', 0)``
$server_EnableNetworkBroadcast Integer ``hiera('nomachine::terminal::server::EnableNetworkBroadcast', 0)``
$server_AvailableSessionTypes String ``hiera('nomachine::terminal::server::AvailableSessionTypes', 'unix-remote,unix-console,unix-default,unix-application,physical-desktop,shadow,unix-xsession-default,unix-gnome,unix-xdm')``
$node_DefaultDesktopCommand String ``hiera('nomachine::terminal::node::DefaultDesktopCommand', '"/etc/X11/xinit/Xsession \'gnome-session --session=gnome\'"')``
$node_AvailableSessionTypes String ``hiera('nomachine::terminal::node::AvailableSessionTypes', 'unix-remote,unix-console,unix-default,unix-application,physical-desktop,shadow,unix-xsession-default,unix-gnome,unix-xdm')``
$node_EnableSmartcardSharing Integer ``hiera('nomachine::terminal::node::EnableSmartcardSharing', 1)``
$node_AudioInterface String ``hiera('nomachine::terminal::node::AudioInterface', 'disabled')``
$node_EnableCUPSSupport Integer ``hiera('nomachine::terminal::node::EnableCUPSSupport', 1)``
$node_ClientConnectionMethods String ``hiera('nomachine::terminal::node::ClientConnectionMethods', 'NX,SSH')``
$node_DisplayServerThreads String ``hiera('nomachine::terminal::node::DisplayServerThreads', 'auto')``
$node_DisplayEncoderThreads String ``hiera('nomachine::terminal::node::DisplayEncoderThreads', 'auto')``
==================================== ========= ===========================================================================================================================================================================================
``nomachine_version``
~~~~~~~~~~~~~~~~~~~~~
This parameters must be defined. Please see ``common.yaml`` for checking the default value.
``server_*``
~~~~~~~~~~~~
``$server_*`` paremeters are customizable settings for the NoMachine ``server.cfg`` configuration file. Please refer to NoMachine official documentation for more information.
``node_*``
~~~~~~~~~~
``$node_*`` paremeters are customizable settings for the NoMachine ``node.cfg`` configuration file. Please refer to NoMachine official documentation for more information.
engineering-guide/puppet/profiles/nomachine/workstation.rst
-56
View File
@@ -1,56 +0,0 @@
``profile::nomachine::workstation``
===================================
This is a sub-class for ``profile::nomachine``.
Installs and configures NoMachine with profile type ``workstation``.
Dependencies
------------
This is part of the ``profile::nomachine``.
Parameters
----------
==================================== ========= ===============================================================================================================================
**Name** **Type** **Default**
------------------------------------ --------- -------------------------------------------------------------------------------------------------------------------------------
$nomachine_version String ``hiera('nomachine::workstation::version')``
$server_EnableUPnP String ``hiera('nomachine::workstation::server::EnableUPnP', 'NX')``
$server_ConnectionsLimit Integer ``hiera('nomachine::workstation::server::ConnectionsLimit', 20)``
$server_ConnectionsUserLimit Integer ``hiera('nomachine::workstation::server::ConnectionsUserLimit', 20)``
$server_VirtualDesktopMode Integer ``hiera('nomachine::workstation::server::VirtualDesktopMode', 2)``
$server_VirtualDesktopsLimit Integer ``hiera('nomachine::workstation::server::VirtualDesktopsLimit', 20)``
$server_VirtualDesktopsUserLimit Integer ``hiera('nomachine::workstation::server::VirtualDesktopsUserLimit', 20)``
$server_SSHAuthorizedKeys String ``hiera('nomachine::workstation::server::SSHAuthorizedKeys', 'authorized_keys')``
$server_PhysicalDesktopAuthorization Integer ``hiera('nomachine::workstation::server::PhysicalDesktopAuthorization', 0)``
$server_PhysicalDesktopMode Integer ``hiera('nomachine::workstation::server::PhysicalDesktopMode', 1)``
$server_PhysicalDesktopSharing Integer ``hiera('nomachine::workstation::server::PhysicalDesktopSharing', 2)``
$server_EnableNetworkBroadcast Integer ``hiera('nomachine::workstation::server::EnableNetworkBroadcast', 1)``
$server_AvailableSessionTypes String ``hiera('nomachine::workstation::server::AvailableSessionTypes', 'shadow,unix-xsession-default')``
$node_DefaultDesktopCommand String ``hiera('nomachine::workstation::node::DefaultDesktopCommand', '"/etc/X11/xinit/Xsession \'gnome-session --session=gnome\'"')``
$node_AvailableSessionTypes String ``hiera('nomachine::workstation::node::AvailableSessionTypes', 'shadow,unix-xsession-default')``
$node_EnableSmartcardSharing Integer ``hiera('nomachine::workstation::node::EnableSmartcardSharing', 1)``
$node_AudioInterface String ``hiera('nomachine::workstation::node::AudioInterface', 'disabled')``
$node_EnableCUPSSupport Integer ``hiera('nomachine::workstation::node::EnableCUPSSupport', 1)``
$node_ClientConnectionMethods String ``hiera('nomachine::workstation::node::ClientConnectionMethods', 'NX,SSH')``
$node_DisplayServerThreads String ``hiera('nomachine::workstation::node::DisplayServerThreads', 'auto')``
$node_DisplayEncoderThreads String ``hiera('nomachine::workstation::node::DisplayEncoderThreads', 'auto')``
==================================== ========= ===============================================================================================================================
``nomachine_version``
~~~~~~~~~~~~~~~~~~~~~
This parameters must be defined. Please see ``common.yaml`` for checking the default value.
``server_*``
~~~~~~~~~~~~
``$server_*`` paremeters are customizable settings for the NoMachine ``server.cfg`` configuration file. Please refer to NoMachine official documentation for more information.
``node_*``
~~~~~~~~~~
``$node_*`` paremeters are customizable settings for the NoMachine ``node.cfg`` configuration file. Please refer to NoMachine official documentation for more information.