WIP

skupperproject · Dec 13, 2024 · 3433200 · 3433200
1 parent f850972
commit 3433200
Show file tree

Hide file tree

Showing 8 changed files with 32 additions and 22 deletions.
diff --git a/config/concepts/connector.yaml b/config/concepts/connector.yaml
@@ -11,7 +11,7 @@ description: |
     <figcaption>The connector model</figcaption>
   </figure>
 
-  A site has zero or more connectors.  Each connector has an
+  A site has zero or many connectors.  Each connector has an
   associated workload and routing key.  The workload can be specified
   as a Kubernetes pod selector or as the host and port of a local
   network service.
@@ -23,7 +23,7 @@ description: |
 
   The routing key is a string identifier that binds the connector to
   listeners in remote sites.  Skupper routers forward client
-  connections to listeners across the network to connectors with
+  connections across the network from listeners to connectors with
   matching routing keys.  The connectors then forward the client
   connections to the workload servers.
 

diff --git a/config/concepts/link.yaml b/config/concepts/link.yaml
@@ -11,7 +11,7 @@ description: |
     <figcaption>The link model</figcaption>
   </figure>
 
-  A site has zero or more links.  Each link has a host, port, and TLS
+  A site has zero or many links.  Each link has a host, port, and TLS
   credentials for making a mutual TLS connection to a remote site.
 
   Application connections and requests flow across links in both

diff --git a/config/concepts/listener.yaml b/config/concepts/listener.yaml
@@ -11,8 +11,10 @@ description: |
     <figcaption>The listener model</figcaption>
   </figure>
 
-  A site has zero or more listeners.  Each listener has an associated
-  connection endpoint (host:port) and routing key.
+  A site has zero or many listeners.  Each listener has an associated
+  connection endpoint and routing key.  The connection endpoint
+  exposes a host and port for accepting connections from local
+  clients.
 
   <figure>
     <img src="images/routing-key-model.svg"/>
@@ -21,7 +23,7 @@ description: |
 
   The routing key is a string identifier that binds the listener to
   connectors in remote sites.  Skupper routers forward client
-  connections to listeners across the network to connectors with
+  connections across the network from listeners to connectors with
   matching routing keys.  The connectors then forward the client
   connections to the workload servers.
 

diff --git a/config/concepts/site.yaml b/config/concepts/site.yaml
@@ -5,6 +5,14 @@ description: |
   are running.  Sites are joined by **[links](link.html)** to form
   application **[networks](network.html)**.
 
+  <figure>
+    <img src="images/site-model.svg"/>
+    <figcaption>The site model</figcaption>
+  </figure>
+
+  A site is associated with one platform and one network.  Each site
+  has zero or many workloads and zero or many links.
+
   Sites operate on multiple **[platforms](platform.html)**.  One site
   corresponds to one namespace in a platform instance.  Sites can be
   added to a network and removed from a network dynamically.
@@ -13,11 +21,6 @@ description: |
   communicating with the local workloads and forwarding traffic to
   routers in remote sites.
 
-  <figure>
-    <img src="images/site-model.svg"/>
-    <figcaption>The site model</figcaption>
-  </figure>
-
   <figure>
     <img src="images/site-1.svg"/>
     <figcaption>A site with three workloads</figcaption>

diff --git a/input/concepts/connector.md b/input/concepts/connector.md
@@ -25,7 +25,7 @@ keys](routing-key.html)**.
   <figcaption>The connector model</figcaption>
 </figure>
 
-A site has zero or more connectors.  Each connector has an
+A site has zero or many connectors.  Each connector has an
 associated workload and routing key.  The workload can be specified
 as a Kubernetes pod selector or as the host and port of a local
 network service.
@@ -37,7 +37,7 @@ network service.
 
 The routing key is a string identifier that binds the connector to
 listeners in remote sites.  Skupper routers forward client
-connections to listeners across the network to connectors with
+connections across the network from listeners to connectors with
 matching routing keys.  The connectors then forward the client
 connections to the workload servers.
 

diff --git a/input/concepts/link.md b/input/concepts/link.md
@@ -27,7 +27,7 @@ connections and requests.  A set of linked sites constitutes a
   <figcaption>The link model</figcaption>
 </figure>
 
-A site has zero or more links.  Each link has a host, port, and TLS
+A site has zero or many links.  Each link has a host, port, and TLS
 credentials for making a mutual TLS connection to a remote site.
 
 Application connections and requests flow across links in both

diff --git a/input/concepts/listener.md b/input/concepts/listener.md
@@ -25,8 +25,10 @@ keys](routing-key.html)**.
   <figcaption>The listener model</figcaption>
 </figure>
 
-A site has zero or more listeners.  Each listener has an associated
-connection endpoint (host:port) and routing key.
+A site has zero or many listeners.  Each listener has an associated
+connection endpoint and routing key.  The connection endpoint
+exposes a host and port for accepting connections from local
+clients.
 
 <figure>
   <img src="images/routing-key-model.svg"/>
@@ -35,7 +37,7 @@ connection endpoint (host:port) and routing key.
 
 The routing key is a string identifier that binds the listener to
 connectors in remote sites.  Skupper routers forward client
-connections to listeners across the network to connectors with
+connections across the network from listeners to connectors with
 matching routing keys.  The connectors then forward the client
 connections to the workload servers.
 

diff --git a/input/concepts/site.md b/input/concepts/site.md
@@ -21,6 +21,14 @@ A **site** is a place on the internet where application workloads
 are running.  Sites are joined by **[links](link.html)** to form
 application **[networks](network.html)**.
 
+<figure>
+  <img src="images/site-model.svg"/>
+  <figcaption>The site model</figcaption>
+</figure>
+
+A site is associated with one platform and one network.  Each site
+has zero or many workloads and zero or many links.
+
 Sites operate on multiple **[platforms](platform.html)**.  One site
 corresponds to one namespace in a platform instance.  Sites can be
 added to a network and removed from a network dynamically.
@@ -29,11 +37,6 @@ Each site has a Skupper router which is responsible for
 communicating with the local workloads and forwarding traffic to
 routers in remote sites.
 
-<figure>
-  <img src="images/site-model.svg"/>
-  <figcaption>The site model</figcaption>
-</figure>
-
 <figure>
   <img src="images/site-1.svg"/>
   <figcaption>A site with three workloads</figcaption>