Update documentation for devel

Auto-generated from c162983 by 'update-gh-pages.sh'

devel/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 69ba087c1b99967bf407df5796f3005d
+config: feb2feaea3f3af457d8858d1f21acefa
 tags: 645f666f9bcd5a90fca523b33c5a78b7

devel/_downloads/36c67ade35a837c924f87e006130752d/nri-resource-policy-configmap.example.yaml

@@ -75,43 +75,6 @@ data:
           - Cpuset: 28,29,30,31
             Socket: 3
           exclusive: false
-  rdt: |+
-    # Common options
-    options:
-      # One of Full, Discovery or Disabled
-      mode: Full
-      # Set to true to disable creation of monitoring groups
-      monitoringDisabled: false
-      l3:
-        # Make this false if L3 CAT must be available
-        optional: true
-      mb:
-        # Make this false if MBA must be available
-        optional: true
-
-    # Configuration of classes
-    partitions:
-      exclusive:
-        # Allocate 60% of all L3 cache to the "exclusive" partition
-        l3Allocation: "60%"
-        mbAllocation: ["100%"]
-        classes:
-          Guaranteed:
-            # Allocate all of the partitions cache lines to "Guaranteed"
-            l3Allocation: "100%"
-      shared:
-        # Allocate 40% L3 cache IDs to the "shared" partition
-        # These will NOT overlap with the cache lines allocated for "exclusive" partition
-        l3Allocation: "40%"
-        mbAllocation: ["50%"]
-        classes:
-          Burstable:
-            # Allow "Burstable" to use all cache lines of the "shared" partition
-            l3Allocation: "100%"
-          BestEffort:
-            # Allow "Besteffort" to use only half of the L3 cache # lines of the "shared" partition.
-            # These will overlap with those used by "Burstable"
-            l3Allocation: "50%"
 ---
 apiVersion: v1
 kind: ConfigMap
@@ -169,43 +132,6 @@ data:
           - Cpuset: 28,29,30,31
             Socket: 3
           exclusive: false
-  rdt: |+
-    # Common options
-    options:
-      # One of Full, Discovery or Disabled
-      mode: Full
-      # Set to true to disable creation of monitoring groups
-      monitoringDisabled: false
-      l3:
-        # Make this false if L3 CAT must be available
-        optional: true
-      mb:
-        # Make this false if MBA must be available
-        optional: true
-
-    # Configuration of classes
-    partitions:
-      exclusive:
-        # Allocate 60% of all L3 cache to the "exclusive" partition
-        l3Allocation: "60%"
-        mbAllocation: ["100%"]
-        classes:
-          Guaranteed:
-            # Allocate all of the partitions cache lines to "Guaranteed"
-            l3Allocation: "100%"
-      shared:
-        # Allocate 40% L3 cache IDs to the "shared" partition
-        # These will NOT overlap with the cache lines allocated for "exclusive" partition
-        l3Allocation: "40%"
-        mbAllocation: ["50%"]
-        classes:
-          Burstable:
-            # Allow "Burstable" to use all cache lines of the "shared" partition
-            l3Allocation: "100%"
-          BestEffort:
-            # Allow "Besteffort" to use only half of the L3 cache # lines of the "shared" partition.
-            # These will overlap with those used by "Burstable"
-            l3Allocation: "50%"
 ---
 apiVersion: v1
 kind: ConfigMap
@@ -263,42 +189,5 @@ data:
           - Cpuset: 28,29,30,31
             Socket: 3
           exclusive: false
-  rdt: |+
-    # Common options
-    options:
-      # One of Full, Discovery or Disabled
-      mode: Full
-      # Set to true to disable creation of monitoring groups
-      monitoringDisabled: false
-      l3:
-        # Make this false if L3 CAT must be available
-        optional: true
-      mb:
-        # Make this false if MBA must be available
-        optional: true
-
-    # Configuration of classes
-    partitions:
-      exclusive:
-        # Allocate 60% of all L3 cache to the "exclusive" partition
-        l3Allocation: "60%"
-        mbAllocation: ["100%"]
-        classes:
-          Guaranteed:
-            # Allocate all of the partitions cache lines to "Guaranteed"
-            l3Allocation: "100%"
-      shared:
-        # Allocate 40% L3 cache IDs to the "shared" partition
-        # These will NOT overlap with the cache lines allocated for "exclusive" partition
-        l3Allocation: "40%"
-        mbAllocation: ["50%"]
-        classes:
-          Burstable:
-            # Allow "Burstable" to use all cache lines of the "shared" partition
-            l3Allocation: "100%"
-          BestEffort:
-            # Allow "Besteffort" to use only half of the L3 cache # lines of the "shared" partition.
-            # These will overlap with those used by "Burstable"
-            l3Allocation: "50%"
   logger: |+
     Debug: resource-manager,cache

devel/_sources/docs/index.md.txt

@@ -0,0 +1,12 @@
+# Welcome to NRI Plugins documentation
+
+```{toctree}
+---
+maxdepth: 2
+caption: Contents
+---
+introduction.md
+resource-policy/index.rst
+contributing.md
+Project GitHub repository <https://github.com/containers/nri-plugins>
+```

devel/_sources/docs/introduction.md.txt

@@ -2,5 +2,5 @@
 
 The NRI plugins is a collection of NRI (Node Resource Interface) based plugins
 to manage various aspects of pod and container life cycle.
-For example the [resource policy plugins](resource_policies) can be used to modify
+For example the [resource policy plugins](resource-policy/policy/index.md) can be used to modify
 the container resource allocation depending on available system resources.

devel/_sources/docs/resource-policy/node-agent.md.txt → devel/_sources/docs/resource-policy/configuration.md.txt

@@ -23,5 +23,5 @@ the node group label.
 There is a
 [sample ConfigMap spec](/sample-configs/nri-resource-policy-configmap.example.yaml)
 that contains a node-specific, a group-specific, and a default ConfigMap
-example. See [any available policy-specific documentation](policy/index.rst)
+example. See [any available policy-specific documentation](policy/index.md)
 for more information on the policy configurations.

devel/_sources/docs/resource-policy/developers-guide/architecture.md.txt

@@ -185,19 +185,19 @@ resources is and to attempt a rebalancing/reallocation if it is deemed
 both possible and necessary.
 
 
-### [Policy Implementations](tree:/cmd/)
+### [Policy Implementations](tree:/cmd/plugins)
 
-#### [Topology Aware](tree:/cmd/topology-aware/)
+#### [Topology Aware](tree:/cmd/plugins/topology-aware/)
 
 A topology-aware policy capable of handling multiple tiers/types of memory,
 typically a DRAM/PMEM combination configured in 2-layer memory mode.
 
-#### [Balloons](tree:/cmd/balloons/)
+#### [Balloons](tree:/cmd/plugins/balloons/)
 
 A balloons policy allows user to define fine grained control how the
 computer resources are distributed to workloads.
 
-#### [Template](tree:/cmd/template/)
+#### [Template](tree:/cmd/plugins/template/)
 
 The template policy can be used as a base for developing new policies.
 It provides hooks that the policy developer can fill to define fine grained

devel/_sources/docs/resource-policy/developers-guide/index.md.txt

@@ -0,0 +1,10 @@
+# Developer's Guide
+
+```{toctree}
+---
+maxdepth: 1
+---
+architecture.md
+testing.rst
+cpu-allocator.md
+```

devel/_sources/docs/resource-policy/developers-guide/testing.md.txt

@@ -0,0 +1,9 @@
+# Testing
+
+```{toctree}
+---
+maxdepth: 1
+---
+unit-test.md
+e2e-test.md
+```

devel/_sources/docs/resource-policy/index.md.txt

@@ -0,0 +1,14 @@
+# Resource Policy Plugins
+
+```{toctree}
+---
+maxdepth: 2
+caption: Contents
+---
+introduction.md
+installation.md
+setup.md
+configuration.md
+policy/index.md
+developers-guide/index.rst
+```