Commit 52f048e4 authored by Kostis Trantzas's avatar Kostis Trantzas
Browse files

Deployed 5c2de56d to develop in public with MkDocs 1.6.1 and mike 2.1.3

parent dac20c74
Loading
Loading
Loading
Loading
+1 −1
Original line number Original line Diff line number Diff line
@@ -2410,7 +2410,7 @@
      <div class="md-progress" data-md-component="progress" role="progressbar"></div>
      <div class="md-progress" data-md-component="progress" role="progressbar"></div>
    
    
    
    
    <script id="__config" type="application/json">{"base": "/develop", "features": ["navigation.instant", "navigation.instant.progress", "navigation.top", "navigation.footer", "navigation.path", "search", "search.highlight"], "search": "/develop/assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
    <script id="__config" type="application/json">{"base": "/develop", "features": ["navigation.instant", "navigation.instant.progress", "navigation.top", "navigation.footer", "navigation.path", "search", "search.highlight", "content.code.copy"], "search": "/develop/assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
    
    
    
    
      <script src="/develop/assets/javascripts/bundle.88dd0f4e.min.js"></script>
      <script src="/develop/assets/javascripts/bundle.88dd0f4e.min.js"></script>
+1 −1
Original line number Original line Diff line number Diff line
@@ -2731,7 +2731,7 @@
      <div class="md-progress" data-md-component="progress" role="progressbar"></div>
      <div class="md-progress" data-md-component="progress" role="progressbar"></div>
    
    
    
    
    <script id="__config" type="application/json">{"base": "..", "features": ["navigation.instant", "navigation.instant.progress", "navigation.top", "navigation.footer", "navigation.path", "search", "search.highlight"], "search": "../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
    <script id="__config" type="application/json">{"base": "..", "features": ["navigation.instant", "navigation.instant.progress", "navigation.top", "navigation.footer", "navigation.path", "search", "search.highlight", "content.code.copy"], "search": "../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
    
    
    
    
      <script src="../assets/javascripts/bundle.88dd0f4e.min.js"></script>
      <script src="../assets/javascripts/bundle.88dd0f4e.min.js"></script>
+33 −37
Original line number Original line Diff line number Diff line
@@ -2400,43 +2400,39 @@
<p>Note the UUID of the service (e.g. c4e7990a-e174-4cd2-9133-b10e56721e08 copy from address bar),  DeploymentRequestID and NSDID from characteristics</p>
<p>Note the UUID of the service (e.g. c4e7990a-e174-4cd2-9133-b10e56721e08 copy from address bar),  DeploymentRequestID and NSDID from characteristics</p>
<p>You can either use the UUID of the service or the DeploymentRequestID  and POST to the Alarms endpoint ( /tmf-api/alarmManagement/v4/alarm)</p>
<p>You can either use the UUID of the service or the DeploymentRequestID  and POST to the Alarms endpoint ( /tmf-api/alarmManagement/v4/alarm)</p>
<p>If the DeploymentRequestID  is used then POST:</p>
<p>If the DeploymentRequestID  is used then POST:</p>
<pre><code>
<div class="language-text highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>{
{
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>  &quot;alarmRaisedTime&quot;: &quot;2021-06-29T12:30:24.675Z&quot;,
  &quot;alarmRaisedTime&quot;: &quot;2021-06-29T12:30:24.675Z&quot;,
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>  &quot;alarmReportingTime&quot;: &quot;2021-06-29T12:30:54.675Z&quot;,
  &quot;alarmReportingTime&quot;: &quot;2021-06-29T12:30:54.675Z&quot;,
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>  &quot;state&quot;: &quot;raised&quot;,
  &quot;state&quot;: &quot;raised&quot;,
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>  &quot;alarmType&quot;: &quot;qualityOfServiceAlarm&quot;,
  &quot;alarmType&quot;: &quot;qualityOfServiceAlarm&quot;,
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a>  &quot;probableCause&quot;: &quot;thresholdCrossed&quot;,
  &quot;probableCause&quot;: &quot;thresholdCrossed&quot;,
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a>  &quot;ackState&quot;: &quot;unacknowledged&quot;,
  &quot;ackState&quot;: &quot;unacknowledged&quot;,
</span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a>  &quot;perceivedSeverity&quot;: &quot;major&quot;,
  &quot;perceivedSeverity&quot;: &quot;major&quot;,
</span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a>  &quot;sourceSystemId&quot;: &quot;mano-client-service&quot;,
  &quot;sourceSystemId&quot;: &quot;mano-client-service&quot;,
</span><span id="__span-0-10"><a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a>  &quot;alarmDetails&quot;: &quot;NSID=3;DeploymentRequestID=1&quot;,
  &quot;alarmDetails&quot;: &quot;NSID=3;DeploymentRequestID=1&quot;,
</span><span id="__span-0-11"><a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a>  &quot;specificProblem&quot;: &quot;myalram raised&quot;
  &quot;specificProblem&quot;: &quot;myalram raised&quot;
</span><span id="__span-0-12"><a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a>}
}
</span></code></pre></div>

</code></pre>
<p>If the UUID is used then POST:</p>
<p>If the UUID is used then POST:</p>
<pre><code>
<div class="language-text highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>{
{
</span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>  &quot;alarmRaisedTime&quot;: &quot;2021-06-29T12:30:24.675Z&quot;,
  &quot;alarmRaisedTime&quot;: &quot;2021-06-29T12:30:24.675Z&quot;,
</span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>  &quot;alarmReportingTime&quot;: &quot;2021-06-29T12:30:54.675Z&quot;,
  &quot;alarmReportingTime&quot;: &quot;2021-06-29T12:30:54.675Z&quot;,
</span><span id="__span-1-4"><a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a>  &quot;state&quot;: &quot;raised&quot;,
  &quot;state&quot;: &quot;raised&quot;,
</span><span id="__span-1-5"><a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a>  &quot;alarmType&quot;: &quot;qualityOfServiceAlarm&quot;,
  &quot;alarmType&quot;: &quot;qualityOfServiceAlarm&quot;,
</span><span id="__span-1-6"><a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a>  &quot;probableCause&quot;: &quot;thresholdCrossed&quot;,
  &quot;probableCause&quot;: &quot;thresholdCrossed&quot;,
</span><span id="__span-1-7"><a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a>  &quot;ackState&quot;: &quot;unacknowledged&quot;,
  &quot;ackState&quot;: &quot;unacknowledged&quot;,
</span><span id="__span-1-8"><a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a>  &quot;perceivedSeverity&quot;: &quot;major&quot;,
  &quot;perceivedSeverity&quot;: &quot;major&quot;,
</span><span id="__span-1-9"><a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a>  &quot;sourceSystemId&quot;: &quot;mano-client-service&quot;,
  &quot;sourceSystemId&quot;: &quot;mano-client-service&quot;,
</span><span id="__span-1-10"><a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a>  &quot;alarmDetails&quot;: &quot;analarm&quot;,
  &quot;alarmDetails&quot;: &quot;analarm&quot;,
</span><span id="__span-1-11"><a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-11"></a>  &quot;specificProblem&quot;: &quot;myalram raised&quot;,
  &quot;specificProblem&quot;: &quot;myalram raised&quot;,
</span><span id="__span-1-12"><a id="__codelineno-1-12" name="__codelineno-1-12" href="#__codelineno-1-12"></a>  &quot;affectedService&quot;: [
  &quot;affectedService&quot;: [
</span><span id="__span-1-13"><a id="__codelineno-1-13" name="__codelineno-1-13" href="#__codelineno-1-13"></a>    {
    {
</span><span id="__span-1-14"><a id="__codelineno-1-14" name="__codelineno-1-14" href="#__codelineno-1-14"></a>      &quot;id&quot;: &quot;c4e7990a-e174-4cd2-9133-b10e56721e08&quot;
      &quot;id&quot;: &quot;c4e7990a-e174-4cd2-9133-b10e56721e08&quot;
</span><span id="__span-1-15"><a id="__codelineno-1-15" name="__codelineno-1-15" href="#__codelineno-1-15"></a>    }
    }
</span><span id="__span-1-16"><a id="__codelineno-1-16" name="__codelineno-1-16" href="#__codelineno-1-16"></a>  ]
  ]
</span><span id="__span-1-17"><a id="__codelineno-1-17" name="__codelineno-1-17" href="#__codelineno-1-17"></a>

</span><span id="__span-1-18"><a id="__codelineno-1-18" name="__codelineno-1-18" href="#__codelineno-1-18"></a>}
}
</span></code></pre></div>

</code></pre>
<p>The Alarm to be created must have the affected Service ID equal to the running service from the scope (the cirros_ns)</p>
<p>The Alarm to be created must have the affected Service ID equal to the running service from the scope (the cirros_ns)</p>
<p>Go to service inventory you will see the notes and also the service characteristics for any  EXEC_ACTION updates</p>
<p>Go to service inventory you will see the notes and also the service characteristics for any  EXEC_ACTION updates</p>
<p>You can also adjust the alarm conditions. They must match true so the alarm to be acknowledged
<p>You can also adjust the alarm conditions. They must match true so the alarm to be acknowledged
@@ -2556,7 +2552,7 @@ So if another external service raises an Alarm (with POST) for the running servi
      <div class="md-progress" data-md-component="progress" role="progressbar"></div>
      <div class="md-progress" data-md-component="progress" role="progressbar"></div>
    
    
    
    
    <script id="__config" type="application/json">{"base": "..", "features": ["navigation.instant", "navigation.instant.progress", "navigation.top", "navigation.footer", "navigation.path", "search", "search.highlight"], "search": "../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
    <script id="__config" type="application/json">{"base": "..", "features": ["navigation.instant", "navigation.instant.progress", "navigation.top", "navigation.footer", "navigation.path", "search", "search.highlight", "content.code.copy"], "search": "../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
    
    
    
    
      <script src="../assets/javascripts/bundle.88dd0f4e.min.js"></script>
      <script src="../assets/javascripts/bundle.88dd0f4e.min.js"></script>
+18 −18
Original line number Original line Diff line number Diff line
@@ -2466,34 +2466,34 @@ These scenarios may include service bundles that involve multiple systems, such
<li>
<li>
<p>K8s API: The Kubernetes API server, which is the central control point for managing the Kubernetes cluster. CRIDGE interacts with the K8s API to manage CRDs and CRs.</p>
<p>K8s API: The Kubernetes API server, which is the central control point for managing the Kubernetes cluster. CRIDGE interacts with the K8s API to manage CRDs and CRs.</p>
<blockquote>
<blockquote>
<p>CRD (Custom Resource Definition): A CRD is a way to define custom resources in Kubernetes cluster-wise. It allows the extension of Kubernetes API to create and manage user-defined resources. Example :</p>
<p>CRD (Custom Resource Definition): A CRD is a way to define custom resources in Kubernetes cluster-wise. It allows the extension of Kubernetes API to create and manage user-defined resources. Example :
<div class="language-text highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>        apiVersion: apiextensions.k8s.io/v1
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>        kind: CustomResourceDefinition
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>        metadata:
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>            name: myresource.example.com
</span></code></pre></div></p>
</blockquote>
</blockquote>
</li>
</li>
</ul>
<li>
<pre><code>        apiVersion: apiextensions.k8s.io/v1
<p>Namespaces: Kubernetes namespaces provide a way to partition resources within a cluster. The diagram shows that multiple namespaces (nsxx, nsyy, nsz) can be managed by CRIDGE.</p>
        kind: CustomResourceDefinition
</li>
        metadata:
            name: myresource.example.com
</code></pre>
<ul>
<li>Namespaces: Kubernetes namespaces provide a way to partition resources within a cluster. The diagram shows that multiple namespaces (nsxx, nsyy, nsz) can be managed by CRIDGE.</li>
</ul>
</ul>
<blockquote>
<blockquote>
<p>CR (Custom Resource):  A CR is an instance of a CRD. It represents the actual custom resource that is managed within the Kubernetes cluster. Example shown in different namespaces:</p>
<p>CR (Custom Resource):  A CR is an instance of a CRD. It represents the actual custom resource that is managed within the Kubernetes cluster. Example shown in different namespaces:
<div class="language-text highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>        apiVersion: example.com/v1
</span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>        kind: Myresource
</span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>        metadata:
</span><span id="__span-1-4"><a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a>          name: example_resource_1
</span></code></pre></div></p>
</blockquote>
</blockquote>
<pre><code>        apiVersion: example.com/v1
        kind: Myresource
        metadata:
          name: example_resource_1
</code></pre>
<p>In a nutchell:</p>
<p>In a nutchell:</p>
<ul>
<ul>
<li>Various OSL services use the Service Bus to communicate with CRIDGE.</li>
<li>Various OSL services use the Service Bus to communicate with CRIDGE.</li>
<li>CRIDGE converts requests towards Kubernetes API and vice-versa, facilitating the integration of custom resources with other OSL services.</li>
<li>CRIDGE converts requests towards Kubernetes API and vice-versa, facilitating the integration of custom resources with other OSL services.</li>
<li>CRDs are defined and managed through the K8s API. The example CRD is named myresource.example.com.</li>
<li>CRDs are defined and managed through the K8s API. The example CRD is named myresource.example.com.</li>
<li>Deploying CRs in Namespaces: Custom resources defined by the CRD are created and managed within different namespaces in the Kubernetes cluster. Each namespace can have its own instances of the custom resources.<pre><code>&gt; The example CRD myresource.example.com allows the creation of custom resources of type Myresource.
<li>Deploying CRs in Namespaces: Custom resources defined by the CRD are created and managed within different namespaces in the Kubernetes cluster. Each namespace can have its own instances of the custom resources.<div class="language-text highlight"><pre><span></span><code>&gt; The example CRD myresource.example.com allows the creation of custom resources of type Myresource.
&gt; Instances of Myresource are created in various namespaces, each with unique names like example_resource_1.
&gt; Instances of Myresource are created in various namespaces, each with unique names like example_resource_1.
</code></pre>
</code></pre></div>
</li>
</li>
</ul>
</ul>
<h1 id="handling-more-than-one-clusters">Handling more than one clusters</h1>
<h1 id="handling-more-than-one-clusters">Handling more than one clusters</h1>
@@ -2777,7 +2777,7 @@ These scenarios may include service bundles that involve multiple systems, such
      <div class="md-progress" data-md-component="progress" role="progressbar"></div>
      <div class="md-progress" data-md-component="progress" role="progressbar"></div>
    
    
    
    
    <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.instant", "navigation.instant.progress", "navigation.top", "navigation.footer", "navigation.path", "search", "search.highlight"], "search": "../../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
    <script id="__config" type="application/json">{"base": "../../..", "features": ["navigation.instant", "navigation.instant.progress", "navigation.top", "navigation.footer", "navigation.path", "search", "search.highlight", "content.code.copy"], "search": "../../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
    
    
    
    
      <script src="../../../assets/javascripts/bundle.88dd0f4e.min.js"></script>
      <script src="../../../assets/javascripts/bundle.88dd0f4e.min.js"></script>
+1 −1
Original line number Original line Diff line number Diff line
@@ -2628,7 +2628,7 @@
      <div class="md-progress" data-md-component="progress" role="progressbar"></div>
      <div class="md-progress" data-md-component="progress" role="progressbar"></div>
    
    
    
    
    <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.instant", "navigation.instant.progress", "navigation.top", "navigation.footer", "navigation.path", "search", "search.highlight"], "search": "../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
    <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.instant", "navigation.instant.progress", "navigation.top", "navigation.footer", "navigation.path", "search", "search.highlight", "content.code.copy"], "search": "../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
    
    
    
    
      <script src="../../assets/javascripts/bundle.88dd0f4e.min.js"></script>
      <script src="../../assets/javascripts/bundle.88dd0f4e.min.js"></script>
Loading