Skip to content

Commit

Permalink
Updated links to api doc pages
Browse files Browse the repository at this point in the history
Changed where the links point:

api.edgexr.org/mc -> api.edgexr.org for MC api
api-edgexr.org -> device-api.edgexr.org for DME apis
  • Loading branch information
levshvarts authored Nov 17, 2023
2 parents a5dd93c + ed3f3dc commit 03b8d73
Show file tree
Hide file tree
Showing 107 changed files with 222 additions and 222 deletions.
4 changes: 2 additions & 2 deletions 404.html
Original file line number Diff line number Diff line change
Expand Up @@ -491,10 +491,10 @@
<ul class="duik-sidebar__nav">
<li class="duik-sidebar__item"><a href="/apis" class="duik-sidebar__link">Overview</a></li>
<li class="duik-sidebar__item">
<a href="https://api.edgexr.org" class="duik-sidebar__link">Device APIs</a>
<a href="https://device-api.edgexr.org" class="duik-sidebar__link">Device APIs</a>
</li>
<li class="duik-sidebar__item">
<a href="https://api.edgexr.org/mc" class="duik-sidebar__link">Edge Orchestration APIs</a>
<a href="https://api.edgexr.org" class="duik-sidebar__link">Edge Orchestration APIs</a>
</li>
<li class="duik-sidebar__item">
<a href="https://mobiledgex.github.io/edge-cloud-sdk-unity" class="duik-sidebar__link">Unity SDK Manual</a>
Expand Down
2 changes: 1 addition & 1 deletion _redirects
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
/t/d049c6c5 /sdks/ios-sdk/ios-sdk-download 301
/t/05a90cc0 /sdks/ios-sdk/ios-sdk-sample 301
/t/326ae321 /sdks/ios-sdk/ios-sdk-third-party-licenses 301
/t/7fe6318a https://api.edgexr.org/mc 301
/t/7fe6318a https://api.edgexr.org 301
/t/52a96ad4 /glossary-of-terms 301
/t/7533a031 /deployments/application-deployment-guides/gpu 301
/t/db8d59f7 /product/mobiledgex-community 301
Expand Down
4 changes: 2 additions & 2 deletions apis/client-side-apis/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
<meta charset="UTF-8" />
<meta http-equiv="refresh" content="0;url='https://api.edgexr.org'" />

<title>Redirecting to https://api.edgexr.org</title>
<title>Redirecting to https://device-api.edgexr.org</title>
</head>
<body>
Redirecting to <a href="https://api.edgexr.org">https://api.edgexr.org</a>.
Redirecting to <a href="https://device-api.edgexr.org">https://device-api.edgexr.org</a>.
</body>
</html>
8 changes: 4 additions & 4 deletions apis/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -491,10 +491,10 @@
<ul class="duik-sidebar__nav">
<li class="duik-sidebar__item active current"><a href="/apis" class="duik-sidebar__link">Overview</a></li>
<li class="duik-sidebar__item">
<a href="https://api.edgexr.org" class="duik-sidebar__link">Device APIs</a>
<a href="https://device-api.edgexr.org" class="duik-sidebar__link">Device APIs</a>
</li>
<li class="duik-sidebar__item">
<a href="https://api.edgexr.org/mc" class="duik-sidebar__link">Edge Orchestration APIs</a>
<a href="https://api.edgexr.org" class="duik-sidebar__link">Edge Orchestration APIs</a>
</li>
<li class="duik-sidebar__item">
<a href="https://mobiledgex.github.io/edge-cloud-sdk-unity" class="duik-sidebar__link">Unity SDK Manual</a>
Expand Down Expand Up @@ -608,14 +608,14 @@ <h1>API Reference</h1>
<!-- Icon Blocks -->
<div class="z-index-2 position-relative">
<section class="duik-icon-block">
<div class="row"><a class="col-md-4 col-lg-3 col-xs-6" href="https://api.edgexr.org">
<div class="row"><a class="col-md-4 col-lg-3 col-xs-6" href="https://device-api.edgexr.org">
<div class="duik-icon-block__item">
<h4 class="h5 mb-2">Device APIs</h4>
<span><p>Client APIs</p>
</span>
</div>
</a>
<a class="col-md-4 col-lg-3 col-xs-6" href="https://api.edgexr.org/mc">
<a class="col-md-4 col-lg-3 col-xs-6" href="https://api.edgexr.org">
<div class="duik-icon-block__item">
<h4 class="h5 mb-2">Edge Orchestration APIs</h4>
<span><p>Edge Orchestration APIs</p>
Expand Down
6 changes: 3 additions & 3 deletions apis/server-side-apis/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
<html>
<head>
<meta charset="UTF-8" />
<meta http-equiv="refresh" content="0;url='https://api.edgexr.org/mc'" />
<meta http-equiv="refresh" content="0;url='https://api.edgexr.org'" />

