From cb803bc2182ef4bdcbbadf6799389d7dfb6dd565 Mon Sep 17 00:00:00 2001 From: James Slagle Date: Wed, 19 Jul 2017 09:51:04 -0400 Subject: [PATCH] Document DeploymentServerBlacklist Change-Id: I03a1f87f20a047e3a5becfa74053620f72b74de8 --- .../install/advanced_deployment/features.rst | 1 + .../advanced_deployment/server_blacklist.rst | 53 +++++++++++++++++++ 2 files changed, 54 insertions(+) create mode 100644 doc/source/install/advanced_deployment/server_blacklist.rst diff --git a/doc/source/install/advanced_deployment/features.rst b/doc/source/install/advanced_deployment/features.rst index 11f3d0db..bf92e72c 100644 --- a/doc/source/install/advanced_deployment/features.rst +++ b/doc/source/install/advanced_deployment/features.rst @@ -20,3 +20,4 @@ Documentation on how to enable and configure various features available in security_hardening api_policies disable_telemetry + server_blacklist diff --git a/doc/source/install/advanced_deployment/server_blacklist.rst b/doc/source/install/advanced_deployment/server_blacklist.rst new file mode 100644 index 00000000..027c800c --- /dev/null +++ b/doc/source/install/advanced_deployment/server_blacklist.rst @@ -0,0 +1,53 @@ +Blacklisting Servers from Heat Deployments +========================================== +Servers can be excluded from getting any updated Heat deployments by adding +them to a blacklist parameter called ``DeploymentServerBlacklist``. + + +Setting the blacklist +--------------------- +The ``DeploymentServerBlacklist`` parameter is a list of Heat server names. + +Write a new environment file, or add the parameter value to an existing +custom environment file and pass the file to the deployment command:: + + parameter_defaults: + DeploymentServerBlacklist: + - overcloud-compute-0 + - overcloud-compute-1 + - overcloud-compute-2 + +.. note:: + The server names in the parameter value are the names according to Heat, not + the actual server hostnames. + +Any servers in the list will be blacklisted by Heat from getting any updated +triggered deployments from Heat. After the stack operation completes, any +blacklisted servers will be unchanged. The blacklisted servers also could have +been powered off, or had their ``os-collect-config`` agents stopped during the +stack operation. + +The blacklist can be used during scale out operations or for isolating changes +to certain servers only. + +.. warning:: + Blacklisting servers should be done with caution, and only when the operator + understands that the requested change can be applied with a blacklist in + effect. + + It would be possible to blacklist servers in ways to create a hung stack in + Heat, or a misconfigured overcloud. For example, cluster configuration + changes that would need to be applied to all members of a pacemaker cluster + would not support blacklisting certain cluster members since it + could result is a misconfigured cluster. + +Clearing the blacklist +---------------------- +When clearing the blacklist for subsequent stack operations, an empty parameter +value must be sent with the deploy command. It is not sufficient to simply omit +the parameter since Heat will use the previously saved value. + +Send an empty list value to force Heat to clear the blacklist:: + + parameter_defaults: + DeploymentServerBlacklist: []