From 5961fb7a6d032c22c09889cfde774ac447c48bae Mon Sep 17 00:00:00 2001 From: Paul Wright <5154224+pwright@users.noreply.github.com> Date: Thu, 28 Mar 2024 17:56:24 +0000 Subject: [PATCH] Fix links overview (#80) * includes changes from https://github.com/skupperproject/skupper-docs/pull/229 * fix formats * update copyright --- config/config.py | 3 + convert-all.sh | 5 + docs/community/index.html | 2 +- docs/docs/cli/index.html | 24 +- docs/docs/cli/native-security-options.html | 12 +- docs/docs/cli/podman.html | 264 ++++++++++++----- docs/docs/cli/tokens.html | 2 +- docs/docs/console/index.html | 2 +- docs/docs/index.html | 2 +- docs/docs/kubernetes-reference/index.html | 2 +- .../skupper_completion.html | 2 +- .../kubernetes-reference/skupper_debug.html | 2 +- .../skupper_debug_dump.html | 2 +- .../skupper_debug_events.html | 2 +- .../skupper_debug_policies.html | 2 +- .../skupper_debug_service.html | 2 +- .../kubernetes-reference/skupper_delete.html | 2 +- .../kubernetes-reference/skupper_expose.html | 2 +- .../kubernetes-reference/skupper_gateway.html | 2 +- .../skupper_gateway_bind.html | 2 +- .../skupper_gateway_delete.html | 2 +- .../skupper_gateway_export-config.html | 2 +- .../skupper_gateway_expose.html | 2 +- .../skupper_gateway_forward.html | 2 +- .../skupper_gateway_generate-bundle.html | 2 +- .../skupper_gateway_init.html | 2 +- .../skupper_gateway_status.html | 2 +- .../skupper_gateway_unbind.html | 2 +- .../skupper_gateway_unexpose.html | 2 +- .../skupper_gateway_unforward.html | 2 +- .../kubernetes-reference/skupper_init.html | 2 +- .../kubernetes-reference/skupper_link.html | 2 +- .../skupper_link_create.html | 2 +- .../skupper_link_delete.html | 2 +- .../skupper_link_status.html | 2 +- .../kubernetes-reference/skupper_network.html | 2 +- .../skupper_network_status.html | 2 +- .../skupper_revoke-access.html | 2 +- .../kubernetes-reference/skupper_service.html | 2 +- .../skupper_service_bind.html | 2 +- .../skupper_service_create.html | 2 +- .../skupper_service_delete.html | 2 +- .../skupper_service_label.html | 2 +- .../skupper_service_status.html | 2 +- .../skupper_service_unbind.html | 2 +- .../kubernetes-reference/skupper_status.html | 2 +- .../kubernetes-reference/skupper_token.html | 2 +- .../skupper_token_create.html | 2 +- .../skupper_unexpose.html | 2 +- .../kubernetes-reference/skupper_update.html | 2 +- .../kubernetes-reference/skupper_version.html | 2 +- .../skupper_version_manifest.html | 2 +- docs/docs/kubernetes/deployment-concerns.html | 5 +- docs/docs/operator/index.html | 2 +- docs/docs/overview/connectivity.html | 2 +- docs/docs/overview/glossary.html | 2 +- docs/docs/overview/index.html | 8 +- docs/docs/overview/resources.html | 2 +- docs/docs/overview/routing.html | 2 +- docs/docs/overview/security.html | 2 +- docs/docs/podman-reference/index.html | 2 +- .../docs/podman-reference/skupper_delete.html | 2 +- .../docs/podman-reference/skupper_expose.html | 2 +- docs/docs/podman-reference/skupper_init.html | 2 +- docs/docs/podman-reference/skupper_link.html | 2 +- .../podman-reference/skupper_link_create.html | 2 +- .../podman-reference/skupper_link_delete.html | 2 +- .../podman-reference/skupper_link_status.html | 2 +- .../skupper_revoke-access.html | 2 +- .../podman-reference/skupper_service.html | 2 +- .../skupper_service_bind.html | 2 +- .../skupper_service_create.html | 2 +- .../skupper_service_delete.html | 2 +- .../skupper_service_status.html | 2 +- .../skupper_service_unbind.html | 2 +- .../docs/podman-reference/skupper_status.html | 2 +- docs/docs/podman-reference/skupper_token.html | 2 +- .../skupper_token_create.html | 2 +- .../podman-reference/skupper_unexpose.html | 2 +- .../docs/podman-reference/skupper_update.html | 2 +- .../podman-reference/skupper_version.html | 2 +- .../skupper_version_manifest.html | 2 +- docs/docs/policy/index.html | 2 +- docs/docs/troubleshooting/index.html | 14 +- docs/docs/yaml/index.html | 2 +- docs/examples/index.html | 2 +- docs/index.html | 2 +- docs/install/index.html | 2 +- docs/install/troubleshooting.html | 2 +- docs/releases/index.html | 2 +- docs/site.html | 2 +- docs/start/aks.html | 2 +- docs/start/eks.html | 2 +- docs/start/gke.html | 2 +- docs/start/ibmks.html | 2 +- docs/start/index.html | 2 +- docs/start/kubernetes.html | 2 +- docs/start/minikube.html | 2 +- docs/start/openshift.html | 2 +- includes/footer.html | 2 +- input/docs/cli/index.md | 22 +- input/docs/cli/native-security-options.md | 8 +- input/docs/cli/podman.md | 278 ++++++++++++++---- input/docs/kubernetes/deployment-concerns.md | 3 +- input/docs/overview/index.md | 6 +- input/docs/troubleshooting/index.md | 12 +- subrepos/skupper-docs/.gitrepo | 4 +- subrepos/skupper-docs/cli/gateway.adoc | 17 +- subrepos/skupper-docs/cli/index.adoc | 100 +------ subrepos/skupper-docs/cli/link-cost.adoc | 82 ++++++ .../cli/native-security-options.adoc | 6 +- subrepos/skupper-docs/cli/network-status.adoc | 2 +- subrepos/skupper-docs/cli/podman.adoc | 272 ++++++++++++----- subrepos/skupper-docs/cli/protocols.adoc | 2 +- subrepos/skupper-docs/console/index.adoc | 30 +- .../kubernetes/deployment-concerns.adoc | 3 +- subrepos/skupper-docs/kubernetes/index.adoc | 1 + .../kubernetes/service-certs.adoc | 1 + subrepos/skupper-docs/overview/index.adoc | 3 +- .../skupper-docs/partials/attributes.adoc | 2 + .../skupper-docs/troubleshooting/index.adoc | 12 +- 121 files changed, 920 insertions(+), 465 deletions(-) create mode 100644 subrepos/skupper-docs/cli/link-cost.adoc diff --git a/config/config.py b/config/config.py index 4610720c..09d6eae7 100644 --- a/config/config.py +++ b/config/config.py @@ -10,3 +10,6 @@ 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}}" diff --git a/convert-all.sh b/convert-all.sh index b80abff6..e7a9e80c 100755 --- a/convert-all.sh +++ b/convert-all.sh @@ -21,3 +21,8 @@ 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 + +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 diff --git a/docs/community/index.html b/docs/community/index.html index 53149905..335efe79 100644 --- a/docs/community/index.html +++ b/docs/community/index.html @@ -146,7 +146,7 @@
Skupper enables secure communication across Kubernetes clusters with no VPNs or special firewall rules
-Copyright © 2023 the Skupper authors
+Copyright © 2024 the Skupper authors
All code and documentation is licensed under diff --git a/docs/docs/cli/index.html b/docs/docs/cli/index.html index 2bd0a2b2..84f4b642 100644 --- a/docs/docs/cli/index.html +++ b/docs/docs/cli/index.html @@ -91,7 +91,8 @@
A service network consists of Skupper sites. -This section describes how to create a site using the default settings.
+This section describes how to create a site in a Kubernetes cluster using the default settings. +See Using Skupper Podman for information about using the Skupper CLI to create Podman sites.skupper
CLI is installed.After creating a service network, you can expose services from a local machine on the service network.
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.
+This documentation describes creating a gateway from a local host to a cluster site. +An alternative approach is to create a site on the local host and link to the cluster site. +See Using Skupper Podman for information about using the Skupper CLI to create Podman sites.
+This section shows how to expose a single service running locally on a service network.
5672
.Skupper includes a command to allow you report all the sites and the services available on a service network.
Skupper provides default, built-in security that scales across clusters and clouds. This section describes additional security you can configure.
See Securing a service network using policies for information about creating granular policies for each cluster.
-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 --create-network-policy
option.
You can now expose services on the service network and those services are not accessible from other namespaces in the cluster.
-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.
Test calling the service from a TLS enabled frontend.
Skupper supports the following protocols for your service network:
For a full list of options, see the Skupper Kubernetes CLI reference and Skupper Podman CLI reference documentation.
Skupper enables secure communication across Kubernetes clusters with no VPNs or special firewall rules
-Copyright © 2023 the Skupper authors
+Copyright © 2024 the Skupper authors
All code and documentation is licensed under diff --git a/docs/docs/cli/native-security-options.html b/docs/docs/cli/native-security-options.html index aab6fb53..2b72556c 100644 --- a/docs/docs/cli/native-security-options.html +++ b/docs/docs/cli/native-security-options.html @@ -1,7 +1,7 @@
-