Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix formats
Browse files Browse the repository at this point in the history
pwright committed Mar 28, 2024
1 parent d0a5906 commit 2df6547
Showing 13 changed files with 66 additions and 66 deletions.
30 changes: 15 additions & 15 deletions docs/docs/cli/index.html
Original file line number Diff line number Diff line change
@@ -250,7 +250,7 @@ <h2 id="specifying-link-cost">Specifying link cost</h2>
For example, in a two site network linked with a high cost with servers and clients on both sites, you can see that a client is served by the local servers while a local server is available.</p>
</li>
</ol>
<h3 id="exposing-services-on-the-service-network-from-a-namespace">Exposing services on the service network from a namespace</h3>
<h2 id="exposing-services-on-the-service-network-from-a-namespace">Exposing services on the service network from a namespace</h2>
<p>After creating a service network, exposed services can communicate across that network.</p>
<p>The <code>skupper</code> CLI has two options for exposing services that already exist in a namespace:</p>
<ul>
@@ -259,7 +259,7 @@ <h3 id="exposing-services-on-the-service-network-from-a-namespace">Exposing serv
<li><code>service create</code> and <code>service bind</code> is a more flexible method of exposing services, for example, if you have multiple services for a deployment.
See <a href="#exposing-complex-services-on-the-service-network">Exposing complex services on the service network</a> for instructions.</li>
</ul>
<h4 id="exposing-simple-services-on-the-service-network">Exposing simple services on the service network</h4>
<h3 id="exposing-simple-services-on-the-service-network">Exposing simple services on the service network</h3>
<p>This section describes how services can be enabled for a service network for simple use cases.</p>
<ol>
<li><p>Create a deployment, some pods, or a service in one of your sites, for example:</p>
@@ -290,7 +290,7 @@ <h4 id="exposing-simple-services-on-the-service-network">Exposing simple service
</ol>
<p><strong>📌 NOTE</strong><br />
If you do not specify ports, <code>skupper</code> uses the <code>containerPort</code> value of the deployment.</p>
<h4 id="exposing-complex-services-on-the-service-network">Exposing complex services on the service network</h4>
<h3 id="exposing-complex-services-on-the-service-network">Exposing complex services on the service network</h3>
<p>This section describes how services can be enabled for a service network for more complex use cases.</p>
<ol>
<li><p>Create a deployment, some pods, or a service in one of your sites, for example:</p>
@@ -324,7 +324,7 @@ <h4 id="exposing-complex-services-on-the-service-network">Exposing complex servi
</code></pre>
</li>
</ol>
<h4 id="exposing-services-from-a-different-namespace-to-the-service-network">Exposing services from a different namespace to the service network</h4>
<h3 id="exposing-services-from-a-different-namespace-to-the-service-network">Exposing services from a different namespace to the service network</h3>
<p>This section shows how to expose a service from a namespace where Skupper is not deployed.</p>
<p>Skupper allows you expose Kubernetes services from other namespaces for any site.
However, if you want to expose workloads, for example deployments, you must create a site as described in this section.</p>
@@ -363,7 +363,7 @@ <h4 id="exposing-services-from-a-different-namespace-to-the-service-network">Exp
</code></pre>
</li>
</ol>
<h3 id="exposing-services-on-the-service-network-from-a-local-machine">Exposing services on the service network from a local machine</h3>
<h2 id="exposing-services-on-the-service-network-from-a-local-machine">Exposing services on the service network from a local machine</h2>
<p>After creating a service network, you can expose services from a local machine on the service network.</p>
<p>For example, if you run a database on a server in your data center, you can deploy a front end in a cluster that can access the data as if the database was running in the cluster.</p>
<dl><dt><strong>📌 NOTE</strong></dt><dd>
@@ -373,7 +373,7 @@ <h3 id="exposing-services-on-the-service-network-from-a-local-machine">Exposing
See <a href="../cli/podman.html">Using Skupper Podman</a> for information about using the Skupper CLI to create Podman sites.</p>
</dd></dl>

