Skip to content

Commit

Permalink
git subrepo pull --force subrepos/skupper-docs
Browse files Browse the repository at this point in the history
subrepo:
  subdir:   "subrepos/skupper-docs"
  merged:   "d92b1d4"
upstream:
  origin:   "git@github.com:skupperproject/skupper-docs.git"
  branch:   "main"
  commit:   "d92b1d4"
git-subrepo:
  version:  "0.4.6"
  origin:   "???"
  commit:   "???"
  • Loading branch information
pwright committed Mar 20, 2024
1 parent fdb81ab commit 0691995
Show file tree
Hide file tree
Showing 7 changed files with 20 additions and 21 deletions.
4 changes: 2 additions & 2 deletions subrepos/skupper-docs/.gitrepo
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
[subrepo]
remote = git@github.com:skupperproject/skupper-docs.git
branch = main
commit = db7b3e48836174cde12e79e1f48f15a0e73eaf58
parent = 9c9eddd0920dea92f43a4765c2d942adcd089520
commit = d92b1d4d2def79b1e4fd6d824f1ab070f5146b54
parent = fdb81abfa8dc43ca04070c1e3c70a806981dc155
method = merge
cmdver = 0.4.6
30 changes: 13 additions & 17 deletions subrepos/skupper-docs/console/index.adoc
Original file line number Diff line number Diff line change
@@ -1,20 +1,16 @@
include::../partials/attributes.adoc[]

[id="skupper-console"]
= Using the Skupper console



The Skupper console provides data and visualizations of the traffic flow between Skupper sites.
= Using the {skupper-console-name}

The {skupper-console-name} provides data and visualizations of the traffic flow between Skupper sites.

// Type: procedure
[id="enabling-console"]
== Enabling the Skupper console
== Enabling the {skupper-console-name}

By default, when you create a Skupper site, a Skupper console is not available.
By default, when you create a Skupper site, a {skupper-console-name} is not available.

When enabled, the Skupper console URL is displayed whenever you check site status using `skupper status`.
When enabled, the {skupper-console-name} URL is displayed whenever you check site status using `skupper status`.

.Prerequisites

Expand Down Expand Up @@ -47,14 +43,14 @@ $ skupper init --enable-console --enable-flow-collector

// Type: procedure
[id="accessing-console"]
== Accessing the Skupper console
== Accessing the {skupper-console-name}

By default, the Skupper console is protected by credentials available in the `skupper-console-users` secret.
By default, the {skupper-console-name} is protected by credentials available in the `skupper-console-users` secret.


.Procedure

. Determine the Skupper console URL using the `skupper` CLI, for example:
. Determine the {skupper-console-name} URL using the `skupper` CLI, for example:
+
[source, bash]
----
Expand All @@ -64,7 +60,7 @@ Skupper is enabled for namespace "west" in interior mode. It is not connected to
The site console url is: https://skupper-west.apps-crc.testing
----

. Browse to the Skupper console URL.
. Browse to the {skupper-console-name} URL.
The credential prompt depends on how the site was created using `skupper init`:
+
* Using the `--console-auth unsecured` option, you are not prompted for credentials.
Expand All @@ -82,16 +78,16 @@ JNZWzMHtyg

// Type: procedure
[id="exploring-console"]
== Exploring the Skupper console
== Exploring the {skupper-console-name}

After exposing a service on the {service-network}, you create an _address_, that is, a service name and port number associated with a site.
There might be many replicas associated with an address.
These replicas are shown in the Skupper console as _processes_.
These replicas are shown in the {skupper-console-name} as _processes_.
Not all participants on a {service-network} are services.
For example, a _frontend_ deployment might call an exposed service named _backend_, but that frontend is not part of the {service-network}.
In the console, both are shown so that you can view the traffic and these are called _components_.

The Skupper console provides an overview of the following:
The {skupper-console-name} provides an overview of the following:

* Topology
* Addresses
Expand All @@ -100,7 +96,7 @@ The Skupper console provides an overview of the following:
* Processes
The Skupper console also provides useful networking information about the {service-network}, for example, traffic levels.
The {skupper-console-name} also provides useful networking information about the {service-network}, for example, traffic levels.

image::../images/skupper-adservice.png[]

Expand Down
1 change: 1 addition & 0 deletions subrepos/skupper-docs/kubernetes/deployment-concerns.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
include::../partials/attributes.adoc[]
= Deployment options on Kubernetes

When you create a site on Kubernetes, there are many options you can use. For example, you can set the number of pods and the resources allocated to each pod.
Expand Down
1 change: 1 addition & 0 deletions subrepos/skupper-docs/kubernetes/index.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
include::../partials/attributes.adoc[]
// Type: procedure
[id="custom-certs"]
= Creating sites using a custom certificate authority
Expand Down
1 change: 1 addition & 0 deletions subrepos/skupper-docs/kubernetes/service-certs.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
include::../partials/attributes.adoc[]
// Type: assembly
[id="encrypting-traffic-pod-router"]
= Encrypting traffic from a pod to the Skupper router
Expand Down
3 changes: 1 addition & 2 deletions subrepos/skupper-docs/overview/index.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@

include::../partials/attributes.adoc[]
//Category: skupper-overview
// Type: assembly

[id="skupper-overview"]
= Skupper overview

Expand Down
1 change: 1 addition & 0 deletions subrepos/skupper-docs/partials/attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@


:skupper-operator-name: Skupper operator
:skupper-console-name: Skupper console

0 comments on commit 0691995

Please sign in to comment.