travelops documentation (#406)

* initial docs push

* adding images to repo

* travelops documentation big update

* Update getting-started.adoc

Author: day0hero

content/patterns/travelops-ossm/_index.adoc

@@ -0,0 +1,34 @@
+---
+title: TravelOps 
+date: 2024-02-09
+tier: sandbox
+summary: This pattern enables you to secure your applications using Red Hat Service Mesh.
+rh_products:
+- Red Hat OpenShift Container Platform
+- Red Hat Service Mesh
+- Red Hat Kiali
+- Red Hat Jaeger Distributed Tracing
+- Red Hat ElasticSearch
+industries:
+- General
+aliases: /travelops/
+links:
+  install: getting-started
+  help: https://groups.google.com/g/validatedpatterns
+  bugs: https://github.com/validatedpatterns-sandbox/travelops/issues
+ci: travelops
+---
+:toc:
+:imagesdir: /images
+:_content-type: ASSEMBLY
+include::modules/comm-attributes.adoc[]
+
+include::modules/trvlops-about.adoc[leveloffset=+1]
+
+include::modules/trvlops-architecture.adoc[leveloffset=+1]
+
+[id="next-steps_trvlops-index"]
+== Next steps
+
+* link:getting-started[Deploy the Pattern] using Helm.
+

content/patterns/travelops-ossm/demo-script.adoc

@@ -0,0 +1,12 @@
+---
+title: Demo Script
+weight: 60
+aliases: /travelops/demo/
+---
+
+:toc:
+:imagesdir: /images
+:_content-type: REFERENCE
+include::modules/comm-attributes.adoc[]
+
+include::modules/trvlops-demo.adoc[leveloffset=+1]

content/patterns/travelops-ossm/getting-started.adoc

@@ -0,0 +1,19 @@
+---
+title: Getting Started
+weight: 10
+aliases: /travelops/getting-started/
+---
+
+:toc:
+:imagesdir: /images
+:_content-type: ASSEMBLY
+include::modules/comm-attributes.adoc[]
+
+include::modules/trvlops-deploying.adoc[leveloffset=1]
+
+[id="next-steps_getting-started"]
+== Next Steps
+
+To run through the demo, refer to link:..//demo-script[Monitor the Mesh]
+
+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!

content/patterns/travelops-ossm/ideas-for-customization.adoc

@@ -0,0 +1,13 @@
+---
+title: Ideas for customization
+weight: 50
+aliases: /travelops/ideas-for-customization/
+---
+
+:toc:
+:imagesdir: /images
+:_content-type: ASSEMBLY
+include::modules/comm-attributes.adoc[]
+
+//header information comes from the module
+include::modules/trvlops-about-customizing-pattern.adoc[leveloffset=+1]

modules/comm-attributes.adoc

@@ -33,6 +33,8 @@
 :med: medical diagnosis
 :multi-devsec-pattern: Multi-cluster DevSecOps pattern
 :multi-devsec: multi-cluster DevSecOps
+:trvlops-pattern: TravelOps pattern
+:trvlops: TravelOps pattern
 // Associated products
 :hashicorp-vault: HashiCorp Vault
 :hashicorp-vault-short: Vault
@@ -152,5 +154,10 @@
 // Red Hat OpenShift AI
 :rh-oai: Red{nbsp}Hat OpenShift Data Science
 :oai: OpenShift Data Science
+// Red Hat Service Mesh
+:rh-sm: Red{nbsp}Hat Service Mesh
+:rh-kiali: Kiali
+:rh-jaeger: Jaeger Distributed Tracing
+:rh-elastic: ElasticSearch
 // Icons
 :grid: grid.png

modules/trvlops-about-customizing-pattern.adoc

@@ -0,0 +1,19 @@
+:_content-type: CONCEPT
+:imagesdir: ../../images
+
+[id="about-customizing-pattern-trvlops"]
+= About customizing the pattern {trvlops-pattern}
+
+One of the major goals of the Validated Patterns development process is to create modular, customizable demos. The {trvlops-pattern} is just an example of a pattern that can deploy a Service Mesh and add applications to it using GitOps. When reading these customization ideas really think of them in the context of starting with this pattern and extending it to meet your organizations needs. 
+
+* oAuth Configuration
+** Create an oAuth provider (HTPasswd, GitHub, MicroSoft)
+** Create RBAC (roles, rolebindings) and assign to users
+
+* External prometheus installation
+
+* Integrate `openshift-pipelines` into the pattern for a full `ci/cd` experience
+
+* Integrate with Keycloak for AuthN / AuthZ 
+
+* Integrate with a real certificate authority like Let's Encrypt

modules/trvlops-about.adoc

@@ -0,0 +1,67 @@
+:_content-type: CONCEPT
+:imagesdir: ../../images
+
+[id="about-travelops-pattern"]
+= About the travelops pattern
+
+Use case::
+
+* Use a GitOps approach to manage hybrid and multi-cloud deployments across both public and private clouds.
+* Enable cross-cluster governance and application lifecycle management.
+* Securely manage secrets across the deployment.
++
+[NOTE]
+====
+Based on the requirements of a specific implementation, certain details might differ. However, all validated patterns that are based on a portfolio architecture, generalize one or more successful deployments of a use case.
+====
+
+Background::
+
+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.
+
+//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.
+
+Organizations are aiming to develop, deploy, and operate applications on an open hybrid cloud in a stable, simple, and secure way. This hybrid strategy includes multi-cloud deployments where workloads might be running on multiple clusters and on multiple clouds, private or public.
+This strategy requires an infrastructure-as-code approach: GitOps. GitOps uses Git repositories as a single source of truth to deliver infrastructure-as-code. Submitted code will be checked by the continuous integration (CI) process, while the continuous delivery (CD) process checks and applies requirements for things like security, infrastructure-as-code, or any other boundaries set for the application framework. All changes to code are tracked, making updates easy while also providing version control should a rollback be needed.
+
+[id="about-solution"]
+== About the solution
+
+This architecture covers a single cluster for all DevOps and GitOps functionality. However, one could extend this architecture to meet hybrid or multicloud demand using a GitOps approach
+
+Benefits of Hybrid Multicloud management with GitOps:
+
+* Unify management across cloud environments.
+* Dynamic infrastructure security.
+* Infrastructural continuous delivery best practices.
+
+In the following figure, logically, this solution can be viewed as being composed of an automation component, unified management including secrets management, and the clusters under management, all running on top of a user-chosen mixture of on-premise data centers and public clouds.
+
+.Logical diagram of hybrid multi-cloud management with GitOps
+image::multicloud-gitops/logical-diagram.png[Logical Architecture]
+
+[id="about-technology"]
+== About the technology
+
+The following technologies are used in this solution:
+
+
+https://www.redhat.com/en/technologies/cloud-computing/openshift/try-it[Red Hat OpenShift Platform]::
+An enterprise-ready Kubernetes container platform built for an open hybrid cloud strategy. It provides a consistent application platform to manage hybrid cloud, public cloud, and edge deployments. It delivers a complete application platform for both traditional and cloud-native applications, allowing them to run anywhere. OpenShift has a pre-configured, pre-installed, and self-updating monitoring stack that provides monitoring for core platform components. It also enables the use of external secret management systems, for example, HashiCorp Vault in this case, to securely add secrets into the OpenShift platform.
+
+https://www.redhat.com/en/technologies/cloud-computing/openshift/try-it[Red Hat OpenShift GitOps]::
+A declarative application continuous delivery tool for Kubernetes based on the ArgoCD project. Application definitions, configurations, and environments are declarative and version controlled in Git. It can automatically push the desired application state into a cluster, quickly find out if the application state is in sync with the desired state, and manage applications in multi-cluster environments.
+
+https://www.redhat.com/en/technologies/management/advanced-cluster-management[Red Hat Advanced Cluster Management for Kubernetes]::
+Controls clusters and applications from a single console, with built-in security policies. Extends the value of Red Hat OpenShift by deploying apps, managing multiple clusters, and enforcing policies across multiple clusters at scale.
+
+https://www.redhat.com/en/technologies/cloud-computing/openshift/what-is-openshift-service-mesh[Red Hat Service Mesh]::
+Red Hat® OpenShift Service Mesh provides a uniform way to connect, manage, and observe microservices-based applications.
+
+https://www.redhat.com/en/technologies/management/ansible[Red Hat Ansible Automation Platform]::
+Provides an enterprise framework for building and operating IT automation at scale across hybrid clouds including edge deployments. It enables users across an organization to create, share, and manage automation, from development and operations to security and network teams.
+
+Hashicorp Vault::
+Provides a secure centralized store for dynamic infrastructure and applications across clusters, including over low-trust networks between clouds and data centers.
+
+This solution also uses a variety of _observability tools_ including the Prometheus monitoring and Grafana dashboard that are integrated with OpenShift as well as components of the Observatorium meta-project which includes Thanos and the Loki API.

modules/trvlops-architecture.adoc

@@ -0,0 +1,54 @@
+:_content-type: CONCEPT
+:imagesdir: ../../images
+
+[id="overview-architecture"]
+= Overview of the architectures
+
+The following figure provides a high level architectural overview of the travelops pattern.
+
+.Overview schematic diagram of the complete solution
+image::travelops/ossm-arch-travelops.png[Physical Architecture,link="/images/travelops/ossm-arch-travelops.png"]
+
+Subsequent schematic diagrams provide details on:
+
+* Hybrid multi-cloud GitOps
+* Dynamic security management
+
+[id="hybrid-multicloud-gitops"]
+== Hybrid Multicloud GitOps
+
+The following figure provides a schematic diagram showing remaining activities associated with setting up the management hub and clusters using Red Hat Advanced Cluster Management.
+
+//figure 5 originally
+.Schematic diagram of hybrid multi-cloud management with GitOps
+image::multicloud-gitops/spi-multi-cloud-gitops-sd-security.png[Schematic diagram of hybrid multi-cloud management with GitOps]
+
+* Manifest and configuration are set as code template in the form of a `Kustomization` YAML file. The file describes the desired end state of the managed cluster. When complete, the `Kustomization` YAML file is pushed into the source control management repository with a version assigned to each update.
+* OpenShift GitOps monitors the repository and detects changes in the repository.
+* OpenShift GitOps creates and updates the manifest by creating Kubernetes objects on top of Red Hat Advanced Cluster Management.
+* Red Hat Advanced Cluster Management provisions, updates, or deletes managed clusters and configuration according to the manifest. In the manifest, you can configure what cloud provider the cluster will be on, the name of the cluster, infrastructure node details and worker node. Governance policy can also be applied as well as provision an agent in the cluster as the bridge between the control center and the managed cluster.
+* OpenShift GitOps continuously monitors the code repository and the status of the clusters reported back to Red Hat Advanced Cluster Management. Any configuration drift or in case of any failure, OpenShift GitOps will automatically try to remediate by applying the manifest or by displaying alerts for manual intervention.
+
+[id="dynamic-security-management"]
+== Dynamic security management
+
+The following figure provides a schematic diagram showing how secrets are handled in this solution.
+
+//figure 6 originally
+.Schematic showing the setup and use of external secrets management
+image::multicloud-gitops/spi-multi-cloud-gitops-sd-security.png[Schematic showing the setup and use of external secrets management]
+
+* During setup, the token to securely access HashiCorp Vault is stored in Ansible Vault. It is encrypted to protect sensitive content.
+
+* Red Hat Advanced Cluster Management for Kubernetes acquires the token from Ansible Vault during install and distributes it among the clusters. As a result, you have centralized control over the managed clusters through RHACM.
+
+* To allow the cluster access to the external vault, you must set up the external secret management with Helm in this study. OpenShift Gitops is used to deploy the external secret object to a managed cluster.
+
+* External secret management fetches secrets from HashiCorp Vault by using the token that was generated in step 2 and constantly monitors for updates.
+
+* Secrets are created in each namespace, where applications can use them.
+
+//[id="slide-deck"]
+//== Presentation
+//
+//View a short presentation slide deck about Multicloud GitOps link:https://speakerdeck.com/rhvalidatedpatterns/multicloud-gitops[here]

modules/trvlops-demo.adoc

@@ -0,0 +1,10 @@
+:_content-type: PROCEDURE
+:imagesdir: ../../../images
+
+[id="demoscript-trvlops-pattern"]
+= TravelOps Demo Script
+
+[WARNING]
+====
+TravelOps demo script is under construction. Will be posted shortly.
+====