Skip to content

Commit

Permalink
build based on 6a917b8
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jul 15, 2024
1 parent 7a165dd commit 33dd86e
Show file tree
Hide file tree
Showing 206 changed files with 206 additions and 206 deletions.
2 changes: 1 addition & 1 deletion previews/PR202/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2024-07-15T07:19:59","documenter_version":"1.3.0"}}
{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2024-07-15T07:23:32","documenter_version":"1.3.0"}}
2 changes: 1 addition & 1 deletion previews/PR202/apidocs/apidocs/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion previews/PR202/development/client_libraries/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion previews/PR202/development/contributing/index.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,4 @@
"mgmtVrfEnabled": "true"
}
}
}</code></pre><p><a href="https://github.com/sonic-net/sonic-buildimage/blob/202205/files/image_config/sysctl/sysctl-net.conf#L7">IP forwarding is deactivated on <code>eth0</code></a>, and no IP Masquerade is configured.</p></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Monday 15 July 2024 07:19">Monday 15 July 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
}</code></pre><p><a href="https://github.com/sonic-net/sonic-buildimage/blob/202205/files/image_config/sysctl/sysctl-net.conf#L7">IP forwarding is deactivated on <code>eth0</code></a>, and no IP Masquerade is configured.</p></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Monday 15 July 2024 07:23">Monday 15 July 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
type MachineAllocation struct {
// existing fields are omitted for readability
PlacementTags []string `json:&quot;placement_tags&quot; description:&quot;by default machines are spread across the racks inside a partition for every project. if placement tags are provided, the machine candidate has an additional anti-affinity to other machines having the same tags&quot;`
}</code></pre></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Monday 15 July 2024 07:19">Monday 15 July 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
}</code></pre></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Monday 15 July 2024 07:23">Monday 15 July 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@
└─╴08b9114b-ec47-4697-b402-a11421788dc6 test 793bb6cd-8b46-479d-9209-0fedca428fe1 fra-equ01 false false 10.128.64.0/22  ●
underlay-fra-equ01 Underlay Network fra-equ01 false false 10.0.0.0/16  ●</code></pre></li><li><p>The user does not see any machines yet.</p><pre><code class="nohighlight hljs">$ metalctl machine ls</code></pre></li><li><p>The user can create a machine.</p><pre><code class="nohighlight hljs">$ metalctl machine create --networks internet,08b9114b-ec47-4697-b402-a11421788dc6 --name test --hostname test --image ubuntu-20.04 --partition fra-equ01 --size c1-xlarge-x86`</code></pre></li><li><p>The machine will now be provisioned.</p><pre><code class="nohighlight hljs">$ metalctl machine ls
ID LAST EVENT WHEN AGE HOSTNAME PROJECT SIZE IMAGE PARTITION
00000000-0000-0000-0000-ac1f6b7befb2 Phoned Home 20s 50d 4h test 793bb6cd-8b46-479d-9209-0fedca428fe1 c1-xlarge-x86 Ubuntu 20.04 20210415 fra-equ01</code></pre></li></ul><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>A user <strong>cannot</strong> list all allocated machines for all projects. The user <strong>must</strong> always switch project context first and can only view the machines inside this project. Only admins can see all machines at once.</p></div></div><h3 id="Scopes-for-Resources"><a class="docs-heading-anchor" href="#Scopes-for-Resources">Scopes for Resources</a><a id="Scopes-for-Resources-1"></a><a class="docs-heading-anchor-permalink" href="#Scopes-for-Resources" title="Permalink"></a></h3><p>The admins / operators of the metal-stack should be able to provide <em>global</em> resources that users are able to use along with their own resources. In particular, users can view and use <em>global</em> resources, but they are not allowed to create, modify or delete them.</p><div class="admonition is-info"><header class="admonition-header">Info</header><div class="admonition-body"><p>When a project ID field is empty on a resource, the resource is considered <em>global</em>.</p></div></div><p>Where possible, users should be capable of creating their own resource entities.</p><table><tr><th style="text-align: left">Resource</th><th style="text-align: left">User</th><th style="text-align: left">Global</th></tr><tr><td style="text-align: left">File System Layout</td><td style="text-align: left">yes</td><td style="text-align: left">yes</td></tr><tr><td style="text-align: left">Firewall</td><td style="text-align: left">yes</td><td style="text-align: left"></td></tr><tr><td style="text-align: left">Firmware</td><td style="text-align: left"></td><td style="text-align: left">yes</td></tr><tr><td style="text-align: left">OS Image</td><td style="text-align: left"></td><td style="text-align: left">yes</td></tr><tr><td style="text-align: left">Machine</td><td style="text-align: left">yes</td><td style="text-align: left"></td></tr><tr><td style="text-align: left">Network (Base)</td><td style="text-align: left"></td><td style="text-align: left">yes</td></tr><tr><td style="text-align: left">Network (Children)</td><td style="text-align: left">yes</td><td style="text-align: left"></td></tr><tr><td style="text-align: left">IP</td><td style="text-align: left">yes</td><td style="text-align: left"></td></tr><tr><td style="text-align: left">Partition</td><td style="text-align: left"></td><td style="text-align: left">yes</td></tr><tr><td style="text-align: left">Project</td><td style="text-align: left">yes</td><td style="text-align: left"></td></tr><tr><td style="text-align: left">Project Token</td><td style="text-align: left">yes</td><td style="text-align: left"></td></tr><tr><td style="text-align: left">Size</td><td style="text-align: left"></td><td style="text-align: left">yes</td></tr><tr><td style="text-align: left">Switch</td><td style="text-align: left"></td><td style="text-align: left"></td></tr><tr><td style="text-align: left">Tenant</td><td style="text-align: left"></td><td style="text-align: left">yes</td></tr></table><div class="admonition is-info"><header class="admonition-header">Info</header><div class="admonition-body"><p>Example: A user can make use of the file system layouts provided by the admins, but can also create own layouts. Same applies for images. As soon as a user creates own resources, the user takes over the responsibility for the machine provisioning to succeed.</p></div></div></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Monday 15 July 2024 07:19">Monday 15 July 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
00000000-0000-0000-0000-ac1f6b7befb2 Phoned Home 20s 50d 4h test 793bb6cd-8b46-479d-9209-0fedca428fe1 c1-xlarge-x86 Ubuntu 20.04 20210415 fra-equ01</code></pre></li></ul><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>A user <strong>cannot</strong> list all allocated machines for all projects. The user <strong>must</strong> always switch project context first and can only view the machines inside this project. Only admins can see all machines at once.</p></div></div><h3 id="Scopes-for-Resources"><a class="docs-heading-anchor" href="#Scopes-for-Resources">Scopes for Resources</a><a id="Scopes-for-Resources-1"></a><a class="docs-heading-anchor-permalink" href="#Scopes-for-Resources" title="Permalink"></a></h3><p>The admins / operators of the metal-stack should be able to provide <em>global</em> resources that users are able to use along with their own resources. In particular, users can view and use <em>global</em> resources, but they are not allowed to create, modify or delete them.</p><div class="admonition is-info"><header class="admonition-header">Info</header><div class="admonition-body"><p>When a project ID field is empty on a resource, the resource is considered <em>global</em>.</p></div></div><p>Where possible, users should be capable of creating their own resource entities.</p><table><tr><th style="text-align: left">Resource</th><th style="text-align: left">User</th><th style="text-align: left">Global</th></tr><tr><td style="text-align: left">File System Layout</td><td style="text-align: left">yes</td><td style="text-align: left">yes</td></tr><tr><td style="text-align: left">Firewall</td><td style="text-align: left">yes</td><td style="text-align: left"></td></tr><tr><td style="text-align: left">Firmware</td><td style="text-align: left"></td><td style="text-align: left">yes</td></tr><tr><td style="text-align: left">OS Image</td><td style="text-align: left"></td><td style="text-align: left">yes</td></tr><tr><td style="text-align: left">Machine</td><td style="text-align: left">yes</td><td style="text-align: left"></td></tr><tr><td style="text-align: left">Network (Base)</td><td style="text-align: left"></td><td style="text-align: left">yes</td></tr><tr><td style="text-align: left">Network (Children)</td><td style="text-align: left">yes</td><td style="text-align: left"></td></tr><tr><td style="text-align: left">IP</td><td style="text-align: left">yes</td><td style="text-align: left"></td></tr><tr><td style="text-align: left">Partition</td><td style="text-align: left"></td><td style="text-align: left">yes</td></tr><tr><td style="text-align: left">Project</td><td style="text-align: left">yes</td><td style="text-align: left"></td></tr><tr><td style="text-align: left">Project Token</td><td style="text-align: left">yes</td><td style="text-align: left"></td></tr><tr><td style="text-align: left">Size</td><td style="text-align: left"></td><td style="text-align: left">yes</td></tr><tr><td style="text-align: left">Switch</td><td style="text-align: left"></td><td style="text-align: left"></td></tr><tr><td style="text-align: left">Tenant</td><td style="text-align: left"></td><td style="text-align: left">yes</td></tr></table><div class="admonition is-info"><header class="admonition-header">Info</header><div class="admonition-body"><p>Example: A user can make use of the file system layouts provided by the admins, but can also create own layouts. Same applies for images. As soon as a user creates own resources, the user takes over the responsibility for the machine provisioning to succeed.</p></div></div></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Monday 15 July 2024 07:23">Monday 15 July 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 33dd86e

Please sign in to comment.