Browse Source

Update comment to fix lint error

This patch updats comment in several manifests to fix lint error with
the following messages:
 - No matching class parameter for documentation of <parameter name>
 - Duplicate class parameter documentation for <parameter name>

Change-Id: I927fc43fefe169d4041d980ef834975822d3755d
changes/11/756111/2
Takashi Kajinami 12 months ago
parent
commit
76a80d9e6c
  1. 4
      manifests/certmonger/libvirt.pp
  2. 4
      manifests/certmonger/libvirt_dirs.pp
  3. 6
      manifests/certmonger/metrics_qdr.pp
  4. 3
      manifests/certmonger/novnc_proxy.pp
  5. 4
      manifests/certmonger/qemu.pp
  6. 4
      manifests/host/liquidio/compute.pp
  7. 11
      manifests/host/liquidio/config.pp
  8. 5
      manifests/network/contrail/config.pp
  9. 5
      manifests/network/contrail/heat.pp
  10. 28
      manifests/network/contrail/neutron_plugin.pp
  11. 4
      manifests/network/contrail/provision.pp
  12. 9
      manifests/profile/base/barbican/backends.pp
  13. 4
      manifests/profile/base/cinder/volume/iscsi.pp
  14. 9
      manifests/profile/base/metrics/qdr.pp
  15. 61
      spec/classes/tripleo_profile_base_nova_conductor_spec.rb

4
manifests/certmonger/libvirt.pp

@ -31,10 +31,6 @@
# (Optional) The CA that certmonger will use to generate the certificates.
# Defaults to hiera('certmonger_ca', 'local').
#
# [*file_owner*]
# (Optional) The user which the certificate and key files belong to.
# Defaults to 'root'
#
# [*postsave_cmd*]
# (Optional) Specifies the command to execute after requesting a certificate.
# If nothing is given, it will default to: "systemctl reload ${service name}"

4
manifests/certmonger/libvirt_dirs.pp

@ -24,10 +24,6 @@
# unspecified, it won't be created.
# Defaults to undef
#
# [*certificate_dir*]
# (Optional) Directory where libvirt's certificates will be stored.
# Defaults to undef
#
# [*key_dir*]
# (Optional) Directory where libvirt's keys will be stored.
# Defaults to undef

6
manifests/certmonger/metrics_qdr.pp

@ -31,12 +31,6 @@
# (Optional) The CA that certmonger will use to generate the certificates.
# Defaults to hiera('certmonger_ca', 'local').
#
# [*dnsnames*]
# (Optional) The DNS names that will be added for the SubjectAltNames entry
# in the certificate. If left unset, the value will be set to the $hostname.
# This parameter can take both a string or an array of strings.
# Defaults to $hostname
#
# [*postsave_cmd*]
# (Optional) Specifies the command to execute after requesting a certificate.
# If nothing is given, it will default to: "systemctl restart ${service name}"

3
manifests/certmonger/novnc_proxy.pp

@ -27,9 +27,6 @@
# [*service_key*]
# The path to the key that will be used for TLS in this service.
#
# [*service_pem*]
# The file in PEM format that the HAProxy service will use as a certificate.
#
# [*certmonger_ca*]
# (Optional) The CA that certmonger will use to generate the certificates.
# Defaults to hiera('certmonger_ca', 'local').

4
manifests/certmonger/qemu.pp

@ -31,10 +31,6 @@
# (Optional) The CA that certmonger will use to generate the certificates.
# Defaults to hiera('certmonger_ca', 'local').
#
# [*file_owner*]
# (Optional) The user which the certificate and key files belong to.
# Defaults to 'root'
#
# [*postsave_cmd*]
# (Optional) Specifies the command to execute after requesting a certificate.
# Defaults to undef.

4
manifests/host/liquidio/compute.pp

@ -16,10 +16,6 @@
# (required) Tenant network's ip of the compute node
# Defaults to hiera('tenant')
#
# [*tenant_network_type*]
# (required) Type of tenant networks to be configured
# Defaults to hiera('neutron::plugins::ml2::tenant_network_types')
#
# [*vf_nums*]
# (required) Number of VFs to be created on the node
#

11
manifests/host/liquidio/config.pp

