Skip to content

OSSM-6856: Operator API Reference Documentation #86115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 20, 2024
Merged

OSSM-6856: Operator API Reference Documentation #86115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions _attributes/common-attributes.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion install/ossm-installing-openshift-service-mesh.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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]
12 changes: 12 additions & 0 deletions modules/ossm-about-service-mesh-custom-resource-definitions.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.