<h4 id="exposing-simple-local-services-to-the-service-network">Exposing simple local services to the service network</h4>
<h3 id="exposing-simple-local-services-to-the-service-network">Exposing simple local services to the service network</h3>
<p>This section shows how to expose a single service running locally on a service network.</p>
<ul>
<li>A service network. Only one site is required.</li>
@@ -412,7 +412,7 @@ <h4 id="exposing-simple-local-services-to-the-service-network">Exposing simple l
<p>The URL field shows the underlying communication and can be ignored.</p>
</li>
</ol>
<h4 id="working-with-complex-local-services-on-the-service-network">Working with complex local services on the service network</h4>
<h3 id="working-with-complex-local-services-on-the-service-network">Working with complex local services on the service network</h3>
<p>This section shows more advanced usage of skupper gateway.</p>
<ol>
<li><p>Create a Skupper gateway:</p>
@@ -471,7 +471,7 @@ <h4 id="working-with-complex-local-services-on-the-service-network">Working with
</ul>
</li>
</ol>
<h4 id="creating-a-gateway-and-applying-it-on-a-different-machine">Creating a gateway and applying it on a different machine</h4>
<h3 id="creating-a-gateway-and-applying-it-on-a-different-machine">Creating a gateway and applying it on a different machine</h3>
<p>If you have access to a cluster from one machine but want to create a gateway to the service network from a different machine, you can create the gateway definition bundle on the first machine and later apply that definition bundle on a second machine as described in this procedure.
For example, if you want to expose a local database service to the service network, but you never want to access the cluster from the database server, you can use this procedure to create the definition bundle and apply it on the database server.</p>
<ol>
@@ -569,7 +569,7 @@ <h4 id="creating-a-gateway-and-applying-it-on-a-different-machine">Creating a ga
</ol>
<p><strong>📌 NOTE</strong><br />
If you need to change the gateway definition, for example to change port, you need to remove the existing gateway and repeat this procedure from the start to redefine the gateway.</p>
<h4 id="gateway-yaml-reference">Gateway YAML reference</h4>
<h3 id="gateway-yaml-reference">Gateway YAML reference</h3>
<p>The <a href="#creating-a-gateway-and-applying-it-on-a-different-machine">Creating a gateway and applying it on a different machine</a> describes how to create a gateway to apply on a separate machine using a gateway definition YAML file.</p>
<p>The following are valid entries in a gateway definition YAML file.</p>
<ul>
@@ -626,7 +626,7 @@ <h4 id="gateway-yaml-reference">Gateway YAML reference</h4>
<li><strong>qdr-listeners.port</strong><br />
Port for skupper router, typically <code>5672</code>.</li>
</ul>
<h4 id="exploring-a-service-network">Exploring a service network</h4>
<h2 id="exploring-a-service-network">Exploring a service network</h2>
<p>Skupper includes a command to allow you report all the sites and the services available on a service network.</p>
<ul>
<li>A service network with more than one site</li>
@@ -676,11 +676,11 @@ <h4 id="exploring-a-service-network">Exploring a service network</h4>
</ol>
</li>
</ol>
<h5 id="securing-a-service-network">Securing a service network</h5>
<h2 id="securing-a-service-network">Securing a service network</h2>
<p>Skupper provides default, built-in security that scales across clusters and clouds.
This section describes additional security you can configure.</p>
<p>See <a href="../policy/index.html">Securing a service network using policies</a> for information about creating granular policies for each cluster.</p>
<h6 id="restricting-access-to-services-using-a-kubernetes-network-policy">Restricting access to services using a Kubernetes network policy</h6>
<h3 id="restricting-access-to-services-using-a-kubernetes-network-policy">Restricting access to services using a Kubernetes network policy</h3>
<p>By default, if you expose a service on the service network, that service is also accessible from other namespaces in the cluster.
You can avoid this situation when creating a site using the <code>--create-network-policy</code> option.</p>
<ol>
@@ -697,7 +697,7 @@ <h6 id="restricting-access-to-services-using-a-kubernetes-network-policy">Restri
</li>
</ol>
<p>You can now expose services on the service network and those services are not accessible from other namespaces in the cluster.</p>
<h6 id="applying-tls-to-tcp-or-http2-traffic-on-the-service-network">Applying TLS to TCP or HTTP2 traffic on the service network</h6>
<h3 id="applying-tls-to-tcp-or-http2-traffic-on-the-service-network">Applying TLS to TCP or HTTP2 traffic on the service network</h3>
<p>By default, the traffic between sites is encrypted, however the traffic between the service pod and the router pod is not encrypted.
For services exposed as TCP or HTTP2, the traffic between the pod and the router pod can be encrypted using TLS.</p>
<ul>
@@ -758,7 +758,7 @@ <h6 id="applying-tls-to-tcp-or-http2-traffic-on-the-service-network">Applying TL
<li><p>Test calling the service from a TLS enabled frontend.</p>
</li>
</ol>
<h6 id="supported-standards-and-protocols">Supported standards and protocols</h6>
<h2 id="supported-standards-and-protocols">Supported standards and protocols</h2>
<p>Skupper supports the following protocols for your service network:</p>
<ul>
<li>TCP - default</li>
@@ -784,7 +784,7 @@ <h6 id="supported-standards-and-protocols">Supported standards and protocols</h6
<p>TCP is implemented as a single streamed message, whereas HTTP1 and HTTP2 are implemented as request/response message routing.</p>
</li>
</ul>
<p><a name="cli-global-options"></a>======= CLI options</p>
<h2 id="cli-options">CLI options</h2>
<p>For a full list of options, see the <a href="../kubernetes-reference/index.html">Skupper Kubernetes CLI reference</a> and <a href="../podman-reference/index.html">Skupper Podman CLI reference</a> documentation.</p>
<dl><dt><strong>⚠️ WARNING</strong></dt><dd>

