From ce982b69907d1becd2c46b74c794cfc98e94dc26 Mon Sep 17 00:00:00 2001
From: Tim O'Keefe <tokeefe@redhat.com>
Date: Wed, 11 Dec 2024 12:05:26 -0500
Subject: [PATCH] OSSM-6856: Operator API Reference Documentation

---
 _attributes/common-attributes.adoc                   |  2 ++
 install/ossm-installing-openshift-service-mesh.adoc  |  3 ++-
 ...out-service-mesh-custom-resource-definitions.adoc | 12 ++++++++++++
 3 files changed, 16 insertions(+), 1 deletion(-)
 create mode 100644 modules/ossm-about-service-mesh-custom-resource-definitions.adoc

diff --git a/_attributes/common-attributes.adoc b/_attributes/common-attributes.adoc
index 597a150fc079..da3bc21d344b 100644
--- a/_attributes/common-attributes.adoc
+++ b/_attributes/common-attributes.adoc
@@ -42,6 +42,8 @@
 :TempoShortName: distributed tracing platform (Tempo)
 :TempoOperator: Tempo Operator
 :TempoVersion: 2.1.1
+//sail 
+:sail-operator: Sail Operator
 //gitops
 :gitops-title: Red{nbsp}Hat OpenShift GitOps
 :gitops-shortname: GitOps
diff --git a/install/ossm-installing-openshift-service-mesh.adoc b/install/ossm-installing-openshift-service-mesh.adoc
index 7051b9a29a76..f57bb817b9c0 100644
--- a/install/ossm-installing-openshift-service-mesh.adoc
+++ b/install/ossm-installing-openshift-service-mesh.adoc
@@ -11,6 +11,7 @@ Installing {ocp-short-name} {SMProductShortName} consists of three main tasks: i
 include::modules/ossm-about-deploying-istio-using-service-mesh-operator.adoc[leveloffset=+1]
 include::modules/ossm-about-deployment-and-update-strategies.adoc[leveloffset=+2]
 include::modules/ossm-installing-operator.adoc[leveloffset=+1]
+include::modules/ossm-about-service-mesh-custom-resource-definitions.adoc[leveloffset=+2]
 include::modules/ossm-about-istio-deployment.adoc[leveloffset=+1]
 include::modules/ossm-creating-istio-project-using-console.adoc[leveloffset=+2]
 include::modules/ossm-creating-istio-resource-using-console.adoc[leveloffset=+2]
@@ -28,4 +29,4 @@ include::modules/ossm-deploying-bookinfo-application.adoc[leveloffset=+2]
 include::modules/ossm-about-accessing-bookinfo-application-using-gateway.adoc[leveloffset=+2]
 include::modules/ossm-accessing-bookinfo-application-using-istio-gateway-injection.adoc[leveloffset=+2]
 include::modules/ossm-accessing-bookinfo-application-using-gateway-api.adoc[leveloffset=+2]
-include::modules/ossm-customizing-istio-configuration.adoc[leveloffset=+1]
+include::modules/ossm-customizing-istio-configuration.adoc[leveloffset=+1]
\ No newline at end of file
diff --git a/modules/ossm-about-service-mesh-custom-resource-definitions.adoc b/modules/ossm-about-service-mesh-custom-resource-definitions.adoc
new file mode 100644
index 000000000000..d016fae1d539
--- /dev/null
+++ b/modules/ossm-about-service-mesh-custom-resource-definitions.adoc
@@ -0,0 +1,12 @@
+// Module included in the following assemblies:
+// * install/ossm-installing-openshift-service-mesh.adoc
+
+:_mod-docs-content-type: CONCEPT
+[id="ossm-about-service-mesh-custom-resource-definitions_{context}"]
+= About Service Mesh custom resource definitions
+
+Installing the {SMProductName} Operator also installs custom resource definitions (CRD) that administrators can use to configure {istio} for {SMProductShortName} installations. The {olm-first} installs two categories of CRDs: {sail-operator} CRDs and {istio} CRDs.
+
+{sail-operator} CRDs define custom resources for installing and maintaining the {istio} components required to operate a service mesh. These custom resources belong to the `sailoperator.io` API group and include the `Istio`, `IstioRevision`, `IstioCNI`, and `ZTunnel` resource kinds. For more information on how to configure these resources, see the `sailoperator.io` link:https://github.com/istio-ecosystem/sail-operator/blob/main/docs/api-reference/sailoperator.io.md[API reference] documentation.
+
+{istio} CRDs are associated with mesh configuration and service management. These CRDs define custom resources in several `istio.io` API groups, such as `networking.istio.io` and `security.istio.io`. The CRDs also include various resource kinds, such as `AuthorizationPolicy`, `DestinationRule`, and `VirtualService`, that administrators use to configure a service mesh.
\ No newline at end of file