Skip to content

Commit

Permalink
Deployed 1741ac7 to current with MkDocs 1.5.3 and mike 2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
EOEPCA CI committed Feb 27, 2025
1 parent da92ad6 commit 7265a3a
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 95 deletions.
120 changes: 48 additions & 72 deletions current/building-blocks/data-access/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1062,35 +1062,35 @@
</li>

<li class="md-nav__item">
<a href="#4-deploy-tyk-gateway-and-redis" class="md-nav__link">
<a href="#4-monitoring-the-deployment" class="md-nav__link">
<span class="md-ellipsis">
4. Deploy Tyk Gateway and Redis
4. Monitoring the Deployment
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#5-monitoring-the-deployment" class="md-nav__link">
<a href="#5-accessing-the-data-access-services" class="md-nav__link">
<span class="md-ellipsis">
5. Monitoring the Deployment
5. Accessing the Data Access Services
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#6-accessing-the-data-access-services" class="md-nav__link">
</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#load-sample-collection" class="md-nav__link">
<span class="md-ellipsis">
6. Accessing the Data Access Services
Load Sample Collection
</span>
</a>

</li>

</ul>
</nav>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -1657,35 +1657,35 @@
</li>

<li class="md-nav__item">
<a href="#4-deploy-tyk-gateway-and-redis" class="md-nav__link">
<a href="#4-monitoring-the-deployment" class="md-nav__link">
<span class="md-ellipsis">
4. Deploy Tyk Gateway and Redis
4. Monitoring the Deployment
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#5-monitoring-the-deployment" class="md-nav__link">
<a href="#5-accessing-the-data-access-services" class="md-nav__link">
<span class="md-ellipsis">
5. Monitoring the Deployment
5. Accessing the Data Access Services
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#6-accessing-the-data-access-services" class="md-nav__link">
</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#load-sample-collection" class="md-nav__link">
<span class="md-ellipsis">
6. Accessing the Data Access Services
Load Sample Collection
</span>
</a>

</li>

</ul>
</nav>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -1807,14 +1807,10 @@ <h2 id="components-overview">Components Overview<a class="headerlink" href="#com
<p><strong>Stacture and Terravis</strong>: Components from EOX View Server providing:</p>
<ul>
<li><strong>Stacture</strong>: Bridges STAC API with OGC API Coverages and OGC WCS.</li>
<li><strong>Terravis</strong>: Provides advanced rendering and processing capabilities.
4. <strong>Tyk Gateway</strong>: API Gateway for authentication, authorization, rate-limiting, and caching, integrated with the Identity Management BB.</li>
<li><strong>Terravis</strong>: Provides advanced rendering and processing capabilities.</li>
</ul>
</li>
<li>
<p><strong>Redis</strong>: In-memory data structure store used by Tyk.</p>
</li>
<li>
<p><strong>eoapi-support</strong><br>
Optional but recommended monitoring stack (Grafana, Prometheus, metrics server) to observe and manage the Data Access services.</p>
</li>
Expand Down Expand Up @@ -1949,36 +1945,13 @@ <h3 id="3-deploy-stacture">3. Deploy Stacture<a class="headerlink" href="#3-depl
<p>This deploys <strong>Stacture</strong> and <strong>Terravis</strong> with images tagged at <code>v0.0.8</code> (configured in your <code>stacture/generated-values.yaml</code>).</p>
</blockquote>
<hr />
<h3 id="4-deploy-tyk-gateway-and-redis">4. Deploy Tyk Gateway and Redis<a class="headerlink" href="#4-deploy-tyk-gateway-and-redis" title="Permanent link">⚓︎</a></h3>
<ol>
<li><strong>Install Redis for Tyk Gateway:</strong></li>
</ol>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-8-1"><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>helm<span class="w"> </span>repo<span class="w"> </span>add<span class="w"> </span>bitnami<span class="w"> </span>https://charts.bitnami.com/bitnami
</span><span id="__span-8-2"><a id="__codelineno-8-2" name="__codelineno-8-2" href="#__codelineno-8-2"></a>helm<span class="w"> </span>repo<span class="w"> </span>update<span class="w"> </span>bitnami
</span><span id="__span-8-3"><a id="__codelineno-8-3" name="__codelineno-8-3" href="#__codelineno-8-3"></a>helm<span class="w"> </span>upgrade<span class="w"> </span>-i<span class="w"> </span>tyk-redis<span class="w"> </span>bitnami/redis<span class="w"> </span><span class="se">\</span>
</span><span id="__span-8-4"><a id="__codelineno-8-4" name="__codelineno-8-4" href="#__codelineno-8-4"></a><span class="w"> </span>--version<span class="w"> </span><span class="m">20</span>.1.0<span class="w"> </span><span class="se">\</span>
</span><span id="__span-8-5"><a id="__codelineno-8-5" name="__codelineno-8-5" href="#__codelineno-8-5"></a><span class="w"> </span>--namespace<span class="w"> </span>data-access<span class="w"> </span><span class="se">\</span>
</span><span id="__span-8-6"><a id="__codelineno-8-6" name="__codelineno-8-6" href="#__codelineno-8-6"></a><span class="w"> </span>--values<span class="w"> </span>tyk-gateway/redis-generated-values.yaml
</span></code></pre></div>
<ol start="2">
<li><strong>Install Tyk Gateway:</strong></li>
</ol>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-9-1"><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a>helm<span class="w"> </span>repo<span class="w"> </span>add<span class="w"> </span>tyk-oss<span class="w"> </span>https://helm.tyk.io/public/helm/charts/
</span><span id="__span-9-2"><a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a>helm<span class="w"> </span>repo<span class="w"> </span>update<span class="w"> </span>tyk-oss
</span><span id="__span-9-3"><a id="__codelineno-9-3" name="__codelineno-9-3" href="#__codelineno-9-3"></a>helm<span class="w"> </span>upgrade<span class="w"> </span>-i<span class="w"> </span>tyk-oss<span class="w"> </span>tyk-oss/tyk-oss<span class="w"> </span><span class="se">\</span>
</span><span id="__span-9-4"><a id="__codelineno-9-4" name="__codelineno-9-4" href="#__codelineno-9-4"></a><span class="w"> </span>--version<span class="w"> </span><span class="m">1</span>.6.0<span class="w"> </span><span class="se">\</span>
</span><span id="__span-9-5"><a id="__codelineno-9-5" name="__codelineno-9-5" href="#__codelineno-9-5"></a><span class="w"> </span>--namespace<span class="w"> </span>data-access<span class="w"> </span><span class="se">\</span>
</span><span id="__span-9-6"><a id="__codelineno-9-6" name="__codelineno-9-6" href="#__codelineno-9-6"></a><span class="w"> </span>--values<span class="w"> </span>tyk-gateway/generated-values.yaml
</span></code></pre></div>
<p>Tyk integrates with Identity Management for secure access and additional capabilities such as rate limiting or caching.</p>
<hr />
<h3 id="5-monitoring-the-deployment">5. Monitoring the Deployment<a class="headerlink" href="#5-monitoring-the-deployment" title="Permanent link">⚓︎</a></h3>
<h3 id="4-monitoring-the-deployment">4. Monitoring the Deployment<a class="headerlink" href="#4-monitoring-the-deployment" title="Permanent link">⚓︎</a></h3>
<p>After deploying, you can monitor the status of the deployments:</p>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-10-1"><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a>kubectl<span class="w"> </span>get<span class="w"> </span>all<span class="w"> </span>-n<span class="w"> </span>data-access
<div class="language-bash highlight"><pre><span></span><code><span id="__span-8-1"><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>kubectl<span class="w"> </span>get<span class="w"> </span>all<span class="w"> </span>-n<span class="w"> </span>data-access
</span></code></pre></div>
<p>Check that all pods are in the <code>Running</code> state and that services/ingresses are properly exposed.</p>
<hr />
<h3 id="6-accessing-the-data-access-services">6. Accessing the Data Access Services<a class="headerlink" href="#6-accessing-the-data-access-services" title="Permanent link">⚓︎</a></h3>
<h3 id="5-accessing-the-data-access-services">5. Accessing the Data Access Services<a class="headerlink" href="#5-accessing-the-data-access-services" title="Permanent link">⚓︎</a></h3>
<p>Once the deployment is complete and all pods are running, you can access the services:</p>
<ul>
<li>
Expand All @@ -1991,18 +1964,24 @@ <h3 id="6-accessing-the-data-access-services">6. Accessing the Data Access Servi
</li>
</ul>
<!-- currently ingress issues -->

<ul>
<li>
<p><strong>Tyk Gateway Dashboard</strong> (if exposed via ingress):<br />
<code>https://tyk-gateway.${INGRESS_HOST}/</code></p>
</li>
<li>
<p><strong>Grafana</strong> (if <code>eoapi-support</code> is installed and ingress is enabled):<br />
<code>https://eoapisupport.${INGRESS_HOST}/</code></p>
</li>
<li><strong>Grafana</strong> (if <code>eoapi-support</code> is installed and ingress is enabled):<br />
<code>https://eoapisupport.${INGRESS_HOST}/</code></li>
</ul>
<!-- add default credentials -->