10 changes: 5 additions & 5 deletions docs/docs/cli/native-security-options.html
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"/>
@@ -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>
@@ -75,11 +75,11 @@
<div>
<main>

<h1 id="securing-a-service-network">Securing a service network</h1>
<h2 id="securing-a-service-network">Securing a service network</h2>
<p>Skupper provides default, built-in security that scales across clusters and clouds.
This section describes additional security you can configure.</p>
<p>See <a href="../policy/index.html">Securing a service network using policies</a> for information about creating granular policies for each cluster.</p>
<h2 id="restricting-access-to-services-using-a-kubernetes-network-policy">Restricting access to services using a Kubernetes network policy</h2>
<h3 id="restricting-access-to-services-using-a-kubernetes-network-policy">Restricting access to services using a Kubernetes network policy</h3>
<p>By default, if you expose a service on the service network, that service is also accessible from other namespaces in the cluster.
You can avoid this situation when creating a site using the <code>--create-network-policy</code> option.</p>
<ol>
@@ -96,7 +96,7 @@ <h2 id="restricting-access-to-services-using-a-kubernetes-network-policy">Restri
</li>
</ol>
<p>You can now expose services on the service network and those services are not accessible from other namespaces in the cluster.</p>
<h2 id="applying-tls-to-tcp-or-http2-traffic-on-the-service-network">Applying TLS to TCP or HTTP2 traffic on the service network</h2>
<h3 id="applying-tls-to-tcp-or-http2-traffic-on-the-service-network">Applying TLS to TCP or HTTP2 traffic on the service network</h3>
<p>By default, the traffic between sites is encrypted, however the traffic between the service pod and the router pod is not encrypted.
For services exposed as TCP or HTTP2, the traffic between the pod and the router pod can be encrypted using TLS.</p>
<ul>
10 changes: 5 additions & 5 deletions docs/docs/cli/podman.html
Original file line number Diff line number Diff line change
@@ -246,7 +246,7 @@ <h2 id="specifying-link-cost">Specifying link cost</h2>
For example, in a two site network linked with a high cost with servers and clients on both sites, you can see that a client is served by the local servers while a local server is available.</p>
</li>
</ol>
<h3 id="exposing-services-on-the-service-network-from-a-linux-host">Exposing services on the service network from a Linux host</h3>
<h2 id="exposing-services-on-the-service-network-from-a-linux-host">Exposing services on the service network from a Linux host</h2>
<p>After creating a service network, exposed services can communicate across that network.</p>
<p>The general flow for working with services is the same for Kubernetes and Podman sites.</p>
<p>The <code>skupper</code> CLI has two options for exposing services that already exist on a host:</p>
@@ -256,7 +256,7 @@ <h3 id="exposing-services-on-the-service-network-from-a-linux-host">Exposing ser
<li><code>service create</code> and <code>service bind</code> is a more flexible method of exposing services, for example, if you have multiple services for a host.
See <a href="#exposing-complex-services-on-the-service-network">Exposing complex services on the service network</a> for instructions.</li>
</ul>
<h4 id="exposing-simple-services-on-the-service-network">Exposing simple services on the service network</h4>
<h3 id="exposing-simple-services-on-the-service-network">Exposing simple services on the service network</h3>
<p>This section describes how services can be enabled for a service network for simple use cases.</p>
<ul>
<li>A Skupper Podman site</li>
@@ -292,7 +292,7 @@ <h4 id="exposing-simple-services-on-the-service-network">Exposing simple service
</code></pre>
</li>
</ol>
<h4 id="exposing-complex-services-on-the-service-network">Exposing complex services on the service network</h4>
<h3 id="exposing-complex-services-on-the-service-network">Exposing complex services on the service network</h3>
<p>This section describes how services can be enabled for a service network for more complex use cases.</p>
<ul>
<li>A Skupper Podman site</li>
@@ -329,7 +329,7 @@ <h4 id="exposing-complex-services-on-the-service-network">Exposing complex servi
</code></pre>
</li>
</ol>
<h4 id="consuming-simple-services-from-the-service-network">Consuming simple services from the service network</h4>
<h3 id="consuming-simple-services-from-the-service-network">Consuming simple services from the service network</h3>
<p>Services exposed on Podman sites are not automatically available to other sites.
This is the equivalent to Kubernetes sites created using <code>skupper init --enable-service-sync false</code>.</p>
<ul>
@@ -344,7 +344,7 @@ <h4 id="consuming-simple-services-from-the-service-network">Consuming simple ser
</code></pre>
</li>
</ol>
<h3 id="deleting-a-podman-site">Deleting a Podman site</h3>
<h2 id="deleting-a-podman-site">Deleting a Podman site</h2>
<p>When you no longer want the Linux host to be part of the service network, you can delete the site.</p>
<dl><dt><strong>📌 NOTE</strong></dt><dd>

Loading

0 comments on commit 2df6547

Please sign in to comment.