From 575fc4b58ad6a02a6317315a2c4b7bc9e8319551 Mon Sep 17 00:00:00 2001 From: James Adams Date: Fri, 21 May 2021 16:00:57 +0000 Subject: [PATCH] Release 21.4.0 documentation --- docs/CAF/CAF_TextRender.rst | 114 +++--- docs/CCM/EDG_WP4_CCM_TextRender.rst | 350 ++++++++--------- .../NCM_Component_authconfig_sssd.rst | 3 +- ...Component_metaconfig_conntrackd_schema.rst | 2 +- ...CM_Component_metaconfig_haproxy_schema.rst | 22 ++ .../NCM_Component_metaconfig_httpd_schema.rst | 4 + ...mponent_metaconfig_logstash_schema_7.0.rst | 50 ++- ...NCM_Component_metaconfig_mailrc_schema.rst | 3 + .../NCM_Component_metaconfig_nginx_schema.rst | 3 + ...M_Component_metaconfig_rsyslog_actions.rst | 2 +- ...CM_Component_metaconfig_rsyslog_inputs.rst | 36 ++ .../NCM_Component_metaconfig_schema.rst | 27 ++ .../NCM_Component_metaconfig_slurm_schema.rst | 136 ++++++- .../NCM_Component_network_core-schema.rst | 21 + docs/components/NCM_Component_opennebula.rst | 6 +- .../NCM_Component_opennebula_common.rst | 102 +++++ .../NCM_Component_opennebula_monitord.rst | 92 +++++ .../NCM_Component_opennebula_schema.rst | 360 +++++++++++++----- .../NCM_Component_postgresql_schema.rst | 12 + docs/components/NCM_Component_sudo_schema.rst | 2 +- .../NCM_Component_systemd_schema.rst | 171 +++++++++ .../aii_opennebula_schema.rst | 17 + .../functions_hardware.rst | 3 + 23 files changed, 1207 insertions(+), 331 deletions(-) create mode 100644 docs/components/NCM_Component_opennebula_common.rst create mode 100644 docs/components/NCM_Component_opennebula_monitord.rst diff --git a/docs/CAF/CAF_TextRender.rst b/docs/CAF/CAF_TextRender.rst index ae27b24..3320d1f 100644 --- a/docs/CAF/CAF_TextRender.rst +++ b/docs/CAF/CAF_TextRender.rst @@ -21,11 +21,11 @@ SYNOPSIS .. code-block:: perl use CAF::TextRender; - + my $module = 'tiny'; my $trd = CAF::TextRender->new($module, $contents, log => $self); print "$trd"; # stringification - + $module = "yaml"; $trd = CAF::TextRender->new($module, $contents, log => $self); # return CAF::FileWriter instance (rendered text already added) @@ -49,95 +49,105 @@ Private methods - ``_initialize`` - + Initialize the process object. Arguments: - - + + - ``module`` - + The rendering module to use: either one of the following reserved values - - + + - json - - JSON format (using ``JSON::XS``) (JSON true and false have to be resp. ``\1`` and c<\0>) - - - + + JSON format (using ``JSON::XS``) (JSON true and false have to be resp. ``\1`` and ``\0``) + + + - yaml - + YAML (using ``YAML::XS``) (YAML true and false, either resp. ``<$YAML_BOOL-``{yes}>> and ``$YAML_BOOL->{no}``; or the strings ``$YAML_BOOL_PREFIX."true"`` and ``$YAML_BOOL_PREFIX."false"`` (There are known problems with creating hashrefs using the ``$YAML_BOOL->{yes}`` value for true; Perl seems to mess up the structure when creating the hashrefs)) - - - + + + + - yamlmulti + + Multi-document YAML, the keys of the passed contents are sorted and + the list of the corresponding values is used to generate the multi-document YAML. + (The keys are only used for sorting) + + See ``yaml`` module for details on handling booleans. + + + - properties - + Java properties format (using ``Config::Properties``), - - - + + + - tiny - + .INI format (using ``Config::Tiny``) - - - + + + (Previously available module was removed in 15.12. Component writers needing this functionality can use the \ **CCM::TextRender**\ subclass instead). - + Or, for any other value, ``Template::Toolkit`` is used, and the ``module`` then indicates the relative path of the template to use. - - - + + + - ``contents`` - + ``contents`` is a hash reference holding the contents to pass to the rendering module. - - - + + + It takes some extra optional arguments: - - + + - ``log``, ``eol`` and ``usecache`` - - Handled by ``_initialize_textopts`` from \ **CAF::ObjectText**\ - - - + + Handled by ``_initialize_textopts`` from \ **CAF::ObjectText**\ + + + - ``includepath`` - + The basedirectory for TT template files, and the INCLUDE_PATH for the Template instance. The ``includepath`` is either a string (i.e. ':'-separated list of paths), an arrayref (of multiple include paths) or undef (the default '/usr/share/templates/quattor' is used). - - - + + + - ``relpath`` - + The relative path w.r.t. the includepath to look for TT template files. This relative path should not be part of the module name, however it is not the INCLUDE_PATH. (In particular, any TT ``INCLUDE`` statement has to use it as the relative basepath). If ``relpath`` is undefined, the default 'metaconfig' is used. If you do not have a subdirectory in the includepath, use an empty string. - - - + + + - ``ttoptions`` - + A hash-reference ``ttoptions`` with Template Toolkit options, except for INCLUDE_PATH which is forced via ``includepath`` option. By default, STRICT (default 0) and RECURSION (default 1) are set. - - - + + + diff --git a/docs/CCM/EDG_WP4_CCM_TextRender.rst b/docs/CCM/EDG_WP4_CCM_TextRender.rst index 8572f74..3a8697c 100644 --- a/docs/CCM/EDG_WP4_CCM_TextRender.rst +++ b/docs/CCM/EDG_WP4_CCM_TextRender.rst @@ -26,74 +26,74 @@ Private methods - ``_initialize`` - + Initialize the process object. Arguments: - - + + - module - + The rendering module to use (see \ **CAF::TextRender**\ for details). - + CCM provides following additional builtin modules: - - + + - general - + using TT to render a ``Config::General`` compatible file. (This is an alias for the ``CCM/general`` TT module). - + Contents is a hashref (does not require a ``Element`` instance), with key/value pairs generated according to the basetype of the value as follows: - - + + - scalar - + converted in a single line - - + + .. code-block:: perl - + - - - - + + + + - arrayref of scalars - + converted in multiple lines as follows - - + + .. code-block:: perl - + ... - - - - + + + + - hashref - + generates a block with format - - + + .. code-block:: perl - + <"key"> - - - - + + + + - arrayref of hashref - + generates series of blocks - - + + .. code-block:: perl - + <"key"> @@ -101,234 +101,236 @@ Private methods ... - - - - + + + + (Whitespace in the block name is enforced with double quotes.) - - - - - + + + + + - contents - + ``contents`` is either a hash reference holding the contents to pass to the rendering module; or a ``EDG::WP4::CCM::CacheManager::Element`` instance, on which ``getTree`` is called with any ``element`` options. - - - + + + All optional arguments from ``CAF::TextRender`` are supported unmodified: - - + + - log - - - + + + - includepath - - - + + + - relpath - - - + + + - eol - - - + + + - usecache - - - + + + - ttoptions - - - + + + Extra optional arguments: - - + + - element - + A hashref holding any ``getTree`` options to pass. These can be the anonymous convert methods ``convert_boolean``, ``convert_string``, ``convert_long`` and ``convert_double``; or one of the predefined convert methods (key is the name, value a boolean wheter or not to use them). - + The ``convert_`` methods are added as last methods. - + The predefined convert methods are: - - + + - cast - + Convert the scalar values to a more exact internal representation. The internal representaiton is important when passed on to other non-pure perl code, in particular the ``XS`` modules like ``JSON::XS`` and ``YAML::XS``. - - - + + + - json - + Enable JSON output, in particular JSON boolean (``cast`` is implied, so the other types should already be in proper format). This is automatically enabled when the json module is used (and not explicitly set). - - - + + + - yaml - + Enable YAML output, in particular YAML boolean (``cast`` is implied, so the other types should already be in proper format). - This is automatically enabled when the yaml + This is automatically enabled when the yaml or yamlmulti module is used (and not explicitly set). - - - + + + - yesno - + Convert boolean to (lowercase) 'yes' and 'no'. - - - + + + - YESNO - + Convert boolean to (uppercase) 'YES' and 'NO'. - - - + + + - truefalse - + Convert boolean to (lowercase) 'true' and 'false'. - - - + + + - TRUEFALSE - + Convert boolean to (uppercase) 'TRUE' and 'FALSE'. - - - + + + - doublequote - + Convert string to doublequoted string. - - - + + + - singlequote - + Convert string to singlequoted string. - - - + + + - joincomma - + Convert list of scalars in comma-separated list of strings (if first element is scalar). List where first element is non-scalar is not converted (but any of the nested list could). - - - + + + - joinspace - + Convert list of scalars in space-separated list of strings (if first element is scalar). List where first element is non-scalar is not converted (but any of the nested list could). - + Caveat: is preceded by ``joincomma`` option. - - - + + + - unescapekey - + Unescape all dict keys. - - - + + + - lowerkey - + Convert all dict keys to lowercase. - - - + + + - upperkey - + Convert all dict keys to uppercase. - - - + + + Other ``getTree`` options - - + + - depth - + Only return the next ``depth`` levels of nesting (and use the Element instances as values). A ``depth == 0`` is the element itself, ``depth == 1`` is the first level, ... - + + The depth is shifted one level when the yamlmulti module is used. + Default or depth ``undef`` returns all levels. - - - - - + + + + + - ccm_format - + Returns the CCM::TextRender instance for predefined ``format`` and ``element``. All options are passed to CCM::TextRender initialisation. Returns undef incase the format is not defined. An array with valid formats is exported via ``@CCM_FORMATS``. - + Supported formats are: - - + + - json - - - + + + - jsonpretty - - - + + + - pan - - - + + + - pancxml - - - + + + - query - - - + + + - yaml - - - + + + Usage example: - - + + .. code-block:: perl - + use EDG::WP4::CCM::TextRender qw(ccm_format); my $format = 'json'; my $element = $config->getElement("/"); my $trd = ccm_format($format, $element); - + if (defined $trd->get_text()) { print "$trd"; } else { $logger->error("Failed to textrender format $format: $trd->{fail}") } - - + + diff --git a/docs/components/NCM_Component_authconfig_sssd.rst b/docs/components/NCM_Component_authconfig_sssd.rst index aea83ee..054cdd4 100644 --- a/docs/components/NCM_Component_authconfig_sssd.rst +++ b/docs/components/NCM_Component_authconfig_sssd.rst @@ -246,9 +246,8 @@ Types - Type: long - Default value: 10 - */software/components/authconfig/authconfig_sssd_domain/force_timeout* - - Required + - Optional - Type: long - - Default value: 60 - */software/components/authconfig/authconfig_sssd_domain/entry_cache_timeout* - Required - Type: long diff --git a/docs/components/NCM_Component_metaconfig_conntrackd_schema.rst b/docs/components/NCM_Component_metaconfig_conntrackd_schema.rst index 9c26dc5..559e6e0 100644 --- a/docs/components/NCM_Component_metaconfig_conntrackd_schema.rst +++ b/docs/components/NCM_Component_metaconfig_conntrackd_schema.rst @@ -68,7 +68,7 @@ Types - Required - Type: conntrackd_service_sync_transport - **/software/components/metaconfig/conntrackd_service_general_unix** - - Description: Unix socket configuration. This socket is used by conntrackd to listen to external commands like `conntrackd -k` or `conntrackd -n`. + - Description: Unix socket configuration. This socket is used by conntrackd to listen to external commands like `conntrackd -k' or `conntrackd -n'. - */software/components/metaconfig/conntrackd_service_general_unix/Path* - Required - Type: string diff --git a/docs/components/NCM_Component_metaconfig_haproxy_schema.rst b/docs/components/NCM_Component_metaconfig_haproxy_schema.rst index a6d5a73..947c9cd 100644 --- a/docs/components/NCM_Component_metaconfig_haproxy_schema.rst +++ b/docs/components/NCM_Component_metaconfig_haproxy_schema.rst @@ -56,6 +56,9 @@ Types - */software/components/metaconfig/haproxy_service_global_config/ssl-default-server-options* - Optional - Type: string + - */software/components/metaconfig/haproxy_service_global_config/ssl-dh-param-file* + - Optional + - Type: absolute_file_path - **/software/components/metaconfig/haproxy_service_global_stats** - Description: options for the stats line in the Global section - */software/components/metaconfig/haproxy_service_global_stats/socket* @@ -274,6 +277,11 @@ Types - Description: interface to bind on - Optional - Type: string + - */software/components/metaconfig/haproxy_service_bind_server_params/alpn* + - Description: enable the TLS ALPN extension + - Optional + - Type: string + - Default value: h2,http/1.1 - **/software/components/metaconfig/haproxy_service_server_params** - */software/components/metaconfig/haproxy_service_server_params/check* - Description: enable health check @@ -326,6 +334,17 @@ Types - */software/components/metaconfig/haproxy_service_backend_server/params* - Optional - Type: haproxy_service_server_params + - **/software/components/metaconfig/haproxy_service_http_check** + - Description: configure 'http-check expect [!] match pattern' + - */software/components/metaconfig/haproxy_service_http_check/inverse* + - Optional + - Type: boolean + - */software/components/metaconfig/haproxy_service_http_check/match* + - Required + - Type: choice + - */software/components/metaconfig/haproxy_service_http_check/pattern* + - Required + - Type: string - **/software/components/metaconfig/haproxy_service_backend** - */software/components/metaconfig/haproxy_service_backend/balance* - Optional @@ -336,6 +355,9 @@ Types - */software/components/metaconfig/haproxy_service_backend/options* - Optional - Type: string + - */software/components/metaconfig/haproxy_service_backend/httpcheck* + - Optional + - Type: haproxy_service_http_check - */software/components/metaconfig/haproxy_service_backend/tcpchecks* - Optional - Type: string diff --git a/docs/components/NCM_Component_metaconfig_httpd_schema.rst b/docs/components/NCM_Component_metaconfig_httpd_schema.rst index aa7c7f5..b696dd4 100644 --- a/docs/components/NCM_Component_metaconfig_httpd_schema.rst +++ b/docs/components/NCM_Component_metaconfig_httpd_schema.rst @@ -9,6 +9,7 @@ Types - **/software/components/metaconfig/httpd_ciphersuite** - **/software/components/metaconfig/httpd_nss_protocol** - **/software/components/metaconfig/httpd_nss_cipherstring** + - **/software/components/metaconfig/httpd_protocols** - **/software/components/metaconfig/httpd_option_plusminus_none** - Description: Either all Options must start with + or -, or no Option may. - **/software/components/metaconfig/httpd_gssapi_credstore** @@ -990,6 +991,9 @@ Types - */software/components/metaconfig/httpd_vhost/header* - Optional - Type: httpd_header + - */software/components/metaconfig/httpd_vhost/protocols* + - Optional + - Type: httpd_protocols - **/software/components/metaconfig/httpd_global_shared** - */software/components/metaconfig/httpd_global_shared/directoryindex* - Optional diff --git a/docs/components/NCM_Component_metaconfig_logstash_schema_7.0.rst b/docs/components/NCM_Component_metaconfig_logstash_schema_7.0.rst index bb07994..7ca7361 100644 --- a/docs/components/NCM_Component_metaconfig_logstash_schema_7.0.rst +++ b/docs/components/NCM_Component_metaconfig_logstash_schema_7.0.rst @@ -413,6 +413,24 @@ Types - */software/components/metaconfig/logstash_filter_grok/patterns_dir* - Optional - Type: string + - */software/components/metaconfig/logstash_filter_grok/overwrite* + - Optional + - Type: string + - */software/components/metaconfig/logstash_filter_grok/tag_on_failure* + - Optional + - Type: string + - */software/components/metaconfig/logstash_filter_grok/tag_on_timeout* + - Optional + - Type: string + - */software/components/metaconfig/logstash_filter_grok/timeout_millis* + - Optional + - Type: long + - */software/components/metaconfig/logstash_filter_grok/timeout_scope* + - Optional + - Type: choice + - */software/components/metaconfig/logstash_filter_grok/target* + - Optional + - Type: string - **/software/components/metaconfig/logstash_filter_bytes2human** - */software/components/metaconfig/logstash_filter_bytes2human/convert* - Required @@ -458,6 +476,9 @@ Types - */software/components/metaconfig/logstash_filter_mutate/update* - Optional - Type: string + - */software/components/metaconfig/logstash_filter_mutate/strip* + - Optional + - Type: string - */software/components/metaconfig/logstash_filter_mutate/exclude_tags* - Optional - Type: string @@ -480,10 +501,10 @@ Types - */software/components/metaconfig/logstash_filter_kv/target* - Optional - Type: string - - */software/components/metaconfig/logstash_filter_kv/trim* + - */software/components/metaconfig/logstash_filter_kv/trim_value* - Optional - Type: string - - */software/components/metaconfig/logstash_filter_kv/trimkey* + - */software/components/metaconfig/logstash_filter_kv/trim_key* - Optional - Type: string - */software/components/metaconfig/logstash_filter_kv/value_split* @@ -499,6 +520,28 @@ Types - */software/components/metaconfig/logstash_filter_json/remove_field* - Optional - Type: string + - **/software/components/metaconfig/logstash_filter_geoip** + - */software/components/metaconfig/logstash_filter_geoip/cache_size* + - Optional + - Type: long + - */software/components/metaconfig/logstash_filter_geoip/database* + - Optional + - Type: absolute_file_path + - */software/components/metaconfig/logstash_filter_geoip/default_database_type* + - Optional + - Type: choice + - */software/components/metaconfig/logstash_filter_geoip/fields* + - Optional + - Type: string + - */software/components/metaconfig/logstash_filter_geoip/source* + - Required + - Type: string + - */software/components/metaconfig/logstash_filter_geoip/tag_on_failure* + - Optional + - Type: string + - */software/components/metaconfig/logstash_filter_geoip/target* + - Optional + - Type: string - **/software/components/metaconfig/logstash_filter_plugin** - */software/components/metaconfig/logstash_filter_plugin/grok* - Optional @@ -524,6 +567,9 @@ Types - */software/components/metaconfig/logstash_filter_plugin/json* - Optional - Type: logstash_filter_json + - */software/components/metaconfig/logstash_filter_plugin/geoip* + - Optional + - Type: logstash_filter_geoip - **/software/components/metaconfig/logstash_output_codec** - Description: Common output - */software/components/metaconfig/logstash_output_codec/plain* diff --git a/docs/components/NCM_Component_metaconfig_mailrc_schema.rst b/docs/components/NCM_Component_metaconfig_mailrc_schema.rst index 0e8d57d..16cc106 100644 --- a/docs/components/NCM_Component_metaconfig_mailrc_schema.rst +++ b/docs/components/NCM_Component_metaconfig_mailrc_schema.rst @@ -24,6 +24,9 @@ Types - */software/components/metaconfig/mailrc_element/nss-config-dir* - Optional - Type: string + - */software/components/metaconfig/mailrc_element/ssl-verify* + - Optional + - Type: choice - **/software/components/metaconfig/mailrc_config** - */software/components/metaconfig/mailrc_config/account* - Optional diff --git a/docs/components/NCM_Component_metaconfig_nginx_schema.rst b/docs/components/NCM_Component_metaconfig_nginx_schema.rst index 39512d0..795e8b7 100644 --- a/docs/components/NCM_Component_metaconfig_nginx_schema.rst +++ b/docs/components/NCM_Component_metaconfig_nginx_schema.rst @@ -71,6 +71,9 @@ Types - */software/components/metaconfig/httpd_ssl/session_cache* - Optional - Type: string + - */software/components/metaconfig/httpd_ssl/dhparam* + - Optional + - Type: absolute_file_path - **/software/components/metaconfig/nginx_global** - Description: Basic nginx declarations. So far we only need to declare how many processes and how many connections per process. - */software/components/metaconfig/nginx_global/worker_processes* diff --git a/docs/components/NCM_Component_metaconfig_rsyslog_actions.rst b/docs/components/NCM_Component_metaconfig_rsyslog_actions.rst index 8b43750..5736c84 100644 --- a/docs/components/NCM_Component_metaconfig_rsyslog_actions.rst +++ b/docs/components/NCM_Component_metaconfig_rsyslog_actions.rst @@ -102,7 +102,7 @@ Types - Type: absolute_file_path - */software/components/metaconfig/rsyslog_action_file/dynaFile* - Optional - - Type: absolute_file_path + - Type: string - */software/components/metaconfig/rsyslog_action_file/closeTimeout* - Optional - Type: long diff --git a/docs/components/NCM_Component_metaconfig_rsyslog_inputs.rst b/docs/components/NCM_Component_metaconfig_rsyslog_inputs.rst index 9f667f9..afe5d99 100644 --- a/docs/components/NCM_Component_metaconfig_rsyslog_inputs.rst +++ b/docs/components/NCM_Component_metaconfig_rsyslog_inputs.rst @@ -422,6 +422,39 @@ Types - */software/components/metaconfig/rsyslog_module_journal/IgnoreNonValidStatefile* - Optional - Type: boolean + - **/software/components/metaconfig/rsyslog_module_pstats** + - */software/components/metaconfig/rsyslog_module_pstats/Interval* + - Optional + - Type: long + - Range: 0.. + - Default value: 300 + - */software/components/metaconfig/rsyslog_module_pstats/Facility* + - Optional + - Type: long + - Range: 1..9 + - Default value: 5 + - */software/components/metaconfig/rsyslog_module_pstats/Severity* + - Optional + - Type: long + - Range: 1..9 + - Default value: 6 + - */software/components/metaconfig/rsyslog_module_pstats/ResetCounters* + - Optional + - Type: boolean + - */software/components/metaconfig/rsyslog_module_pstats/Format* + - Optional + - Type: choice + - Default value: legacy + - */software/components/metaconfig/rsyslog_module_pstats/log.syslog* + - Optional + - Type: boolean + - Default value: true + - */software/components/metaconfig/rsyslog_module_pstats/log.file* + - Optional + - Type: absolute_file_path + - */software/components/metaconfig/rsyslog_module_pstats/Bracketing* + - Optional + - Type: boolean - **/software/components/metaconfig/rsyslog_module_input** - */software/components/metaconfig/rsyslog_module_input/file* - Optional @@ -445,3 +478,6 @@ Types - */software/components/metaconfig/rsyslog_module_input/journal* - Optional - Type: rsyslog_module_journal + - */software/components/metaconfig/rsyslog_module_input/pstats* + - Optional + - Type: rsyslog_module_pstats diff --git a/docs/components/NCM_Component_metaconfig_schema.rst b/docs/components/NCM_Component_metaconfig_schema.rst index e013537..eb2b1ab 100644 --- a/docs/components/NCM_Component_metaconfig_schema.rst +++ b/docs/components/NCM_Component_metaconfig_schema.rst @@ -53,6 +53,23 @@ Types - Optional - Type: boolean - **/software/components/metaconfig/caf_service_action** + - **/software/components/metaconfig/metaconfig_actions** + - */software/components/metaconfig/metaconfig_actions/pre* + - Description: Always run, happens before possible modifications. A failure will cancel any file modification, unless the command is prefixed with -. + - Optional + - Type: string + - */software/components/metaconfig/metaconfig_actions/test* + - Description: Always run before possible modifications with the new (or unchanged) file content is passed on stdin. A failure will cancel any file modification, unless the command is prefixed with -. Runs with 'keeps_state' enabled, so do not modify anything with this command. + - Optional + - Type: string + - */software/components/metaconfig/metaconfig_actions/changed* + - Description: Only run after file is modified, but before any daemon action is executed. A failure in this command has no effect on whether the daemon action is executed later. + - Optional + - Type: string + - */software/components/metaconfig/metaconfig_actions/post* + - Description: Always run, regardless of whether file was modified or not, and after the 'changed' action but before any daemon action. A failure of this command has no effect on the subsequent daemon action. + - Optional + - Type: string - **/software/components/metaconfig/metaconfig_config** - */software/components/metaconfig/metaconfig_config/mode* - Description: File permissions. Defaults to 0644. @@ -93,7 +110,17 @@ Types - Description: Predefined conversions from EDG::WP4::CCM::TextRender - Optional - Type: metaconfig_textrender_convert + - */software/components/metaconfig/metaconfig_config/actions* + - Description: Actions (i.e. names found in /software/components/metadata/commands) to run when processing the service. Refer to the metaconfig_actions type definition for the available hooks for when a command may be run. + - Optional + - Type: metaconfig_actions + - **/software/components/metaconfig/metaconfig_command** + - Description: Command must start with absolute path to executable. If the executable is preceded with a '-', it means that a non-zero exit code (i.e. failure) is treated as success w.r.t. reporting and continuation. - **/software/components/metaconfig/metaconfig_component** - */software/components/metaconfig/metaconfig_component/services* - Required - Type: metaconfig_config + - */software/components/metaconfig/metaconfig_component/commands* + - Description: Command registry for allowed actions, keys should be used as action value + - Optional + - Type: metaconfig_command diff --git a/docs/components/NCM_Component_metaconfig_slurm_schema.rst b/docs/components/NCM_Component_metaconfig_slurm_schema.rst index 02567ec..229cea2 100644 --- a/docs/components/NCM_Component_metaconfig_slurm_schema.rst +++ b/docs/components/NCM_Component_metaconfig_slurm_schema.rst @@ -204,7 +204,7 @@ Types - Optional - Type: long - Range: 0.. - - */software/components/metaconfig/slurm_scheduler_parameters/default_queue_depth* + - */software/components/metaconfig/slurm_scheduler_parameters/default_5fqueue_5fdepth* - Optional - Type: long - Range: 0.. @@ -234,7 +234,7 @@ Types - Optional - Type: long - Range: 0.. - - */software/components/metaconfig/slurm_scheduler_parameters/kill_invalid_depend* + - */software/components/metaconfig/slurm_scheduler_parameters/kill_5finvalid_5fdepend* - Optional - Type: boolean - */software/components/metaconfig/slurm_scheduler_parameters/max_array_tasks* @@ -440,12 +440,21 @@ Types - */software/components/metaconfig/slurm_launch_params/cray_net_exclusive* - Optional - Type: boolean + - */software/components/metaconfig/slurm_launch_params/disable_send_gids* + - Optional + - Type: boolean + - */software/components/metaconfig/slurm_launch_params/enable_nss_slurm* + - Optional + - Type: boolean - */software/components/metaconfig/slurm_launch_params/lustre_no_flush* - Optional - Type: boolean - */software/components/metaconfig/slurm_launch_params/mem_sort* - Optional - Type: boolean + - */software/components/metaconfig/slurm_launch_params/mpir_use_nodeaddr* + - Optional + - Type: boolean - */software/components/metaconfig/slurm_launch_params/send_gids* - Optional - Type: boolean @@ -458,11 +467,27 @@ Types - */software/components/metaconfig/slurm_launch_params/test_exec* - Optional - Type: boolean + - */software/components/metaconfig/slurm_launch_params/use_interactive_step* + - Optional + - Type: boolean + - **/software/components/metaconfig/slurm_authalt_params** + - */software/components/metaconfig/slurm_authalt_params/disable_token_creation* + - Optional + - Type: boolean + - */software/components/metaconfig/slurm_authalt_params/jwt_key* + - Optional + - Type: absolute_file_path - **/software/components/metaconfig/slurm_conf_control** - */software/components/metaconfig/slurm_conf_control/AllowSpecResourcesUsage* - Optional - Type: long - Range: 0..1 + - */software/components/metaconfig/slurm_conf_control/AuthAltParameters* + - Optional + - Type: slurm_authalt_params + - */software/components/metaconfig/slurm_conf_control/AuthAltTypes* + - Optional + - Type: choice - */software/components/metaconfig/slurm_conf_control/AuthInfo* - Optional - Type: string @@ -484,6 +509,9 @@ Types - */software/components/metaconfig/slurm_conf_control/ChosLoc* - Optional - Type: absolute_file_path + - */software/components/metaconfig/slurm_conf_control/CliFilterPlugins* + - Optional + - Type: string - */software/components/metaconfig/slurm_conf_control/ClusterName* - Required - Type: string @@ -777,6 +805,42 @@ Types - */software/components/metaconfig/slurm_conf_prolog_epilog/TaskProlog* - Optional - Type: absolute_file_path + - **/software/components/metaconfig/slurm_ctld_parameters** + - */software/components/metaconfig/slurm_ctld_parameters/allow_user_triggers* + - Optional + - Type: boolean + - */software/components/metaconfig/slurm_ctld_parameters/cloud_dns* + - Optional + - Type: boolean + - */software/components/metaconfig/slurm_ctld_parameters/cloud_reg_addrs* + - Optional + - Type: boolean + - */software/components/metaconfig/slurm_ctld_parameters/enable_configless* + - Optional + - Type: boolean + - */software/components/metaconfig/slurm_ctld_parameters/idle_on_node_suspend* + - Optional + - Type: boolean + - */software/components/metaconfig/slurm_ctld_parameters/power_save_interval* + - Optional + - Type: long + - Range: 0.. + - */software/components/metaconfig/slurm_ctld_parameters/power_save_min_interval* + - Optional + - Type: long + - Range: 0.. + - */software/components/metaconfig/slurm_ctld_parameters/max_dbd_msg_action* + - Optional + - Type: choice + - */software/components/metaconfig/slurm_ctld_parameters/preempt_send_user_signal* + - Optional + - Type: boolean + - */software/components/metaconfig/slurm_ctld_parameters/reboot_from_controller* + - Optional + - Type: boolean + - */software/components/metaconfig/slurm_ctld_parameters/user_resv_delete* + - Optional + - Type: boolean - **/software/components/metaconfig/slurm_conf_process** - */software/components/metaconfig/slurm_conf_process/MCSParameters* - Optional @@ -796,6 +860,9 @@ Types - */software/components/metaconfig/slurm_conf_process/SlurmdUser* - Optional - Type: string + - */software/components/metaconfig/slurm_conf_process/SlurmctldParameters* + - Optional + - Type: slurm_ctld_parameters - */software/components/metaconfig/slurm_conf_process/SlurmctldPidFile* - Optional - Type: absolute_file_path @@ -1607,6 +1674,12 @@ Types - */software/components/metaconfig/slurm_dbd_conf/ArchiveUsage* - Optional - Type: boolean + - */software/components/metaconfig/slurm_dbd_conf/AuthAltParameters* + - Optional + - Type: slurm_authalt_params + - */software/components/metaconfig/slurm_dbd_conf/AuthAltTypes* + - Optional + - Type: choice - */software/components/metaconfig/slurm_dbd_conf/AuthInfo* - Optional - Type: string @@ -1735,3 +1808,62 @@ Types - */software/components/metaconfig/slurm_dbd_conf/TrackSlurmctldDown* - Optional - Type: boolean + - **/software/components/metaconfig/slurm_job_container_per_node_conf** + - */software/components/metaconfig/slurm_job_container_per_node_conf/AutoBasePath* + - Optional + - Type: boolean + - */software/components/metaconfig/slurm_job_container_per_node_conf/Basepath* + - Optional + - Type: absolute_file_path + - */software/components/metaconfig/slurm_job_container_per_node_conf/InitScript* + - Optional + - Type: absolute_file_path + - **/software/components/metaconfig/slurm_job_container_node_conf** + - */software/components/metaconfig/slurm_job_container_node_conf/NodeName* + - Required + - Type: string + - **/software/components/metaconfig/slurm_job_container_conf** + - */software/components/metaconfig/slurm_job_container_conf/Default* + - Optional + - Type: slurm_job_container_per_node_conf + - */software/components/metaconfig/slurm_job_container_conf/Nodes* + - Optional + - Type: slurm_job_container_node_conf + - **/software/components/metaconfig/slurm_gres_autodetect_conf** + - */software/components/metaconfig/slurm_gres_autodetect_conf/AutoDetect* + - Optional + - Type: choice + - **/software/components/metaconfig/slurm_gres_per_node_conf** + - */software/components/metaconfig/slurm_gres_per_node_conf/NodeName* + - Required + - Type: string + - */software/components/metaconfig/slurm_gres_per_node_conf/Cores* + - Optional + - Type: long + - */software/components/metaconfig/slurm_gres_per_node_conf/Count* + - Optional + - Type: long + - Range: 0.. + - */software/components/metaconfig/slurm_gres_per_node_conf/File* + - Optional + - Type: absolute_file_path + - */software/components/metaconfig/slurm_gres_per_node_conf/Flags* + - Optional + - Type: choice + - */software/components/metaconfig/slurm_gres_per_node_conf/Links* + - Optional + - Type: long + - Range: 0.. + - */software/components/metaconfig/slurm_gres_per_node_conf/Name* + - Optional + - Type: choice + - */software/components/metaconfig/slurm_gres_per_node_conf/Type* + - Optional + - Type: string + - **/software/components/metaconfig/slurm_gres_conf** + - */software/components/metaconfig/slurm_gres_conf/Default* + - Optional + - Type: slurm_gres_autodetect_conf + - */software/components/metaconfig/slurm_gres_conf/Nodes* + - Optional + - Type: slurm_gres_per_node_conf diff --git a/docs/components/NCM_Component_network_core-schema.rst b/docs/components/NCM_Component_network_core-schema.rst index 8b1b9c0..77c52cb 100644 --- a/docs/components/NCM_Component_network_core-schema.rst +++ b/docs/components/NCM_Component_network_core-schema.rst @@ -29,6 +29,10 @@ Types - Description: routing table - Optional - Type: network_valid_routing_table + - */software/components/network/structure_route/onlink* + - Description: pretend that the nexthop is directly attached to this link + - Optional + - Type: boolean - */software/components/network/structure_route/command* - Description: route add command options to use (cannot be combined with other options) - Optional @@ -375,6 +379,23 @@ Types - */software/components/network/structure_interface/ipv6init* - Optional - Type: boolean + - */software/components/network/structure_interface/my_inner_ipaddr* + - Description: tunnel IP + - Optional + - Type: type_ip + - */software/components/network/structure_interface/my_inner_prefix* + - Description: tunnel IP netmask prefix + - Optional + - Type: long + - Range: 0..32 + - */software/components/network/structure_interface/my_outer_ipaddr* + - Description: primary local IP address + - Optional + - Type: type_ip + - */software/components/network/structure_interface/peer_outer_ipaddr* + - Description: remote peer primary IP address + - Optional + - Type: type_ip - */software/components/network/structure_interface/plugin* - Optional - Type: structure_interface_plugin diff --git a/docs/components/NCM_Component_opennebula.rst b/docs/components/NCM_Component_opennebula.rst index 4d0500d..16d2377 100644 --- a/docs/components/NCM_Component_opennebula.rst +++ b/docs/components/NCM_Component_opennebula.rst @@ -71,6 +71,10 @@ Features that are implemented at this moment: +* Adding/removing OpenNebula VM groups and roles + + + * Assign OpenNebula resources to virtual clusters @@ -126,7 +130,7 @@ INITIAL CREATION To set up the initial cluster, some steps should be taken: -1. First install the required Ruby gems in your OpenNebula server. You can use OpenNebula installgems addon : `https://github.com/OpenNebula/addon-installgems `_. +1. First install the required Ruby gems in your OpenNebula server (only for OpenNebula 5.10 or older). You can use OpenNebula installgems addon : `https://github.com/OpenNebula/addon-installgems `_. diff --git a/docs/components/NCM_Component_opennebula_common.rst b/docs/components/NCM_Component_opennebula_common.rst new file mode 100644 index 0000000..06018a8 --- /dev/null +++ b/docs/components/NCM_Component_opennebula_common.rst @@ -0,0 +1,102 @@ +##################################### +NCM\::Component\::opennebula - common +##################################### + +Types +----- + + - **/software/components/opennebula/opennebula_device_prefix** + - **/software/components/opennebula/opennebula_vdc_rules** + - **/software/components/opennebula/opennebula_mysql_db** + - */software/components/opennebula/opennebula_mysql_db/server* + - Optional + - Type: string + - */software/components/opennebula/opennebula_mysql_db/port* + - Optional + - Type: type_port + - */software/components/opennebula/opennebula_mysql_db/user* + - Optional + - Type: string + - */software/components/opennebula/opennebula_mysql_db/passwd* + - Optional + - Type: string + - */software/components/opennebula/opennebula_mysql_db/db_name* + - Optional + - Type: string + - */software/components/opennebula/opennebula_mysql_db/connections* + - Description: Number of DB connections. The DB needs to be configured to support oned + monitord connections. + - Required + - Type: long + - Range: 1.. + - Default value: 25 + - */software/components/opennebula/opennebula_mysql_db/compare_binary* + - Description: Compare strings using BINARY clause makes name searches case sensitive + - Required + - Type: boolean + - Default value: false + - **/software/components/opennebula/opennebula_db** + - */software/components/opennebula/opennebula_db/backend* + - Required + - Type: string + - **/software/components/opennebula/opennebula_log** + - */software/components/opennebula/opennebula_log/system* + - Description: Configuration for the logging system file: to log in the sched.log file syslog: to use the syslog facilities + - Required + - Type: string + - Default value: file + - */software/components/opennebula/opennebula_log/debug_level* + - Description: debug_level: 0 = ERROR 1 = WARNING 2 = INFO 3 = DEBUG Includes general scheduling information (default) 4 = DDEBUG Includes time taken for each step 5 = DDDEBUG Includes detailed information about the scheduling decision, such as VM requirements, Host ranking for each VM, etc. This will impact the performance + - Required + - Type: long + - Range: 0..5 + - Default value: 3 + - **/software/components/opennebula/opennebula_im** + - */software/components/opennebula/opennebula_im/name* + - Required + - Type: string + - */software/components/opennebula/opennebula_im/executable* + - Required + - Type: string + - Default value: one_im_ssh + - */software/components/opennebula/opennebula_im/arguments* + - Required + - Type: string + - */software/components/opennebula/opennebula_im/sunstone_name* + - Optional + - Type: string + - */software/components/opennebula/opennebula_im/threads* + - Description: Number of threads, i.e. number of hosts monitored at the same time + - Optional + - Type: long + - Range: 0.. + - **/software/components/opennebula/opennebula_vm** + - */software/components/opennebula/opennebula_vm/executable* + - Required + - Type: string + - Default value: one_vmm_exec + - */software/components/opennebula/opennebula_vm/arguments* + - Required + - Type: string + - */software/components/opennebula/opennebula_vm/default* + - Required + - Type: string + - */software/components/opennebula/opennebula_vm/sunstone_name* + - Required + - Type: string + - */software/components/opennebula/opennebula_vm/imported_vms_actions* + - Required + - Type: string + - */software/components/opennebula/opennebula_vm/keep_snapshots* + - Required + - Type: boolean + - Default value: true + +Functions +--------- + + - is_consistent_database + - Description: check if a specific type of database has the right attributes + - is_consistent_datastore + - Description: check if a specific type of datastore has the right attributes + - is_consistent_vnet + - Description: check if a specific type of vnet has the right attributes diff --git a/docs/components/NCM_Component_opennebula_monitord.rst b/docs/components/NCM_Component_opennebula_monitord.rst new file mode 100644 index 0000000..f6c01a9 --- /dev/null +++ b/docs/components/NCM_Component_opennebula_monitord.rst @@ -0,0 +1,92 @@ +####################################### +NCM\::Component\::opennebula - monitord +####################################### + +Types +----- + + - **/software/components/opennebula/opennebula_monitord_network** + - Description: OpenNebula monitoring network setup. Reads messages from monitor agent. + - */software/components/opennebula/opennebula_monitord_network/address* + - Description: Network address to bind the UDP listener to + - Required + - Type: type_ipv4 + - */software/components/opennebula/opennebula_monitord_network/monitor_address* + - Description: Agents will send updates to this monitor address if "auto" is used, agents will detect the address from the ssh connection frontend -> host ($SSH_CLIENT), "auto" is not usable for HA setup + - Required + - Type: string + - Default value: auto + - */software/components/opennebula/opennebula_monitord_network/port* + - Description: Monitoring listening port + - Required + - Type: type_port + - Default value: 4124 + - */software/components/opennebula/opennebula_monitord_network/threads* + - Description: Number of processing threads + - Required + - Type: long + - Range: 1.. + - Default value: 8 + - */software/components/opennebula/opennebula_monitord_network/pubkey* + - Description: Absolute path to public key (agents). Empty for no encryption + - Required + - Type: string + - */software/components/opennebula/opennebula_monitord_network/privkey* + - Description: Absolute path to private key (monitord). Empty for no encryption + - Required + - Type: string + - **/software/components/opennebula/opennebula_probes_period** + - Description: OpenNebula probes Configuration. Time in seconds to execute each probe category. + - */software/components/opennebula/opennebula_probes_period/beacon_host* + - Description: Heartbeat for the host + - Required + - Type: long + - Range: 1.. + - Default value: 30 + - */software/components/opennebula/opennebula_probes_period/system_host* + - Description: Host static/configuration information + - Required + - Type: long + - Range: 1.. + - Default value: 600 + - */software/components/opennebula/opennebula_probes_period/monitor_host* + - Description: Host variable information + - Required + - Type: long + - Range: 1.. + - Default value: 120 + - */software/components/opennebula/opennebula_probes_period/state_vm* + - Description: VM status (ie. running, error, stopped...) + - Required + - Type: long + - Range: 1.. + - Default value: 5 + - */software/components/opennebula/opennebula_probes_period/monitor_vm* + - Description: VM resource usage metrics + - Required + - Type: long + - Range: 1.. + - Default value: 30 + - */software/components/opennebula/opennebula_probes_period/sync_state_vm* + - Description: When monitor probes have been stopped more than sync_vm_state seconds, send a complete VM report + - Required + - Type: long + - Range: 1.. + - Default value: 180 + - **/software/components/opennebula/opennebula_monitord** + - Description: Type that sets the monitord configuration file + - */software/components/opennebula/opennebula_monitord/log* + - Required + - Type: opennebula_log + - */software/components/opennebula/opennebula_monitord/db* + - Required + - Type: opennebula_mysql_db + - */software/components/opennebula/opennebula_monitord/network* + - Required + - Type: opennebula_monitord_network + - */software/components/opennebula/opennebula_monitord/probes_period* + - Required + - Type: opennebula_probes_period + - */software/components/opennebula/opennebula_monitord/im_mad* + - Required + - Type: opennebula_im diff --git a/docs/components/NCM_Component_opennebula_schema.rst b/docs/components/NCM_Component_opennebula_schema.rst index 30bb023..9ff83f0 100644 --- a/docs/components/NCM_Component_opennebula_schema.rst +++ b/docs/components/NCM_Component_opennebula_schema.rst @@ -5,37 +5,6 @@ NCM\::Component\::opennebula - schema Types ----- - - **/software/components/opennebula/directory** - - **/software/components/opennebula/opennebula_mysql_db** - - */software/components/opennebula/opennebula_mysql_db/server* - - Optional - - Type: string - - */software/components/opennebula/opennebula_mysql_db/port* - - Optional - - Type: type_port - - */software/components/opennebula/opennebula_mysql_db/user* - - Optional - - Type: string - - */software/components/opennebula/opennebula_mysql_db/passwd* - - Optional - - Type: string - - */software/components/opennebula/opennebula_mysql_db/db_name* - - Optional - - Type: string - - **/software/components/opennebula/opennebula_db** - - */software/components/opennebula/opennebula_db/backend* - - Required - - Type: string - - **/software/components/opennebula/opennebula_log** - - */software/components/opennebula/opennebula_log/system* - - Required - - Type: string - - Default value: file - - */software/components/opennebula/opennebula_log/debug_level* - - Required - - Type: long - - Range: 0..3 - - Default value: 3 - **/software/components/opennebula/opennebula_federation** - */software/components/opennebula/opennebula_federation/mode* - Required @@ -48,51 +17,48 @@ Types - */software/components/opennebula/opennebula_federation/master_oned* - Required - Type: string - - **/software/components/opennebula/opennebula_im** - - */software/components/opennebula/opennebula_im/executable* - - Required - - Type: string - - Default value: one_im_ssh - - */software/components/opennebula/opennebula_im/arguments* + - */software/components/opennebula/opennebula_federation/server_id* - Required - - Type: string - - */software/components/opennebula/opennebula_im/sunstone_name* - - Optional - - Type: string - - **/software/components/opennebula/opennebula_im_mad_collectd** - - **/software/components/opennebula/opennebula_im_mad_kvm** - - **/software/components/opennebula/opennebula_im_mad_xen** - - **/software/components/opennebula/opennebula_im_mad** - - */software/components/opennebula/opennebula_im_mad/collectd* - - Required - - Type: opennebula_im_mad_collectd - - */software/components/opennebula/opennebula_im_mad/kvm* - - Required - - Type: opennebula_im_mad_kvm - - */software/components/opennebula/opennebula_im_mad/xen* - - Optional - - Type: opennebula_im_mad_xen - - **/software/components/opennebula/opennebula_vm** - - */software/components/opennebula/opennebula_vm/executable* + - Type: long + - Range: -1.. + - **/software/components/opennebula/opennebula_raft** + - Description: Since 5.12.x Opennebula uses the Raft algorithm. It can be tuned by several parameters in the configuration file + - */software/components/opennebula/opennebula_raft/limit_purge* + - Description: Number of DB log records that will be deleted on each purge - Required - - Type: string - - Default value: one_vmm_exec - - */software/components/opennebula/opennebula_vm/arguments* + - Type: long + - Range: 1.. + - Default value: 100000 + - */software/components/opennebula/opennebula_raft/log_retention* + - Description: Number of DB log records kept. It determines the synchronization window across servers and extra storage space needed - Required - - Type: string - - */software/components/opennebula/opennebula_vm/default* + - Type: long + - Range: 1.. + - Default value: 250000 + - */software/components/opennebula/opennebula_raft/log_purge_timeout* + - Description: How often applied records are purged according to the log retention value (in seconds) - Required - - Type: string - - */software/components/opennebula/opennebula_vm/sunstone_name* + - Type: long + - Range: 1.. + - Default value: 60 + - */software/components/opennebula/opennebula_raft/election_timeout_ms* + - Description: Timeout to start an election process if no heartbeat or log is received from the leader (in milliseconds) - Required - - Type: string - - */software/components/opennebula/opennebula_vm/imported_vms_actions* + - Type: long + - Range: 1.. + - Default value: 5000 + - */software/components/opennebula/opennebula_raft/broadcast_timeout_ms* + - Description: How often heartbeats are sent to followers (in milliseconds) - Required - - Type: string - - */software/components/opennebula/opennebula_vm/keep_snapshots* + - Type: long + - Range: 1.. + - Default value: 500 + - */software/components/opennebula/opennebula_raft/xmlrpc_timeout_ms* + - Description: Timeout for Raft-related API calls (in milliseconds). For an infinite timeout, set this value to 0 - Required - - Type: boolean - - Default value: false + - Type: long + - Range: 0.. + - Default value: 1000 - **/software/components/opennebula/opennebula_vm_mad_kvm** - **/software/components/opennebula/opennebula_vm_mad_xen** - **/software/components/opennebula/opennebula_vm_mad** @@ -119,12 +85,24 @@ Types - */software/components/opennebula/opennebula_datastore_mad/arguments* - Required - Type: string - - Default value: -t 15 -d dummy,fs,vmfs,lvm,ceph + - Default value: -t 15 -d dummy,fs,lvm,ceph,dev,iscsi_libvirt,vcenter -s shared,ssh,ceph,fs_lvm,qcow2,vcenter - **/software/components/opennebula/opennebula_hm_mad** - */software/components/opennebula/opennebula_hm_mad/executable* - Required - Type: string - Default value: one_hm + - */software/components/opennebula/opennebula_hm_mad/arguments* + - Description: for the driver executable, can be an absolute path or relative to $ONE_LOCATION/etc (or /etc/one/ if OpenNebula was installed in /) + - Required + - Type: string + - Default value: -p 2101 -l 2102 -b 127.0.0.1 + - **/software/components/opennebula/opennebula_hook_log_conf** + - */software/components/opennebula/opennebula_hook_log_conf/log_retention* + - Description: Number of execution records saved in the database for each hook + - Required + - Type: long + - Range: 1.. + - Default value: 20 - **/software/components/opennebula/opennebula_auth_mad** - */software/components/opennebula/opennebula_auth_mad/executable* - Required @@ -145,7 +123,7 @@ Types - Default value: NONE - */software/components/opennebula/opennebula_tm_mad_conf/clone_target* - Required - - Type: string + - Type: choice - Default value: SYSTEM - */software/components/opennebula/opennebula_tm_mad_conf/shared* - Required @@ -154,6 +132,64 @@ Types - */software/components/opennebula/opennebula_tm_mad_conf/ds_migrate* - Optional - Type: boolean + - */software/components/opennebula/opennebula_tm_mad_conf/driver* + - Optional + - Type: choice + - */software/components/opennebula/opennebula_tm_mad_conf/allow_orphans* + - Optional + - Type: string + - */software/components/opennebula/opennebula_tm_mad_conf/tm_mad_system* + - Optional + - Type: string + - */software/components/opennebula/opennebula_tm_mad_conf/ln_target_ssh* + - Optional + - Type: string + - */software/components/opennebula/opennebula_tm_mad_conf/clone_target_ssh* + - Optional + - Type: string + - */software/components/opennebula/opennebula_tm_mad_conf/disk_type_ssh* + - Optional + - Type: string + - */software/components/opennebula/opennebula_tm_mad_conf/ln_target_shared* + - Optional + - Type: string + - */software/components/opennebula/opennebula_tm_mad_conf/clone_target_shared* + - Optional + - Type: string + - */software/components/opennebula/opennebula_tm_mad_conf/disk_type_shared* + - Optional + - Type: string + - **/software/components/opennebula/opennebula_auth_mad_conf** + - Description: Authentication Driver Behavior Definition. The configuration for each driver is defined in AUTH_MAD_CONF. + - */software/components/opennebula/opennebula_auth_mad_conf/name* + - Description: Name of the auth driver + - Required + - Type: string + - */software/components/opennebula/opennebula_auth_mad_conf/password_change* + - Description: Allow the end users to change their own password. Oneadmin can still change other users passwords + - Required + - Type: boolean + - */software/components/opennebula/opennebula_auth_mad_conf/driver_managed_groups* + - Description: Allow the driver to set the users group even after user creation. In this case addgroup, delgroup and chgrp will be disabled, with the exception of chgrp to one of the groups in the list of secondary groups + - Required + - Type: boolean + - Default value: false + - */software/components/opennebula/opennebula_auth_mad_conf/max_token_time* + - Description: Limit the maximum token validity, in seconds. Use -1 for unlimited maximum, 0 to disable login tokens + - Required + - Type: long + - Range: -1.. + - **/software/components/opennebula/opennebula_vn_mad_conf** + - Description: Virtual Network Driver Behavior Definition. The configuration for each driver is defined in VN_MAD_CONF. + - */software/components/opennebula/opennebula_vn_mad_conf/name* + - Description: Name of the auth driver + - Required + - Type: string + - */software/components/opennebula/opennebula_vn_mad_conf/bridge_type* + - Description: Define the technology used by the driver + - Required + - Type: choice + - Default value: linux - **/software/components/opennebula/opennebula_ds_mad_conf** - Description: The configuration for each driver is defined in DS_MAD_CONF. These values are used when creating a new datastore and should not be modified since they defined the datastore behavior. - */software/components/opennebula/opennebula_ds_mad_conf/name* @@ -192,6 +228,11 @@ Types - Description: set to TRUE for external marketplaces - Optional - Type: boolean + - */software/components/opennebula/opennebula_market_mad_conf/sunstone_name* + - Description: Name displayed in Sunstone + - Required + - Type: string + - Default value: OpenNebula.org Marketplace - **/software/components/opennebula/opennebula_default_cost** - Description: The following attributes define the default cost for Virtual Machines that don't have a CPU, MEMORY or DISK cost. This is used by the oneshowback calculate method. - */software/components/opennebula/opennebula_default_cost/cpu_cost* @@ -215,8 +256,10 @@ Types - Range: 5900..65535 - Default value: 5900 - */software/components/opennebula/opennebula_vnc_ports/reserved* + - Description: Comma-separated list of reserved ports or ranges. Two numbers separated by a colon indicate a range - Optional - - Type: long + - Type: string + - Default value: 32768:65536 - **/software/components/opennebula/opennebula_vlan_ids** - Description: LAN ID pool for the automatic VLAN_ID assignment. This pool is for 802.1Q networks (Open vSwitch and 802.1Q drivers). The driver will try first to allocate VLAN_IDS[START] + VNET_ID - */software/components/opennebula/opennebula_vlan_ids/start* @@ -225,8 +268,10 @@ Types - Type: long - Default value: 2 - */software/components/opennebula/opennebula_vlan_ids/reserved* + - Description: Comma-separated list of VLAN_IDs or ranges. Two numbers separated by a colon indicate a range - Optional - - Type: long + - Type: string + - Default value: 0, 1, 4095 - **/software/components/opennebula/opennebula_vxlan_ids** - Description: Automatic VXLAN Network ID (VNI) assignment. This is used or vxlan networks. NOTE: reserved is not supported by this pool - */software/components/opennebula/opennebula_vxlan_ids/start* @@ -245,7 +290,7 @@ Types - Description: arguments for the driver executable: -t number of threads, i.e. number of repo operations at the same time -m marketplace mads separated by commas - Required - Type: string - - Default value: -t 15 -m http,s3,one + - Default value: -t 15 -m http,s3,one,linuxcontainers,turnkeylinux,dockerhub - **/software/components/opennebula/opennebula_ceph_datastore** - Description: type for ceph datastore specific attributes. ceph_host, ceph_secret, ceph_user, ceph_user_key and pool_name are mandatory - */software/components/opennebula/opennebula_ceph_datastore/ceph_host* @@ -302,12 +347,12 @@ Types - Type: choice - */software/components/opennebula/opennebula_datastore/ds_mad* - Required - - Type: string + - Type: choice - Default value: ceph - */software/components/opennebula/opennebula_datastore/tm_mad* - Description: set system Datastore TM_MAD value. shared: The storage area for the system datastore is a shared directory across the hosts. vmfs: A specialized version of the shared one to use the vmfs file system. ssh: Uses a local storage area from each host for the system datastore. ceph: Uses Ceph storage backend. - Required - - Type: string + - Type: choice - Default value: ceph - */software/components/opennebula/opennebula_datastore/type* - Required @@ -445,6 +490,37 @@ Types - Description: In KB. Applies to all the Hosts in this cluster. It will be subtracted from the TOTAL MEM. This value can be negative, in that case you’ll be actually increasing the overall capacity so overcommiting host capacity. - Optional - Type: long + - **/software/components/opennebula/opennebula_vmgroup_role** + - Description: type for vmgroup roles specific attributes. + - */software/components/opennebula/opennebula_vmgroup_role/name* + - Description: The name of the role, it needs to be unique within the VM Group + - Required + - Type: string + - */software/components/opennebula/opennebula_vmgroup_role/policy* + - Description: Placement policy for the VMs of the role + - Optional + - Type: choice + - */software/components/opennebula/opennebula_vmgroup_role/host_affined* + - Description: Defines a set of hosts (by their ID) where the VMs of the role can be executed + - Optional + - Type: string + - */software/components/opennebula/opennebula_vmgroup_role/host_anti_affined* + - Description: Defines a set of hosts (by their ID) where the VMs of the role cannot be executed + - Optional + - Type: string + - **/software/components/opennebula/opennebula_vmgroup** + - Description: Set OpenNebula vmgroups and their porperties. + - */software/components/opennebula/opennebula_vmgroup/role* + - Optional + - Type: opennebula_vmgroup_role + - */software/components/opennebula/opennebula_vmgroup/affined* + - Description: List of roles whose VMs has to be placed in the same host + - Optional + - Type: string + - */software/components/opennebula/opennebula_vmgroup/anti_affined* + - Description: List of roles whose VMs cannot be placed in the same host + - Optional + - Type: string - **/software/components/opennebula/opennebula_remoteconf_ceph** - */software/components/opennebula/opennebula_remoteconf_ceph/pool_name* - Required @@ -457,7 +533,7 @@ Types - Type: string - */software/components/opennebula/opennebula_remoteconf_ceph/staging_dir* - Optional - - Type: directory + - Type: absolute_file_path - Default value: /var/tmp - */software/components/opennebula/opennebula_remoteconf_ceph/rbd_format* - Optional @@ -473,7 +549,7 @@ Types - Type: opennebula_db - */software/components/opennebula/opennebula_oned/default_device_prefix* - Optional - - Type: string + - Type: opennebula_device_prefix - Default value: hd - */software/components/opennebula/opennebula_oned/onegate_endpoint* - Optional @@ -489,6 +565,24 @@ Types - Required - Type: long - Default value: 50 + - */software/components/opennebula/opennebula_oned/monitoring_interval_datastore* + - Description: Time in seconds between each DATASTORE monitoring cycle + - Required + - Type: long + - Range: 0.. + - Default value: 300 + - */software/components/opennebula/opennebula_oned/monitoring_interval_market* + - Description: Time in seconds between each MARKETPLACE monitoring cycle + - Required + - Type: long + - Range: 0.. + - Default value: 600 + - */software/components/opennebula/opennebula_oned/monitoring_interval_db_update* + - Description: Time in seconds between DB writes of VM monitoring information. -1 to disable DB updating and 0 to write every update + - Required + - Type: long + - Range: -1.. + - Default value: 0 - */software/components/opennebula/opennebula_oned/host_per_interval* - Optional - Type: long @@ -507,6 +601,41 @@ Types - */software/components/opennebula/opennebula_oned/vm_submit_on_hold* - Optional - Type: boolean + - */software/components/opennebula/opennebula_oned/vm_admin_operations* + - Required + - Type: string + - */software/components/opennebula/opennebula_oned/vm_manage_operations* + - Description: The following parameters define the operations associated to the ADMIN, MANAGE and USE permissions. Note that some VM operations require additional permissions on other objects. Also some operations refers to a class of actions: - disk-snapshot, includes create, delete and revert actions - disk-attach, includes attach and detach actions - nic-attach, includes attach and detach actions - snapshot, includes create, delete and revert actions - resched, includes resched and unresched actions + - Required + - Type: string + - */software/components/opennebula/opennebula_oned/vm_use_operations* + - Required + - Type: string + - */software/components/opennebula/opennebula_oned/default_vdc_host_acl* + - Description: Default ACL rules created when a resource is added to a VDC. The following attributes configure the permissions granted to the VDC group for each resource type + - Required + - Type: opennebula_vdc_rules + - Default value: MANAGE + - */software/components/opennebula/opennebula_oned/default_vdc_vnet_acl* + - Required + - Type: opennebula_vdc_rules + - Default value: USE + - */software/components/opennebula/opennebula_oned/default_vdc_datastore_acl* + - Required + - Type: opennebula_vdc_rules + - Default value: USE + - */software/components/opennebula/opennebula_oned/default_vdc_cluster_host_acl* + - Required + - Type: opennebula_vdc_rules + - Default value: MANAGE + - */software/components/opennebula/opennebula_oned/default_vdc_cluster_net_acl* + - Required + - Type: opennebula_vdc_rules + - Default value: USE + - */software/components/opennebula/opennebula_oned/default_vdc_cluster_datastore_acl* + - Required + - Type: opennebula_vdc_rules + - Default value: USE - */software/components/opennebula/opennebula_oned/max_conn* - Optional - Type: long @@ -533,7 +662,7 @@ Types - Type: string - */software/components/opennebula/opennebula_oned/scripts_remote_dir* - Required - - Type: directory + - Type: absolute_file_path - Default value: /var/tmp/one - */software/components/opennebula/opennebula_oned/log* - Required @@ -541,6 +670,9 @@ Types - */software/components/opennebula/opennebula_oned/federation* - Required - Type: opennebula_federation + - */software/components/opennebula/opennebula_oned/raft* + - Required + - Type: opennebula_raft - */software/components/opennebula/opennebula_oned/port* - Required - Type: type_port @@ -559,11 +691,11 @@ Types - Default value: 02:00 - */software/components/opennebula/opennebula_oned/datastore_location* - Optional - - Type: directory + - Type: absolute_file_path - Default value: /var/lib/one/datastores - */software/components/opennebula/opennebula_oned/datastore_base_path* - Optional - - Type: directory + - Type: absolute_file_path - Default value: /var/lib/one/datastores - */software/components/opennebula/opennebula_oned/datastore_capacity_check* - Required @@ -575,7 +707,7 @@ Types - Default value: OS - */software/components/opennebula/opennebula_oned/default_cdrom_device_prefix* - Required - - Type: string + - Type: opennebula_device_prefix - Default value: hd - */software/components/opennebula/opennebula_oned/session_expiration_time* - Required @@ -587,7 +719,7 @@ Types - Default value: 177 - */software/components/opennebula/opennebula_oned/im_mad* - Required - - Type: opennebula_im_mad + - Type: opennebula_im - */software/components/opennebula/opennebula_oned/vm_mad* - Required - Type: opennebula_vm_mad @@ -600,6 +732,9 @@ Types - */software/components/opennebula/opennebula_oned/hm_mad* - Required - Type: opennebula_hm_mad + - */software/components/opennebula/opennebula_oned/hook_log_conf* + - Required + - Type: opennebula_hook_log_conf - */software/components/opennebula/opennebula_oned/auth_mad* - Required - Type: opennebula_auth_mad @@ -631,16 +766,42 @@ Types - */software/components/opennebula/opennebula_oned/market_mad_conf* - Required - Type: opennebula_market_mad_conf + - */software/components/opennebula/opennebula_oned/auth_mad_conf* + - Required + - Type: opennebula_auth_mad_conf + - */software/components/opennebula/opennebula_oned/vn_mad_conf* + - Required + - Type: opennebula_vn_mad_conf - */software/components/opennebula/opennebula_oned/vm_restricted_attr* - Required - Type: string - */software/components/opennebula/opennebula_oned/image_restricted_attr* - Required - Type: string - - Default value: SOURCE - */software/components/opennebula/opennebula_oned/vnet_restricted_attr* - Required - Type: string + - */software/components/opennebula/opennebula_oned/user_restricted_attr* + - Required + - Type: string + - */software/components/opennebula/opennebula_oned/group_restricted_attr* + - Required + - Type: string + - */software/components/opennebula/opennebula_oned/host_encrypted_attr* + - Required + - Type: string + - */software/components/opennebula/opennebula_oned/vm_encrypted_attr* + - Required + - Type: string + - */software/components/opennebula/opennebula_oned/vnet_encrypted_attr* + - Required + - Type: string + - */software/components/opennebula/opennebula_oned/datastore_encrypted_attr* + - Required + - Type: string + - */software/components/opennebula/opennebula_oned/cluster_encrypted_attr* + - Required + - Type: string - */software/components/opennebula/opennebula_oned/inherit_datastore_attr* - Required - Type: string @@ -688,7 +849,7 @@ Types - Default value: prod - */software/components/opennebula/opennebula_sunstone/tmpdir* - Required - - Type: directory + - Type: absolute_file_path - Default value: /var/tmp - */software/components/opennebula/opennebula_sunstone/host* - Required @@ -723,6 +884,16 @@ Types - Required - Type: string - Default value: opennebula + - */software/components/opennebula/opennebula_sunstone/webauthn_origin* + - Description: This value needs to match `window.location.origin` evaluated by the User Agent during registration and authentication ceremonies. Remember that WebAuthn requires TLS on anything else than localhost + - Required + - Type: type_absoluteURI + - Default value: http://localhost:9869 + - */software/components/opennebula/opennebula_sunstone/webauthn_rpname* + - Description: Relying Party name for display purposes + - Required + - Type: string + - Default value: OpenNebula Cloud - */software/components/opennebula/opennebula_sunstone/encode_user_password* - Optional - Type: boolean @@ -921,6 +1092,9 @@ Types - */software/components/opennebula/opennebula_untouchables/clusters* - Optional - Type: string + - */software/components/opennebula/opennebula_untouchables/vmgroups* + - Optional + - Type: string - **/software/components/opennebula/component_opennebula** - Description: Type to define ONE basic resources datastores, vnets, hosts names, etc - */software/components/opennebula/component_opennebula/datastores* @@ -938,6 +1112,9 @@ Types - */software/components/opennebula/component_opennebula/clusters* - Optional - Type: opennebula_cluster + - */software/components/opennebula/component_opennebula/vmgroups* + - Optional + - Type: opennebula_vmgroup - */software/components/opennebula/component_opennebula/hosts* - Optional - Type: opennebula_host @@ -950,6 +1127,9 @@ Types - */software/components/opennebula/component_opennebula/oned* - Optional - Type: opennebula_oned + - */software/components/opennebula/component_opennebula/monitord* + - Optional + - Type: opennebula_monitord - */software/components/opennebula/component_opennebula/sunstone* - Optional - Type: opennebula_sunstone @@ -972,13 +1152,3 @@ Types - Description: in some cases (such a Sunstone standalone configuration with apache), some OpenNebula configuration files should be accessible by a different group (as apache). This variable sets the group name to change these files permissions. - Optional - Type: string - -Functions ---------- - - - is_consistent_database - - Description: check if a specific type of database has the right attributes - - is_consistent_datastore - - Description: check if a specific type of datastore has the right attributes - - is_consistent_vnet - - Description: check if a specific type of vnet has the right attributes diff --git a/docs/components/NCM_Component_postgresql_schema.rst b/docs/components/NCM_Component_postgresql_schema.rst index 6c27314..2d9101b 100644 --- a/docs/components/NCM_Component_postgresql_schema.rst +++ b/docs/components/NCM_Component_postgresql_schema.rst @@ -473,6 +473,18 @@ Types - */software/components/postgresql/postgresql_mainconfig/ssl* - Optional - Type: boolean + - */software/components/postgresql/postgresql_mainconfig/ssl_ca_file* + - Optional + - Type: absolute_file_path + - */software/components/postgresql/postgresql_mainconfig/ssl_cert_file* + - Optional + - Type: absolute_file_path + - */software/components/postgresql/postgresql_mainconfig/ssl_crl_file* + - Optional + - Type: absolute_file_path + - */software/components/postgresql/postgresql_mainconfig/ssl_key_file* + - Optional + - Type: absolute_file_path - */software/components/postgresql/postgresql_mainconfig/ssl_ciphers* - Optional - Type: string diff --git a/docs/components/NCM_Component_sudo_schema.rst b/docs/components/NCM_Component_sudo_schema.rst index 76dcd1c..de7a8de 100644 --- a/docs/components/NCM_Component_sudo_schema.rst +++ b/docs/components/NCM_Component_sudo_schema.rst @@ -253,7 +253,7 @@ Types - Optional - Type: sudo_defaults - */software/components/sudo/sudo_component/user_aliases* - - Description: dicts of lists of strings containing the alias information. The name of each named list must start with a letter, and contain only letters, numbers and underscores. All the letters must be capitals. i.e. the name must match `^[A-Z][A-Z0-9_]*$`. They can be preceeded by an '!', indicating the alias must *not* match that name. The contents may be preceeded by an '!', indicating that item must not be part of the alias. The contents of host aliases can be either host names, IP addresses or network specifications (IP/netmask). A valid example: "/software/components/sudo/user_aliases/FOO" = list ("bar", "%wheel", "!root"); + - Description: dicts of lists of strings containing the alias information. The name of each named list must start with a letter, and contain only letters, numbers and underscores. All the letters must be capitals. i.e. the name must match ^[A-Z][A-Z0-9_]*$. They can be preceeded by an '!', indicating the alias must *not* match that name. The contents may be preceeded by an '!', indicating that item must not be part of the alias. The contents of host aliases can be either host names, IP addresses or network specifications (IP/netmask). A valid example: "/software/components/sudo/user_aliases/FOO" = list ("bar", "%wheel", "!root"); - Optional - Type: sudo_user_alias - */software/components/sudo/sudo_component/run_as_aliases* diff --git a/docs/components/NCM_Component_systemd_schema.rst b/docs/components/NCM_Component_systemd_schema.rst index 0355954..aa571f3 100644 --- a/docs/components/NCM_Component_systemd_schema.rst +++ b/docs/components/NCM_Component_systemd_schema.rst @@ -396,6 +396,69 @@ Types - */software/components/systemd/systemd_unitfile_config_systemd_exec/WorkingDirectory* - Optional - Type: string + - **/software/components/systemd/systemd_unitfile_config_systemd_resource_control_devicelist** + - **/software/components/systemd/systemd_unitfile_config_systemd_resource_control_block_weight** + - **/software/components/systemd/systemd_unitfile_config_systemd_resource_control** + - Description: systemd.resource-control directives https://www.freedesktop.org/software/systemd/man/systemd.resource-control.html valid for [Slice], [Scope], [Service], [Socket], [Mount], or [Swap] sections + - */software/components/systemd/systemd_unitfile_config_systemd_resource_control/CPUAccounting* + - Optional + - Type: boolean + - */software/components/systemd/systemd_unitfile_config_systemd_resource_control/CPUShares* + - Optional + - Type: long + - Range: 2..262144 + - */software/components/systemd/systemd_unitfile_config_systemd_resource_control/StartupCPUShares* + - Optional + - Type: long + - Range: 2..262144 + - */software/components/systemd/systemd_unitfile_config_systemd_resource_control/CPUQuota* + - Optional + - Type: long + - Range: 0..100 + - */software/components/systemd/systemd_unitfile_config_systemd_resource_control/MemoryAccounting* + - Optional + - Type: boolean + - */software/components/systemd/systemd_unitfile_config_systemd_resource_control/MemoryLimit* + - Optional + - Type: long + - */software/components/systemd/systemd_unitfile_config_systemd_resource_control/TasksAccounting* + - Optional + - Type: boolean + - */software/components/systemd/systemd_unitfile_config_systemd_resource_control/TasksMax* + - Optional + - Type: string + - */software/components/systemd/systemd_unitfile_config_systemd_resource_control/BlockIOAccounting* + - Optional + - Type: boolean + - */software/components/systemd/systemd_unitfile_config_systemd_resource_control/BlockIOWeight* + - Optional + - Type: long + - Range: 10..1000 + - */software/components/systemd/systemd_unitfile_config_systemd_resource_control/StartupBlockIOWeight* + - Optional + - Type: long + - Range: 10..1000 + - */software/components/systemd/systemd_unitfile_config_systemd_resource_control/BlockIODeviceWeight* + - Optional + - Type: systemd_unitfile_config_systemd_resource_control_block_weight + - */software/components/systemd/systemd_unitfile_config_systemd_resource_control/BlockIOReadBandwidth* + - Optional + - Type: systemd_unitfile_config_systemd_resource_control_block_weight + - */software/components/systemd/systemd_unitfile_config_systemd_resource_control/BlockIOWriteBandwidth* + - Optional + - Type: systemd_unitfile_config_systemd_resource_control_block_weight + - */software/components/systemd/systemd_unitfile_config_systemd_resource_control/DeviceAllow* + - Optional + - Type: systemd_unitfile_config_systemd_resource_control_devicelist + - */software/components/systemd/systemd_unitfile_config_systemd_resource_control/DevicePolicy* + - Optional + - Type: choice + - */software/components/systemd/systemd_unitfile_config_systemd_resource_control/Slice* + - Optional + - Type: string + - */software/components/systemd/systemd_unitfile_config_systemd_resource_control/Delegate* + - Optional + - Type: boolean - **/software/components/systemd/systemd_unitfile_config_service** - Description: the [Service] section http://www.freedesktop.org/software/systemd/man/systemd.service.html - */software/components/systemd/systemd_unitfile_config_service/AmbientCapabilities* @@ -674,6 +737,105 @@ Types - Optional - Type: long - Range: 0.. + - **/software/components/systemd/systemd_unitfile_config_mount** + - Description: the [mount] section http://www.freedesktop.org/software/systemd/man/systemd.mount.html + - */software/components/systemd/systemd_unitfile_config_mount/What* + - Required + - Type: string + - */software/components/systemd/systemd_unitfile_config_mount/Where* + - Required + - Type: absolute_file_path + - */software/components/systemd/systemd_unitfile_config_mount/Type* + - Optional + - Type: string + - */software/components/systemd/systemd_unitfile_config_mount/Options* + - Optional + - Type: string + - */software/components/systemd/systemd_unitfile_config_mount/SloppyOptions* + - Optional + - Type: boolean + - */software/components/systemd/systemd_unitfile_config_mount/LazyUnmount* + - Optional + - Type: boolean + - */software/components/systemd/systemd_unitfile_config_mount/ReadWriteOnly* + - Optional + - Type: boolean + - */software/components/systemd/systemd_unitfile_config_mount/ForceUnmount* + - Optional + - Type: boolean + - */software/components/systemd/systemd_unitfile_config_mount/DirectoryMode* + - Optional + - Type: type_octal_mode + - */software/components/systemd/systemd_unitfile_config_mount/TimeoutSec* + - Optional + - Type: long + - Range: 0.. + - **/software/components/systemd/systemd_unitfile_config_automount** + - Description: the [Automount] section http://www.freedesktop.org/software/systemd/man/systemd.automount.html + - */software/components/systemd/systemd_unitfile_config_automount/Where* + - Required + - Type: absolute_file_path + - */software/components/systemd/systemd_unitfile_config_automount/DirectoryMode* + - Optional + - Type: type_octal_mode + - */software/components/systemd/systemd_unitfile_config_automount/TimeoutSec* + - Optional + - Type: long + - Range: 0.. + - **/software/components/systemd/systemd_unitfile_config_timer** + - Description: the [Timer] section http://www.freedesktop.org/software/systemd/man/systemd.timer.html + - */software/components/systemd/systemd_unitfile_config_timer/OnActiveSec* + - Optional + - Type: long + - Range: 0.. + - */software/components/systemd/systemd_unitfile_config_timer/OnBootSec* + - Optional + - Type: long + - Range: 0.. + - */software/components/systemd/systemd_unitfile_config_timer/OnStartupSec* + - Optional + - Type: long + - Range: 0.. + - */software/components/systemd/systemd_unitfile_config_timer/OnUnitActiveSec* + - Optional + - Type: long + - Range: 0.. + - */software/components/systemd/systemd_unitfile_config_timer/OnUnitInactiveSec* + - Optional + - Type: long + - Range: 0.. + - */software/components/systemd/systemd_unitfile_config_timer/OnCalendar* + - Optional + - Type: string + - */software/components/systemd/systemd_unitfile_config_timer/AccuracySec* + - Optional + - Type: long + - Range: 0.. + - */software/components/systemd/systemd_unitfile_config_timer/RandomizedDelaySec* + - Optional + - Type: long + - Range: 0.. + - */software/components/systemd/systemd_unitfile_config_timer/FixedRandomDelay* + - Optional + - Type: boolean + - */software/components/systemd/systemd_unitfile_config_timer/OnClockChange* + - Optional + - Type: boolean + - */software/components/systemd/systemd_unitfile_config_timer/OnTimezoneChange* + - Optional + - Type: boolean + - */software/components/systemd/systemd_unitfile_config_timer/Unit* + - Optional + - Type: string + - */software/components/systemd/systemd_unitfile_config_timer/Persistent* + - Optional + - Type: boolean + - */software/components/systemd/systemd_unitfile_config_timer/WakeSystem* + - Optional + - Type: boolean + - */software/components/systemd/systemd_unitfile_config_timer/RemainAfterElapse* + - Optional + - Type: boolean - **/software/components/systemd/systemd_unitfile_config** - Description: Unit configuration sections includes, unit and install are type agnostic unit and install are mandatory, but not enforced by schema (possible issues in case of replace=true) the other attributes are only valid for a specific type - */software/components/systemd/systemd_unitfile_config/includes* @@ -689,6 +851,15 @@ Types - */software/components/systemd/systemd_unitfile_config/socket* - Optional - Type: systemd_unitfile_config_socket + - */software/components/systemd/systemd_unitfile_config/mount* + - Optional + - Type: systemd_unitfile_config_mount + - */software/components/systemd/systemd_unitfile_config/automount* + - Optional + - Type: systemd_unitfile_config_automount + - */software/components/systemd/systemd_unitfile_config/timer* + - Optional + - Type: systemd_unitfile_config_timer - */software/components/systemd/systemd_unitfile_config/unit* - Optional - Type: systemd_unitfile_config_unit diff --git a/docs/template-library-core/aii_opennebula_schema.rst b/docs/template-library-core/aii_opennebula_schema.rst index 7765314..c43c335 100644 --- a/docs/template-library-core/aii_opennebula_schema.rst +++ b/docs/template-library-core/aii_opennebula_schema.rst @@ -30,6 +30,7 @@ Types - Type: boolean - Default value: true - **opennebula_vmtemplate_vnet** + - **opennebula_rdm_disk** - **opennebula_vmtemplate_datastore** - **valid_interface_ignoremac** - Description: Type that checks if the network interface is available from the quattor tree @@ -66,6 +67,14 @@ Types - Description: third value from onehost TYPE section - Optional - Type: long + - **opennebula_vmtemplate_vmgroup** + - Description: Type that sets VM Groups and Roles for a specifc VM. VMGroups are placed by dynamically generating the requirement (SCHED_REQUIREMENTS) of each VM an re-evaluating these expressions. Moreover, the following is also considered: The scheduler will look for a host with enough capacity for an affined set of VMs. If there is no such host all the affined VMs will remain pending. If new VMs are added to an affined role, it will pick one of the hosts where the VMs are running. By default, all should be running in the same host but if you manually migrate a VM to another host it will be considered feasible for the role. The scheduler does not have any synchronization point with the state of the VM group, it will start scheduling pending VMs as soon as they show up. Re-scheduling of VMs works as for any other VM, it will look for a different host considering the placement constraints. For more info: https://docs.opennebula.org/5.8/advanced_components/application_flow_and_auto-scaling/vmgroups.html + - *opennebula_vmtemplate_vmgroup/vmgroup_name* + - Required + - Type: string + - *opennebula_vmtemplate_vmgroup/role* + - Required + - Type: string - **opennebula_placements** - Description: Type that sets placement constraints and preferences for the VM, valid for all hosts More info: http://docs.opennebula.org/5.0/operation/references/template.html#placement-section - *opennebula_placements/sched_requirements* @@ -93,6 +102,10 @@ Types - Description: Set the OpenNebula opennebula/datastore name for each vdx - Required - Type: opennebula_vmtemplate_datastore + - *opennebula_vmtemplate/diskrdmpath* + - Description: Set raw device mapping (RDM) for a specific virtual disk, for instance: '/system/opennebula/diskrdmpath/vdd/' = '/dev/sdf'; will passthrough the block device to the VM as vdd disk. Disk size is ignored in this case. It requires a RDM datastore. See: https://docs.opennebula.org/5.8/deployment/open_cloud_storage_setup/dev_ds.html + - Optional + - Type: opennebula_rdm_disk - *opennebula_vmtemplate/ignoremac* - Description: Set ignoremac tree to avoid to include MAC values within AR/VM templates - Optional @@ -133,6 +146,10 @@ Types - Description: The optional memoryBacking element may contain several elements that influence how virtual memory pages are backed by host pages. hugepages: This tells the hypervisor that the guest should have its memory allocated using hugepages instead of the normal native page size. nosharepages: Instructs hypervisor to disable shared pages (memory merge, KSM) for this domain. locked: When set and supported by the hypervisor, memory pages belonging to the domain will be locked in hosts memory and the host will not be allowed to swap them out, which might be required for some workloads such as real-time. For QEMU/KVM guests, the memory used by the QEMU process itself will be locked too: unlike guest memory, this is an amount libvirt has no way of figuring out in advance, so it has to remove the limit on locked memory altogether. Thus, enabling this option opens up to a potential security risk: the host will be unable to reclaim the locked memory back from the guest when its running out of memory, which means a malicious guest allocating large amounts of locked memory could cause a denial-of-service attach on the host. - Optional - Type: string + - *opennebula_vmtemplate/vmgroup* + - Description: Request existing VM Group and roles. A VM Group defines a set of related VMs, and associated placement constraints for the VMs in the group. A VM Group allows you to place together (or separately) ceartain VMs (or VM classes, roles). VMGroups will help you to optimize the performance (e.g. not placing all the cpu bound VMs in the same host) or improve the fault tolerance (e.g. not placing all your front-ends in the same host) of your multi-VM applications. + - Optional + - Type: opennebula_vmtemplate_vmgroup Variables --------- diff --git a/docs/template-library-core/functions_hardware.rst b/docs/template-library-core/functions_hardware.rst index 8134c37..e1904af 100644 --- a/docs/template-library-core/functions_hardware.rst +++ b/docs/template-library-core/functions_hardware.rst @@ -17,3 +17,6 @@ Functions - get_num_of_max_threads - Arguments: - A HW template (string) or a HW configuration (nested dict) to use as a source of hardware configuration (optional) + - get_total_ram + - Arguments: + - A HW template (string) or a HW configuration (nested dict) to use as a source of hardware configuration (optional)