Skip to content

Commit 27bba47

Browse files
committed
Merge branch 'suse-observability' into suse-observability-staging
2 parents f5c815c + 4a8794f commit 27bba47

21 files changed

Lines changed: 501 additions & 45 deletions
90.1 KB
Loading

SUMMARY.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,8 @@
9696
* [Overview](setup/otel/overview.md)
9797
* [Getting started](setup/otel/getting-started/README.md)
9898
* [Concepts](setup/otel/concepts.md)
99-
* [Rancher & Kubernetes](setup/otel/getting-started/getting-started-k8s.md)
99+
* [Kubernetes](setup/otel/getting-started/getting-started-k8s.md)
100+
* [Kubernetes Operator](setup/otel/getting-started/getting-started-k8s-operator.md)
100101
* [Linux](setup/otel/getting-started/getting-started-linux.md)
101102
* [AWS Lambda](setup/otel/getting-started/getting-started-lambda.md)
102103
* [Open telemetry collector](setup/otel/collector.md)
@@ -119,6 +120,7 @@
119120
* [Kubernetes / OpenShift](setup/install-stackstate/kubernetes_openshift/README.md)
120121
* [Kubernetes install](setup/install-stackstate/kubernetes_openshift/kubernetes_install.md)
121122
* [OpenShift install](setup/install-stackstate/kubernetes_openshift/openshift_install.md)
123+
* [Alibaba Cloud ACK install](setup/install-stackstate/kubernetes_openshift/ack.md)
122124
* [Required Permissions](setup/install-stackstate/kubernetes_openshift/required_permissions.md)
123125
* [Override default configuration](setup/install-stackstate/kubernetes_openshift/customize_config.md)
124126
* [Configure storage](setup/install-stackstate/kubernetes_openshift/storage.md)
@@ -131,6 +133,8 @@
131133
* [Slack notifications](setup/configure-stackstate/slack-notifications.md)
132134
* [E-mail notifications](setup/configure-stackstate/email-notifications.md)
133135
* [Stackpacks](stackpacks/about-stackpacks.md)
136+
* [Advanced](advanced/index.md)
137+
* [Analytics](advanced/analytics.md)
134138
* [Release Notes](setup/release-notes/README.md)
135139
* [v2.0.0 - 11/Sep/2024](setup/release-notes/v2.0.0.md)
136140
* [v2.0.1 - 18/Sep/2024](setup/release-notes/v2.0.1.md)
@@ -140,6 +144,7 @@
140144
* [v2.2.1 - 10/Dec/2024](setup/release-notes/v2.2.1.md)
141145
* [v2.3.0 - 30/Jan/2025](setup/release-notes/v2.3.0.md)
142146
* [v2.3.1 - 17/Mar/2025](setup/release-notes/v2.3.1.md)
147+
* [v2.3.2 - 22/Apr/2025](setup/release-notes/v2.3.2.md)
143148
* [Upgrade SUSE Observability](setup/upgrade-stackstate/README.md)
144149
* [Migration from StackState](setup/upgrade-stackstate/migrate-from-6.md)
145150
* [Steps to upgrade](setup/upgrade-stackstate/steps-to-upgrade.md)

advanced/analytics.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
description: SUSE Observability Self-hosted
3+
---
4+
5+
# Analytics page
6+
7+
Analytics page provides a powerful and flexible interface to query and analyze your observability data using [STQL queries](../develop/reference/k8sTs-stql_reference.md).
8+
This interactive environment empowers you to go beyond pre-built dashboards and gain deeper insights into the health, performance, and dependencies of your dynamic environment.
9+
10+
{% hint style="warning" %}
11+
**The Analytics page is deprecated, but you can still enable it by configuring specific permissions. However, we strongly recommend leveraging StackPacks for enhanced observability and analysis, as they provide a more robust and actively supported alternative.**
12+
13+
Two permissions are required to enable Analytics Page:
14+
- `access-analytics`
15+
- `execute-scripts`
16+
17+
More details: [Permissions management](../setup/security/rbac/rbac_permissions.md)
18+
19+
{% endhint %}

