Browse Source

Merge "Add description of additional attributes for nodes, bonds, NICs"

Jenkins 2 years ago
parent
commit
7f7fea75c3

+ 2
- 1
plugindocs/fuel-plugin-sdk-guide/create-plugin.rst View File

@@ -21,7 +21,8 @@ This section includes the following topics:
21 21
    create-plugin/actions-existing-roles.rst
22 22
    create-plugin/plugin-settings.rst
23 23
    create-plugin/plugin-node-roles.rst
24
+   create-plugin/plugin-attributes.rst
24 25
    create-plugin/modify-ui.rst
25 26
    create-plugin/plugin-repos.rst
26 27
    create-plugin/add-driverlog.rst
27
-   create-plugin/plugin-versioning-system.rst
28
+   create-plugin/plugin-versioning-system.rst

+ 70
- 0
plugindocs/fuel-plugin-sdk-guide/create-plugin/plugin-attributes.rst View File

@@ -0,0 +1,70 @@
1
+
2
+.. _plugin-attributes:
3
+
4
+Additional attributes for NICs, bonds, and nodes
5
+------------------------------------------------
6
+
7
+You can provide additional attributes for NICs, bonds, and nodes. This is
8
+useful for a plugin providing "per interface" or "per node" technology.
9
+
10
+An example of this use case is virtual functions support for vRouter on
11
+each network interface in Contrail.
12
+
13
+**To provide additional attributes for NICs:**
14
+
15
+Edit the ``nic_attributes.yaml`` file with the additional attributes.
16
+
17
+**Example:**
18
+
19
+.. code-block:: yaml
20
+
21
+    attribute_a:
22
+      label: "NIC attribute A"
23
+      description: "Your description"
24
+      type: "text"
25
+      value: ""
26
+    attribute_b:
27
+      label: "NIC attribute B"
28
+      description: "Your description"
29
+      type: "checkbox"
30
+      value: false
31
+
32
+**To provide additional attributes for bonds:**
33
+
34
+Edit the ``bond_attributes.yaml`` file with the additional attributes.
35
+
36
+**Example:**
37
+
38
+.. code-block:: yaml
39
+
40
+    attribute_a:
41
+      label: "Bond attribute A"
42
+      description: "Your description"
43
+      type: "text"
44
+      value: ""
45
+    attribute_b:
46
+      label: "Bond attribute B"
47
+      description: "Your description"
48
+      type: "checkbox"
49
+      value: false
50
+
51
+**To provide additional attributes for nodes:**
52
+
53
+Edit the ``node_attributes.yaml`` file with the additional attributes.
54
+
55
+**Example:**
56
+
57
+.. code-block:: yaml
58
+
59
+    plugin_section_a:
60
+      metadata:
61
+        group: "your_new_section"
62
+        label: "Section A"
63
+      attribute_a:
64
+        label: "Node attribute A for section A"
65
+        description: "Your description"
66
+        type: "text"
67
+      attribute_b:
68
+        label: "Node attribute B for section A"
69
+        description: "Your description"
70
+        type: "checkbox"

Loading…
Cancel
Save