Merge pull request #7535 from tigercomputing/Icinga/feature/config-stage-activate-parameter

API /v1/config/stages 'activate' parameter

doc/12-icinga2-api.md

@@ -1849,8 +1849,12 @@ in the Director's deployment log.
 Send a `POST` request to the URL endpoint `/v1/config/stages` and add the name of an existing
 configuration package to the URL path (e.g. `example-cmdb`).
 The request body must contain the `files` attribute with the value being
-a dictionary of file targets and their content. You can also specify an optional `reload` attribute
-that will tell icinga2 to reload after stage config validation. By default this is set to `true`.
+a dictionary of file targets and their content.
+
+Optional attributes include `reload` (defaults to `true`) and `activate` (defaults to `true`).
+The `reload` attribute will tell icinga2 to reload after stage config validation.
+The `activate` attribute will tell icinga2 to activate the stage if it validates.
+If `activate` is set to `false`, `reload` must also be `false`.
 
 The file path requires one of these two directories inside its path:
 
@@ -1900,6 +1904,10 @@ can be disabled by setting `reload` to `false` in the request.
 If the validation for the new config stage failed, the old stage
 and its configuration objects will remain active.
 
+Activation may be inhibited even for stages that validate correctly by setting
+`activate` to `false`. This may be useful for validating the contents of a stage
+without making it active, for example in a CI (continuous integration) system.
+
 > **Note**
 >
 > Old stages are not purged automatically. You can [remove stages](12-icinga2-api.md#icinga2-api-config-management-delete-config-stage) that are no longer in use.

lib/remote/configpackageutility.cpp

@@ -171,7 +171,7 @@ void ConfigPackageUtility::ActivateStage(const String& packageName, const String
 	WritePackageConfig(packageName);
 }
 
-void ConfigPackageUtility::TryActivateStageCallback(const ProcessResult& pr, const String& packageName, const String& stageName, bool reload)
+void ConfigPackageUtility::TryActivateStageCallback(const ProcessResult& pr, const String& packageName, const String& stageName, bool activate, bool reload)
 {
 	String logFile = GetPackageDir() + "/" + packageName + "/" + stageName + "/startup.log";
 	std::ofstream fpLog(logFile.CStr(), std::ofstream::out | std::ostream::binary | std::ostream::trunc);
@@ -185,14 +185,16 @@ void ConfigPackageUtility::TryActivateStageCallback(const ProcessResult& pr, con
 
 	/* validation went fine, activate stage and reload */
 	if (pr.ExitStatus == 0) {
-		{
-			boost::mutex::scoped_lock lock(GetStaticPackageMutex());
+		if (activate) {
+			{
+				boost::mutex::scoped_lock lock(GetStaticPackageMutex());
 
-			ActivateStage(packageName, stageName);
+				ActivateStage(packageName, stageName);
+			}
+
+			if (reload)
+				Application::RequestRestart();
 		}
-
-		if (reload)
-			Application::RequestRestart();
 	} else {
 		Log(LogCritical, "ConfigPackageUtility")
 			<< "Config validation failed for package '"
@@ -200,7 +202,7 @@ void ConfigPackageUtility::TryActivateStageCallback(const ProcessResult& pr, con
 	}
 }
 
-void ConfigPackageUtility::AsyncTryActivateStage(const String& packageName, const String& stageName, bool reload)
+void ConfigPackageUtility::AsyncTryActivateStage(const String& packageName, const String& stageName, bool activate, bool reload)
 {
 	VERIFY(Application::GetArgC() >= 1);
 
@@ -226,7 +228,7 @@ void ConfigPackageUtility::AsyncTryActivateStage(const String& packageName, cons
 
 	Process::Ptr process = new Process(Process::PrepareCommand(args));
 	process->SetTimeout(Application::GetReloadTimeout());
-	process->Run(std::bind(&TryActivateStageCallback, _1, packageName, stageName, reload));
+	process->Run(std::bind(&TryActivateStageCallback, _1, packageName, stageName, activate, reload));
 }
 
 void ConfigPackageUtility::DeleteStage(const String& packageName, const String& stageName)

lib/remote/configpackageutility.hpp

@@ -37,7 +37,7 @@ public:
 	static void SetActiveStage(const String& packageName, const String& stageName);
 	static void SetActiveStageToFile(const String& packageName, const String& stageName);
 	static void ActivateStage(const String& packageName, const String& stageName);
-	static void AsyncTryActivateStage(const String& packageName, const String& stageName, bool reload);
+	static void AsyncTryActivateStage(const String& packageName, const String& stageName, bool activate, bool reload);
 
 	static std::vector<std::pair<String, bool> > GetFiles(const String& packageName, const String& stageName);
 
@@ -54,7 +54,7 @@ private:
 	static void WritePackageConfig(const String& packageName);
 	static void WriteStageConfig(const String& packageName, const String& stageName);
 
-	static void TryActivateStageCallback(const ProcessResult& pr, const String& packageName, const String& stageName, bool reload);
+	static void TryActivateStageCallback(const ProcessResult& pr, const String& packageName, const String& stageName, bool activate, bool reload);
 };
 
 }

lib/remote/configstageshandler.cpp

@@ -112,6 +112,11 @@ void ConfigStagesHandler::HandlePost(
 	if (params->Contains("reload"))
 		reload = HttpUtility::GetLastParameter(params, "reload");
 
+	bool activate = true;
+
+	if (params->Contains("activate"))
+		activate = HttpUtility::GetLastParameter(params, "activate");
+
 	Dictionary::Ptr files = params->Get("files");
 
 	String stageName;
@@ -120,12 +125,15 @@ void ConfigStagesHandler::HandlePost(
 		if (!files)
 			BOOST_THROW_EXCEPTION(std::invalid_argument("Parameter 'files' must be specified."));
 
+		if (reload && !activate)
+			BOOST_THROW_EXCEPTION(std::invalid_argument("Parameter 'reload' must be false when 'activate' is false."));
+
 		boost::mutex::scoped_lock lock(ConfigPackageUtility::GetStaticPackageMutex());
 
 		stageName = ConfigPackageUtility::CreateStage(packageName, files);
 
 		/* validate the config. on success, activate stage and reload */
-		ConfigPackageUtility::AsyncTryActivateStage(packageName, stageName, reload);
+		ConfigPackageUtility::AsyncTryActivateStage(packageName, stageName, activate, reload);
 	} catch (const std::exception& ex) {
 		return HttpUtility::SendJsonError(response, params, 500,
 			"Stage creation failed.",