config_o_mat 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4f7f711f4b074d2c732ce431dfd678df82d8fe579ba8da5f9035937af9f278f4
+  data.tar.gz: 8540f7ffdaa0e2474b0a00a9ade88c912e9babbd9b41b5ff43c6ece58b8f64e6
+SHA512:
+  metadata.gz: ae17e8208db65c89c8c0ad943d7ec55a1decf711cab1a1692beccf6a593307548a59b231bd1957780de7f44c18a43ac6718ef9db22ce7fb43dd347dee179cf8e
+  data.tar.gz: f5810b31cc743ceb07622b1db928f4db28f39bd593d94ba3e73004d90d8e9b0e9c274de28cf84502e21098c20812df4ad3ffa0dea067ddd82d0d111dfa94eda9

data/.gitignore

@@ -0,0 +1,9 @@
+# rspec persistence data
+spec/rspec_persistence.txt
+
+# test coverage data
+coverage/
+
+# YARD doc db and output
+.yardoc/
+doc/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+configurator

data/.ruby-version

@@ -0,0 +1 @@
+2.7.4

data/Gemfile

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Teak.io, 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
+#
+#     https://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.
+
+source 'https://rubygems.org'
+
+gem 'aws-sdk-appconfig', '~> 1.18', require: false
+gem 'logsformyfamily', '~> 0.2', require: false
+gem 'lifecycle_vm', '~> 0.1.1', require: false
+gem 'ruby-dbus', '~> 0.16.0', require: false
+gem 'sd_notify', '~> 0.1', require: false
+
+gem 'rspec', '~> 3.10', group: :test, require: false
+gem 'simplecov', '~> 0.21', group: :test, require: false

data/Gemfile.lock

@@ -0,0 +1,56 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aws-eventstream (1.2.0)
+    aws-partitions (1.525.0)
+    aws-sdk-appconfig (1.19.0)
+      aws-sdk-core (~> 3, >= 3.122.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-core (3.122.0)
+      aws-eventstream (~> 1, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.525.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1.0)
+    aws-sigv4 (1.4.0)
+      aws-eventstream (~> 1, >= 1.0.2)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    jmespath (1.4.0)
+    lifecycle_vm (0.1.2)
+    logsformyfamily (0.2.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    ruby-dbus (0.16.0)
+    sd_notify (0.1.1)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aws-sdk-appconfig (~> 1.18)
+  lifecycle_vm (~> 0.1.1)
+  logsformyfamily (~> 0.2)
+  rspec (~> 3.10)
+  ruby-dbus (~> 0.16.0)
+  sd_notify (~> 0.1)
+  simplecov (~> 0.21)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

data/NOTICE

@@ -0,0 +1,2 @@
+configurator
+Copyright 2021 Teak.io, Inc.

data/README.md

@@ -0,0 +1,15 @@
+# Configurator
+
+Configurator manages runtime configuration of services by reading data from AWS AppConfig and AWS SecretsManager, rendering ERB templates with that data, and then restarting systemd services to apply configuration updates.
+
+## Usage
+Configurator requires two pieces of meta configuration to start
+- A configuration directory in $CONFIGURATION_DIRECTORY or passed in with -c/--configuration-directory
+- A runtime directory in $RUNTIME_DIRECTORY or passed in with -r/--runtime-directory
+
+Configurator will read all and apply files ending in .conf in the configuration directory in lexical order to configure itself.
+
+Configuration files are in YAML. Configurator will read the following keys:
+
+log_level: # One of debug, info, notice, warn, error. Defaults to info.
+refresh_interval: # Number of seconds between each configuration source poll. Defaults to 5

data/Rakefile

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Teak.io, 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
+#
+#     https://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.
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+  # No rspec here
+end
+
+begin
+  require 'yard'
+
+  YARD::Rake::YardocTask.new(:doc) do |t|
+    t.files = ['lib/**/*.rb']
+    t.stats_options = ['--list-undoc']
+  end
+rescue LoadError
+  # No doc generation for you
+end
+
+require "bundler/gem_tasks"

data/bin/config_o_mat-configurator

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+
+# Copyright 2021 Teak.io, 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
+#
+#     https://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 'config_o_mat/configurator'
+require 'logsformyfamily'
+
+LogsForMyFamily.configure do |config|
+  config.version = ConfigOMat::Configurator::VM::VERSION
+  config.app_name = ConfigOMat::Configurator::VM.name
+end
+
+logger = LogsForMyFamily::Logger.new
+logger.backends = [ConfigOMat::StdoutLogWriter.new]
+log_level = ENV['CONFIG_O_MAT_LOG_LEVEL']&.to_sym
+if log_level && LogsForMyFamily::Logger::LEVELS.include?(log_level)
+  logger.filter_level(log_level)
+elsif log_level
+  warn "Unknown log level requested in CONFIG_O_MAT_LOG_LEVEL: #{log_level}"
+end
+
+memory = ConfigOMat::Configurator::Memory.new(argv: ARGV, env: ENV, logger: logger)
+vm = ConfigOMat::Configurator::VM.new(memory)
+vm.call
+
+if vm.errors?
+  warn "Errored executing #{vm.error_op.class.name}"
+  warn "Errors: #{vm.errors}"
+
+  if vm.recovery_errors?
+    warn ''
+    warn "Errors recovering from error. Errored executing recovery #{vm.current_op.class.name}"
+    warn "Errors: #{vm.recovery_errors}"
+  end
+
+  exit 1
+end

data/bin/config_o_mat-meta_configurator

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+
+# Copyright 2021 Teak.io, 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
+#
+#     https://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 'config_o_mat/meta_configurator'
+require 'logsformyfamily'
+
+LogsForMyFamily.configure do |config|
+  config.version = ConfigOMat::MetaConfigurator::VM::VERSION
+  config.app_name = ConfigOMat::MetaConfigurator::VM.name
+end
+
+logger = LogsForMyFamily::Logger.new
+logger.backends = [ConfigOMat::StdoutLogWriter.new]
+log_level = ENV['CONFIG_O_MAT_LOG_LEVEL']&.to_sym
+if log_level && LogsForMyFamily::Logger::LEVELS.include?(log_level)
+  logger.filter_level(log_level)
+elsif log_level
+  warn "Unknown log level requested in CONFIG_O_MAT_LOG_LEVEL: #{log_level}"
+end
+
+memory = ConfigOMat::MetaConfigurator::Memory.new(argv: ARGV, env: ENV, logger: logger)
+vm = ConfigOMat::MetaConfigurator::VM.new(memory)
+vm.call
+
+if vm.errors?
+  warn "Errored executing #{vm.error_op.class.name}"
+  warn "Errors: #{vm.errors}"
+
+  if vm.recovery_errors?
+    warn ''
+    warn "Errors recovering from error. Errored executing recovery #{vm.current_op.class.name}"
+    warn "Errors: #{vm.recovery_errors}"
+  end
+
+  exit 1
+end

data/config_o_mat.gemspec

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Teak.io, 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
+#
+#     https://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_relative 'lib/config_o_mat/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "config_o_mat"
+  spec.version       = ConfigOMat::VERSION
+  spec.authors       = ["Alex Scarborough"]
+  spec.email         = ["alex@teak.io"]
+
+  spec.summary       = "ConfigOMat applies AWS AppConfig to Systemd services."
+  spec.homepage      = "https://github.com/GoCarrot/configurator"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/GoCarrot/configurator"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features|script)/}) }
+  end
+
+  spec.require_paths = ["lib"]
+  spec.executables   = ["config_o_mat-configurator", "config_o_mat-meta_configurator"]
+
+  spec.add_dependency('aws-sdk-appconfig', '~> 1.18')
+  spec.add_dependency('logsformyfamily', '~> 0.2')
+  spec.add_dependency('lifecycle_vm', '~> 0.1.1')
+  spec.add_dependency('ruby-dbus', '~> 0.16.0')
+  spec.add_dependency('sd_notify', '~> 0.1.1')
+
+  spec.add_development_dependency('simplecov', '~> 0.21.2')
+  spec.add_development_dependency('rspec', '~> 3.10')
+end

data/design/configurator_lifecycle_test.dot

@@ -0,0 +1,91 @@
+digraph "configurator_lifecycle_test"
+{
+  bgcolor = "#ffffff"
+
+  node [
+    class = "node"
+    ,fillcolor = "#ffffff",style = "filled"
+    ,shape = "rect"
+    ,"_vis_" = "label"
+  ];
+
+  subgraph {
+    "reading_meta_config" []
+
+    rank = "source"
+  }
+
+  "Config Error?" [label="Config Error?", shape="diamond"]
+  "running" []
+
+  subgraph {
+    "applying_profiles" []
+    "initial_applying_profiles" []
+    rank = "same"
+  }
+
+  "refreshing_profiles" []
+  "Refresh Error?" [label="Refresh Error?", shape="diamond"]
+
+  "applying_profile" []
+  "First Run?" [label="First Run?", shape="diamond"]
+  "generating_templates" []
+  "Template Error?" [label="Template Error?", shape="diamond"]
+  "Profiles to Apply?" [label="Profiles to Apply?", shape="diamond"]
+
+  "reloading_services" []
+  "Services to Reload?" [label="Services to Reload?", shape="diamond"]
+  "reloading_service" []
+  "Reload Error?" [label="Reload Error?", shape="diamond"]
+
+  "pending_failure" []
+  "First Run PF" [label="First Run?", shape="diamond"]
+  "Retries Left?" [label="Retries Left?", shape="diamond"]
+  "refreshing_profile" []
+
+  subgraph {
+    "FAIL" []
+    "EXIT" []
+    rank = "sink"
+  }
+
+  edge [
+    class = "edge"
+    ,weight = "1"
+    ,penwidth = "1"
+    ,"_vis_" = "label"
+    ,"color" = "#a0a0a4"
+    ,"style" = "solid"
+  ]; 
+
+  "reading_meta_config" -> "Config Error?"
+  "Config Error?" -> "pending_failure" [label="Yes", color="red"]
+  "Config Error?" -> "refreshing_profiles" [label="No", color="green"]
+  "refreshing_profiles" -> "First Run?"
+  "Refresh Error?" -> "pending_failure" [label="Yes", color="red"]
+  "Refresh Error?" -> "generating_templates" [label="No", color="green"]
+  "First Run?" -> "initial_applying_profiles" [label="Yes"]
+  "First Run?" -> "applying_profiles" [label="No"]
+  "initial_applying_profiles" -> "Refresh Error?"
+  "generating_templates" -> "Template Error?"
+  "Template Error?" -> "reloading_services" [label="No", color="green"]
+  "Template Error?" -> "pending_failure" [label="Yes", color="red"]
+  "reloading_services" -> "Services to Reload?"
+  "Services to Reload?" -> "reloading_service" [label="Yes"]
+  "Services to Reload?" -> "applying_profiles" [label="No"]
+  "reloading_service" -> "Reload Error?"
+  "Reload Error?" -> "reloading_services" [label="No", color="green"]
+  "Reload Error?" -> "pending_failure" [label="Yes", color="red"]
+  "applying_profiles" -> "Profiles to Apply?"
+  "Profiles to Apply?" -> "applying_profile" [label="Yes"]
+  "Profiles to Apply?"-> "running" [label="No", constraint=false]
+  "applying_profile" -> "Refresh Error?"
+  "pending_failure" -> "First Run PF"
+  "First Run PF" -> "FAIL" [label="Yes"]
+  "First Run PF" -> "Retries Left?" [label="No", color="green"]
+  "Retries Left?" -> "FAIL" [label="No", color="red"]
+  "Retries Left?" -> "refreshing_profile" [label="Yes"]
+  "refreshing_profile" -> "applying_profile"
+  "running" -> "refreshing_profiles"
+  "running" -> "EXIT"
+}

data/design/original_design.md

@@ -0,0 +1,45 @@
+Configurator
+
+Object Types:
+
+Service -- A systemd service that is configured/managed by the configurator
+ConfigurationProfile -- An AWS AppConfig configuration that the configurator retrieves
+Template -- A template file that the configurator will use to generate an updated configuration file
+
+Lifecycle:
+OnBoot
+  Each ConfigurationProfile will be loaded in declaration order. Once all ConfigurationProfiles are fully loaded, each Template will be evaluated. Once all Templates are evaluated, the configurator will go through each Service in declaration order and trigger a configuration update. Configuration updates are synchronus -- the configurator will not proceed to the next service until it has confirmed that configuration has been applied to the current service. If a service is not currently running then a configuration update will be considered successful immediately after updating configuration files.
+
+ConfigurationProfileLoad
+  The configuration profile will be loaded from AWS AppConfig. Any ancillary data defined by the loaded profile, e.g. secrets, will then be loaded. If any step fails the configurator will enter the OnPendingFailure state with the given ConfigurationProfile.
+
+Every RefreshInterval
+  Each ConfigurationProfile will be refreshed in declaration order. If a ConfigurationProfile is updated, Templates which reference that profile will be reevaluated. Once all such Templates are reevaluated, any which change will trigger configuration updates for any referencing Services in declaration order. All steps are synchronous, that is if a ConfigurationProfile has an update the configurator will _stop_ refreshing other profiles until all changes from the updated ConfigurationProfile have been successfully applied, and if multiple Services reference a Template each service must successfully complete its reload before the configurator will refresh the next Service.
+
+ConfigurationUpdate
+  Configuration updates are applied atomically. That is, if updating a single ConfigurationProfile modifies multiple Templates, the configurator will not apply changes until _all_ such Templates have been updated. Similarily if a modification to a Template requires multiple Services to be reloaded the configurator will not start reloading a Service until the prior Service reload is complete and successful. If any Service reload fails in the process of applying a ConfigurationUpdate, the source ConfigurationProfile will be considered to have failed and the configurator will
+    1. Roll back the faulty ConfigurationProfile
+    2. Perform a ConfigurationUpdate with the rolled back ConfigurationProfile
+    3. In some way indicate failure such that AWS AppConfig can determine a course of action
+
+OnPendingFailure
+  If a ConfigurationUpdate fails, the configurator enters a "pending failure" state. When pending failure, the configurator will exclusively refresh the ConfigurationProfile which triggered the failed ConfigurationUpdate. If the ConfigurationProfile does not receive any updates (including a rollback by AWS AppConfig) within FailureTimeout, the configurator will itself enter a failure state and trigger its systemd OnFailure action. N.B. This may include systemd initiated restarts of the configurator.
+
+State:
+For each ConfigurationProfile the configurator will persistently store the most recently successfully applied version and the most recently retrieved version. If the configurator starts with state present, and any ConfigurationProfile has a retrieved version that does not equal its applied version, the configurator will immediately refresh the ConfigurationProfile from AWS AppConfig and proceed to ConfigurationUpdate for that ConfigurationProfile.
+
+Service reload:
+A Service may define one of the following ways to apply its updated configuration
+- try-reload-or-restart
+  This will use systemd to try-reload-or-restart the managed service. By default this will be considered successful if the try-reload-or-restart operation succeeds.
+- flip-flpp
+  This will use a custom script to manage an instantiated service unit with the instances @1 and @2. If both instances are running at the time of the reload, the configurator will enter OnPendingFailure. Otherwise the configurator will bring up the instance which is not currently running. By default if starting that instance succeeds then the configurator will stop the old instance and consider the reload successful.
+
+A Service may also define additional health checks to verify that configuration reload both took effect and is a "good" configuration
+- change-child-pid
+  The configurator will monitor the set of child pids for the service's MAINPID for changes. If no changes occur (that is the service does not rotate its children) within ReloadTimeout then the configurator will enter OnPendingFailure. If the service has no child pids then the configurator will enter OnPendingFailure.
+- unicorn-health-comparison
+  The configurator will read health data from both active unicorn masters after BakeTime. If the new master is failing notably more requests than the previous master, the configurator will enter OnPendingFailure.
+
+Communicating with systemd:
+As Debian 11 still uses a pre-JS version of polkit we can't just grant the configurator limited permissions to manipulate systemd. Instead, we use a set of signal files monitored with systemd path units to trigger actions in systemd.