Uploaded image for project: 'OpenShift Service Mesh'
  1. OpenShift Service Mesh
  2. OSSM-9079

Scope initial product documentation for ambient mode

XMLWordPrintable

    • Icon: Spike Spike
    • Resolution: Done
    • Icon: Blocker Blocker
    • None
    • OSSM 3.0.0, OSSM 3.1.0
    • None

      For Technology Preview, we should have enough documentation for a user to get started with Istio's Ambient mode using OpenShift Service Mesh. It is important to consider that Istio's ambient mode represents a different way of setting up service mesh and adds a "fork" in the user journey to get started with service mesh, that we did not have before.

      There will need to be an alternate installation workflow to the section that guides users to install the Bookinfo application and then to enable sidecar injection.] For Ambient mode GA (3.2), we will likely want to break the installation up into an Ambient vs Sidecar workflows, and also consider that there may be a future "combined" mode supported.

      For tech preview (3.1), we can create a new "Getting started with Istio ambient mode" page that will likely live under the "Installing" section. This section should include:

      • A brief (high-level, no more than one page) overview of Istio's ambient mode, including:
        • The Istio ambient mode architecture in brief, including
          • ZTunnel proxy
          • Waypoint proxy
          • istio-cni
        • Why use Istio's ambient mode? Including a brief of benefits and trade offs (shorten significantly from the ones in the blog post)
        • This blog post has a lot of this content, though we should shorten it a lot for the docs and ensure it does not contain any "future" reference material. There are other Ambient references that can go deep, so no need to say too much here.
      • Pre-requisites to using Ambient mode with OSSM, including:
        • OpenShift Container Platform 4.19+ (This is needed for supported Kubernetes Gateway API CRDs).
        • OpenShift Service Mesh 3.1.0+ operator is installed
        • ...
        • Can a sidecar version of OSSM exist already on the cluster or does the user need a clean cluster?
        • Can a version of OSSM 2.6 or earlier be present? (I expect not, but it is important to state if not).
      • A procedure to Install Istio's ambient mode, using the Bookinfo app 
        • This blog post has a procedure, which could be used, though we should not reference any community/istio.io artifacts (including bookinfo yamls, gateway api CRDs, etc). There is also this doc here that is community oriented.
        • Be sure to clearly call out the step when the bookinfo apps are added to ambient mesh, perhaps start the step with "To add the bookinfo workloads to the service mesh using ambient mode, ...."
        • Validate that the workloads are part of the mesh using istioctl and (if setup) Kiali
      • Note additional resource links in community documentation, such as the Ambient mode architecture: https://istio.io/latest/docs/ambient/architecture/.

              mbabushk@redhat.com Maxim Babushkin
              jlongmui@redhat.com Jamie Longmuir
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Created:
                Updated:
                Resolved: