docs: explaining the example situation of the tutor_v12 reference

Ian2012 · Jun 28, 2022 · c5d1d6a · c5d1d6a
1 parent 6bbebca
commit c5d1d6a
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/drydock/references/tutor_v12.yml b/drydock/references/tutor_v12.yml
@@ -1,6 +1,12 @@
+#
+# The tutor_V12 reference is an installation that mimics the exact configuration of k8s made
+# by tutor v12.2.0.
+#
 ---
 drydock:
   builder_class:  drydock.manifest_builder.application.manifest_builder.ManifestBuilder
+  # In the current form, this config_class will fail to load the variable RUN_CADDY so the rendering fails.
+  # a party interested in this could extend the config class to solve the issue.
   config_class: drydock.manifest_builder.infrastructure.tutor_config.TutorConfig
   manifest_class: drydock.manifest_builder.infrastructure.flex_tutor_manifest.FlexibleTutorManifest
   manifest_options: