Skip to content
Snippets Groups Projects
Commit ef48c44a authored by yangalicace1's avatar yangalicace1
Browse files

Deployed 57c62004 to develop in public with MkDocs 1.6.1 and mike 2.1.3

parent b1722566
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
public/develop/search/search_index.json
+ 1
− 1
View file @ ef48c44a
Source diff could not be displayed: it is too large. Options to address this: view the blob.
public/develop/supported_service_handlers/index.html
+ 13
− 13
View file @ ef48c44a
...@@ -580,19 +580,19 @@ ...@@ -580,19 +580,19 @@
<p>This section summarizes the service handlers supported by the TeraFlowSDN controller.</p> <p>This section summarizes the service handlers supported by the TeraFlowSDN controller.</p>
<ul> <ul>
<li><a href="/7.-Supported-Service-Handlers/7.1.-L2NM-Emulated">7.1. L2NM Emulated</a></li> <li><a href="#71-l2nm-emulated">7.1. L2NM Emulated</a></li>
<li><a href="/7.-Supported-Service-Handlers/7.2.-L2NM-IETF-L2VPN">7.2. L2NM IETF L2VPN</a></li> <li><a href="#72-l2nm-ietf-l2vpn">7.2. L2NM IETF L2VPN</a></li>
<li><a href="/7.-Supported-Service-Handlers/7.3.-L2NM-NetConf-OpenConfig">7.3. L2NM NetConf OpenConfig</a></li> <li><a href="#73-l2nm-netconf-openconfig">7.3. L2NM NetConf OpenConfig</a></li>
<li><a href="/7.-Supported-Service-Handlers/7.4.-L2NM-P4">7.4. L2NM P4</a></li> <li><a href="#74-l2nm-p4">7.4. L2NM P4</a></li>
<li><a href="/7.-Supported-Service-Handlers/7.5.-L3NM-Emulated">7.5. L3NM Emulated</a></li> <li><a href="#75-l3nm-emulated">7.5. L3NM Emulated</a></li>
<li><a href="/7.-Supported-Service-Handlers/7.6.-L3NM-gNMI-OpenConfig">7.6. L3NM gNMI OpenConfig</a></li> <li><a href="#76-l3nm-gnmi-openconfig">7.6. L3NM gNMI OpenConfig</a></li>
<li><a href="/7.-Supported-Service-Handlers/7.7.-L3NM-NetConf-OpenConfig">7.7. L3NM NetConf OpenConfig</a></li> <li><a href="#77-l3nm-netconf-openconfig">7.7. L3NM NetConf OpenConfig</a></li>
<li><a href="/7.-Supported-Service-Handlers/7.8.-L3NM-IETF-ACTN">7.8. L3NM IETF ACTN</a></li> <li><a href="#78-l3nm-ietf-actn">7.8. L3NM IETF ACTN</a></li>
<li><a href="/7.-Supported-Service-Handlers/7.9.-End-to-end-Orchestrator">7.9. End-to-end Orchestrator</a></li> <li><a href="#79-end-to-end-orchestrator">7.9. End-to-end Orchestrator</a></li>
<li><a href="/7.-Supported-Service-Handlers/7.10.-Microwave">7.10. Microwave</a></li> <li><a href="#710-microwave">7.10. Microwave</a></li>
<li><a href="/7.-Supported-Service-Handlers/7.11.-Optical-OpenConfig">7.11. Optical OpenConfig</a></li> <li><a href="#711-optical-openconfig">7.11. Optical OpenConfig</a></li>
<li><a href="/7.-Supported-Service-Handlers/7.12.-Transport-API">7.12. Transport API</a></li> <li><a href="#712-transport-api">7.12. Transport API</a></li>
<li><a href="/7.-Supported-Service-Handlers/7.13.-XR-Pluggable">7.13. XR Pluggable</a></li> <li><a href="#713-xr-pluggable">7.13. XR Pluggable</a></li>
</ul> </ul>
<h2 id="71-l2nm-emulated"><strong>7.1. L2NM Emulated</strong></h2> <h2 id="71-l2nm-emulated"><strong>7.1. L2NM Emulated</strong></h2>
<p><strong>Documentation in progress</strong></p> <p><strong>Documentation in progress</strong></p>
......
public/develop/troubleshooting/index.html
+ 125
− 1
View file @ ef48c44a
...@@ -75,6 +75,11 @@ ...@@ -75,6 +75,11 @@
<label class="md-overlay" for="__drawer"></label> <label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip"> <div data-md-component="skip">
<a href="#81-release-disk-space" class="md-skip">
Skip to content
</a>
</div> </div>
<div data-md-component="announce"> <div data-md-component="announce">
...@@ -395,6 +400,17 @@ ...@@ -395,6 +400,17 @@
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
8. Troubleshooting
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active"> <a href="./" class="md-nav__link md-nav__link--active">
...@@ -405,6 +421,50 @@ ...@@ -405,6 +421,50 @@
</a> </a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#81-release-disk-space" class="md-nav__link">
<span class="md-ellipsis">
8.1. Release Disk Space
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#82-activate-debug-mode-for-microservices-and-collect-logs" class="md-nav__link">
<span class="md-ellipsis">
8.2. Activate DEBUG mode for microservices and collect logs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#83-download-a-snapshot-of-the-context-database" class="md-nav__link">
<span class="md-ellipsis">
8.3. Download a snapshot of the Context database
</span>
</a>
</li>
</ul>
</nav>
</li> </li>
...@@ -426,7 +486,71 @@ ...@@ -426,7 +486,71 @@
<h1>8. Troubleshooting</h1> <h1>8. Troubleshooting</h1>
<ul>
<li><a href="./8.-Troubleshooting/8.1.-Release-Disk-Space">8.1. Release Disk Space</a></li>
<li><a href="./8.-Troubleshooting/8.2.-Activate-DEBUG-mode-for-microservices-and-collect-logs">8.2. Activate DEBUG mode for microservices and collect logs</a></li>
<li><a href="./8.-Troubleshooting/8.3.-Download-a-snapshot-of-the-Context-database">8.3. Download a snapshot of the Context database</a></li>
</ul>
<h2 id="81-release-disk-space"><strong>8.1. Release Disk Space</strong></h2>
<p><strong>Page under construction.</strong></p>
<p>Clean images when your <code>/var/lib/docker</code> starts taking up too much space:</p>
<pre><code class="language-bash">docker system prune -a
</code></pre>
<h2 id="82-activate-debug-mode-for-microservices-and-collect-logs"><strong>8.2. Activate DEBUG mode for microservices and collect logs</strong></h2>
<p>In some cases might happen that some component is not working or reporting errors.
In those cases it makes sense to activate DEBUG mode on those components and collect the logs.</p>
<h3><u>Activate DEBUG mode in components</h3>
<p></u></p>
<p>Before deploying the TeraFlowSDN, in the <a href="https://labs.etsi.org/rep/tfs/controller/-/tree/master/manifests">manifests</a> folder, modify the appropriate files for the microservices to be inspected, e.g. <code>contextservice.yaml</code>, <code>deviceservice.yaml</code>, <code>serviceservice.yaml</code>, <code>pathcompservice.yaml</code>, and <code>nbiservice.yaml</code>, by changing environment variable <code>LOG_LEVEL</code> to <code>DEBUG</code>.</p>
<pre><code class="language-yaml">apiVersion: apps/v1
kind: Deployment
#...
spec:
# ...
template:
# ...
spec:
# ...
containers:
# ...
- name: server
# ...
env:
# ...
- name: LOG_LEVEL
value: &quot;INFO&quot; # change to &quot;DEBUG&quot;
# ...
</code></pre>
<h3><u>Redeploy TeraFlowSDN</h3>
<p></u></p>
<p>Redeploy TeraFlowSDN as usual using the example <code>my_deploy.sh</code> specifications or whatever file you created with your deploy specs.</p>
<pre><code class="language-bash">source my_deploy.sh
./deploy/all.sh
</code></pre>
<p>Wait for the deployment to finish.</p>
<h3><u>Use TeraFlowSDN</h3>
<p></u></p>
<p>Do whatever actions you were testing and were missbehaving, such as onboarding a topology, creating a connectivity service, etc.</p>
<h3><u>Collect log files</h3>
<p></u></p>
<p>A number of helper scripts, named as <code>show_logs_&lt;component&gt;.sh</code>, are provided to facilitate log collection in the <a href="https://labs.etsi.org/rep/tfs/controller/-/tree/master/scripts">scripts</a> folder.
These scripts dump, by default, the logs on the screen, but can be redirected to files when needed.</p>
<p>In the following example, the logs of <code>context</code>, <code>device</code>, <code>service</code>, <code>pathcomp-frontend</code>, and <code>nbi</code> are stored in respective log files instead of the screen.</p>
<pre><code class="language-bash">cd ~/tfs-ctrl
./scripts/show_logs_context.sh &gt; context.log
./scripts/show_logs_device.sh &gt; device.log
./scripts/show_logs_service.sh &gt; service.log
./scripts/show_logs_pathcomp_frontend.sh &gt; pathcomp_frontend.log
./scripts/show_logs_nbi.sh &gt; nbi.log
</code></pre>
<p>The resulting logs will be stored in the root TeraFlowSDN folder.</p>
<blockquote></blockquote>
<h2 id="83-download-a-snapshot-of-the-context-database"><strong>8.3. Download a snapshot of the Context database</strong></h2>
<p>In the WebUI, there is a tab named as <code>Debug</code> that you can use to interrogate the Context database.
In particular, there is a link named as <code>Dummy Contexts</code>. This link produces a JSON descriptor file containing all the contexts, topologies, devices, links, slices, services, connections, constraints, and configuration rules present in Context. The resulting file can be onboarded in a blank TeraFlowSDN instance for testing purposes.</p>
<p><strong>IMPORTANT</strong>: The Dummy Contexts feature might take few seconds to respond while it composes the reply.</p>
<p><strong>IMPORTANT</strong>: The produced file is labelled as <code>"dummy": true</code>; that means it is a snapshot of the database that can be loaded directly into Context. This means it does not pass through the Device/Service/Slice components to onboard the records, but it drops the records directly in Context. This is useful to investigate the content on the database when an issue arises.</p>
<p><strong>WARNING</strong>: The dump retrieves all the information in clear text! Remember to <strong>manually anonymize your sensitive data</strong> such as credentials, IP addresses, etc.</p>
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment