diff --git a/docs/modules/opa/pages/implementation-notes.adoc b/docs/modules/opa/pages/implementation-notes.adoc index 9401980d..ff271403 100644 --- a/docs/modules/opa/pages/implementation-notes.adoc +++ b/docs/modules/opa/pages/implementation-notes.adoc @@ -1,4 +1,5 @@ = Implementation notes +:description: Implementation notes on the Stackable operator for Open Policy Agent (OPA), covering one OPA Pod per node and how the bundle builder serves policies. These notes may be of use when trying to understand why things are implemented the way that they are, but should not be required reading for regular use. diff --git a/docs/modules/opa/pages/reference/commandline-parameters.adoc b/docs/modules/opa/pages/reference/commandline-parameters.adoc index 86bd6b1f..63c44893 100644 --- a/docs/modules/opa/pages/reference/commandline-parameters.adoc +++ b/docs/modules/opa/pages/reference/commandline-parameters.adoc @@ -1,4 +1,5 @@ = Command line parameters +:description: Command-line parameters the Stackable operator for Open Policy Agent (OPA) accepts, with their default values and usage examples. This operator accepts the following command line parameters: diff --git a/docs/modules/opa/pages/reference/crds.adoc b/docs/modules/opa/pages/reference/crds.adoc index fb66a83f..3ba38400 100644 --- a/docs/modules/opa/pages/reference/crds.adoc +++ b/docs/modules/opa/pages/reference/crds.adoc @@ -1,3 +1,4 @@ = CRD reference +:description: CRD reference for the Stackable operator for Open Policy Agent (OPA) on the Stackable Hub, covering every field, default and API version. Find all CRD reference for the Stackable operator for OpenPolicyAgent at: {crd-ref}{crd-ref-release}&operator=opa-operator. diff --git a/docs/modules/opa/pages/reference/environment-variables.adoc b/docs/modules/opa/pages/reference/environment-variables.adoc index 04d83a2f..ce365192 100644 --- a/docs/modules/opa/pages/reference/environment-variables.adoc +++ b/docs/modules/opa/pages/reference/environment-variables.adoc @@ -1,4 +1,5 @@ = Environment variables +:description: Environment variables the Stackable operator for Open Policy Agent (OPA) accepts, with their default values and what each one controls. This operator accepts the following environment variables: diff --git a/docs/modules/opa/pages/reference/index.adoc b/docs/modules/opa/pages/reference/index.adoc index eeb572f1..a7092429 100644 --- a/docs/modules/opa/pages/reference/index.adoc +++ b/docs/modules/opa/pages/reference/index.adoc @@ -1,4 +1,5 @@ = Reference +:description: Reference for the Stackable operator for Open Policy Agent (OPA), covering CRD fields, discovery ConfigMap properties, CLI parameters and environment variables. Consult the reference documentation section to find exhaustive information on: diff --git a/docs/modules/opa/pages/usage-guide/listenerclass.adoc b/docs/modules/opa/pages/usage-guide/listenerclass.adoc index 563bc7c4..f67810a7 100644 --- a/docs/modules/opa/pages/usage-guide/listenerclass.adoc +++ b/docs/modules/opa/pages/usage-guide/listenerclass.adoc @@ -1,4 +1,5 @@ = Service exposition with ListenerClasses +:description: Exposing the Open Policy Agent (OPA) API with a ListenerClass, covering cluster-internal and external access to the Service the operator creates. OPA offers an API. The operator deploys a Service called `` (where `` is the name of the OpaCluster) through which OPA can be reached. diff --git a/docs/modules/opa/pages/usage-guide/operations/cluster-operations.adoc b/docs/modules/opa/pages/usage-guide/operations/cluster-operations.adoc index 20c0eccb..8a28987b 100644 --- a/docs/modules/opa/pages/usage-guide/operations/cluster-operations.adoc +++ b/docs/modules/opa/pages/usage-guide/operations/cluster-operations.adoc @@ -1,3 +1,4 @@ = Cluster Operation +:description: Cluster operations for Open Policy Agent (OPA), covering how to pause reconciliation of a cluster or stop it entirely through its custom resource. OPA installations can be configured with different cluster operations like pausing reconciliation or stopping the cluster. See xref:concepts:operations/cluster_operations.adoc[cluster operations] for more details. diff --git a/docs/modules/opa/pages/usage-guide/operations/graceful-shutdown.adoc b/docs/modules/opa/pages/usage-guide/operations/graceful-shutdown.adoc index d1e72491..06530921 100644 --- a/docs/modules/opa/pages/usage-guide/operations/graceful-shutdown.adoc +++ b/docs/modules/opa/pages/usage-guide/operations/graceful-shutdown.adoc @@ -1,4 +1,5 @@ = Graceful shutdown +:description: Graceful shutdown of Open Policy Agent (OPA) servers, covering the configurable shutdown timeout and how OPA stops answering policy queries. You can configure the graceful shutdown as described in xref:concepts:operations/graceful_shutdown.adoc[]. diff --git a/docs/modules/opa/pages/usage-guide/operations/index.adoc b/docs/modules/opa/pages/usage-guide/operations/index.adoc index ca75700b..8d2e2601 100644 --- a/docs/modules/opa/pages/usage-guide/operations/index.adoc +++ b/docs/modules/opa/pages/usage-guide/operations/index.adoc @@ -1,5 +1,6 @@ = Operations +:description: Operating Open Policy Agent (OPA) with the Stackable operator, covering graceful shutdown, Pod disruptions, Pod placement and cluster operations. This section of the documentation is intended for the operations teams that maintain a Stackable Data Platform installation. diff --git a/docs/modules/opa/pages/usage-guide/resources.adoc b/docs/modules/opa/pages/usage-guide/resources.adoc index 475b66ce..a53307ad 100644 --- a/docs/modules/opa/pages/usage-guide/resources.adoc +++ b/docs/modules/opa/pages/usage-guide/resources.adoc @@ -1,6 +1,7 @@ = Resource requests +:description: CPU and memory requests and limits for Open Policy Agent (OPA) Pods, which run as a DaemonSet with one Pod on every Kubernetes node. -include::concepts:stackable_resource_requests.adoc[] +include::concepts:partial$stackable_resource_requests.adoc[] A minimal OPA setup consists of 1 Pod per Node (DaemonSet) and has the following https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource requirements] per scheduled Pod: