Update runbook

thevickypedia · Aug 15, 2024 · f1fd5e9 · f1fd5e9
1 parent 2992cbc
commit f1fd5e9
Show file tree

Hide file tree

Showing 8 changed files with 322 additions and 82 deletions.
diff --git a/doc_gen/index.rst b/doc_gen/index.rst
@@ -12,34 +12,39 @@ Welcome to NCTL's documentation!
 
    README
 
-NCTL - Main
-===========
+Ngrok Tunnel
+============
 
-.. automodule:: nctl.main
+.. automodule:: nctl.ngrok
 
-CloudFront
-==========
-.. automodule:: nctl.cloudfront
+AWS CloudFront
+==============
+
+.. automodule:: nctl.aws
 
 Logger
 ======
 
+.. autoclass:: nctl.logger.LogConfig(pydantic.BaseModel)
+   :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
+
 .. automodule:: nctl.logger
+   :exclude-members: LogConfig
 
 Models
 ======
 
-.. autoclass:: nctl.models.Concurrency(BaseModel)
+.. autoclass:: nctl.models.Concurrency(pydantic.BaseModel)
    :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
 
 ====
 
-.. autoclass:: pyninja.models.EnvConfig(BaseModel)
+.. autoclass:: nctl.models.EnvConfig(pydantic.BaseSettings)
    :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
 
 ====
 
-.. automodule:: pyninja.models
+.. automodule:: nctl.models
    :exclude-members: Concurrency, EnvConfig, concurrency, env
 
 Squire

diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -12,34 +12,39 @@ Welcome to NCTL's documentation!
 
    README
 
-NCTL - Main
-===========
+Ngrok Tunnel
+============
 
-.. automodule:: nctl.main
+.. automodule:: nctl.ngrok
 
-CloudFront
-==========
-.. automodule:: nctl.cloudfront
+AWS CloudFront
+==============
+
+.. automodule:: nctl.aws
 
 Logger
 ======
 
+.. autoclass:: nctl.logger.LogConfig(pydantic.BaseModel)
+   :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
+
 .. automodule:: nctl.logger
+   :exclude-members: LogConfig
 
 Models
 ======
 
-.. autoclass:: nctl.models.Concurrency(BaseModel)
+.. autoclass:: nctl.models.Concurrency(pydantic.BaseModel)
    :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
 
 ====
 
-.. autoclass:: pyninja.models.EnvConfig(BaseModel)
+.. autoclass:: nctl.models.EnvConfig(pydantic.BaseSettings)
    :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
 
 ====
 
-.. automodule:: pyninja.models
+.. automodule:: nctl.models
    :exclude-members: Concurrency, EnvConfig, concurrency, env
 
 Squire

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -43,14 +43,16 @@ <h1 id="index">Index</h1>
 
 <div class="genindex-jumpbox">
  <a href="#A"><strong>A</strong></a>
- | <a href="#B"><strong>B</strong></a>
  | <a href="#C"><strong>C</strong></a>
  | <a href="#D"><strong>D</strong></a>
  | <a href="#E"><strong>E</strong></a>
  | <a href="#F"><strong>F</strong></a>
  | <a href="#G"><strong>G</strong></a>
+ | <a href="#H"><strong>H</strong></a>
+ | <a href="#L"><strong>L</strong></a>
  | <a href="#M"><strong>M</strong></a>
  | <a href="#N"><strong>N</strong></a>
+ | <a href="#P"><strong>P</strong></a>
  | <a href="#R"><strong>R</strong></a>
  | <a href="#T"><strong>T</strong></a>
  | <a href="#U"><strong>U</strong></a>
@@ -62,25 +64,25 @@ <h2 id="A">A</h2>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#nctl.logger.AddProcessName">AddProcessName (class in nctl.logger)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#nctl.models.Concurrency.Config.arbitrary_types_allowed">arbitrary_types_allowed (nctl.models.Concurrency.Config attribute)</a>
+</li>
+      <li><a href="index.html#nctl.models.EnvConfig.aws_access_key_id">aws_access_key_id (nctl.models.EnvConfig attribute)</a>
 </li>
   </ul></td>