<title>Redirecting to https://api.edgexr.org/mc</title>
<title>Redirecting to https://api.edgexr.org</title>
</head>
<body>
Redirecting to <a href="https://api.edgexr.org/mc">https://api.edgexr.org/mc</a>.
Redirecting to <a href="https://api.edgexr.org">https://api.edgexr.org</a>.
</body>
</html>
4 changes: 2 additions & 2 deletions deployments/accounts/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -491,10 +491,10 @@
<ul class="duik-sidebar__nav">
<li class="duik-sidebar__item"><a href="/apis" class="duik-sidebar__link">Overview</a></li>
<li class="duik-sidebar__item">
<a href="https://api.edgexr.org" class="duik-sidebar__link">Device APIs</a>
<a href="https://device-api.edgexr.org" class="duik-sidebar__link">Device APIs</a>
</li>
<li class="duik-sidebar__item">
<a href="https://api.edgexr.org/mc" class="duik-sidebar__link">Edge Orchestration APIs</a>
<a href="https://api.edgexr.org" class="duik-sidebar__link">Edge Orchestration APIs</a>
</li>
<li class="duik-sidebar__item">
<a href="https://mobiledgex.github.io/edge-cloud-sdk-unity" class="duik-sidebar__link">Unity SDK Manual</a>
Expand Down
4 changes: 2 additions & 2 deletions deployments/accounts/manage-accts/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -491,10 +491,10 @@
<ul class="duik-sidebar__nav">
<li class="duik-sidebar__item"><a href="/apis" class="duik-sidebar__link">Overview</a></li>
<li class="duik-sidebar__item">
<a href="https://api.edgexr.org" class="duik-sidebar__link">Device APIs</a>
<a href="https://device-api.edgexr.org" class="duik-sidebar__link">Device APIs</a>
</li>
<li class="duik-sidebar__item">
<a href="https://api.edgexr.org/mc" class="duik-sidebar__link">Edge Orchestration APIs</a>
<a href="https://api.edgexr.org" class="duik-sidebar__link">Edge Orchestration APIs</a>
</li>
<li class="duik-sidebar__item">
<a href="https://mobiledgex.github.io/edge-cloud-sdk-unity" class="duik-sidebar__link">Unity SDK Manual</a>
Expand Down
4 changes: 2 additions & 2 deletions deployments/accounts/org-users/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -491,10 +491,10 @@
<ul class="duik-sidebar__nav">
<li class="duik-sidebar__item"><a href="/apis" class="duik-sidebar__link">Overview</a></li>
<li class="duik-sidebar__item">
<a href="https://api.edgexr.org" class="duik-sidebar__link">Device APIs</a>
<a href="https://device-api.edgexr.org" class="duik-sidebar__link">Device APIs</a>
</li>
<li class="duik-sidebar__item">
<a href="https://api.edgexr.org/mc" class="duik-sidebar__link">Edge Orchestration APIs</a>
<a href="https://api.edgexr.org" class="duik-sidebar__link">Edge Orchestration APIs</a>
</li>
<li class="duik-sidebar__item">
<a href="https://mobiledgex.github.io/edge-cloud-sdk-unity" class="duik-sidebar__link">Unity SDK Manual</a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -491,10 +491,10 @@
<ul class="duik-sidebar__nav">
<li class="duik-sidebar__item"><a href="/apis" class="duik-sidebar__link">Overview</a></li>
<li class="duik-sidebar__item">
<a href="https://api.edgexr.org" class="duik-sidebar__link">Device APIs</a>
<a href="https://device-api.edgexr.org" class="duik-sidebar__link">Device APIs</a>
</li>
<li class="duik-sidebar__item">
<a href="https://api.edgexr.org/mc" class="duik-sidebar__link">Edge Orchestration APIs</a>
<a href="https://api.edgexr.org" class="duik-sidebar__link">Edge Orchestration APIs</a>
</li>
<li class="duik-sidebar__item">
<a href="https://mobiledgex.github.io/edge-cloud-sdk-unity" class="duik-sidebar__link">Unity SDK Manual</a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -491,10 +491,10 @@
<ul class="duik-sidebar__nav">
<li class="duik-sidebar__item"><a href="/apis" class="duik-sidebar__link">Overview</a></li>
<li class="duik-sidebar__item">
<a href="https://api.edgexr.org" class="duik-sidebar__link">Device APIs</a>
<a href="https://device-api.edgexr.org" class="duik-sidebar__link">Device APIs</a>
</li>
<li class="duik-sidebar__item">
<a href="https://api.edgexr.org/mc" class="duik-sidebar__link">Edge Orchestration APIs</a>
<a href="https://api.edgexr.org" class="duik-sidebar__link">Edge Orchestration APIs</a>
</li>
<li class="duik-sidebar__item">
<a href="https://mobiledgex.github.io/edge-cloud-sdk-unity" class="duik-sidebar__link">Unity SDK Manual</a>
Expand Down
6 changes: 3 additions & 3 deletions deployments/application-deployment-guides/gpu/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -491,10 +491,10 @@
<ul class="duik-sidebar__nav">
<li class="duik-sidebar__item"><a href="/apis" class="duik-sidebar__link">Overview</a></li>
<li class="duik-sidebar__item">
<a href="https://api.edgexr.org" class="duik-sidebar__link">Device APIs</a>
<a href="https://device-api.edgexr.org" class="duik-sidebar__link">Device APIs</a>
</li>
<li class="duik-sidebar__item">
<a href="https://api.edgexr.org/mc" class="duik-sidebar__link">Edge Orchestration APIs</a>
<a href="https://api.edgexr.org" class="duik-sidebar__link">Edge Orchestration APIs</a>
</li>
<li class="duik-sidebar__item">
<a href="https://mobiledgex.github.io/edge-cloud-sdk-unity" class="duik-sidebar__link">Unity SDK Manual</a>
Expand Down Expand Up @@ -622,7 +622,7 @@ <h1>
.
resources:
limits:
nvidia.com/gpu: 1</code></pre><h2 id='vgpu-drivers-installation'><a class='anchor' aria-hidden='true' href='#vgpu-drivers-installation'><svg class='octicon octicon-link' viewBox='0 0 16 16' version='1.1' width='16' height='16' aria-hidden='true'><path fill-rule='evenodd' d='M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z'></path></svg></a>vGPU Drivers Installation</h2><p>The EdgeXR platform supports <a href="https://www.nvidia.com/en-us/data-center/virtual-solutions/">Nvidia vGPU</a> technology in order to maximize the performance of GPU workloads and help scale applications. vGPUs can be used in two cases:</p><ul><li><p>When using a vGPU sliced <a href="/deployments/deployment-workflow/flavors">flavor</a> on the EdgeXR platform</p></li></ul><ul><li><p>When virtualization a GPU to perform a task the GPU is not capable of i.e. Graphics Rendering on AI GPU like the Tesla T4</p></li></ul><p>For <a href="/deployments/application-deployment-guides/virtual-machine">Virtual Machine</a> deployments, for the above use cases, you will be required to install vGPU drivers in your <a href="/deployments/deployment-workflow/app-instances">application instance</a>. These drivers will vary from cloudlet to cloudlet and as such, you will need to download &amp; install these drivers into your application instance based on the cloudlet you have deployed your application. Drivers can be downloaded via the <a target="_blank" href="https://api.edgexr.org/mc">EdgeXR Controller APIs</a>. Below are some examples using the EdgeXR <a href="/tools/mcctl-guides">mcctl CLI</a> to find the relevant drivers for your application instance and get the download URL for the drivers. </p><p>For Docker and Kubernetes applications, the correct vGPU driver for the cloudlet is automatically installed during <a href="/deployments/deployment-workflow/clusters">cluster</a> creation and such you will only need to need to define the GPU requirements in your Deployment Manifest as outlined above. </p><h3 id='show-list-of-drivers'><a class='anchor' aria-hidden='true' href='#show-list-of-drivers'><svg class='octicon octicon-link' viewBox='0 0 16 16' version='1.1' width='16' height='16' aria-hidden='true'><path fill-rule='evenodd' d='M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z'></path></svg></a>Show List of Drivers</h3><pre><code>❯ mcctl gpudriver show region=EU
nvidia.com/gpu: 1</code></pre><h2 id='vgpu-drivers-installation'><a class='anchor' aria-hidden='true' href='#vgpu-drivers-installation'><svg class='octicon octicon-link' viewBox='0 0 16 16' version='1.1' width='16' height='16' aria-hidden='true'><path fill-rule='evenodd' d='M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z'></path></svg></a>vGPU Drivers Installation</h2><p>The EdgeXR platform supports <a href="https://www.nvidia.com/en-us/data-center/virtual-solutions/">Nvidia vGPU</a> technology in order to maximize the performance of GPU workloads and help scale applications. vGPUs can be used in two cases:</p><ul><li><p>When using a vGPU sliced <a href="/deployments/deployment-workflow/flavors">flavor</a> on the EdgeXR platform</p></li></ul><ul><li><p>When virtualization a GPU to perform a task the GPU is not capable of i.e. Graphics Rendering on AI GPU like the Tesla T4</p></li></ul><p>For <a href="/deployments/application-deployment-guides/virtual-machine">Virtual Machine</a> deployments, for the above use cases, you will be required to install vGPU drivers in your <a href="/deployments/deployment-workflow/app-instances">application instance</a>. These drivers will vary from cloudlet to cloudlet and as such, you will need to download &amp; install these drivers into your application instance based on the cloudlet you have deployed your application. Drivers can be downloaded via the <a target="_blank" href="https://api.edgexr.org">EdgeXR Controller APIs</a>. Below are some examples using the EdgeXR <a href="/tools/mcctl-guides">mcctl CLI</a> to find the relevant drivers for your application instance and get the download URL for the drivers. </p><p>For Docker and Kubernetes applications, the correct vGPU driver for the cloudlet is automatically installed during <a href="/deployments/deployment-workflow/clusters">cluster</a> creation and such you will only need to need to define the GPU requirements in your Deployment Manifest as outlined above. </p><h3 id='show-list-of-drivers'><a class='anchor' aria-hidden='true' href='#show-list-of-drivers'><svg class='octicon octicon-link' viewBox='0 0 16 16' version='1.1' width='16' height='16' aria-hidden='true'><path fill-rule='evenodd' d='M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z'></path></svg></a>Show List of Drivers</h3><pre><code>❯ mcctl gpudriver show region=EU

