summaryrefslogtreecommitdiff
path: root/interface-definitions/containers.xml.in
blob: f54207936b8a27d34263858a85474c6205104664 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
<?xml version="1.0"?>
<interfaceDefinition>
  <node name="container" owner="${vyos_conf_scripts_dir}/containers.py">
    <properties>
      <help>Container applications</help>
    </properties>
    <children>
      <tagNode name="name">
        <properties>
          <help>Container name</help>
        </properties>
        <children>
          <leafNode name="allow-host-networks">
            <properties>
              <help>Allow host networks in container</help>
              <valueless/>
            </properties>
          </leafNode>
          <leafNode name="description">
            <properties>
              <help>Container description</help>
            </properties>
          </leafNode>
          <tagNode name="environment">
            <properties>
              <help>Add custom environment variables</help>
            </properties>
            <children>
              <leafNode name="value">
                <properties>
                  <help>Set environment option value</help>
                  <valueHelp>
                    <format>txt</format>
                    <description>Set environment option value</description>
                  </valueHelp>
                </properties>
              </leafNode>
            </children>
          </tagNode>
          <leafNode name="image">
            <properties>
              <help>Image name in the hub-registry</help>
            </properties>
          </leafNode>
          <tagNode name="network">
            <properties>
              <help>Attach user defined network to container</help>
              <completionHelp>
                <path>container network</path>
              </completionHelp>
            </properties>
            <children>
              <leafNode name="address">
                <properties>
                  <help>Set IPv4 static address to container (optional)</help>
                  <valueHelp>
                    <format>ipv4</format> 
                    <description>IPv4 address (x.x.x.1 reserved)</description>
                  </valueHelp>
                  <constraint>
                    <validator name="ipv4-address"/>
                  </constraint>
                </properties>
              </leafNode>
            </children>
          </tagNode>
        </children>
      </tagNode>
      <tagNode name="network">
        <properties>
          <help>Network name</help>
        </properties>
        <children>
          <leafNode name="description">
            <properties>
              <help>Network description</help>
            </properties>
          </leafNode>
          <leafNode name="ipv4-prefix">
            <properties>
              <help>Prefix which allocated to that network</help>
              <valueHelp>
                <format>ipv4net</format>
                <description>IPv4 network and prefix length</description>
              </valueHelp>
              <constraint>
                <validator name="ip-prefix"/>
              </constraint>
            </properties>
          </leafNode>
        </children>
      </tagNode>
      <leafNode name="registry">
        <properties>
          <help>Add registry (default docker.io)</help>
          <multi/>
        </properties>
        <defaultValue>docker.io</defaultValue>
      </leafNode>
    </children>
  </node>
</interfaceDefinition>