Skip to content

Commit e537f0c

Browse files
authored
Merge pull request validatedpatterns#554 from kquinn1204/TELCODOCS-2228-updates
TELCODOCS-2228 Updates based on audit travelops
2 parents 7ac1e83 + 892d749 commit e537f0c

File tree

5 files changed

+114
-54
lines changed

5 files changed

+114
-54
lines changed

content/patterns/travelops/_index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,5 @@ include::modules/trvlops-architecture.adoc[leveloffset=+1]
3030
[id="next-steps_trvlops-index"]
3131
== Next steps
3232

33-
* link:getting-started[Deploy the Pattern] using Helm.
33+
* link:getting-started[Deploy the Pattern].
3434

content/patterns/travelops/demo-script.adoc

Lines changed: 0 additions & 12 deletions
This file was deleted.

content/patterns/travelops/getting-started.adoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,4 @@ include::modules/trvlops-deploying.adoc[leveloffset=1]
1414
[id="next-steps_getting-started"]
1515
== Next Steps
1616

17-
To run through the demo, refer to link:..//demo-script[Monitor the Mesh]
18-
19-
Like what you see, but can't quite put your finger on how you could use a Service Mesh? Check out link:../ideas-for-customization[Ways to customize the Mesh] for some ideas!
17+
See link:../ideas-for-customization[Ways to customize the Mesh] for some ideas on how to customize the pattern.

modules/trvlops-about.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Based on the requirements of a specific implementation, certain details might di
1717

1818
Background::
1919

20-
The {trvlops-pattern} deployed using OpenShift GitOps and is comprised of Red Hat Service Mesh (RHSM), Kiali for the Service Mesh console, Jaeger for distributed tracing, and elasticsearch for logging and analytics. The application deployed is from the Kiali traveldemo tutorial. This pattern isn't as much about the demo as it is about the capabilities that are enabled with a few simple configurations. Service Mesh's are being incorporated across multiple platforms to provide secure communications between services.
20+
The {trvlops-pattern} deployed using OpenShift GitOps and is comprised of Red Hat Service Mesh (RHSM), Kiali for the Service Mesh console, Jaeger for distributed tracing, and elasticsearch for logging and analytics. The application deployed is from the link:https://kiali.io/docs/tutorials/travels/[Kiali traveldemo]. This pattern focuses on demonstrating capabilities enabled through simple configurations, rather than the demo itself. Service Mesh technology is adopted across multiple platforms to ensure secure communication between services.
2121

2222
//In this pattern we implement Mutual TLS (mTLS) which is completed per namespace. To enable a namespace in the mesh you must add the namespace to the list under `serviceMeshMemberNamespaces` in `values-travelops.yaml`. This will create a Service Mesh Member (SMM) resource, which tells the Service Mesh that resources in the namespace are authorized in the mesh.
2323

modules/trvlops-deploying.adoc

Lines changed: 111 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,25 @@
88

99
* An OpenShift cluster
1010
** To create an OpenShift cluster, go to the https://console.redhat.com/[Red Hat Hybrid Cloud console].
11-
** Select *Services \-> Containers \-> Create cluster*.
12-
** The cluster must have a dynamic `StorageClass` to provision `PersistentVolumes`. See link:../../multicloud-gitops/mcg-cluster-sizing[sizing your cluster].
11+
** Select *OpenShift \-> Red Hat OpenShift Container Platform \-> Create cluster*.
12+
** The cluster must have a dynamic `StorageClass` to provision `PersistentVolumes`. Verify that a dynamic `StorageClass` exists before creating one by running the following command:
13+
+
14+
[source,terminal]
15+
----
16+
$ oc get storageclass -o custom-columns=NAME:.metadata.name,PROVISIONER:.provisioner,DEFAULT:.metadata.annotations."storageclass\.kubernetes\.io/is-default-class"
17+
----
18+
+
19+
.Example output
20+
+
21+
[source,terminal]
22+
----
23+
NAME PROVISIONER DEFAULT
24+
gp2-csi ebs.csi.aws.com <none>
25+
gp3-csi ebs.csi.aws.com true
26+
----
27+
+
28+
For more information about creating a dynamic `StorageClass`, see the https://docs.openshift.com/container-platform/latest/storage/dynamic-provisioning.html[Dynamic provisioning] documentation.
29+
1330
* Optional: A second OpenShift cluster for multicloud demonstration.
1431
//Replaced git and podman prereqs with the tooling dependencies page
1532
* https://validatedpatterns.io/learn/quickstart/[Install the tooling dependencies].
@@ -22,22 +39,57 @@ public or private cloud by using https://console.redhat.com/openshift/create[Red
2239
.Procedure
2340