key:
name: nvidia-450
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -491,10 +491,10 @@
<ul class="duik-sidebar__nav">
<li class="duik-sidebar__item"><a href="/apis" class="duik-sidebar__link">Overview</a></li>
<li class="duik-sidebar__item">
<a href="https://api.edgexr.org" class="duik-sidebar__link">Device APIs</a>
<a href="https://device-api.edgexr.org" class="duik-sidebar__link">Device APIs</a>
</li>
<li class="duik-sidebar__item">
<a href="https://api.edgexr.org/mc" class="duik-sidebar__link">Edge Orchestration APIs</a>
<a href="https://api.edgexr.org" class="duik-sidebar__link">Edge Orchestration APIs</a>
</li>
<li class="duik-sidebar__item">
<a href="https://mobiledgex.github.io/edge-cloud-sdk-unity" class="duik-sidebar__link">Unity SDK Manual</a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -491,10 +491,10 @@
<ul class="duik-sidebar__nav">
<li class="duik-sidebar__item"><a href="/apis" class="duik-sidebar__link">Overview</a></li>
<li class="duik-sidebar__item">
<a href="https://api.edgexr.org" class="duik-sidebar__link">Device APIs</a>
<a href="https://device-api.edgexr.org" class="duik-sidebar__link">Device APIs</a>
</li>
<li class="duik-sidebar__item">
<a href="https://api.edgexr.org/mc" class="duik-sidebar__link">Edge Orchestration APIs</a>
<a href="https://api.edgexr.org" class="duik-sidebar__link">Edge Orchestration APIs</a>
</li>
<li class="duik-sidebar__item">
<a href="https://mobiledgex.github.io/edge-cloud-sdk-unity" class="duik-sidebar__link">Unity SDK Manual</a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -491,10 +491,10 @@
<ul class="duik-sidebar__nav">
<li class="duik-sidebar__item"><a href="/apis" class="duik-sidebar__link">Overview</a></li>
<li class="duik-sidebar__item">
<a href="https://api.edgexr.org" class="duik-sidebar__link">Device APIs</a>
<a href="https://device-api.edgexr.org" class="duik-sidebar__link">Device APIs</a>
</li>
<li class="duik-sidebar__item">
<a href="https://api.edgexr.org/mc" class="duik-sidebar__link">Edge Orchestration APIs</a>
<a href="https://api.edgexr.org" class="duik-sidebar__link">Edge Orchestration APIs</a>
</li>
<li class="duik-sidebar__item">
<a href="https://mobiledgex.github.io/edge-cloud-sdk-unity" class="duik-sidebar__link">Unity SDK Manual</a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -491,10 +491,10 @@
<ul class="duik-sidebar__nav">
<li class="duik-sidebar__item"><a href="/apis" class="duik-sidebar__link">Overview</a></li>
<li class="duik-sidebar__item">
<a href="https://api.edgexr.org" class="duik-sidebar__link">Device APIs</a>
<a href="https://device-api.edgexr.org" class="duik-sidebar__link">Device APIs</a>
</li>
<li class="duik-sidebar__item">
<a href="https://api.edgexr.org/mc" class="duik-sidebar__link">Edge Orchestration APIs</a>
<a href="https://api.edgexr.org" class="duik-sidebar__link">Edge Orchestration APIs</a>
</li>
<li class="duik-sidebar__item">
<a href="https://mobiledgex.github.io/edge-cloud-sdk-unity" class="duik-sidebar__link">Unity SDK Manual</a>
Expand Down
4 changes: 2 additions & 2 deletions deployments/application-deployment-guides/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -491,10 +491,10 @@
<ul class="duik-sidebar__nav">
<li class="duik-sidebar__item"><a href="/apis" class="duik-sidebar__link">Overview</a></li>
<li class="duik-sidebar__item">
<a href="https://api.edgexr.org" class="duik-sidebar__link">Device APIs</a>
<a href="https://device-api.edgexr.org" class="duik-sidebar__link">Device APIs</a>
</li>
<li class="duik-sidebar__item">
<a href="https://api.edgexr.org/mc" class="duik-sidebar__link">Edge Orchestration APIs</a>
<a href="https://api.edgexr.org" class="duik-sidebar__link">Edge Orchestration APIs</a>
</li>
<li class="duik-sidebar__item">
<a href="https://mobiledgex.github.io/edge-cloud-sdk-unity" class="duik-sidebar__link">Unity SDK Manual</a>
Expand Down
Loading

0 comments on commit 03b8d73

Please sign in to comment.