1
0
mirror of https://github.com/OpenNebula/one.git synced 2024-12-23 17:33:56 +03:00
one/include/NebulaTemplate.h
Pavel Czerný 442041fd07
F #6341: Generic Quotas
- Generic quotas are defined and read from oned.conf (QUOTA_VM_ATTRIBUTE)
- Generic quotas react to the running mode (i.e. account only when the VM is
  running). For each quota oned also adds a RUNNIN_* metric
- one.system.config API call has been updated so every user can read
  quota configuration:
    . Sensitive information is hidden (***)
    . Oneadmin group has no longer access to sensitive information
      through the API
- CLI has been updated to render generic quotas
- onedb fsck fixes generic quotas reading the configuration from
  oned.conf

Other changes in this PR:
- Refactor Quota metrics to use std::vector instead of C array
Squashed commit of the following:
- New methods to Template and Attribute classes to render hidden
  attributes as "***"
- Update Quota calls to not include unneeded quotas

co-authored-by:Ruben S. Montero <rsmontero@opennebula.org>
2024-01-08 14:07:03 +01:00

93 lines
3.0 KiB
C++

/* -------------------------------------------------------------------------- */
/* Copyright 2002-2023, OpenNebula Project, OpenNebula Systems */
/* */
/* Licensed under the Apache License, Version 2.0 (the "License"); you may */
/* not use this file except in compliance with the License. You may obtain */
/* a copy of the License at */
/* */
/* http://www.apache.org/licenses/LICENSE-2.0 */
/* */
/* Unless required by applicable law or agreed to in writing, software */
/* distributed under the License is distributed on an "AS IS" BASIS, */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
/* See the License for the specific language governing permissions and */
/* limitations under the License. */
/* -------------------------------------------------------------------------- */
#ifndef NEBULA_TEMPLATE_H_
#define NEBULA_TEMPLATE_H_
#include "Template.h"
#include <map>
/**
* This class provides the basic abstraction for OpenNebula configuration files
*/
class NebulaTemplate : public Template
{
public:
NebulaTemplate(const std::string& etc_location, const char * _conf_name,
const char * root_name)
: Template(false, '=', root_name)
, hidden_attributes{
{"DB", {"BACKEND", "SERVER", "PORT", "USER", "PASSWD", "DB_NAME"}}
}
{
if (_conf_name[0] == '/')
{
conf_file = _conf_name;
}
else
{
conf_file = etc_location + _conf_name;
}
}
virtual ~NebulaTemplate() = default;
/**
* Parse and loads the configuration in the template
*/
virtual int load_configuration();
std::string& to_str(std::string& str) const override;
std::string& to_xml_hidden(std::string& str) const;
protected:
/**
* Full path to the configuration file
*/
std::string conf_file;
/**
* Defaults for the configuration file
*/
std::multimap<std::string, Attribute*> conf_default;
/**
* Hidden attributes, which shouldn't be displayed to non-admin users
* For Simple attributes use {"PORT", {}}
* For Vector attributes use {"DB", {"USER", "PASSWD"}}
*/
std::map<std::string, std::set<std::string>> hidden_attributes;
/**
* Sets the defaults value for the template
*/
virtual void set_conf_default() = 0;
/**
* Sets the defaults value for multiple attributes
*/
virtual void set_multiple_conf_default() = 0;
/**
* Sets a default single attribute value
*/
void set_conf_single(const std::string& attr, const std::string& value);
};
#endif /*NEBULA_TEMPLATE_H_*/