Skip to content

Commit 73667ee

Browse files
lfranckelfrancke
authored
docs: Add page descriptions (#913)
* docs: Add page descriptions * docs: Include the resource requests partial
1 parent 97739d8 commit 73667ee

10 files changed

Lines changed: 11 additions & 1 deletion

File tree

‎docs/modules/opa/pages/implementation-notes.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= Implementation notes
2+
: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.
23

34
These notes may be of use when trying to understand why things are implemented the way that they are,
45
but should not be required reading for regular use.

‎docs/modules/opa/pages/reference/commandline-parameters.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= Command line parameters
2+
:description: Command-line parameters the Stackable operator for Open Policy Agent (OPA) accepts, with their default values and usage examples.
23

34
This operator accepts the following command line parameters:
45

‎docs/modules/opa/pages/reference/crds.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
= CRD reference
2+
:description: CRD reference for the Stackable operator for Open Policy Agent (OPA) on the Stackable Hub, covering every field, default and API version.
23

34
Find all CRD reference for the Stackable operator for OpenPolicyAgent at: {crd-ref}{crd-ref-release}&operator=opa-operator.

‎docs/modules/opa/pages/reference/environment-variables.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= Environment variables
2+
:description: Environment variables the Stackable operator for Open Policy Agent (OPA) accepts, with their default values and what each one controls.
23

34
This operator accepts the following environment variables:
45

‎docs/modules/opa/pages/reference/index.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= Reference
2+
:description: Reference for the Stackable operator for Open Policy Agent (OPA), covering CRD fields, discovery ConfigMap properties, CLI parameters and environment variables.
23

34
Consult the reference documentation section to find exhaustive information on:
45

‎docs/modules/opa/pages/usage-guide/listenerclass.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= Service exposition with ListenerClasses
2+
:description: Exposing the Open Policy Agent (OPA) API with a ListenerClass, covering cluster-internal and external access to the Service the operator creates.
23

34
OPA offers an API.
45
The operator deploys a Service called `<name>` (where `<name>` is the name of the OpaCluster) through which OPA can be reached.

‎docs/modules/opa/pages/usage-guide/operations/cluster-operations.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
= Cluster Operation
2+
:description: Cluster operations for Open Policy Agent (OPA), covering how to pause reconciliation of a cluster or stop it entirely through its custom resource.
23

34
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.

‎docs/modules/opa/pages/usage-guide/operations/graceful-shutdown.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= Graceful shutdown
2+
:description: Graceful shutdown of Open Policy Agent (OPA) servers, covering the configurable shutdown timeout and how OPA stops answering policy queries.
23

34
You can configure the graceful shutdown as described in xref:concepts:operations/graceful_shutdown.adoc[].
45

‎docs/modules/opa/pages/usage-guide/operations/index.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11

22
= Operations
3+
:description: Operating Open Policy Agent (OPA) with the Stackable operator, covering graceful shutdown, Pod disruptions, Pod placement and cluster operations.
34

45
This section of the documentation is intended for the operations teams that maintain a Stackable Data Platform installation.
56

‎docs/modules/opa/pages/usage-guide/resources.adoc‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
= Resource requests
2+
: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.
23

3-
include::concepts:stackable_resource_requests.adoc[]
4+
include::concepts:partial$stackable_resource_requests.adoc[]
45

56
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:
67

0 commit comments

Comments
 (0)