@ -4,9 +4,9 @@
#
# === Parameters
#
# [*xxx_config*]
# (optional) Allow configuration of arbitrary Neutron xxx specific configurations.
# The value is a hash of neutron_config resources. Example:
# [*liquidio_config*]
# (optional) Allow configuration of liquidio.conf configurations.
# The value is a hash of liquidio_config resources. Example:
# server_config =>
# { 'DEFAULT/foo' => { value => 'fooValue'},
# 'DEFAULT/bar' => { value => 'barValue'}
@ -15,15 +15,12 @@
# NOTE: { 'DEFAULT/foo': value => 'fooValue'; 'DEFAULT/bar': value => 'barValue'} is invalid.
#
# In yaml format, Example:
# server_config:
# liquidio_config:
# DEFAULT/foo:
# value: fooValue
# DEFAULT/bar:
# value: barValue
#
# [*liquidio_config*]
# (optional) Allow configuration of liquidio.conf configurations.
#
class tripleo::host::liquidio::config (
$liquidio_config = {}
) {

5
manifests/network/contrail/config.pp

@ -145,11 +145,6 @@
# (optional) Listen port for config-api
# Defaults to hiera('contrail::api_port')
#
# [*linklocal_service_name*]
# (optional) name of link local service
# String value
# Defaults to metadata
#
# [*linklocal_service_port*]
# (optional) port of link local service
# String value

5
manifests/network/contrail/heat.pp

@ -24,11 +24,6 @@
# String value.
# Defaults to hiera('contrail::admin_password')
#
# [*admin_tenant_name*]
# (optional) admin tenant name.
# String value.
# Defaults to hiera('contrail::admin_tenant_name')
#
# [*admin_token*]
# (optional) admin token
# String value.

28
manifests/network/contrail/neutron_plugin.pp

@ -57,14 +57,6 @@
# String value.
# Defaults to hiera('contrail::service_certificate',false)
#
# [*api_server_ip*]
# IP address of the API Server
# Defaults to $::os_service_default
#
# [*api_server_port*]
# Port of the API Server.
# Defaults to $::os_service_default
#
# [*contrail_extensions*]
# Array of OpenContrail extensions to be supported
# Defaults to $::os_service_default
@ -74,26 +66,6 @@
# contrail_extensions => ['ipam:neutron_plugin_contrail.plugins.opencontrail.contrail_plugin_ipam.NeutronPluginContrailIpam']
# }
#
# [*keystone_auth_url*]
# Url of the keystone auth server
# Defaults to $::os_service_default
#
# [*keystone_admin_user*]
# Admin user name
# Defaults to $::os_service_default
#
# [*keystone_admin_tenant_name*]
# Admin_tenant_name
# Defaults to $::os_service_default
#
# [*keystone_admin_password*]
# Admin password
# Defaults to $::os_service_default
#
# [*keystone_admin_token*]
# Admin token
# Defaults to $::os_service_default
#
# [*package_ensure*]
# (optional) Ensure state for package.
# Defaults to 'present'.

4
manifests/network/contrail/provision.pp

@ -19,10 +19,6 @@
#
# == Parameters:
#
# [*host_ip*]
# (required) host IP address of Control
# String (IPv4) value.
#
# [*admin_password*]
# (optional) admin password
# String value.

9
manifests/profile/base/barbican/backends.pp

@ -18,15 +18,6 @@
#
# === Parameters
#
# [*bootstrap_node*]
# (Optional) The hostname of the node responsible for bootstrapping tasks
# Defaults to hiera('barbican_api_bootstrap_node_name')
#
# [*step*]
# (Optional) The current step in deployment. See tripleo-heat-templates
# for more details.
# Defaults to hiera('step')
#
# [*simple_crypto_backend_enabled*]
# (Optional) Whether the simple crypto backend is enabled or not. This is
# dynamically set via t-h-t.

4
manifests/profile/base/cinder/volume/iscsi.pp

@ -37,10 +37,6 @@
# (Optional) The iscsi protocol to use
# Defaults to 'iscsi'
#
# [*cinder_lvm_loop_device_size*]
# (Optional) The size (in MB) of the LVM loopback volume
# Defaults to '10280'
#
# [*step*]
# (Optional) The current step in deployment. See tripleo-heat-templates
# for more details.

9
manifests/profile/base/metrics/qdr.pp

@ -26,15 +26,6 @@
# Password for the qdrouter daemon
# Defaults to undef
#
# [*listen_on_external*]
# (optional) Whether QDR should listen for connections
# on external_listener_addr rather than listener_addr.
# Defaults to false
#
# [*external_listener_addr*]
# (optional) Bind address for external connections (CloudForms for example)
# Defaults to 'localhost'
#
# [*listener_addr*]
# (optional) Service host name
# Defaults to 'localhost'

61
spec/classes/tripleo_profile_base_nova_conductor_spec.rb

@ -1,61 +0,0 @@
#
# Copyright (C) 2017 Red Hat, Inc.
#
# 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.
#
require 'spec_helper'
describe 'tripleo::profile::base::nova::conductor' do
shared_examples_for 'tripleo::profile::base::nova::conductor' do
let(:pre_condition) do
<<-eos
class { 'tripleo::profile::base::nova':
step => #{params[:step]},
oslomsg_rpc_hosts => [ '127.0.0.1' ],
}
eos
end
context 'with step less than 4' do
let(:params) { { :step => 1, } }
it {
is_expected.to contain_class('tripleo::profile::base::nova::conductor')
is_expected.to contain_class('tripleo::profile::base::nova')
is_expected.to_not contain_class('nova::conductor')
}
end
context 'with step 4' do
let(:params) { { :step => 4, } }
it {
is_expected.to contain_class('tripleo::profile::base::nova::conductor')
is_expected.to contain_class('tripleo::profile::base::nova')
is_expected.to contain_class('nova::conductor')
}
end
end
on_supported_os.each do |os, facts|
context "on #{os}" do
let(:facts) do
facts.merge({ :hostname => 'node.example.com' })
end
it_behaves_like 'tripleo::profile::base::nova::conductor'
end
end
end
Loading…
Cancel
Save