-</tr></table>
-
-<h2 id="B">B</h2>
-<table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="index.html#nctl.logger.build_logger">build_logger() (in module nctl.logger)</a>
+      <li><a href="index.html#nctl.models.EnvConfig.aws_default_region">aws_default_region (nctl.models.EnvConfig attribute)</a>
+</li>
+      <li><a href="index.html#nctl.models.EnvConfig.aws_profile_name">aws_profile_name (nctl.models.EnvConfig attribute)</a>
+</li>
+      <li><a href="index.html#nctl.models.EnvConfig.aws_secret_access_key">aws_secret_access_key (nctl.models.EnvConfig attribute)</a>
 </li>
   </ul></td>
 </tr></table>
 
 <h2 id="C">C</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="index.html#nctl.cloudfront.CloudFront">CloudFront (class in nctl.cloudfront)</a>
+      <li><a href="index.html#nctl.aws.CloudFront">CloudFront (class in nctl.aws)</a>
 </li>
       <li><a href="index.html#nctl.models.Concurrency.cloudfront_process">cloudfront_process (nctl.models.Concurrency attribute)</a>
 </li>
@@ -90,7 +92,9 @@ <h2 id="C">C</h2>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#nctl.models.Concurrency.Config">Concurrency.Config (class in nctl.models)</a>
 </li>
-      <li><a href="index.html#nctl.cloudfront.CloudFront.create_distribution">create_distribution() (nctl.cloudfront.CloudFront method)</a>
+      <li><a href="index.html#nctl.logger.configure_logging">configure_logging() (in module nctl.logger)</a>
+</li>
+      <li><a href="index.html#nctl.aws.CloudFront.create_distribution">create_distribution() (nctl.aws.CloudFront method)</a>
 </li>
       <li><a href="index.html#nctl.squire.create_ngrok_config">create_ngrok_config() (in module nctl.squire)</a>
 </li>
@@ -100,7 +104,19 @@ <h2 id="C">C</h2>
 <h2 id="D">D</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="index.html#nctl.main.distribution_handler">distribution_handler() (in module nctl.main)</a>
+      <li><a href="index.html#nctl.logger.LogConfig.debug">debug (nctl.logger.LogConfig attribute)</a>
+
+      <ul>
+        <li><a href="index.html#nctl.models.EnvConfig.debug">(nctl.models.EnvConfig attribute)</a>
+</li>
+      </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#nctl.models.EnvConfig.distribution_config">distribution_config (nctl.models.EnvConfig attribute)</a>
+</li>
+      <li><a href="index.html#nctl.ngrok.distribution_handler">distribution_handler() (in module nctl.ngrok)</a>
+</li>
+      <li><a href="index.html#nctl.models.EnvConfig.distribution_id">distribution_id (nctl.models.EnvConfig attribute)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -109,22 +125,68 @@ <h2 id="E">E</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#nctl.squire.env_loader">env_loader() (in module nctl.squire)</a>
+</li>
+      <li><a href="index.html#nctl.models.EnvConfig">EnvConfig (class in nctl.models)</a>
 </li>
   </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#nctl.models.EnvConfig.Config">EnvConfig.Config (class in nctl.models)</a>
+</li>
+      <li><a href="index.html#nctl.logger.LogConfig.Config.extra">extra (nctl.logger.LogConfig.Config attribute)</a>
+
+      <ul>
+        <li><a href="index.html#nctl.models.EnvConfig.Config.extra">(nctl.models.EnvConfig.Config attribute)</a>
+</li>
+      </ul></li>
+  </ul></td>
 </tr></table>
 
 <h2 id="F">F</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#nctl.logger.AddProcessName.filter">filter() (nctl.logger.AddProcessName method)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#nctl.models.EnvConfig.from_env_file">from_env_file() (nctl.models.EnvConfig class method)</a>
 </li>
   </ul></td>
 </tr></table>
 
 <h2 id="G">G</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="index.html#nctl.cloudfront.CloudFront.get_distribution">get_distribution() (nctl.cloudfront.CloudFront method)</a>