<hr />
<h2 id="load-sample-collection">Load Sample Collection<a class="headerlink" href="#load-sample-collection" title="Permanent link">⚓︎</a></h2>
<p>The following steps load a sample <code>Sentinel2-L2A-Iceland</code> collection into eoAPI.</p>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-9-1"><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a><span class="nb">cd</span><span class="w"> </span>collections/sentinel-2-iceland
</span><span id="__span-9-2"><a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a>../ingest.sh
</span><span id="__span-9-3"><a id="__codelineno-9-3" name="__codelineno-9-3" href="#__codelineno-9-3"></a><span class="nb">cd</span><span class="w"> </span>../..
</span></code></pre></div>
<p>Check the loaded collection via STAC Browser&hellip;</p>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-10-1"><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a><span class="nb">source</span><span class="w"> </span>~/.eoepca/state
</span><span id="__span-10-2"><a id="__codelineno-10-2" name="__codelineno-10-2" href="#__codelineno-10-2"></a>xdg-open<span class="w"> </span>https://radiantearth.github.io/stac-browser/#/external/eoapi.<span class="si">${</span><span class="nv">INGRESS_HOST</span><span class="si">}</span>/stac/collections/sentinel-2-iceland
</span></code></pre></div>
<hr />
<h2 id="testing-and-validation">Testing and Validation<a class="headerlink" href="#testing-and-validation" title="Permanent link">⚓︎</a></h2>
<p>Below are some quick ways to test and validate the Data Access services.</p>
Expand Down Expand Up @@ -2059,21 +2038,18 @@ <h3 id="3-perform-basic-api-tests">3. Perform Basic API Tests<a class="headerlin
<hr />
<h2 id="uninstallation">Uninstallation<a class="headerlink" href="#uninstallation" title="Permanent link">⚓︎</a></h2>
<p>To uninstall the Data Access Building Block and clean up associated resources:</p>
<div class="language-bash highlight"><pre><span></span><code><span id="__span-14-1"><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a>helm<span class="w"> </span>uninstall<span class="w"> </span>tyk-oss<span class="w"> </span>-n<span class="w"> </span>data-access
</span><span id="__span-14-2"><a id="__codelineno-14-2" name="__codelineno-14-2" href="#__codelineno-14-2"></a>helm<span class="w"> </span>uninstall<span class="w"> </span>tyk-redis<span class="w"> </span>-n<span class="w"> </span>data-access
</span><span id="__span-14-3"><a id="__codelineno-14-3" name="__codelineno-14-3" href="#__codelineno-14-3"></a>helm<span class="w"> </span>uninstall<span class="w"> </span>stacture<span class="w"> </span>-n<span class="w"> </span>data-access
</span><span id="__span-14-4"><a id="__codelineno-14-4" name="__codelineno-14-4" href="#__codelineno-14-4"></a>helm<span class="w"> </span>uninstall<span class="w"> </span>eoapi-support<span class="w"> </span>-n<span class="w"> </span>data-access
</span><span id="__span-14-5"><a id="__codelineno-14-5" name="__codelineno-14-5" href="#__codelineno-14-5"></a>helm<span class="w"> </span>uninstall<span class="w"> </span>eoapi<span class="w"> </span>-n<span class="w"> </span>data-access
</span><span id="__span-14-6"><a id="__codelineno-14-6" name="__codelineno-14-6" href="#__codelineno-14-6"></a>helm<span class="w"> </span>uninstall<span class="w"> </span>pgo<span class="w"> </span>-n<span class="w"> </span>data-access
</span><span id="__span-14-7"><a id="__codelineno-14-7" name="__codelineno-14-7" href="#__codelineno-14-7"></a>
</span><span id="__span-14-8"><a id="__codelineno-14-8" name="__codelineno-14-8" href="#__codelineno-14-8"></a>kubectl<span class="w"> </span>delete<span class="w"> </span>namespace<span class="w"> </span>data-access
<div class="language-bash highlight"><pre><span></span><code><span id="__span-14-1"><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a>helm<span class="w"> </span>uninstall<span class="w"> </span>stacture<span class="w"> </span>-n<span class="w"> </span>data-access
</span><span id="__span-14-2"><a id="__codelineno-14-2" name="__codelineno-14-2" href="#__codelineno-14-2"></a>helm<span class="w"> </span>uninstall<span class="w"> </span>eoapi-support<span class="w"> </span>-n<span class="w"> </span>data-access
</span><span id="__span-14-3"><a id="__codelineno-14-3" name="__codelineno-14-3" href="#__codelineno-14-3"></a>helm<span class="w"> </span>uninstall<span class="w"> </span>eoapi<span class="w"> </span>-n<span class="w"> </span>data-access
</span><span id="__span-14-4"><a id="__codelineno-14-4" name="__codelineno-14-4" href="#__codelineno-14-4"></a>helm<span class="w"> </span>uninstall<span class="w"> </span>pgo<span class="w"> </span>-n<span class="w"> </span>data-access
</span><span id="__span-14-5"><a id="__codelineno-14-5" name="__codelineno-14-5" href="#__codelineno-14-5"></a>
</span><span id="__span-14-6"><a id="__codelineno-14-6" name="__codelineno-14-6" href="#__codelineno-14-6"></a>kubectl<span class="w"> </span>delete<span class="w"> </span>namespace<span class="w"> </span>data-access
</span></code></pre></div>
<hr />
<h2 id="further-reading">Further Reading<a class="headerlink" href="#further-reading" title="Permanent link">⚓︎</a></h2>
<ul>
<li><a href="https://github.com/EOEPCA/data-access"><abbr title="EO Exploitation Platform Common Architecture">EOEPCA</abbr>+ Data Access GitHub Repository</a></li>
<li><a href="https://github.com/developmentseed/eoAPI">eoAPI Documentation</a></li>
<li><a href="https://tyk.io/docs/">Tyk Gateway Documentation</a></li>
<li><a href="https://access.crunchydata.com/documentation/postgres-operator/">Crunchy Data Postgres Operator Documentation</a></li>
</ul>

Expand Down
Loading

0 comments on commit 7265a3a

Please sign in to comment.