From 18a9ac11713bea0f7b6ebaeb78f7eff71b160cca Mon Sep 17 00:00:00 2001 From: Bartlomiej Poniecki-Klotz Date: Tue, 26 Oct 2021 12:57:52 +0200 Subject: [PATCH] hide-create-volume config added The configuration option hide-create-volume was added and is passed into the horizon configuration as hide_create_volume. Closes-Bug: #1939079 Change-Id: I639810d5908cc58f41907f9a3bd66dc78b9517d6 --- config.yaml | 6 + hooks/horizon_contexts.py | 1 + templates/stein/local_settings.py | 1044 +++++++++++++++++++++++++++ test-requirements.txt | 2 + unit_tests/test_horizon_contexts.py | 52 ++ 5 files changed, 1105 insertions(+) create mode 100644 templates/stein/local_settings.py diff --git a/config.yaml b/config.yaml index e1baf4d1..048576b9 100644 --- a/config.yaml +++ b/config.yaml @@ -340,6 +340,12 @@ options: workflow for image and instance snapshot sources when launching an instance. This option has an effect only to Ocata or newer releases. + hide-create-volume: + type: boolean + default: False + description: | + Hide the "Create New Volume" option and rely on the + default-create-volume value during instance creation. image-formats: type: string default: "" diff --git a/hooks/horizon_contexts.py b/hooks/horizon_contexts.py index b6f86b32..6d67aeae 100644 --- a/hooks/horizon_contexts.py +++ b/hooks/horizon_contexts.py @@ -245,6 +245,7 @@ class HorizonContext(OSContextGenerator): 'default_domain': config('default-domain'), 'multi_domain': False if config('default-domain') else True, "default_create_volume": config("default-create-volume"), + 'hide_create_volume': config('hide-create-volume'), 'image_formats': config('image-formats'), 'api_result_limit': config('api-result-limit') or 1000, 'enable_fip_topology_check': config('enable-fip-topology-check'), diff --git a/templates/stein/local_settings.py b/templates/stein/local_settings.py new file mode 100644 index 00000000..3e2bbf34 --- /dev/null +++ b/templates/stein/local_settings.py @@ -0,0 +1,1044 @@ +# -*- coding: utf-8 -*- + +import os + +from django.utils.translation import ugettext_lazy as _ + +from horizon.utils import secret_key + +{% if use_syslog %} +from logging.handlers import SysLogHandler +{% endif %} + +from openstack_dashboard import exceptions +from openstack_dashboard.settings import HORIZON_CONFIG + +DEBUG = {{ debug }} +TEMPLATE_DEBUG = DEBUG + + +# WEBROOT is the location relative to Webserver root +# should end with a slash. +WEBROOT = '/' +#LOGIN_URL = WEBROOT + 'auth/login/' +#LOGOUT_URL = WEBROOT + 'auth/logout/' +# +# LOGIN_REDIRECT_URL can be used as an alternative for +# HORIZON_CONFIG.user_home, if user_home is not set. +# Do not set it to '/home/', as this will cause circular redirect loop +#LOGIN_REDIRECT_URL = WEBROOT + +# If horizon is running in production (DEBUG is False), set this +# with the list of host/domain names that the application can serve. +# For more information see: +# https://docs.djangoproject.com/en/dev/ref/settings/#allowed-hosts +#ALLOWED_HOSTS = ['horizon.example.com', ] + +# Set SSL proxy settings: +# Pass this header from the proxy after terminating the SSL, +# and don't forget to strip it from the client's request. +# For more information see: +# https://docs.djangoproject.com/en/dev/ref/settings/#secure-proxy-ssl-header +#SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https') + +# If Horizon is being served through SSL, then uncomment the following two +# settings to better secure the cookies from security exploits +#CSRF_COOKIE_SECURE = True +#SESSION_COOKIE_SECURE = True +{% if ssl_configured %} +CSRF_COOKIE_SECURE = True +SESSION_COOKIE_SECURE = True +{% endif %} + +# A method to supersede the token timeout with a shorter dashboard session +# timeout in seconds. +SESSION_TIMEOUT = {{ session_timeout }} + +# The absolute path to the directory where message files are collected. +# The message file must have a .json file extension. When the user logins to +# horizon, the message files collected are processed and displayed to the user. +#MESSAGES_PATH=None + +# Overrides for OpenStack API versions. Use this setting to force the +# OpenStack dashboard to use a specific API version for a given service API. +# Versions specified here should be integers or floats, not strings. +# NOTE: The version should be formatted as it appears in the URL for the +# service API. For example, The identity service APIs have inconsistent +# use of the decimal point, so valid options would be 2.0 or 3. +# Minimum compute version to get the instance locked status is 2.9. +#OPENSTACK_API_VERSIONS = { +# "data-processing": 1.1, +# "identity": 3, +# "volume": 2, +# "compute": 2, +#} + +# Set this to True if running on a multi-domain model. When this is enabled, it +# will require the user to enter the Domain name in addition to the username +# for login. +#OPENSTACK_KEYSTONE_MULTIDOMAIN_SUPPORT = False + +# Overrides the default domain used when running on single-domain model +# with Keystone V3. All entities will be created in the default domain. +# NOTE: This value must be the ID of the default domain, NOT the name. +# Also, you will most likely have a value in the keystone policy file like this +# "cloud_admin": "rule:admin_required and domain_id:" +# This value must match the domain id specified there. +#OPENSTACK_KEYSTONE_DEFAULT_DOMAIN = 'default' + +# Set this to True to enable panels that provide the ability for users to +# manage Identity Providers (IdPs) and establish a set of rules to map +# federation protocol attributes to Identity API attributes. +# This extension requires v3.0+ of the Identity API. +#OPENSTACK_KEYSTONE_FEDERATION_MANAGEMENT = False + +# Set Console type: +# valid options are "AUTO"(default), "VNC", "SPICE", "RDP", "SERIAL" or None +# Set to None explicitly if you want to deactivate the console. +#CONSOLE_TYPE = "AUTO" + +# If provided, a "Report Bug" link will be displayed in the site header +# which links to the value of this setting (ideally a URL containing +# information on how to report issues). +#HORIZON_CONFIG["bug_url"] = "http://bug-report.example.com" + +# Show backdrop element outside the modal, do not close the modal +# after clicking on backdrop. +#HORIZON_CONFIG["modal_backdrop"] = "static" + +# Specify a regular expression to validate user passwords. +#HORIZON_CONFIG["password_validator"] = { +# "regex": '.*', +# "help_text": _("Your password does not meet the requirements."), +#} + +# Disable simplified floating IP address management for deployments with +# multiple floating IP pools or complex network requirements. +#HORIZON_CONFIG["simple_ip_management"] = False + +# Turn off browser autocompletion for forms including the login form and +# the database creation workflow if so desired. +#HORIZON_CONFIG["password_autocomplete"] = "off" +{% if allow_password_autocompletion %} +HORIZON_CONFIG["password_autocomplete"] = "on" +{% endif %} + +# Setting this to True will disable the reveal button for password fields, +# including on the login form. +#HORIZON_CONFIG["disable_password_reveal"] = False +{% if disable_password_reveal %} +HORIZON_CONFIG["disable_password_reveal"] = True +{% endif %} + + +LOCAL_PATH = os.path.dirname(os.path.abspath(__file__)) + +# Set custom secret key: +# You can either set it to a specific value or you can let horizon generate a +# default secret key that is unique on this machine, e.i. regardless of the +# amount of Python WSGI workers (if used behind Apache+mod_wsgi): However, +# there may be situations where you would want to set this explicitly, e.g. +# when multiple dashboard instances are distributed on different machines +# (usually behind a load-balancer). Either you have to make sure that a session +# gets all requests routed to the same dashboard instance or you set the same +# SECRET_KEY for all of them. +SECRET_KEY = "{{ secret }}" + +# We recommend you use memcached for development; otherwise after every reload +# of the django development server, you will have to login again. To use +# memcached set CACHES to something like + +CACHES = { + 'default': { + 'BACKEND': 'django.core.cache.backends.memcached.MemcachedCache', + 'LOCATION': '127.0.0.1:11211', + }, +} +{% if database_host -%} +SESSION_ENGINE = 'django.contrib.sessions.backends.cached_db' +DATABASES = { + 'default': { + # Database configuration here + 'ENGINE': 'django.db.backends.mysql', + 'NAME': '{{ database }}', + 'USER': '{{ database_user }}', + 'PASSWORD': '{{ database_password }}', + 'HOST': '{{ database_host }}', + 'default-character-set': 'utf8' + } +} +{% else -%} +{% if api_version == "3" -%} +# Warning: Please add DB relation for Keystone v3 + HA deployments +SESSION_ENGINE = 'django.contrib.sessions.backends.cache' +{% endif -%} +{% endif -%} +#CACHES = { +# 'default': { +# 'BACKEND': 'django.core.cache.backends.locmem.LocMemCache', +# } +#} + +# Send email to the console by default +EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend' +# Or send them to /dev/null +#EMAIL_BACKEND = 'django.core.mail.backends.dummy.EmailBackend' + +# Configure these for your outgoing email host +#EMAIL_HOST = 'smtp.my-company.com' +#EMAIL_PORT = 25 +#EMAIL_HOST_USER = 'djangomail' +#EMAIL_HOST_PASSWORD = 'top-secret!' + +# For multiple regions uncomment this configuration, and add (endpoint, title). +#AVAILABLE_REGIONS = [ +# ('http://cluster1.example.com:5000/v2.0', 'cluster1'), +# ('http://cluster2.example.com:5000/v2.0', 'cluster2'), +#] +{% if regions|length > 1 -%} +AVAILABLE_REGIONS = [ +{% for region in regions -%} + ('{{ region.endpoint }}', '{{ region.title }}'), +{% endfor -%} +] +{% endif -%} + +OPENSTACK_HOST = "{{ ks_host }}" +OPENSTACK_KEYSTONE_DEFAULT_ROLE = "{{ default_role }}" +{% if api_version == "3" -%} +OPENSTACK_KEYSTONE_URL = "{{ ks_protocol }}://%s:{{ ks_port }}/v3" % OPENSTACK_HOST +OPENSTACK_API_VERSIONS = { "identity": 3, } +OPENSTACK_KEYSTONE_MULTIDOMAIN_SUPPORT = {{ multi_domain }} +OPENSTACK_KEYSTONE_DEFAULT_DOMAIN = "{{ default_domain or admin_domain_id }}" +{% else -%} +OPENSTACK_KEYSTONE_URL = "{{ ks_protocol }}://%s:{{ ks_port }}/v2.0" % OPENSTACK_HOST +{% endif -%} + + +# Enables keystone web single-sign-on if set to True. +#WEBSSO_ENABLED = False + +# Determines which authentication choice to show as default. +#WEBSSO_INITIAL_CHOICE = "credentials" + +# The list of authentication mechanisms which include keystone +# federation protocols and identity provider/federation protocol +# mapping keys (WEBSSO_IDP_MAPPING). Current supported protocol +# IDs are 'saml2' and 'oidc' which represent SAML 2.0, OpenID +# Connect respectively. +# Do not remove the mandatory credentials mechanism. +# Note: The last two tuples are sample mapping keys to a identity provider +# and federation protocol combination (WEBSSO_IDP_MAPPING). +#WEBSSO_CHOICES = ( +# ("credentials", _("Keystone Credentials")), +# ("oidc", _("OpenID Connect")), +# ("saml2", _("Security Assertion Markup Language")), +# ("acme_oidc", "ACME - OpenID Connect"), +# ("acme_saml2", "ACME - SAML2"), +#) + +# A dictionary of specific identity provider and federation protocol +# combinations. From the selected authentication mechanism, the value +# will be looked up as keys in the dictionary. If a match is found, +# it will redirect the user to a identity provider and federation protocol +# specific WebSSO endpoint in keystone, otherwise it will use the value +# as the protocol_id when redirecting to the WebSSO by protocol endpoint. +# NOTE: The value is expected to be a tuple formatted as: (, ). +#WEBSSO_IDP_MAPPING = { +# "acme_oidc": ("acme", "oidc"), +# "acme_saml2": ("acme", "saml2"), +#} + +# Disable SSL certificate checks (useful for self-signed certificates): +#OPENSTACK_SSL_NO_VERIFY = True + +# The CA certificate to use to verify SSL connections +#OPENSTACK_SSL_CACERT = '/path/to/cacert.pem' + +# The OPENSTACK_KEYSTONE_BACKEND settings can be used to identify the +# capabilities of the auth backend for Keystone. +# If Keystone has been configured to use LDAP as the auth backend then set +# can_edit_user to False and name to 'ldap'. +# +# TODO(tres): Remove these once Keystone has an API to identify auth backend. +OPENSTACK_KEYSTONE_BACKEND = { + 'name': 'native', + 'can_edit_user': True, + 'can_edit_group': True, + 'can_edit_project': True, + 'can_edit_domain': True, + 'can_edit_role': True, +} + +# Setting this to True, will add a new "Retrieve Password" action on instance, +# allowing Admin session password retrieval/decryption. +#OPENSTACK_ENABLE_PASSWORD_RETRIEVE = False +{% if password_retrieve %} +OPENSTACK_ENABLE_PASSWORD_RETRIEVE = True +{% endif %} + +# The Launch Instance user experience has been significantly enhanced. +# You can choose whether to enable the new launch instance experience, +# the legacy experience, or both. The legacy experience will be removed +# in a future release, but is available as a temporary backup setting to ensure +# compatibility with existing deployments. Further development will not be +# done on the legacy experience. Please report any problems with the new +# experience via the Launchpad tracking system. +# +# Toggle LAUNCH_INSTANCE_LEGACY_ENABLED and LAUNCH_INSTANCE_NG_ENABLED to +# determine the experience to enable. Set them both to true to enable +# both. +#LAUNCH_INSTANCE_LEGACY_ENABLED = True +#LAUNCH_INSTANCE_NG_ENABLED = False + +# A dictionary of settings which can be used to provide the default values for +# properties found in the Launch Instance modal. +#LAUNCH_INSTANCE_DEFAULTS = { +# 'config_drive': False, +# 'enable_scheduler_hints': True, +# 'disable_image': False, +# 'disable_instance_snapshot': False, +# 'disable_volume': False, +# 'disable_volume_snapshot': False, +# 'create_volume': True, +#} +LAUNCH_INSTANCE_DEFAULTS = { + 'create_volume': {{ default_create_volume }}, + 'disable_instance_snapshot': {{ disable_instance_snapshot }}, + 'hide_create_volume': {{ hide_create_volume }} +} + +# The Xen Hypervisor has the ability to set the mount point for volumes +# attached to instances (other Hypervisors currently do not). Setting +# can_set_mount_point to True will add the option to set the mount point +# from the UI. +OPENSTACK_HYPERVISOR_FEATURES = { + 'can_set_mount_point': False, + 'can_set_password': False, + 'requires_keypair': False, + 'enable_quotas': True +} + +# The OPENSTACK_CINDER_FEATURES settings can be used to enable optional +# services provided by cinder that is not exposed by its extension API. +OPENSTACK_CINDER_FEATURES = { + 'enable_backup': {{ cinder_backup }}, +} + +# The OPENSTACK_NEUTRON_NETWORK settings can be used to enable optional +# services provided by neutron. Options currently available are load +# balancer service, security groups, quotas, VPN service. +OPENSTACK_NEUTRON_NETWORK = { + 'enable_router': True, + 'enable_quotas': True, + 'enable_ipv6': True, + 'enable_distributed_router': {{ neutron_network_dvr }}, + 'enable_ha_router': {{ neutron_network_l3ha }}, + 'enable_lb': {{ neutron_network_lb }}, + 'enable_firewall': {{ neutron_network_firewall }}, + 'enable_vpn': {{ neutron_network_vpn }}, + 'enable_fip_topology_check': {{ enable_fip_topology_check }}, + + # Default dns servers you would like to use when a subnet is + # created. This is only a default, users can still choose a different + # list of dns servers when creating a new subnet. + # The entries below are examples only, and are not appropriate for + # real deployments + # 'default_dns_nameservers': ["8.8.8.8", "8.8.4.4", "208.67.222.222"], + + # Neutron can be configured with a default Subnet Pool to be used for IPv4 + # subnet-allocation. Specify the label you wish to display in the Address + # pool selector on the create subnet step if you want to use this feature. + 'default_ipv4_subnet_pool_label': None, + + # Neutron can be configured with a default Subnet Pool to be used for IPv6 + # subnet-allocation. Specify the label you wish to display in the Address + # pool selector on the create subnet step if you want to use this feature. + # You must set this to enable IPv6 Prefix Delegation in a PD-capable + # environment. + 'default_ipv6_subnet_pool_label': None, + + # The profile_support option is used to detect if an external router can be + # configured via the dashboard. When using specific plugins the + # profile_support can be turned on if needed. + {% if support_profile -%} + 'profile_support': '{{ support_profile }}', + {% else -%} + 'profile_support': None, + {% endif -%} + #'profile_support': 'cisco', + + # Set which provider network types are supported. Only the network types + # in this list will be available to choose from when creating a network. + # Network types include local, flat, vlan, gre, vxlan and geneve. + 'supported_provider_types': ['*'], + + # You can configure available segmentation ID range per network type + # in your deployment. + # 'segmentation_id_range': { + # 'vlan': [1024, 2048], + # 'vxlan': [4094, 65536], + # }, + + # You can define additional provider network types here. + # 'extra_provider_types': { + # 'awesome_type': { + # 'display_name': 'Awesome New Type', + # 'require_physical_network': False, + # 'require_segmentation_id': True, + # } + # }, + + # Set which VNIC types are supported for port binding. Only the VNIC + # types in this list will be available to choose from when creating a + # port. + # VNIC types include 'normal', 'macvtap' and 'direct'. + # Set to empty list or None to disable VNIC type selection. + 'supported_vnic_types': ['*'], +} + +# The OPENSTACK_HEAT_STACK settings can be used to disable password +# field required while launching the stack. +OPENSTACK_HEAT_STACK = { + 'enable_user_pass': True, +} + +# The OPENSTACK_IMAGE_BACKEND settings can be used to customize features +# in the OpenStack Dashboard related to the Image service, such as the list +# of supported image formats. +{% if image_formats -%} +OPENSTACK_IMAGE_BACKEND = { + 'image_formats': [ + ('', _('Select format')), + {% if 'aki' in image_formats -%}('aki', _('AKI - Amazon Kernel Image')),{% endif %} + {% if 'ami' in image_formats -%}('ami', _('AMI - Amazon Machine Image')),{% endif %} + {% if 'ari' in image_formats -%}('ari', _('ARI - Amazon Ramdisk Image')),{% endif %} + {% if 'docker' in image_formats -%}('docker', _('Docker')),{% endif %} + {% if 'iso' in image_formats -%}('iso', _('ISO - Optical Disk Image')),{% endif %} + {% if 'ova' in image_formats -%}('ova', _('OVA - Open Virtual Appliance')),{% endif %} + {% if 'qcow2' in image_formats -%}('qcow2', _('QCOW2 - QEMU Emulator')),{% endif %} + {% if 'raw' in image_formats -%}('raw', _('Raw')),{% endif %} + {% if 'vdi' in image_formats -%}('vdi', _('VDI - Virtual Disk Image')),{% endif %} + {% if 'vhd' in image_formats -%}('vhd', _('VHD - Virtual Hard Disk')),{% endif %} + {% if 'vmdk' in image_formats -%}('vmdk', _('VMDK - Virtual Machine Disk')),{% endif %} + ], +} +{% endif -%} + +# The IMAGE_CUSTOM_PROPERTY_TITLES settings is used to customize the titles for +# image custom property attributes that appear on image detail pages. +IMAGE_CUSTOM_PROPERTY_TITLES = { + "architecture": _("Architecture"), + "kernel_id": _("Kernel ID"), + "ramdisk_id": _("Ramdisk ID"), + "image_state": _("Euca2ools state"), + "project_id": _("Project ID"), + "image_type": _("Image Type"), +} + +# The IMAGE_RESERVED_CUSTOM_PROPERTIES setting is used to specify which image +# custom properties should not be displayed in the Image Custom Properties +# table. +IMAGE_RESERVED_CUSTOM_PROPERTIES = [] + +# Set to 'legacy' or 'direct' to allow users to upload images to glance via +# Horizon server. When enabled, a file form field will appear on the create +# image form. If set to 'off', there will be no file form field on the create +# image form. See documentation for deployment considerations. +#HORIZON_IMAGES_UPLOAD_MODE = 'legacy' + +# OPENSTACK_ENDPOINT_TYPE specifies the endpoint type to use for the endpoints +# in the Keystone service catalog. Use this setting when Horizon is running +# external to the OpenStack environment. The default is 'publicURL'. +#OPENSTACK_ENDPOINT_TYPE = "publicURL" +{% if primary_endpoint -%} +OPENSTACK_ENDPOINT_TYPE = "{{ primary_endpoint }}" +{% endif -%} + +# SECONDARY_ENDPOINT_TYPE specifies the fallback endpoint type to use in the +# case that OPENSTACK_ENDPOINT_TYPE is not present in the endpoints +# in the Keystone service catalog. Use this setting when Horizon is running +# external to the OpenStack environment. The default is None. This +# value should differ from OPENSTACK_ENDPOINT_TYPE if used. +#SECONDARY_ENDPOINT_TYPE = None +{% if secondary_endpoint -%} +SECONDARY_ENDPOINT_TYPE = "{{ secondary_endpoint }}" +{% endif -%} + +# The number of objects (Swift containers/objects or images) to display +# on a single page before providing a paging element (a "more" link) +# to paginate results. +API_RESULT_LIMIT = {{ api_result_limit }} +API_RESULT_PAGE_SIZE = 20 + +# The size of chunk in bytes for downloading objects from Swift +SWIFT_FILE_TRANSFER_CHUNK_SIZE = 512 * 1024 + +# Specify a maximum number of items to display in a dropdown. +DROPDOWN_MAX_ITEMS = {{ dropdown_max_items }} + +# The timezone of the server. This should correspond with the timezone +# of your entire OpenStack installation, and hopefully be in UTC. +TIME_ZONE = "UTC" + +# When launching an instance, the menu of available flavors is +# sorted by RAM usage, ascending. If you would like a different sort order, +# you can provide another flavor attribute as sorting key. Alternatively, you +# can provide a custom callback method to use for sorting. You can also provide +# a flag for reverse sort. For more info, see +# http://docs.python.org/2/library/functions.html#sorted +#CREATE_INSTANCE_FLAVOR_SORT = { +# 'key': 'name', +# # or +# 'key': my_awesome_callback_method, +# 'reverse': False, +#} + +# Set this to True to display an 'Admin Password' field on the Change Password +# form to verify that it is indeed the admin logged-in who wants to change +# the password. +{% if enforce_password_check %} +ENFORCE_PASSWORD_CHECK = True +{% endif %} + + +# Modules that provide /auth routes that can be used to handle different types +# of user authentication. Add auth plugins that require extra route handling to +# this list. +#AUTHENTICATION_URLS = [ +# 'openstack_auth.urls', +#] + +# The Horizon Policy Enforcement engine uses these values to load per service +# policy rule files. The content of these files should match the files the +# OpenStack services are using to determine role based access control in the +# target installation. + +# Path to directory containing policy.json files +#POLICY_FILES_PATH = os.path.join(ROOT_PATH, "conf") +{% if policyd_overrides_activated -%} +# Policies are overriden and all policies are here rather than in package conf +POLICY_FILES_PATH = '/etc/openstack-dashboard/policy.d/' + +# These are matched from the defaults + any in the overrides +{% if policy_dirs -%} +POLICY_DIRS = { +{% for k, vs in policy_dirs.items() -%} + "{{ k }}": [{% for v in vs -%}"{{ v }}", {% endfor -%}], +{% endfor -%} +} +{% endif -%} +{% endif -%} + +# Map of local copy of service policy files. +# Please insure that your identity policy file matches the one being used on +# your keystone servers. There is an alternate policy file that may be used +# in the Keystone v3 multi-domain case, policy.v3cloudsample.json. +# This file is not included in the Horizon repository by default but can be +# found at +# http://git.openstack.org/cgit/openstack/keystone/tree/etc/ \ +# policy.v3cloudsample.json +# Having matching policy files on the Horizon and Keystone servers is essential +# for normal operation. This holds true for all services and their policy files. +{% if api_version == "3" -%} +POLICY_FILES = { + 'identity': 'keystonev3_policy.json', + 'compute': 'nova_policy.json', + 'volume': 'cinder_policy.json', + 'image': 'glance_policy.json', + 'orchestration': 'heat_policy.json', + 'network': 'neutron_policy.json', +} +{% endif -%} + +# TODO: (david-lyle) remove when plugins support adding settings. +# Note: Only used when trove-dashboard plugin is configured to be used by +# Horizon. +# Trove user and database extension support. By default support for +# creating users and databases on database instances is turned on. +# To disable these extensions set the permission here to something +# unusable such as ["!"]. +#TROVE_ADD_USER_PERMS = [] +#TROVE_ADD_DATABASE_PERMS = [] + +# Change this patch to the appropriate list of tuples containing +# a key, label and static directory containing two files: +# _variables.scss and _styles.scss +#AVAILABLE_THEMES = [ +# ('default', 'Default', 'themes/default'), +# ('material', 'Material', 'themes/material'), +#] + +LOGGING = { + 'version': 1, + # When set to True this will disable all logging except + # for loggers specified in this configuration dictionary. Note that + # if nothing is specified here and disable_existing_loggers is True, + # django.db.backends will still log unless it is disabled explicitly. + 'disable_existing_loggers': False, + 'formatters': { + 'operation': { + # The format of "%(message)s" is defined by + # OPERATION_LOG_OPTIONS['format'] + 'format': '%(asctime)s %(message)s' + }, + }, + 'handlers': { + 'null': { + 'level': 'DEBUG', + 'class': 'logging.NullHandler', + }, + 'console': { + # Set the level to "DEBUG" for verbose output logging. + 'level': 'INFO', + 'class': 'logging.StreamHandler', + }, + 'operation': { + 'level': 'INFO', + 'class': 'logging.StreamHandler', + 'formatter': 'operation', + }, + {% if use_syslog %} + 'syslog': { + 'level': 'INFO', + 'class': 'logging.handlers.SysLogHandler', + }, + {% endif %} + }, + 'loggers': { + # Logging from django.db.backends is VERY verbose, send to null + # by default. + 'django.db.backends': { + 'handlers': ['null'], + 'propagate': False, + }, + 'requests': { + 'handlers': ['null'], + 'propagate': False, + }, + 'horizon': { + {% if use_syslog %} + 'handlers': ['syslog'], + {% else %} + 'handlers': ['console'], + {% endif %} + 'level': 'DEBUG', + 'propagate': False, + }, + 'openstack_dashboard': { + {% if use_syslog %} + 'handlers': ['syslog'], + {% else %} + 'handlers': ['console'], + {% endif %} + 'level': 'DEBUG', + 'propagate': False, + }, + 'novaclient': { + {% if use_syslog %} + 'handlers': ['syslog'], + {% else %} + 'handlers': ['console'], + {% endif %} + 'level': 'DEBUG', + 'propagate': False, + }, + 'cinderclient': { + {% if use_syslog %} + 'handlers': ['syslog'], + {% else %} + 'handlers': ['console'], + {% endif %} + 'level': 'DEBUG', + 'propagate': False, + }, + 'keystoneclient': { + {% if use_syslog %} + 'handlers': ['syslog'], + {% else %} + 'handlers': ['console'], + {% endif %} + 'level': 'DEBUG', + 'propagate': False, + }, + 'glanceclient': { + {% if use_syslog %} + 'handlers': ['syslog'], + {% else %} + 'handlers': ['console'], + {% endif %} + 'level': 'DEBUG', + 'propagate': False, + }, + 'neutronclient': { + {% if use_syslog %} + 'handlers': ['syslog'], + {% else %} + 'handlers': ['console'], + {% endif %} + 'level': 'DEBUG', + 'propagate': False, + }, + 'heatclient': { + {% if use_syslog %} + 'handlers': ['syslog'], + {% else %} + 'handlers': ['console'], + {% endif %} + 'level': 'DEBUG', + 'propagate': False, + }, + 'ceilometerclient': { + {% if use_syslog %} + 'handlers': ['syslog'], + {% else %} + 'handlers': ['console'], + {% endif %} + 'level': 'DEBUG', + 'propagate': False, + }, + 'swiftclient': { + {% if use_syslog %} + 'handlers': ['syslog'], + {% else %} + 'handlers': ['console'], + {% endif %} + 'level': 'DEBUG', + 'propagate': False, + }, + 'openstack_auth': { + {% if use_syslog %} + 'handlers': ['syslog'], + {% else %} + 'handlers': ['console'], + {% endif %} + 'level': 'DEBUG', + 'propagate': False, + }, + 'nose.plugins.manager': { + {% if use_syslog %} + 'handlers': ['syslog'], + {% else %} + 'handlers': ['console'], + {% endif %} + 'level': 'DEBUG', + 'propagate': False, + }, + 'django': { + {% if use_syslog %} + 'handlers': ['syslog'], + {% else %} + 'handlers': ['console'], + {% endif %} + 'level': 'DEBUG', + 'propagate': False, + }, + 'iso8601': { + 'handlers': ['null'], + 'propagate': False, + }, + 'scss': { + 'handlers': ['null'], + 'propagate': False, + }, + }, +} + +# 'direction' should not be specified for all_tcp/udp/icmp. +# It is specified in the form. +SECURITY_GROUP_RULES = { + 'all_tcp': { + 'name': _('All TCP'), + 'ip_protocol': 'tcp', + 'from_port': '1', + 'to_port': '65535', + }, + 'all_udp': { + 'name': _('All UDP'), + 'ip_protocol': 'udp', + 'from_port': '1', + 'to_port': '65535', + }, + 'all_icmp': { + 'name': _('All ICMP'), + 'ip_protocol': 'icmp', + 'from_port': '-1', + 'to_port': '-1', + }, + 'ssh': { + 'name': 'SSH', + 'ip_protocol': 'tcp', + 'from_port': '22', + 'to_port': '22', + }, + 'smtp': { + 'name': 'SMTP', + 'ip_protocol': 'tcp', + 'from_port': '25', + 'to_port': '25', + }, + 'dns': { + 'name': 'DNS', + 'ip_protocol': 'tcp', + 'from_port': '53', + 'to_port': '53', + }, + 'http': { + 'name': 'HTTP', + 'ip_protocol': 'tcp', + 'from_port': '80', + 'to_port': '80', + }, + 'pop3': { + 'name': 'POP3', + 'ip_protocol': 'tcp', + 'from_port': '110', + 'to_port': '110', + }, + 'imap': { + 'name': 'IMAP', + 'ip_protocol': 'tcp', + 'from_port': '143', + 'to_port': '143', + }, + 'ldap': { + 'name': 'LDAP', + 'ip_protocol': 'tcp', + 'from_port': '389', + 'to_port': '389', + }, + 'https': { + 'name': 'HTTPS', + 'ip_protocol': 'tcp', + 'from_port': '443', + 'to_port': '443', + }, + 'smtps': { + 'name': 'SMTPS', + 'ip_protocol': 'tcp', + 'from_port': '465', + 'to_port': '465', + }, + 'imaps': { + 'name': 'IMAPS', + 'ip_protocol': 'tcp', + 'from_port': '993', + 'to_port': '993', + }, + 'pop3s': { + 'name': 'POP3S', + 'ip_protocol': 'tcp', + 'from_port': '995', + 'to_port': '995', + }, + 'ms_sql': { + 'name': 'MS SQL', + 'ip_protocol': 'tcp', + 'from_port': '1433', + 'to_port': '1433', + }, + 'mysql': { + 'name': 'MYSQL', + 'ip_protocol': 'tcp', + 'from_port': '3306', + 'to_port': '3306', + }, + 'rdp': { + 'name': 'RDP', + 'ip_protocol': 'tcp', + 'from_port': '3389', + 'to_port': '3389', + }, +} + +# Deprecation Notice: +# +# The setting FLAVOR_EXTRA_KEYS has been deprecated. +# Please load extra spec metadata into the Glance Metadata Definition Catalog. +# +# The sample quota definitions can be found in: +# /etc/metadefs/compute-quota.json +# +# The metadata definition catalog supports CLI and API: +# $glance --os-image-api-version 2 help md-namespace-import +# $glance-manage db_load_metadefs +# +# See Metadata Definitions on: http://docs.openstack.org/developer/glance/ + +# TODO: (david-lyle) remove when plugins support settings natively +# Note: This is only used when the Sahara plugin is configured and enabled +# for use in Horizon. +# Indicate to the Sahara data processing service whether or not +# automatic floating IP allocation is in effect. If it is not +# in effect, the user will be prompted to choose a floating IP +# pool for use in their cluster. False by default. You would want +# to set this to True if you were running Nova Networking with +# auto_assign_floating_ip = True. +#SAHARA_AUTO_IP_ALLOCATION_ENABLED = False + +# The hash algorithm to use for authentication tokens. This must +# match the hash algorithm that the identity server and the +# auth_token middleware are using. Allowed values are the +# algorithms supported by Python's hashlib library. +#OPENSTACK_TOKEN_HASH_ALGORITHM = 'md5' + +# AngularJS requires some settings to be made available to +# the client side. Some settings are required by in-tree / built-in horizon +# features. These settings must be added to REST_API_REQUIRED_SETTINGS in the +# form of ['SETTING_1','SETTING_2'], etc. +# +# You may remove settings from this list for security purposes, but do so at +# the risk of breaking a built-in horizon feature. These settings are required +# for horizon to function properly. Only remove them if you know what you +# are doing. These settings may in the future be moved to be defined within +# the enabled panel configuration. +# You should not add settings to this list for out of tree extensions. +# See: https://wiki.openstack.org/wiki/Horizon/RESTAPI +REST_API_REQUIRED_SETTINGS = ['OPENSTACK_HYPERVISOR_FEATURES', + 'LAUNCH_INSTANCE_DEFAULTS', + 'OPENSTACK_IMAGE_FORMATS'] + +# Additional settings can be made available to the client side for +# extensibility by specifying them in REST_API_ADDITIONAL_SETTINGS +# !! Please use extreme caution as the settings are transferred via HTTP/S +# and are not encrypted on the browser. This is an experimental API and +# may be deprecated in the future without notice. +#REST_API_ADDITIONAL_SETTINGS = [] + +############################################################################### +# Ubuntu Settings +############################################################################### + +{% if ubuntu_theme %} +# Enable the Ubuntu theme if it is present. +DEFAULT_THEME = 'ubuntu' +{% elif default_theme %} +try: + AVAILABLE_THEMES +except NameError: + try: + from openstack_dashboard.settings import AVAILABLE_THEMES + except ImportError: + AVAILABLE_THEMES = [] + pass +if '{{ default_theme }}' not in [el[0] for el in AVAILABLE_THEMES]: + AVAILABLE_THEMES += [ + ('{{ default_theme }}', '{{ default_theme }}', + 'themes/{{ default_theme }}'), + ] +DEFAULT_THEME = '{{ default_theme }}' +{% elif custom_theme %} +AVAILABLE_THEMES = [] +try: + from custom_theme import * +except ImportError: + pass +AVAILABLE_THEMES += [ + ('default', 'Default', 'themes/default'), + ('custom', 'custom', 'themes/custom') +] +{% endif %} + +WEBROOT = '{{ webroot }}' +STATIC_URL = '/static/' + +{% if webroot == "/" %} +LOGIN_URL='/auth/login/' +LOGOUT_URL='/auth/logout/' +{% else %} +LOGIN_URL='{{ webroot }}/auth/login/' +LOGOUT_URL='{{ webroot }}/auth/logout/' +{% endif %} +LOGIN_REDIRECT_URL='{{ webroot }}' + +# By default, validation of the HTTP Host header is disabled. Production +# installations should have this set accordingly. For more information +# see https://docs.djangoproject.com/en/dev/ref/settings/. +ALLOWED_HOSTS = '*' + +# Compress all assets offline as part of packaging installation +#COMPRESS_OFFLINE = True + +# DISALLOW_IFRAME_EMBED can be used to prevent Horizon from being embedded +# within an iframe. Legacy browsers are still vulnerable to a Cross-Frame +# Scripting (XFS) vulnerability, so this option allows extra security hardening +# where iframes are not used in deployment. Default setting is True. +# For more information see: +# http://tinyurl.com/anticlickjack +#DISALLOW_IFRAME_EMBED = True + +# Help URL can be made available for the client. To provide a help URL, edit the +# following attribute to the URL of your choice. +#HORIZON_CONFIG["help_url"] = "http://openstack.mycompany.org" + +# Settings for OperationLogMiddleware +# OPERATION_LOG_ENABLED is flag to use the function to log an operation on +# Horizon. +# mask_targets is arrangement for appointing a target to mask. +# method_targets is arrangement of HTTP method to output log. +# format is the log contents. +#OPERATION_LOG_ENABLED = False +#OPERATION_LOG_OPTIONS = { +# 'mask_fields': ['password'], +# 'target_methods': ['POST'], +# 'format': ("[%(domain_name)s] [%(domain_id)s] [%(project_name)s]" +# " [%(project_id)s] [%(user_name)s] [%(user_id)s] [%(request_scheme)s]" +# " [%(referer_url)s] [%(request_url)s] [%(message)s] [%(method)s]" +# " [%(http_status)s] [%(param)s]"), +#} + +# The default date range in the Overview panel meters - either minus N +# days (if the value is integer N), or from the beginning of the current month +# until today (if set to None). This setting should be used to limit the amount +# of data fetched by default when rendering the Overview panel. +#OVERVIEW_DAYS_RANGE = 1 + +# To allow operators to require admin users provide a search criteria first +# before loading any data into the admin views, set the following attribute to +# True +#ADMIN_FILTER_DATA_FIRST=False + +# Dict used to restrict user private subnet cidr range. +# An empty list means that user input will not be restricted +# for a corresponding IP version. By default, there is +# no restriction for IPv4 or IPv6. To restrict +# user private subnet cidr range set ALLOWED_PRIVATE_SUBNET_CIDR +# to something like +#ALLOWED_PRIVATE_SUBNET_CIDR = { +# 'ipv4': ['10.0.0.0/8', '192.168.0.0/16'], +# 'ipv6': ['fc00::/7'] +#} +ALLOWED_PRIVATE_SUBNET_CIDR = {'ipv4': [], 'ipv6': []} + +# Project and user can have any attributes by keystone v3 mechanism. +# This settings can treat these attributes on Horizon. +# It means, when you show Create/Update modal, attribute below is +# shown and you can specify any value. +# If you'd like to display these extra data in project or user index table, +# Keystone v3 allows you to add extra properties to Project and Users. +# Horizon's customization (http://docs.openstack.org/developer/horizon/topics/customizing.html#horizon-customization-module-overrides) +# allows you to display this extra information in the Create/Update modal and +# the corresponding tables. +#PROJECT_TABLE_EXTRA_INFO = { +# 'phone_num': _('Phone Number'), +#} +#USER_TABLE_EXTRA_INFO = { +# 'phone_num': _('Phone Number'), +#} +{{ settings|join('\n\n') }} + +{% if websso_data %} +WEBSSO_ENABLED = True +WEBSSO_CHOICES = ( +{% for provider_data in websso_data -%} + ("{{ '{}_{}'.format(provider_data['idp-name'], provider_data['protocol-name']) }}", "{{ provider_data['user-facing-name'] }}"), +{% endfor -%} + ("credentials", _("Keystone Credentials")) +) + +WEBSSO_IDP_MAPPING = { +{% for provider_data in websso_data -%} + "{{ '{}_{}'.format(provider_data['idp-name'], provider_data['protocol-name']) }}": ("{{ provider_data['idp-name'] }}", "{{ provider_data['protocol-name'] }}"), +{% endfor -%} +} +{% endif %} diff --git a/test-requirements.txt b/test-requirements.txt index dba2c767..f853625d 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -7,6 +7,8 @@ # requirements. They are intertwined. Also, Zaza itself should specify # all of its own requirements and if it doesn't, fix it there. # +pyparsing<3.0.0 # aodhclient is pinned in zaza and needs pyparsing < 3.0.0, but cffi also needs it, so pin here. +cffi==1.14.6; python_version < '3.6' # cffi 1.15.0 drops support for py35. setuptools<50.0.0 # https://github.com/pypa/setuptools/commit/04e3df22df840c6bb244e9b27bc56750c44b7c85 requests>=2.18.4 diff --git a/unit_tests/test_horizon_contexts.py b/unit_tests/test_horizon_contexts.py index 8089093f..c2436a34 100644 --- a/unit_tests/test_horizon_contexts.py +++ b/unit_tests/test_horizon_contexts.py @@ -116,6 +116,7 @@ class TestHorizonContexts(CharmTestCase): "multi_domain": True, "allow_password_autocompletion": False, "default_create_volume": True, + 'hide_create_volume': False, "image_formats": '', "api_result_limit": 1000, "enable_fip_topology_check": True, @@ -150,6 +151,7 @@ class TestHorizonContexts(CharmTestCase): "multi_domain": False, "allow_password_autocompletion": False, "default_create_volume": True, + 'hide_create_volume': False, "image_formats": '', "api_result_limit": 1000, "enable_fip_topology_check": True, @@ -185,6 +187,7 @@ class TestHorizonContexts(CharmTestCase): "multi_domain": True, "allow_password_autocompletion": False, "default_create_volume": True, + 'hide_create_volume': False, "image_formats": '', "api_result_limit": 1000, "enable_fip_topology_check": True, @@ -220,6 +223,7 @@ class TestHorizonContexts(CharmTestCase): "multi_domain": True, "allow_password_autocompletion": False, "default_create_volume": True, + 'hide_create_volume': False, "image_formats": '', "api_result_limit": 1000, "enable_fip_topology_check": True, @@ -254,6 +258,7 @@ class TestHorizonContexts(CharmTestCase): "multi_domain": True, "allow_password_autocompletion": False, "default_create_volume": True, + 'hide_create_volume': False, "image_formats": '', "api_result_limit": 1000, "enable_fip_topology_check": True, @@ -288,6 +293,7 @@ class TestHorizonContexts(CharmTestCase): "multi_domain": True, "allow_password_autocompletion": False, "default_create_volume": True, + 'hide_create_volume': False, "image_formats": '', "api_result_limit": 1000, "enable_fip_topology_check": True, @@ -323,6 +329,7 @@ class TestHorizonContexts(CharmTestCase): "multi_domain": True, "allow_password_autocompletion": False, "default_create_volume": True, + 'hide_create_volume': False, "image_formats": '', "api_result_limit": 1000, "enable_fip_topology_check": True, @@ -361,6 +368,7 @@ class TestHorizonContexts(CharmTestCase): "multi_domain": True, "allow_password_autocompletion": False, "default_create_volume": True, + 'hide_create_volume': False, "image_formats": '', "api_result_limit": 1000, "enable_fip_topology_check": True, @@ -395,6 +403,7 @@ class TestHorizonContexts(CharmTestCase): "multi_domain": True, "allow_password_autocompletion": False, "default_create_volume": True, + "hide_create_volume": False, "image_formats": '', "api_result_limit": 1000, "enable_fip_topology_check": True, @@ -434,6 +443,7 @@ class TestHorizonContexts(CharmTestCase): "multi_domain": True, "allow_password_autocompletion": False, "default_create_volume": True, + 'hide_create_volume': False, "image_formats": '', "api_result_limit": 1000, "enable_fip_topology_check": True, @@ -468,6 +478,7 @@ class TestHorizonContexts(CharmTestCase): "multi_domain": True, "allow_password_autocompletion": False, "default_create_volume": True, + 'hide_create_volume': False, "image_formats": '', "api_result_limit": 1000, "enable_fip_topology_check": True, @@ -502,6 +513,7 @@ class TestHorizonContexts(CharmTestCase): "multi_domain": True, "allow_password_autocompletion": False, "default_create_volume": True, + 'hide_create_volume': False, "image_formats": '', "api_result_limit": 1000, "enable_fip_topology_check": True, @@ -537,6 +549,7 @@ class TestHorizonContexts(CharmTestCase): "multi_domain": True, "allow_password_autocompletion": True, "default_create_volume": True, + 'hide_create_volume': False, "image_formats": '', "api_result_limit": 1000, "enable_fip_topology_check": True, @@ -572,6 +585,43 @@ class TestHorizonContexts(CharmTestCase): "multi_domain": True, "allow_password_autocompletion": False, "default_create_volume": False, + 'hide_create_volume': False, + "image_formats": '', + "api_result_limit": 1000, + "enable_fip_topology_check": True, + "session_timeout": 3600, + "dropdown_max_items": 30, + "enable_consistency_groups": False, + "disable_instance_snapshot": False, + "disable_password_reveal": False, + "enforce_password_check": True, + } + ) + + def test_HorizonContext_hide_create_volume(self): + self.maxDiff = 900 + self.test_config.set('hide-create-volume', True) + self.assertEqual(horizon_contexts.HorizonContext()(), + {'compress_offline': True, 'debug': False, + 'customization_module': '', + 'webroot': '/horizon', + 'ubuntu_theme': True, + 'default_theme': None, + 'custom_theme': False, + 'secret': 'secret', + 'support_profile': None, + "neutron_network_dvr": False, + "neutron_network_l3ha": False, + "neutron_network_lb": False, + "neutron_network_firewall": False, + "neutron_network_vpn": False, + "cinder_backup": False, + "password_retrieve": False, + "default_domain": None, + "multi_domain": True, + "allow_password_autocompletion": False, + "default_create_volume": True, + 'hide_create_volume': True, "image_formats": '', "api_result_limit": 1000, "enable_fip_topology_check": True, @@ -607,6 +657,7 @@ class TestHorizonContexts(CharmTestCase): "multi_domain": True, "allow_password_autocompletion": False, "default_create_volume": True, + 'hide_create_volume': False, "image_formats": 'iso qcow2 raw', "api_result_limit": 1000, "enable_fip_topology_check": True, @@ -642,6 +693,7 @@ class TestHorizonContexts(CharmTestCase): "multi_domain": True, "allow_password_autocompletion": False, "default_create_volume": True, + 'hide_create_volume': False, "image_formats": '', "api_result_limit": 1000, "enable_fip_topology_check": False,