2441
. Fork the https://github.com/validatedpatterns-sandbox/travelops[travelops] repository on GitHub.
42+
2543
. Clone the forked copy of this repository.
2644
+
2745
[source,terminal]
2846
----
29-
git clone [email protected]:your-username/travelops.git
47+
$ git clone [email protected]:your-username/travelops.git
48+
----
49+
50+
. Go to your repository: Ensure you are in the root directory of your Git repository by using:
51+
+
52+
[source,terminal]
53+
----
54+
$ cd /path/to/your/repository
55+
----
56+
57+
. Run the following command to set the upstream repository:
58+
+
59+
[source,terminal]
60+
----
61+
$ git remote add -f upstream [email protected]:validatedpatterns-sandbox/travelops.git
3062
----
3163

64+
. Verify the setup of your remote repositories by running the following command:
65+
+
66+
[source,terminal]
67+
----
68+
$ git remote -v
69+
----
70+
+
71+
.Example output
72+
+
73+
[source,terminal]
74+
----
75+
origin [email protected]:<your-username>/travelops.git (fetch)
76+
origin [email protected]:<your-username>/travelops.git (push)
77+
upstream https://github.com/validatedpatterns-sandbox/travelops.git (fetch)
78+
upstream https://github.com/validatedpatterns-sandbox/travelops.git (push)
79+
----
80+
3281
. Create a local copy of the secret values file that can safely include credentials. Run the following commands:
3382
+
3483
[source,terminal]
3584
----
36-
cp values-secret.yaml.template ~/values-secret-travelops.yaml
85+
$ cp values-secret.yaml.template ~/values-secret-travelops.yaml
3786
----
3887
+
3988
[source,yaml]
4089
----
90+
# A more formal description of this format can be found here:
91+
# https://github.com/validatedpatterns/rhvp.cluster_utils/tree/main/roles/vault_utils#values-secret-file-format
92+
4193
version: "2.0"
4294
# Ideally you NEVER COMMIT THESE VALUES TO GIT (although if all passwords are
4395
# automatically generated inside the vault this should not really matter)
@@ -50,83 +102,92 @@ secrets:
50102
- name: rootpasswd
51103
onMissingValue: generate
52104
vaultPolicy: validatedPatternDefaultPolicy
53-
54-
# Uncomment the following if you want to enable HTPasswd oAuth
55-
# - name: htpasswd
56-
# vaultPrefixes:
57-
# - global
58-
# fields:
59-
# - name: htpasswd
60-
# path: '/path/to/users.htpasswd'
61105
----
62106
+
63107
[WARNING]
64108
====
65-
Do not commit this file. You do not want to push personal credentials to GitHub. If you do not want to customize the secrets, these steps are not needed. The framework generates a random password for the config-demo application.
109+
Do not commit this file. Committing it may expose personal credentials to GitHub. If you do not want to customize the secrets, skip these steps. The framework generates a random password for the `config-demo` application.
66110
====
67111

68-
. Customize the deployment for your cluster. Run the following command:
112+
. Customize the deployment for your cluster by following these steps:
113+
114+
.. Create a new branch named my-branch and switch to it by running the following command:
69115
+
70116
[source,terminal]
71117
----
72-
git switch -c my-branch
118+
$ git switch -c my-branch
73119
----
120+
121+
.. Edit the `values-hub.yaml` file to customize the deployment for your cluster by running the following command:
74122
+
75123
[source,terminal]
76124
----
77-
vi values-hub.yaml
125+
$ vi values-hub.yaml
78126
----
127+
128+
.. Stage the changes to the `values-hub.yaml` file by running the following commands:
79129
+
80130
[source,terminal]
81131
----
82-
git add values-hub.yaml
132+
$ git add values-hub.yaml
83133
----
134+
135+
.. Commit the changes to the `values-hub.yaml` file by running the following commands:
84136
+
85137
[source,terminal]
86138
----
87-
git commit values-hub.yaml
139+
$ git commit -m "update deployment for my-branch"
88140
----
141+
142+
.. Push the changes to the `values-hub.yaml` file by running the following command:
89143
+
90144
[source,terminal]
91145
----
92-
git push origin my-branch
146+
$ git push origin my-branch
93147
----
94148

95149
. Deploy the pattern by running `./pattern.sh make install` or by using the link:/infrastructure/using-validated-pattern-operator/[Validated Patterns Operator].
96150

97151
[id="deploying-cluster-using-patternsh-file"]
98-
== Deploying the cluster by using the pattern.sh file
152+
== Deploying the pattern by using the pattern.sh script
99153

