Skip to content

Commit 3d555e6

Browse files
author
openshift-service-mesh-bot
committed
Automated merge
* upstream/main: Enhance Documentation: convert markdown file to AsciiDocs (istio-ecosystem#1118) fix(e2e): Add cleanup trap to prevent false positives in CI test runs (istio-ecosystem#1227)
2 parents 51fafe8 + e823206 commit 3d555e6

36 files changed

+4820
-4434
lines changed

Makefile.core.mk

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -229,12 +229,11 @@ test.e2e.kind: istioctl ## Deploy a KinD cluster and run the end-to-end tests ag
229229
test.e2e.describe: ## Runs ginkgo outline -format indent over the e2e test to show in BDD style the steps and test structure
230230
GINKGO_FLAGS="$(GINKGO_FLAGS)" ${SOURCE_DIR}/tests/e2e/common-operator-integ-suite.sh --describe
231231

232-
.PHONE: test.docs
233-
test.docs: runme istioctl ## Run the documentation examples tests.
234-
## test.docs use runme to test the documentation examples.
232+
.PHONY: test.docs
233+
test.docs: istioctl ## Run the documentation examples tests.
235234
## Check the specific documentation to understand the use of the tool
236-
@echo "Running runme test on the documentation examples."
237-
@PATH=$(LOCALBIN):$$PATH tests/documentation_tests/scripts/run-docs-examples.sh
235+
@echo "Running test on the documentation examples."
236+
@PATH=$(LOCALBIN):$$PATH tests/documentation_tests/scripts/run-asciidocs-test.sh
238237
@echo "Documentation examples tested successfully"
239238

240239
##@ Build

docs/README.adoc

Lines changed: 318 additions & 0 deletions
Large diffs are not rendered by default.

docs/README.md

Lines changed: 0 additions & 272 deletions
This file was deleted.
Lines changed: 64 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,25 @@
1-
[Return to Project Root](../README.md)
1+
// Variables embedded for GitHub compatibility
2+
:istio_latest_version: 1.26.3
3+
:istio_latest_version_revision_format: 1-26-3
4+
:istio_latest_tag: v1.26-latest
5+
:istio_latest_minus_one_version: 1.26.2
6+
:istio_latest_minus_one_version_revision_format: 1-26-2
27

3-
# Table of Contents
8+
link:../README.adoc[Return to Project Root]
49

5-
- [Addons](#addons)
6-
- [Deploy Prometheus and Jaeger addons](#deploy-prometheus-and-jaeger-addons)
7-
- [Deploy Kiali addon](#deploy-kiali-addon)
8-
- [Find the active revision of your Istio instance. In our case it is `test`.](#find-the-active-revision-of-your-istio-instance)
9-
- [Deploy Gateway and Bookinfo](#deploy-gateway-and-bookinfo)
10-
- [Generate traffic and visualize your mesh](#generate-traffic-and-visualize-your-mesh)
10+
== Table of Contents
1111

12-
## Addons
12+
- <<addons>>
13+
- <<deploy-prometheus-and-jaeger-addons>>
14+
- <<deploy-kiali-addon>>
15+
- <<find-the-active-revision-of-your-istio-instance>>
16+
- <<deploy-gateway-and-bookinfo>>
17+
- <<generate-traffic-and-visualize-your-mesh>>
1318

14-
Addons are managed separately from the Sail Operator. You can follow the [istio documentation](https://istio.io/latest/docs/ops/integrations/) for how to install addons. Below is an example of how to install some addons for Istio.
19+
[[addons]]
20+
== Addons
21+
22+
Addons are managed separately from the Sail Operator. You can follow the link:https://istio.io/latest/docs/ops/integrations/[istio documentation] for how to install addons. Below is an example of how to install some addons for Istio.
1523

1624
The sample will deploy:
1725

@@ -25,26 +33,31 @@ The sample will deploy:
2533
- Sail operator is installed.
2634
- Control Plane is installed via the Sail Operator.
2735

28-
### Deploy Prometheus and Jaeger addons
36+
[[deploy-prometheus-and-jaeger-addons]]
37+
=== Deploy Prometheus and Jaeger addons
2938

30-
```bash
39+
[source,bash,subs="attributes+"]
40+
----
3141
kubectl apply -f https://raw.githubusercontent.com/istio/istio/master/samples/addons/prometheus.yaml
3242
kubectl apply -f https://raw.githubusercontent.com/istio/istio/master/samples/addons/jaeger.yaml
33-
```
43+
----
3444

35-
### Deploy Kiali addon
45+
[[deploy-kiali-addon]]
46+
=== Deploy Kiali addon
3647

3748
Install the kiali operator.
3849

3950
You can install the kiali operator through OLM if running on Openshift, otherwise you can use helm:
4051

41-
```bash
52+
[source,bash,subs="attributes+"]
53+
----
4254
helm install --namespace kiali-operator --create-namespace kiali-operator kiali/kiali-operator
43-
```
55+
----
4456

4557
Create a Kiali resource. We're enabling tracing and disabling grafana here since tracing is disabled by default and grafana is not part of this example.
4658

47-
```bash
59+
[source,bash,subs="attributes+"]
60+
----
4861
kubectl apply -f - <<EOF
4962
apiVersion: kiali.io/v1alpha1
5063
kind: Kiali
@@ -58,70 +71,81 @@ spec:
5871
grafana:
5972
enabled: false
6073
EOF
61-
```
74+
----
6275

63-
### Find the active revision of your Istio instance.
76+
[[find-the-active-revision-of-your-istio-instance]]
77+
=== Find the active revision of your Istio instance.
6478
In our case it is `test` the istio resource name.
6579

66-
```console
80+
[source,console,subs="attributes+"]
81+
----
6782
kubectl get istios
6883
NAME REVISIONS READY IN USE ACTIVE REVISION STATUS VERSION AGE
69-
test 1 1 0 test Healthy v1.24.3 8m10s
70-
```
84+
test 1 1 0 test Healthy v{istio_latest_version} 8m10s
85+
----
7186

72-
### Deploy Gateway and Bookinfo
87+
[[deploy-gateway-and-bookinfo]]
88+
=== Deploy Gateway and Bookinfo
7389

7490
Create the bookinfo namespace (if it doesn't already exist) and enable injection.
7591

76-
```bash
92+
[source,bash,subs="attributes+"]
93+
----
7794
kubectl create namespace bookinfo
7895
kubectl label namespace bookinfo istio.io/rev=test
79-
```
96+
----
8097

8198
Install Bookinfo demo app.
8299

83-
```bash
100+
[source,bash,subs="attributes+"]
101+
----
84102
kubectl apply -n bookinfo -f https://raw.githubusercontent.com/istio/istio/master/samples/bookinfo/platform/kube/bookinfo.yaml
85103
kubectl apply -n bookinfo -f https://raw.githubusercontent.com/istio/istio/master/samples/bookinfo/platform/kube/bookinfo-versions.yaml
86-
```
104+
----
87105

88106
Install gateway API CRDs if they are not already installed.
89107

90-
```bash
108+
[source,bash,subs="attributes+"]
109+
----
91110
kubectl get crd gateways.gateway.networking.k8s.io &> /dev/null || \
92111
{ kubectl kustomize "github.com/kubernetes-sigs/gateway-api/config/crd?ref=v1.1.0" | kubectl apply -f -; }
93-
```
112+
----
94113

95114
Create bookinfo gateway.
96115

97-
```bash
116+
[source,bash,subs="attributes+"]
117+
----
98118
kubectl apply -n bookinfo -f https://raw.githubusercontent.com/istio/istio/master/samples/bookinfo/gateway-api/bookinfo-gateway.yaml
99119
kubectl wait -n bookinfo --for=condition=programmed gtw bookinfo-gateway
100-
```
120+
----
101121

102-
### Generate traffic and visualize your mesh
122+
[[generate-traffic-and-visualize-your-mesh]]
123+
=== Generate traffic and visualize your mesh
103124

104125
Send traffic to the productpage service. Note that this command will run until canceled.
105126

106-
```bash
127+
[source,bash,subs="attributes+"]
128+
----
107129
export INGRESS_HOST=$(kubectl get gtw bookinfo-gateway -n bookinfo -o jsonpath='{.status.addresses[0].value}')
108130
export INGRESS_PORT=$(kubectl get gtw bookinfo-gateway -n bookinfo -o jsonpath='{.spec.listeners[?(@.name=="http")].port}')
109131
export GATEWAY_URL=$INGRESS_HOST:$INGRESS_PORT
110132
watch curl http://${GATEWAY_URL}/productpage &> /dev/null
111-
```
133+
----
112134

113135
In a separate terminal, open Kiali to visualize your mesh.
114136

115137
If using Openshift, open the Kiali route:
116138

117-
```bash
139+
[source,bash,subs="attributes+"]
140+
----
118141
echo https://$(kubectl get routes -n istio-system kiali -o jsonpath='{.spec.host}')
119-
```
142+
----
120143

121144
Otherwise, port forward to the kiali pod directly:
122145

123-
```bash
146+
[source,bash,subs="attributes+"]
147+
----
124148
kubectl port-forward -n istio-system svc/kiali 20001:20001
125-
```
126-
<!-- markdown-link-check-disable-next-line -->
127-
You can view Kiali dashboard at: http://localhost:20001
149+
----
150+
151+
You can view Kiali dashboard at: http://localhost:20001

0 commit comments

Comments
 (0)