advanced/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
description: SUSE Observability Self-hosted
3+
---
4+
5+
# Advanced configuration
6+

scripts/suse-observability_logs_collector.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/bin/bash
22

33
# Namespace to collect information
4-
NAMESPACE="suse-observability"
4+
NAMESPACE=${1:-suse-observability}
55

66
# Check if kubectl is installed or not
77
if ! command -v kubectl &>/dev/null; then
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
description: SUSE Observability Self-hosted
3+
---
4+
5+
# Alibaba Cloud Container Service for Kubernetes (ACK) installation notes
6+
7+
## Minimum volume size
8+
9+
Alibaba Cloud's Container Service for Kubernetes (ACK) enforces a minimum volume size of **20 GiB** for disk-based PersistentVolumeClaims (PVCs). When deploying on ACK, Persistent Volume Claims (pvc) have to request **at least 20Gi** of storage. Failure to meet the 20Gi minimum may result in volume provisioning and failures during Helm deployment.
10+
11+
We provide a dedicated set of Helm values that adjusts all volume sizes to meet this requirement. If you're installing on ACK, use this file during installation:
12+
13+
```yaml
14+
# ack-values.yaml
15+
zookeeper:
16+
persistence:
17+
size: 20Gi
18+
stackstate:
19+
components:
20+
checks:
21+
tmpToPVC:
22+
volumeSize: 20Gi
23+
healthSync:
24+
tmpToPVC:
25+
volumeSize: 20Gi
26+
localpvc:
27+
size: 20Gi
28+
state:
29+
tmpToPVC:
30+
volumeSize: 20Gi
31+
sync:
32+
tmpToPVC:
33+
volumeSize: 20Gi
34+
vmagent:
35+
persistence:
36+
size: 20Gi
37+
experimental:
38+
storeTransactionLogsToPVC:
39+
volumeSize: 20Gi
40+
stackpacks:
41+
localpvc:
42+
size: 20Gi
43+
pvc:
44+
size: 20Gi
45+
backup:
46+
configuration:
47+
scheduled:
48+
pvc:
49+
size: 20Gi
50+
```
51+
52+
Please create a separate file for the ACK-specific values and use it during installation. For example, if you follow [Kubernetes install documentation](https://docs.stackstate.com/self-hosted-setup/install-stackstate/kubernetes_openshift/kubernetes_install#deploy-suse-observability-with-helm) and save the above values in a file called `ack-values.yaml`, you can install Suse Observability with:
53+
54+
```bash
55+
helm upgrade \
56+
--install \
57+
--namespace suse-observability \
58+
--values $VALUES_DIR/suse-observability-values/templates/baseConfig_values.yaml \
59+
--values $VALUES_DIR/suse-observability-values/templates/sizing_values.yaml \
60+
--values ack-values.yaml \
61+
suse-observability \
62+
suse-observability/suse-observability
63+
```

setup/install-stackstate/kubernetes_openshift/ingress.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ helm upgrade --install \
4545
--namespace "suse-observability" \
4646
--values "ingress_values.yaml" \
4747
--values $VALUES_DIR/suse-observability-values/templates/baseConfig_values.yaml \
48-
--values $VALUES_DIR/suse-observability-values/templates/sizing_values.yaml \
48+
--values $VALUES_DIR/suse-observability-values/templates/sizing_values.yaml \
4949
suse-observability \
5050
suse-observability/suse-observability
5151
```
@@ -107,7 +107,7 @@ helm upgrade \
107107
--namespace "suse-observability" \
108108
--values "ingress_otel_values.yaml" \
109109
--values $VALUES_DIR/suse-observability-values/templates/baseConfig_values.yaml \
110-
--values $VALUES_DIR/suse-observability-values/templates/sizing_values.yaml \
110+
--values $VALUES_DIR/suse-observability-values/templates/sizing_values.yaml \
111111
suse-observability \
112112
suse-observability/suse-observability
113113
```

setup/install-stackstate/kubernetes_openshift/kubernetes_install.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@ description: SUSE Observability Self-hosted
1010
Extra notes for installing on:
1111

1212
* **Kubernetes clusters with limited permissions**: Read the [required permissions](required_permissions.md).
13+
* **Alibaba Cloud Container Service for Kubernetes (ACK)**: Read the [ACK installation notes](ack.md).
1314
* **OpenShift**: Refer to the [OpenShift installation instructions](openshift_install.md).
1415
{% endhint %}
15-
16+
1617
Before you start the installation of SUSE Observability:
1718

1819
* Check the [requirements](/setup/install-stackstate/requirements.md) to make sure that your Kubernetes environment fits the setup that you will use (recommended, minimal or non- high availability).
@@ -114,7 +115,7 @@ helm upgrade \
114115
--install \
115116
--namespace suse-observability \
116117
--values $VALUES_DIR/suse-observability-values/templates/baseConfig_values.yaml \
117-
--values $VALUES_DIR/suse-observability-values/templates/sizing_values.yaml \
118+
--values $VALUES_DIR/suse-observability-values/templates/sizing_values.yaml \
118119
suse-observability \
119120
suse-observability/suse-observability
120121
```

setup/install-stackstate/kubernetes_openshift/openshift_install.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ helm upgrade \
141141
--install \
142142
--namespace suse-observability \
143143
--values $VALUES_DIR/suse-observability-values/templates/baseConfig_values.yaml \
144-
--values $VALUES_DIR/suse-observability-values/templates/sizing_values.yaml \
144+
--values $VALUES_DIR/suse-observability-values/templates/sizing_values.yaml \
145145
--values openshift-values.yaml \
146146
--set "clickhouse.sidecars[0].securityContext.runAsUser=null" \
147147
suse-observability \
@@ -164,7 +164,7 @@ helm upgrade \
164164
--namespace suse-observability \
165165
--values local-docker-registry.yaml \
166166
--values $VALUES_DIR/suse-observability-values/templates/baseConfig_values.yaml \
167-
--values $VALUES_DIR/suse-observability-values/templates/sizing_values.yaml \
167+
--values $VALUES_DIR/suse-observability-values/templates/sizing_values.yaml \
168168
--values openshift-values.yaml \
169169
--set "clickhouse.sidecars[0].securityContext.runAsUser=null" \
170170
suse-observability \

setup/install-stackstate/kubernetes_openshift/storage.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,21 @@ stackstate:
9393
vmagent:
9494
persistence:
9595
size: 10Gi
96+
experimental:
97+
storeTransactionLogsToPVC:
98+
volumeSize: 600Mi
99+
stackpacks:
100+
pvc:
101+
size: 1Gi
102+
103+
backup:
104+
configuration:
105+
scheduled:
106+
pvc:
107+
size: 1Gi
108+
minio:
109+
persistence:
110+
size: 500Gi
96111
```
97112
{% endtab %}
98113
{% tab title="Changing volume size Non-Ha" %}
@@ -148,6 +163,23 @@ stackstate:
148163
vmagent:
149164
persistence:
150165
size: 10Gi
166+
experimental:
167+
storeTransactionLogsToPVC:
168+
volumeSize: 600Mi
169+
stackpacks:
170+
localpvc:
171+
size: 1Gi
172+
pvc:
173+
size: 1Gi
174+
175+
backup:
176+
configuration:
177+
scheduled:
178+
pvc:
179+
size: 1Gi
180+
minio:
181+
persistence:
182+
size: 500Gi
151183
```
152184
{% endtab %}
153185
{% endtabs %}

0 commit comments

Comments
 (0)