+      <li><a href="index.html#nctl.aws.CloudFront.get_distribution">get_distribution() (nctl.aws.CloudFront method)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+<h2 id="H">H</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#nctl.models.EnvConfig.Config.hide_input_in_errors">hide_input_in_errors (nctl.models.EnvConfig.Config attribute)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#nctl.models.EnvConfig.host">host (nctl.models.EnvConfig attribute)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+<h2 id="L">L</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#nctl.logger.LogConfig.log_config">log_config (nctl.logger.LogConfig attribute)</a>
+
+      <ul>
+        <li><a href="index.html#nctl.models.EnvConfig.log_config">(nctl.models.EnvConfig attribute)</a>
+</li>
+      </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#nctl.logger.LogConfig">LogConfig (class in nctl.logger)</a>
+</li>
+      <li><a href="index.html#nctl.logger.LogConfig.Config">LogConfig.Config (class in nctl.logger)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -136,11 +198,13 @@ <h2 id="M">M</h2>
     module
 
       <ul>
-        <li><a href="index.html#module-nctl.cloudfront">nctl.cloudfront</a>
+        <li><a href="index.html#module-nctl.aws">nctl.aws</a>
 </li>
         <li><a href="index.html#module-nctl.logger">nctl.logger</a>
 </li>
-        <li><a href="index.html#module-nctl.main">nctl.main</a>
+        <li><a href="index.html#module-nctl.models">nctl.models</a>
+</li>
+        <li><a href="index.html#module-nctl.ngrok">nctl.ngrok</a>
 </li>
         <li><a href="index.html#module-nctl.squire">nctl.squire</a>
 </li>
@@ -152,26 +216,33 @@ <h2 id="N">N</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li>
-    nctl.cloudfront
+    nctl.aws
 
       <ul>
-        <li><a href="index.html#module-nctl.cloudfront">module</a>
+        <li><a href="index.html#module-nctl.aws">module</a>
 </li>
       </ul></li>
       <li>
     nctl.logger
 
       <ul>
         <li><a href="index.html#module-nctl.logger">module</a>
+</li>
+      </ul></li>
+      <li>
+    nctl.models
+
+      <ul>
+        <li><a href="index.html#module-nctl.models">module</a>
 </li>
       </ul></li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li>
-    nctl.main
+    nctl.ngrok
 
       <ul>
-        <li><a href="index.html#module-nctl.main">module</a>
+        <li><a href="index.html#module-nctl.ngrok">module</a>
 </li>
       </ul></li>
       <li>
@@ -181,13 +252,29 @@ <h2 id="N">N</h2>
         <li><a href="index.html#module-nctl.squire">module</a>
 </li>
       </ul></li>
+      <li><a href="index.html#nctl.models.EnvConfig.ngrok_auth">ngrok_auth (nctl.models.EnvConfig attribute)</a>
+</li>
+      <li><a href="index.html#nctl.models.EnvConfig.ngrok_config">ngrok_config (nctl.models.EnvConfig attribute)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+<h2 id="P">P</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#nctl.models.EnvConfig.port">port (nctl.models.EnvConfig attribute)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#nctl.logger.LogConfig.process">process (nctl.logger.LogConfig attribute)</a>
+</li>
   </ul></td>
 </tr></table>
 
 <h2 id="R">R</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="index.html#nctl.cloudfront.CloudFront.run">run() (nctl.cloudfront.CloudFront method)</a>
+      <li><a href="index.html#nctl.aws.CloudFront.run">run() (nctl.aws.CloudFront method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
@@ -199,23 +286,23 @@ <h2 id="R">R</h2>
 <h2 id="T">T</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="index.html#nctl.main.tunnel">tunnel() (in module nctl.main)</a>
+      <li><a href="index.html#nctl.ngrok.tunnel">tunnel() (in module nctl.ngrok)</a>
 </li>
   </ul></td>
 </tr></table>
 
 <h2 id="U">U</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="index.html#nctl.cloudfront.CloudFront.update_distribution">update_distribution() (nctl.cloudfront.CloudFront method)</a>
+      <li><a href="index.html#nctl.aws.CloudFront.update_distribution">update_distribution() (nctl.aws.CloudFront method)</a>
 </li>
   </ul></td>
 </tr></table>
 
 <h2 id="W">W</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="index.html#nctl.main.writer">writer() (in module nctl.main)</a>
+      <li><a href="index.html#nctl.ngrok.writer">writer() (in module nctl.ngrok)</a>
 </li>
   </ul></td>
 </tr></table>