100-
To deploy the cluster by using the `pattern.sh` file, complete the following steps:
154+
To deploy the pattern by using the `pattern.sh` script, complete the following steps:
101155

102-
. Login to your cluster by running the following command:
156+
. Log in to your cluster by running the following:
157+
158+
.. Obtain an API token by visiting https://oauth-openshift.apps.<your-cluster>.<domain>/oauth/token/request
159+
160+
.. Log in with this retrieved token by running the following command:
103161
+
104162
[source,terminal]
105163
----
106-
oc login
164+
$ oc login --token=<retrieved-token> --server=https://api.<your-cluster>.<domain>:6443
107165
----
108-
+
109-
Optional: Set the `KUBECONFIG` variable for the `kubeconfig` file path:
166+
167+
. Alternatively log in by running the following command:
110168
+
111169
[source,terminal]
112170
----
113-
export KUBECONFIG=~/<path_to_kubeconfig>
171+
$ export KUBECONFIG=~/<path_to_kubeconfig>
114172
----
115173

116-
. Deploy the pattern to your cluster. Run the following command:
174+
. Deploy the pattern to your cluster by running the following command:
117175
+
118176
[source,terminal]
119177
----
120-
./pattern.sh make install
178+
$ ./pattern.sh make install
121179
----
122180

123181
[id="verify-trvlops-pattern-install"]
124182
== Verify TravelOps Pattern installation
125183

126184
. Verify that the Operators have been installed.
185+
127186
.. To verify, in the OpenShift Container Platform web console, navigate to *Operators → Installed Operators* page.
128-
.. Set your project to `All Projects` and verify the operators are isntalled and have a status of `Succeeded`.
129-
. Verify that all applications are synchronized. Under the project `travelops-hub` click the URL for the `hub` gitops `server`.
187+
188+
.. Set your project to `All Projects` and verify the operators are installed and have a status of `Succeeded`.
189+
190+
. Verify that all applications are synchronized. Under *Networking* -> *Routes* with the project set to *travelops-hub* select the *Location URL* associated with the *hub-gitops-server* . All application are report status as `Synched`.
130191
+
131192
image::travelops/ossm-sync-success.png[ArgoCD Applications,link="/images/travelops/ossm-sync-success.png"]
132193

@@ -137,14 +198,25 @@ As part of this pattern, HashiCorp Vault has been installed. Refer to the sectio
137198
[id="verify-trvlops-dashboards"]
138199
== Verify installation by checking the TravelOps Dashboards
139200

140-
. Access the Kiali and Travel Control dashboards
141-
201+
. Access the Kiali control dashboards by running the following commands:
142202
+
143203
[source, terminal]
144204
----
145205
KIALI=https://$(oc get route -n istio-system kiali -o jsonpath='{.spec.host}')
146206
echo ${KIALI}
207+
----
208+
+
209+
.Example output
210+
+
211+
[source,terminal]
212+
----
213+
https://kiali-istio-system.apps.<cluster_id>.<cluster_domain>
214+
----
147215

216+
. Access the Travel Control dashboards by running the following commands:
217+
+
218+
[source, terminal]
219+
----
148220
CONTROL=http://$(oc get route -n istio-system istio-ingressgateway -o jsonpath='{.spec.host}')
149221
echo ${CONTROL}
150222
----
@@ -164,14 +236,16 @@ image:travelops/ossm-kiali-db-arrows.png[Kiali Dashboard,link="/images/travelops
164236
[id="review-travelops-agency-svc"]
165237
== Review Travel Agency Application Graph
166238

167-
In the Kiali dashboard we can see how all of the various components interact with each other within the service mesh. Just to get a glimpse of what we are able to see let's take a look at the applications and services in the `travel-agency` namespace.
239+
In the Kiali dashboard you can see how all of the various components interact with each other within the service mesh. Just to get a glimpse of what we are able to see let's take a look at the applications and services in the `travel-agency` namespace.
168240

169241
In the left hand menu:
170242

171-
* click Graph
172-
* in the `Namespace` dropdown, select `travel-agency`
173-
* exit the menu
243+
. Cilck *Graph*.
174244

175-
You should see all of the deployments and services that make up the travel-agency application.
245+
. In the `Namespace` dropdown, select `travel-agency`.
176246

247+
. Exit the menu
248+
249+
You should see all of the deployments and services that make up the travel-agency application.
250+
+
177251
image:travelops/travel-agency-svc-kiali.png[Travel Agency,link="/images/travelops/travel-agency-svc-kiali.png"]

0 commit comments

Comments
 (0)