From 02ffeba0d94885aa9e4f00cff7325d6e622e6a01 Mon Sep 17 00:00:00 2001 From: Takashi Kajinami Date: Sun, 22 Mar 2020 22:09:32 +0900 Subject: [PATCH] Replace deprecated gnocchi::storage::coordination_url The gnocchi::storage::corrdination_url parameter was deprecated to be replaced by the gnocchi::coordination_url parameter. This patch make puppet-tripleo to use the new parameter instead of the deprecated one. Depends-on: https://review.opendev.org/#/c/713448/ Change-Id: I2bbe95375c465aea8d2fe91b31897541ed998ae7 --- manifests/profile/base/gnocchi.pp | 69 +++++++++++- manifests/profile/base/gnocchi/api.pp | 4 - .../tripleo_profile_base_gnocchi_api_spec.rb | 93 +++++++++------- .../tripleo_profile_base_gnocchi_spec.rb | 103 ++++++++++++++++++ spec/fixtures/hieradata/default.yaml | 1 + 5 files changed, 225 insertions(+), 45 deletions(-) create mode 100644 spec/classes/tripleo_profile_base_gnocchi_spec.rb diff --git a/manifests/profile/base/gnocchi.pp b/manifests/profile/base/gnocchi.pp index 6650d342b..d4082c82d 100644 --- a/manifests/profile/base/gnocchi.pp +++ b/manifests/profile/base/gnocchi.pp @@ -18,18 +18,79 @@ # # === Parameters # +# [*bootstrap_node*] +# (Optional) The hostname of the node responsible for bootstrapping tasks +# Defaults to hiera('gnocchi_api_short_bootstrap_node_name') +# +# [*certificates_specs*] +# (Optional) The specifications to give to certmonger for the certificate(s) +# it will create. +# Example with hiera: +# apache_certificates_specs: +# httpd-internal_api: +# hostname: +# service_certificate: +# service_key: +# principal: "haproxy/" +# Defaults to hiera('apache_certificate_specs', {}). +# +# [*enable_internal_tls*] +# (Optional) Whether TLS in the internal network is enabled or not. +# Defaults to hiera('enable_internal_tls', false) +# +# [*gnocchi_redis_password*] +# (Required) Password for the gnocchi redis user for the coordination url +# Defaults to hiera('gnocchi_redis_password') +# +# [*gnocchi_network*] +# (Optional) The network name where the gnocchi endpoint is listening on. +# This is set by t-h-t. +# Defaults to hiera('gnocchi_api_network', undef) +# +# [*redis_vip*] +# (Required) Redis ip address for the coordination url +# Defaults to hiera('redis_vip') +# # [*step*] # (Optional) The current step in deployment. See tripleo-heat-templates # for more details. # Defaults to hiera('step') # class tripleo::profile::base::gnocchi ( - $step = Integer(hiera('step')), + $bootstrap_node = hiera('gnocchi_api_short_bootstrap_node_name', undef), + $certificates_specs = hiera('apache_certificates_specs', {}), + $enable_internal_tls = hiera('enable_internal_tls', false), + $gnocchi_network = hiera('gnocchi_api_network', undef), + $gnocchi_redis_password = hiera('gnocchi_redis_password'), + $redis_vip = hiera('redis_vip'), + $step = Integer(hiera('step')), ) { - if $step >= 3 { - warning('Gnocchi is deprecated and is going to be removed in future.') + warning('Gnocchi is deprecated and is going to be removed in future.') - include gnocchi + if $::hostname == downcase($bootstrap_node) { + $sync_db = true + } else { + $sync_db = false + } + + if $enable_internal_tls { + if !$gnocchi_network { + fail('gnocchi_api_network is not set in the hieradata.') + } + $tls_certfile = $certificates_specs["httpd-${gnocchi_network}"]['service_certificate'] + $tls_keyfile = $certificates_specs["httpd-${gnocchi_network}"]['service_key'] + $tls_query_param = '?ssl=true' + } else { + $tls_certfile = undef + $tls_keyfile = undef + $tls_query_param = '' + } + + if $step >= 4 or ($step >= 3 and $sync_db) { + + class { 'gnocchi': + coordination_url => join(['redis://:', $gnocchi_redis_password, '@', normalize_ip_for_uri($redis_vip), ':6379/', $tls_query_param]), + } include gnocchi::config include gnocchi::cors include gnocchi::client diff --git a/manifests/profile/base/gnocchi/api.pp b/manifests/profile/base/gnocchi/api.pp index 890055f53..dc6e135d1 100644 --- a/manifests/profile/base/gnocchi/api.pp +++ b/manifests/profile/base/gnocchi/api.pp @@ -124,10 +124,6 @@ class tripleo::profile::base::gnocchi::api ( ssl_key => $tls_keyfile, } - class { 'gnocchi::storage': - coordination_url => join(['redis://:', $gnocchi_redis_password, '@', normalize_ip_for_uri($redis_vip), ':6379/', $tls_query_param]), - } - if $incoming_storage_driver == 'redis' { class { 'gnocchi::storage::incoming::redis': redis_url => join(['redis://:', $gnocchi_redis_password, '@', normalize_ip_for_uri($redis_vip), ':6379/', $tls_query_param]), diff --git a/spec/classes/tripleo_profile_base_gnocchi_api_spec.rb b/spec/classes/tripleo_profile_base_gnocchi_api_spec.rb index cddb8b9fa..6eed8d226 100644 --- a/spec/classes/tripleo_profile_base_gnocchi_api_spec.rb +++ b/spec/classes/tripleo_profile_base_gnocchi_api_spec.rb @@ -24,72 +24,90 @@ describe 'tripleo::profile::base::gnocchi::api' do shared_examples_for 'tripleo::profile::base::gnocchi::api' do let(:pre_condition) do - " - class { 'tripleo::profile::base::gnocchi': step => #{params[:step]}, } - " + <<-eos + class { 'tripleo::profile::base::gnocchi': + step => #{params[:step]}, + } +eos end context 'with step less than 3' do let(:params) { { :step => 2, - :gnocchi_redis_password => 'gnocchi', - :redis_vip => '127.0.0.1' } } it { is_expected.to contain_class('tripleo::profile::base::gnocchi::api') + is_expected.to contain_class('tripleo::profile::base::gnocchi') + is_expected.to contain_class('tripleo::profile::base::gnocchi::authtoken') + is_expected.to_not contain_class('gnocchi::db::sync') is_expected.to_not contain_class('gnocchi::api') is_expected.to_not contain_class('gnocchi::wsgi::apache') } end - context 'with step 4 on bootstrap' do + context 'with step 3 on bootstrap' do let(:params) { { - :step => 4, + :step => 3, :bootstrap_node => 'node.example.com', - :gnocchi_redis_password => 'gnocchi', - :redis_vip => '127.0.0.1' } } it { + is_expected.to contain_class('tripleo::profile::base::gnocchi::api') + is_expected.to contain_class('tripleo::profile::base::gnocchi') + is_expected.to contain_class('tripleo::profile::base::gnocchi::authtoken') is_expected.to contain_class('gnocchi::db::sync') is_expected.to contain_class('gnocchi::api') is_expected.to contain_class('gnocchi::wsgi::apache') } end - context 'with step 4' do + context 'with step 3 not on bootstrap' do let(:params) { { - :step => 4, - :gnocchi_redis_password => 'gnocchi', - :redis_vip => '127.0.0.1' + :step => 3, + :bootstrap_node => 'other.example.com', } } it { + is_expected.to contain_class('tripleo::profile::base::gnocchi::api') + is_expected.to contain_class('tripleo::profile::base::gnocchi') + is_expected.to contain_class('tripleo::profile::base::gnocchi::authtoken') + is_expected.to_not contain_class('gnocchi::db::sync') + is_expected.to_not contain_class('gnocchi::api') + is_expected.to_not contain_class('gnocchi::wsgi::apache') + } + end + + context 'with step 4' do + let(:params) { { + :step => 4, + } } + + it { + is_expected.to contain_class('tripleo::profile::base::gnocchi::api') + is_expected.to contain_class('tripleo::profile::base::gnocchi') + is_expected.to contain_class('tripleo::profile::base::gnocchi::authtoken') is_expected.to contain_class('gnocchi::api') is_expected.to contain_class('gnocchi::wsgi::apache') - is_expected.to contain_class('gnocchi::storage').with( - :coordination_url => 'redis://:gnocchi@127.0.0.1:6379/' - ) is_expected.to contain_class('gnocchi::storage::swift') } end context 'with step 4 with file backend' do let(:params) { { - :step => 4, - :gnocchi_backend => 'file', - :gnocchi_redis_password => 'gnocchi', - :redis_vip => '127.0.0.1', + :step => 4, + :gnocchi_backend => 'file', + :gnocchi_redis_password => 'gnocchi', + :redis_vip => '127.0.0.1', :incoming_storage_driver => 'redis', } } it { + is_expected.to contain_class('tripleo::profile::base::gnocchi::api') + is_expected.to contain_class('tripleo::profile::base::gnocchi') + is_expected.to contain_class('tripleo::profile::base::gnocchi::authtoken') is_expected.to contain_class('gnocchi::api') is_expected.to contain_class('gnocchi::wsgi::apache') - is_expected.to contain_class('gnocchi::storage').with( - :coordination_url => 'redis://:gnocchi@127.0.0.1:6379/' - ) is_expected.to contain_class('gnocchi::storage::incoming::redis').with( :redis_url => 'redis://:gnocchi@127.0.0.1:6379/' ) @@ -99,20 +117,20 @@ describe 'tripleo::profile::base::gnocchi::api' do context 'with step 4 with ceph backend' do let(:params) { { - :step => 4, - :gnocchi_backend => 'rbd', - :gnocchi_redis_password => 'gnocchi', - :redis_vip => '127.0.0.1', + :step => 4, + :gnocchi_backend => 'rbd', + :gnocchi_redis_password => 'gnocchi', + :redis_vip => '127.0.0.1', :gnocchi_rbd_client_name => 'openstack', :incoming_storage_driver => 'redis', } } it { + is_expected.to contain_class('tripleo::profile::base::gnocchi::api') + is_expected.to contain_class('tripleo::profile::base::gnocchi') + is_expected.to contain_class('tripleo::profile::base::gnocchi::authtoken') is_expected.to contain_class('gnocchi::api') is_expected.to contain_class('gnocchi::wsgi::apache') - is_expected.to contain_class('gnocchi::storage').with( - :coordination_url => 'redis://:gnocchi@127.0.0.1:6379/' - ) is_expected.to contain_class('gnocchi::storage::incoming::redis').with( :redis_url => 'redis://:gnocchi@127.0.0.1:6379/' ) @@ -124,10 +142,10 @@ describe 'tripleo::profile::base::gnocchi::api' do context 'skip incoming storage in step 4' do let(:params) { { - :step => 4, - :gnocchi_backend => 'rbd', - :gnocchi_redis_password => 'gnocchi', - :redis_vip => '127.0.0.1', + :step => 4, + :gnocchi_backend => 'rbd', + :gnocchi_redis_password => 'gnocchi', + :redis_vip => '127.0.0.1', :incoming_storage_driver => '', } } @@ -138,13 +156,14 @@ describe 'tripleo::profile::base::gnocchi::api' do context 'with step 5 on bootstrap' do let(:params) { { - :step => 5, + :step => 5, :bootstrap_node => 'node.example.com', - :gnocchi_redis_password => 'gnocchi', - :redis_vip => '127.0.0.1' } } it { + is_expected.to contain_class('tripleo::profile::base::gnocchi::api') + is_expected.to contain_class('tripleo::profile::base::gnocchi') + is_expected.to contain_class('tripleo::profile::base::gnocchi::authtoken') is_expected.to contain_class('gnocchi::api') is_expected.to contain_class('gnocchi::wsgi::apache') } diff --git a/spec/classes/tripleo_profile_base_gnocchi_spec.rb b/spec/classes/tripleo_profile_base_gnocchi_spec.rb new file mode 100644 index 000000000..2971a24dd --- /dev/null +++ b/spec/classes/tripleo_profile_base_gnocchi_spec.rb @@ -0,0 +1,103 @@ +# +# Copyright (C) 2020 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::gnocchi' do + + before :each do + facts.merge!({ :step => params[:step] }) + end + + shared_examples_for 'tripleo::profile::base::gnocchi' do + context 'with step less than 3' do + let(:params) { { + :step => 2, + } } + + it { + is_expected.to_not contain_class('gnocchi') + is_expected.to_not contain_class('gnocchi::config') + is_expected.to_not contain_class('gnocchi::cors') + is_expected.to_not contain_class('gnocchi::client') + is_expected.to_not contain_class('gnocchi::logging') + } + end + + context 'with step 3 on bootstrap' do + let(:params) { { + :step => 3, + :bootstrap_node => 'node.example.com', + :gnocchi_redis_password => 'gnocchi', + :redis_vip => '127.0.0.1', + } } + + it { + is_expected.to contain_class('gnocchi').with( + :coordination_url => 'redis://:gnocchi@127.0.0.1:6379/' + ) + is_expected.to contain_class('gnocchi::config') + is_expected.to contain_class('gnocchi::cors') + is_expected.to contain_class('gnocchi::client') + is_expected.to contain_class('gnocchi::logging') + } + end + + context 'with step 3 not on bootstrap' do + let(:params) { { + :step => 3, + :bootstrap_node => 'other.example.com', + } } + + it { + is_expected.to_not contain_class('gnocchi') + is_expected.to_not contain_class('gnocchi::config') + is_expected.to_not contain_class('gnocchi::cors') + is_expected.to_not contain_class('gnocchi::client') + is_expected.to_not contain_class('gnocchi::logging') + } + end + + context 'with step 4' do + let(:params) { { + :step => 4, + :gnocchi_redis_password => 'gnocchi', + :redis_vip => '127.0.0.1', + } } + + it { + is_expected.to contain_class('gnocchi').with( + :coordination_url => 'redis://:gnocchi@127.0.0.1:6379/' + ) + is_expected.to contain_class('gnocchi::config') + is_expected.to contain_class('gnocchi::cors') + is_expected.to contain_class('gnocchi::client') + is_expected.to contain_class('gnocchi::logging') + } + 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::gnocchi' + end + end +end + diff --git a/spec/fixtures/hieradata/default.yaml b/spec/fixtures/hieradata/default.yaml index 4b3cac883..716db2512 100644 --- a/spec/fixtures/hieradata/default.yaml +++ b/spec/fixtures/hieradata/default.yaml @@ -52,6 +52,7 @@ gnocchi_api_short_bootstrap_node_name: node gnocchi::keystone::authtoken::password: 'password' gnocchi::storage::ceph::ceph_username: 'gnocchi' gnocchi::storage::ceph::ceph_secret: 'password' +gnocchi_redis_password: 'password' # ironic related items ironic::api::authtoken::password: 'password' ironic_api_short_bootstrap_node_name: node