ci: Merge pull request #706 from AlexCuse/main

Signed-off-by: edgex-jenkins <[email protected]>
edgexfoundry · Mar 8, 2022 · 07a3d48 · 07a3d48
1 parent be071df
commit 07a3d48
Show file tree

Hide file tree

Showing 5 changed files with 222 additions and 137 deletions.
diff --git a/2.2/microservices/application/AdvancedTopics/index.html b/2.2/microservices/application/AdvancedTopics/index.html
@@ -1664,6 +1664,13 @@
     How it works
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#custom-storage" class="md-nav__link">
+    Custom Storage
+  </a>
+
 </li>
 
       </ul>
@@ -2767,6 +2774,13 @@
     How it works
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#custom-storage" class="md-nav__link">
+    Custom Storage
+  </a>
+
 </li>
 
       </ul>
@@ -3074,6 +3088,59 @@ <h4 id="how-it-works">How it works</h4>
 <p class="admonition-title">Note</p>
 <p>Changing Writable.Pipeline.ExecutionOrder will invalidate all currently stored data and result in it all being removed from the database on the next retry. This is because the position of the <em>export</em> function can no longer be guaranteed and no way to ensure it is properly executed on the retry.</p>
 </div>
+<h4 id="custom-storage">Custom Storage</h4>
+<p>The default backing store is redis.  Custom implementations of the <code>StoreClient</code> interface can be provided if redis does not meet your requirements.</p>
+<p><div class="highlight"><pre><span></span><code><span class="kd">type</span><span class="w"> </span><span class="nx">StoreClient</span><span class="w"> </span><span class="kd">interface</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
+<span class="w">    </span><span class="c1">// Store persists a stored object to the data store and returns the assigned UUID.</span><span class="w"></span>
+<span class="w">    </span><span class="nx">Store</span><span class="p">(</span><span class="nx">o</span><span class="w"> </span><span class="nx">StoredObject</span><span class="p">)</span><span class="w"> </span><span class="p">(</span><span class="nx">id</span><span class="w"> </span><span class="kt">string</span><span class="p">,</span><span class="w"> </span><span class="nx">err</span><span class="w"> </span><span class="kt">error</span><span class="p">)</span><span class="w"></span>
+
+<span class="w">    </span><span class="c1">// RetrieveFromStore gets an object from the data store.</span><span class="w"></span>
+<span class="w">    </span><span class="nx">RetrieveFromStore</span><span class="p">(</span><span class="nx">appServiceKey</span><span class="w"> </span><span class="kt">string</span><span class="p">)</span><span class="w"> </span><span class="p">(</span><span class="nx">objects</span><span class="w"> </span><span class="p">[]</span><span class="nx">StoredObject</span><span class="p">,</span><span class="w"> </span><span class="nx">err</span><span class="w"> </span><span class="kt">error</span><span class="p">)</span><span class="w"></span>
+
+<span class="w">    </span><span class="c1">// Update replaces the data currently in the store with the provided data.</span><span class="w"></span>
+<span class="w">    </span><span class="nx">Update</span><span class="p">(</span><span class="nx">o</span><span class="w"> </span><span class="nx">StoredObject</span><span class="p">)</span><span class="w"> </span><span class="kt">error</span><span class="w"></span>
+
+<span class="w">    </span><span class="c1">// RemoveFromStore removes an object from the data store.</span><span class="w"></span>
+<span class="w">    </span><span class="nx">RemoveFromStore</span><span class="p">(</span><span class="nx">o</span><span class="w"> </span><span class="nx">StoredObject</span><span class="p">)</span><span class="w"> </span><span class="kt">error</span><span class="w"></span>
+
+<span class="w">    </span><span class="c1">// Disconnect ends the connection.</span><span class="w"></span>
+<span class="w">    </span><span class="nx">Disconnect</span><span class="p">()</span><span class="w"> </span><span class="kt">error</span><span class="w"></span>
+<span class="p">}</span><span class="w"></span>
+</code></pre></div>
+A factory function to create these clients can then be registered with your service by calling <a href="../ApplicationServiceAPI/#registercustomstorefactory">RegisterCustomStoreFactory</a></p>
+<div class="highlight"><pre><span></span><code><span class="nx">service</span><span class="p">.</span><span class="nx">RegisterCustomStoreFactory</span><span class="p">(</span><span class="s">&quot;jetstream&quot;</span><span class="p">,</span><span class="w"> </span><span class="kd">func</span><span class="p">(</span><span class="nx">cfg</span><span class="w"> </span><span class="nx">interfaces</span><span class="p">.</span><span class="nx">DatabaseInfo</span><span class="p">,</span><span class="w"> </span><span class="nx">cred</span><span class="w"> </span><span class="nx">config</span><span class="p">.</span><span class="nx">Credentials</span><span class="p">)</span><span class="w"> </span><span class="p">(</span><span class="nx">interfaces</span><span class="p">.</span><span class="nx">StoreClient</span><span class="p">,</span><span class="w"> </span><span class="kt">error</span><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
+<span class="w">    </span><span class="nx">conn</span><span class="p">,</span><span class="w"> </span><span class="nx">err</span><span class="w"> </span><span class="o">:=</span><span class="w"> </span><span class="nx">nats</span><span class="p">.</span><span class="nx">Connect</span><span class="p">(</span><span class="nx">fmt</span><span class="p">.</span><span class="nx">Sprintf</span><span class="p">(</span><span class="s">&quot;nats://%s:%d&quot;</span><span class="p">,</span><span class="w"> </span><span class="nx">cfg</span><span class="p">.</span><span class="nx">Host</span><span class="p">,</span><span class="w"> </span><span class="nx">cfg</span><span class="p">.</span><span class="nx">Port</span><span class="p">))</span><span class="w"></span>
+
+<span class="w">    </span><span class="k">if</span><span class="w"> </span><span class="nx">err</span><span class="w"> </span><span class="o">!=</span><span class="w"> </span><span class="kc">nil</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
+<span class="w">        </span><span class="k">return</span><span class="w"> </span><span class="kc">nil</span><span class="p">,</span><span class="w"> </span><span class="nx">err</span><span class="w"></span>
+<span class="w">    </span><span class="p">}</span><span class="w"></span>
+
+<span class="w">    </span><span class="nx">js</span><span class="p">,</span><span class="w"> </span><span class="nx">err</span><span class="w"> </span><span class="o">:=</span><span class="w"> </span><span class="nx">conn</span><span class="p">.</span><span class="nx">JetStream</span><span class="p">()</span><span class="w"></span>
+
+<span class="w">    </span><span class="k">if</span><span class="w"> </span><span class="nx">err</span><span class="w"> </span><span class="o">!=</span><span class="w"> </span><span class="kc">nil</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
+<span class="w">        </span><span class="k">return</span><span class="w"> </span><span class="kc">nil</span><span class="p">,</span><span class="w"> </span><span class="nx">err</span><span class="w"></span>
+<span class="w">    </span><span class="p">}</span><span class="w"></span>
+
+<span class="w">    </span><span class="nx">kv</span><span class="p">,</span><span class="w"> </span><span class="nx">err</span><span class="w"> </span><span class="o">:=</span><span class="w"> </span><span class="nx">js</span><span class="p">.</span><span class="nx">KeyValue</span><span class="p">(</span><span class="nx">serviceKey</span><span class="p">)</span><span class="w"></span>
+
+<span class="w">    </span><span class="k">if</span><span class="w"> </span><span class="nx">err</span><span class="w"> </span><span class="o">!=</span><span class="w"> </span><span class="kc">nil</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
+<span class="w">        </span><span class="nx">kv</span><span class="p">,</span><span class="w"> </span><span class="nx">err</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="nx">js</span><span class="p">.</span><span class="nx">CreateKeyValue</span><span class="p">(</span><span class="o">&amp;</span><span class="nx">nats</span><span class="p">.</span><span class="nx">KeyValueConfig</span><span class="p">{</span><span class="nx">Bucket</span><span class="p">:</span><span class="w"> </span><span class="nx">serviceKey</span><span class="p">})</span><span class="w"></span>
+<span class="w">    </span><span class="p">}</span><span class="w"></span>
+
+<span class="w">    </span><span class="k">return</span><span class="w"> </span><span class="o">&amp;</span><span class="nx">JetstreamStore</span><span class="p">{</span><span class="w"></span>
+<span class="w">        </span><span class="nx">conn</span><span class="p">:</span><span class="w">       </span><span class="nx">conn</span><span class="p">,</span><span class="w"></span>
+<span class="w">        </span><span class="nx">serviceKey</span><span class="p">:</span><span class="w"> </span><span class="nx">serviceKey</span><span class="p">,</span><span class="w"></span>
+<span class="w">        </span><span class="nx">kv</span><span class="p">:</span><span class="w">         </span><span class="nx">kv</span><span class="p">,</span><span class="w"></span>
+<span class="w">    </span><span class="p">},</span><span class="w"> </span><span class="nx">err</span><span class="w"></span>
+<span class="p">})</span><span class="w"></span>
+</code></pre></div>
+<p>and configured using the registered name in the <code>Database</code> section:</p>
+<div class="highlight"><pre><span></span><code><span class="k">[Database]</span><span class="w"></span>
+<span class="w">    </span><span class="n">Type</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;jetstream&quot;</span><span class="w"></span>
+<span class="w">    </span><span class="n">Host</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;broker&quot;</span><span class="w"></span>
+<span class="w">    </span><span class="n">Port</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">4222</span><span class="w"></span>
+<span class="w">    </span><span class="n">Timeout</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">&quot;5s&quot;</span><span class="w"></span>
+</code></pre></div>
 <h3 id="secrets">Secrets</h3>
 <h4 id="configuration_1">Configuration</h4>
 <p>All instances of App Services running in secure mode require a SecretStore to be configured. With the use of <code>Redis Pub/Sub</code> as the default EdgeX MessageBus all App Services need the <code>redisdb</code> known secret added to their SecretStore      so they can connect to the Secure EdgeX MessageBus. See the <a href="../../../security/Ch-Secure-MessageBus/">Secure MessageBus</a> documentation for more details.</p>

