You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/concepts/pages/overview.adoc
+9-8Lines changed: 9 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -7,11 +7,12 @@ image::overview.drawio.svg[]
7
7
8
8
The operators are deployed into a Kubernetes cluster, one operator per product (such as Apache ZooKeeper, Apache HDFS, Apache Druid). Every operator has at its core a custom resource (CR) which defines a product instance (shown in green above). The operator creates Kubernetes objects based on the CRs, such as ConfigMaps, StatefulSets and Services.
9
9
10
-
The operators are deployed with the Stackable CLI tool and product instances are created by deploying manifests into Kubernetes.
10
+
The operators are deployed with xref:management:stackablectl:index.adoc[] (the Stackable CLI tool) and product instances are created by deploying manifests into Kubernetes.
11
11
12
-
Aspects like SQL database configuration, storage configuration or authentication and authorization work the same way across all operators.
12
+
Aspects like SQL database configuration, xref:resources.adoc[storage configuration] or xref:authentication.adoc[authentication] and xref:opa.adoc[authorization] work the same way across all operators.
13
13
Most operators support LDAP as a common way to authenticate with product instances and OPA as a common way to set up authorization.
14
14
15
+
[#operators]
15
16
== Operators
16
17
17
18
The Operators form the core of the Stackable platform. There is one operator for every supported product, as well as a few supporting operators. All Stackable Operators are built on top of a common framework, so they look and behave in a similar way.
@@ -26,13 +27,13 @@ The diagram above shows the custom resource in green. It contains all the config
26
27
[#discovery]
27
28
=== Discovery
28
29
29
-
The operator also creates a **discovery ConfigMap** for every product instance which is used by other products to connect to it. The ConfigMap has the same name as the product instance and contains information about how to connect to the product. This ConfigMap can then be referenced in other product instance resources.
30
+
The operator also creates a xref:service-discovery.adoc[**discovery ConfigMap**] for every product instance which is used by other products to connect to it. The ConfigMap has the same name as the product instance and contains information about how to connect to the product. This ConfigMap can then be referenced in other product instance resources.
30
31
31
32
image::discovery.drawio.svg[]
32
33
33
34
For example, Apache ZooKeeper is a dependency of many other products, such as Apache HDFS and Apache Druid. The HDFS and Druid resources can simply reference the ZooKeeper cluster by name and the operators will use the discovery ConfigMap to configure the Druid and HDFS Pods to connect to the ZooKeeper Service.
34
35
35
-
You can also create these discovery ConfigMaps yourself to make products discoverable that are not operatored by a Stackable Operator. Learn more about product discovery at xref::service_discovery.adoc[].
36
+
You can also create these discovery ConfigMaps yourself to make products discoverable that are not operatored by a Stackable Operator. Learn more about product discovery at xref:service-discovery.adoc[].
36
37
37
38
[#roles]
38
39
=== Roles
@@ -41,12 +42,12 @@ Almost all products that Stackable supports need multiple different processes to
41
42
42
43
All roles are configured together in the custom resource for the product, but they each get their own StatefulSet, ConfigMaps and Service.
43
44
44
-
Learn more about roles: xref::roles-and-role-groups.adoc[]
45
+
Learn more about roles: xref:roles-and-role-groups.adoc[]
45
46
46
47
[#deployment]
47
48
== Deployment
48
49
49
-
All operators and products run as containers in a Kubernetes cluster. The operators are deployed with stackablectl (the Stackable CLI) or Helm.
50
+
All operators and products run as containers in a xref:home::kubernetes.adoc[Kubernetes cluster]. The operators are deployed with stackablectl (the Stackable CLI) or Helm.
50
51
51
52
image::deployment.drawio.svg[]
52
53
@@ -63,6 +64,6 @@ Besides the products themselves, there are also related objects, such as S3 buck
63
64
64
65
image::common_objects.drawio.svg[]
65
66
66
-
These objects can be reused by all operators that support this feature. The S3 bucket only needs to be described once, and then it can be referenced in all products that support reading and/or writing from/to S3. Learn more about S3 configuration: xref::s3.adoc[].
67
+
These objects can be reused by all operators that support this feature. The S3 bucket only needs to be described once, and then it can be referenced in all products that support reading and/or writing from/to S3. Learn more about S3 configuration: xref:s3.adoc[].
67
68
68
-
Similarly for the OpenPolicyAgent (OPA). Configuring it looks the same across all products. Learn more: xref::opa.adoc[].
69
+
Similarly for the OpenPolicyAgent (OPA). Configuring it looks the same across all products. Learn more: xref:opa.adoc[].
0 commit comments