Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix table and {{.ID}} rendering #82

Merged
merged 1 commit into from
Apr 3, 2024
Merged

fix table and {{.ID}} rendering #82

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions config/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,3 @@ def path_nav(page):

latest_release_version = _latest_release["version"]
latest_release_date = format_date(parse_timestamp(_latest_release["date"]))
ID = "{{.ID}}"
Image="{{.Image}}"
Labels="{{.Labels}}"
11 changes: 7 additions & 4 deletions convert-all.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,11 @@ cp -r subrepos/skupper-docs/images/ input/docs/
# To process nested numbered lists
python python/nested-numbers.py input/docs/operator/

# To workaround https://github.com/ssorj/plano/issues/3
# To workaround transform interpreting {{.ID}} as a var:

sed -i 's/.ID/ID/g' input/docs/cli/podman.md
sed -i 's/.Image/Image/g' input/docs/cli/podman.md
sed -i 's/.Labels/Labels/g' input/docs/cli/podman.md
sed -i 's/.ID/{.ID}/g' input/docs/cli/podman.md
sed -i 's/.Image/{.Image}/g' input/docs/cli/podman.md
sed -i 's/.Labels/{.Labels}/g' input/docs/cli/podman.md

# To workaround https://github.com/skupperproject/skupper-website/issues/81
sed -i 's/ | /| /g' input/docs/kubernetes/deployment-concerns.md
4 changes: 2 additions & 2 deletions docs/docs/cli/native-security-options.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Skupper - #Securing a service network</title>
<title>Skupper - # Securing a service network</title>
<meta name="description" content="Multicluster communication for Kubernetes. Skupper is a layer 7 service interconnect. It enables secure communication across Kubernetes clusters with no VPNs or special firewall rules."/>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic|Roboto+Mono:400,400italic|Alegreya+Sans:300,300italic,400,400italic,500,500italic,700,700italic;display=optional"/>
Expand Down Expand Up @@ -58,7 +58,7 @@
</div>
</div>
</nav>
<nav id="-path-nav"><div><a href="/docs/index.html">Documentation</a> <span class="path-separator">&#8250;</span> <a href="/docs/cli/index.html">Using the Skupper CLI</a> <span class="path-separator">&#8250;</span> <a href="/docs/cli/native-security-options.html">#Securing a service network</a></div></nav>
<nav id="-path-nav"><div><a href="/docs/index.html">Documentation</a> <span class="path-separator">&#8250;</span> <a href="/docs/cli/index.html">Using the Skupper CLI</a> <span class="path-separator">&#8250;</span> <a href="/docs/cli/native-security-options.html"># Securing a service network</a></div></nav>
<nav id="-site-menu-layer" style="display: none;">
<div>
<a href="/index.html">Home</a>
Expand Down
29 changes: 24 additions & 5 deletions docs/docs/kubernetes/deployment-concerns.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,12 +91,31 @@ <h2 id="scaling-for-increased-traffic">Scaling for increased traffic</h2>
<li><p>Determine the router CPU allocation you require.</p>
<p>By default, the router CPU allocation is <code>BestEffort</code> as described in <a href="https://kubernetes.io/docs/concepts/workloads/pods/pod-qos/#besteffort">Pod Quality of Service Classes</a>.</p>
<p>Consider the following CPU allocation options:</p>
<p>| Router CPU | Description |
| --- | --- |
| 1 | Helps avoid issues with <code>BestEffort</code> on low resource clusters |
| 2 | Suitable for production environments |
| 5 | Maximum performance |</p>
</li>
</ol>
<table>
<thead>
<tr>
<th>Router CPU</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>1</td>
<td>Helps avoid issues with <code>BestEffort</code> on low resource clusters</td>
</tr>
<tr>
<td>2</td>
<td>Suitable for production environments</td>
</tr>
<tr>
<td>5</td>
<td>Maximum performance</td>
</tr>
</tbody>
</table>
<ol start="2">
<li><p>If you are using the Skupper CLI, set the CPU allocation for the router using the <code>--router-cpu</code> option. For example:</p>
<pre><code class="language-bash">$ skupper init --router-cpu 2
</code></pre>
Expand Down
2 changes: 1 addition & 1 deletion input/docs/cli/podman.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,7 +337,7 @@ This procedure removes all containers, volumes and networks labeled `application
To check the labels associated with running containers:

```bash
$ podman ps -a --format "{{ID}} {{Image}} {{Labels}}"
$ podman ps -a --format "{{{.ID}}} {{{.Image}}} {{{.Labels}}}"
```
</dd></dl>

Expand Down
10 changes: 5 additions & 5 deletions input/docs/kubernetes/deployment-concerns.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ Increasing the number of routers does not improve network performance. An incom

Consider the following CPU allocation options:

| Router CPU | Description |
| --- | --- |
| 1 | Helps avoid issues with `BestEffort` on low resource clusters |
| 2 | Suitable for production environments |
| 5 | Maximum performance |
| Router CPU | Description |
| --- | --- |
| 1 | Helps avoid issues with `BestEffort` on low resource clusters |
| 2 | Suitable for production environments |
| 5 | Maximum performance |
2. If you are using the Skupper CLI, set the CPU allocation for the router using the `--router-cpu` option. For example:

```bash
Expand Down