diff --git a/2.2/microservices/application/ApplicationServiceAPI/index.html b/2.2/microservices/application/ApplicationServiceAPI/index.html
@@ -1816,6 +1816,13 @@
     RegisterCustomTriggerFactory
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#registercustomstorefactory" class="md-nav__link">
+    RegisterCustomStoreFactory
+  </a>
+
 </li>
 
       </ul>
@@ -3085,6 +3092,13 @@
     RegisterCustomTriggerFactory
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#registercustomstorefactory" class="md-nav__link">
+    RegisterCustomStoreFactory
+  </a>
+
 </li>
 
       </ul>
@@ -3158,6 +3172,7 @@ <h1 id="application-service-api">Application Service API</h1>
 <span class="w">    </span><span class="nx">AddRoute</span><span class="p">(</span><span class="nx">route</span><span class="w"> </span><span class="kt">string</span><span class="p">,</span><span class="w"> </span><span class="nx">handler</span><span class="w"> </span><span class="kd">func</span><span class="p">(</span><span class="nx">http</span><span class="p">.</span><span class="nx">ResponseWriter</span><span class="p">,</span><span class="w"> </span><span class="o">*</span><span class="nx">http</span><span class="p">.</span><span class="nx">Request</span><span class="p">),</span><span class="w"> </span><span class="nx">methods</span><span class="w"> </span><span class="o">...</span><span class="kt">string</span><span class="p">)</span><span class="w"> </span><span class="kt">error</span><span class="w"></span>
 <span class="w">    </span><span class="nx">RequestTimeout</span><span class="p">()</span><span class="w"> </span><span class="nx">time</span><span class="p">.</span><span class="nx">Duration</span><span class="w"></span>
 <span class="w">    </span><span class="nx">RegisterCustomTriggerFactory</span><span class="p">(</span><span class="nx">name</span><span class="w"> </span><span class="kt">string</span><span class="p">,</span><span class="w"> </span><span class="nx">factory</span><span class="w"> </span><span class="kd">func</span><span class="p">(</span><span class="nx">TriggerConfig</span><span class="p">)</span><span class="w"> </span><span class="p">(</span><span class="nx">Trigger</span><span class="p">,</span><span class="w"> </span><span class="kt">error</span><span class="p">))</span><span class="w"> </span><span class="kt">error</span><span class="w"></span>
+<span class="w">    </span><span class="nx">RegisterCustomStoreFactory</span><span class="p">(</span><span class="nx">name</span><span class="w"> </span><span class="kt">string</span><span class="p">,</span><span class="w"> </span><span class="nx">factory</span><span class="w"> </span><span class="kd">func</span><span class="p">(</span><span class="nx">cfg</span><span class="w"> </span><span class="nx">DatabaseInfo</span><span class="p">,</span><span class="w"> </span><span class="nx">cred</span><span class="w"> </span><span class="nx">config</span><span class="p">.</span><span class="nx">Credentials</span><span class="p">)</span><span class="w"> </span><span class="p">(</span><span class="nx">StoreClient</span><span class="p">,</span><span class="w"> </span><span class="kt">error</span><span class="p">))</span><span class="w"> </span><span class="kt">error</span><span class="w"></span>
 <span class="p">}</span><span class="w"></span>
 </code></pre></div>
 <h2 id="factory-functions">Factory Functions</h2>
@@ -3556,6 +3571,9 @@ <h3 id="requesttimeout">RequestTimeout()</h3>
 <h3 id="registercustomtriggerfactory">RegisterCustomTriggerFactory</h3>
 <p><code>RegisterCustomTriggerFactory(name string, factory func(TriggerConfig) (Trigger, error)) error</code></p>
 <p>This API registers a trigger factory for a custom trigger to be used. See the <a href="../Triggers/#custom-triggers">Custom Triggers</a> section for more details and example.</p>
+<h3 id="registercustomstorefactory">RegisterCustomStoreFactory</h3>
+<p><code>RegisterCustomStoreFactory(name string, factory func(cfg DatabaseInfo, cred config.Credentials) (StoreClient, error)) error</code></p>
+<p>This API registers a factory to construct a custom store client for the <a href="../AdvancedTopics/#store-and-forward">store &amp; forward</a> loop.</p>
 
 
 

diff --git a/2.2/search/search_index.json b/2.2/search/search_index.json