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: docs/vendor/preflight-examples.mdx
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,11 +10,11 @@ import NodeCpuSecret from "../partials/preflights/_node-cpu-secret.mdx"
10
10
11
11
# Example preflight specs
12
12
13
-
This section includes common examples of preflight check specifications. For more examples, see the [Troubleshoot example repository](https://github.com/replicatedhq/troubleshoot/tree/main/examples/preflight) in GitHub.
13
+
This section includes example preflight check specifications. For more, see the [Troubleshoot example repository](https://github.com/replicatedhq/troubleshoot/tree/main/examples/preflight) in GitHub.
14
14
15
15
## Check HTTP or HTTPS requests from the cluster
16
16
17
-
The examples below use the `http` collector and the `textAnalyze` analyzer to check that an HTTP request to the Slack API at `https://api.slack.com/methods/api.test` made from the cluster returns a successful response of `"status": 200,`.
17
+
The example below uses the `http` collector and the `textAnalyze` analyzer to check that an HTTP request to the Slack API at `https://api.slack.com/methods/api.test` made from the cluster returns a successful response of `"status": 200,`.
18
18
19
19
For more information, see [HTTP](https://troubleshoot.sh/docs/collect/http/) and [Regular Expression](https://troubleshoot.sh/docs/analyze/regex/) in the Troubleshoot documentation.
20
20
@@ -26,7 +26,7 @@ For more information, see [HTTP](https://troubleshoot.sh/docs/collect/http/) and
26
26
27
27
## Check Kubernetes version
28
28
29
-
The examples below use the `clusterVersion` analyzer to check the version of Kubernetes running in the cluster. The `clusterVersion` analyzer uses data from the default `clusterInfo` collector. The `clusterInfo` collector is automatically included.
29
+
The example below uses the `clusterVersion` analyzer to check the version of Kubernetes running in the cluster. The `clusterVersion` analyzer uses data from the default `clusterInfo` collector. The `clusterInfo` collector is automatically included.
30
30
31
31
For more information, see [Cluster Version](https://troubleshoot.sh/docs/analyze/cluster-version/) and [Cluster Info](https://troubleshoot.sh/docs/collect/cluster-info/) in the Troubleshoot documentation.
32
32
@@ -38,7 +38,7 @@ For more information, see [Cluster Version](https://troubleshoot.sh/docs/analyze
38
38
39
39
## Check Kubernetes distribution
40
40
41
-
The examples below use the `distribution` analyzer to check the Kubernetes distribution of the cluster. The `distribution` analyzer uses data from the default `clusterInfo` collector. The `clusterInfo` collector is automatically included.
41
+
The example below uses the `distribution` analyzer to check the Kubernetes distribution of the cluster. The `distribution` analyzer uses data from the default `clusterInfo` collector. The `clusterInfo` collector is automatically included.
42
42
43
43
For more information, see [Cluster Info](https://troubleshoot.sh/docs/collect/cluster-info/) and [Distribution](https://troubleshoot.sh/docs/analyze/distribution/) in the Troubleshoot documentation.
44
44
@@ -50,7 +50,7 @@ For more information, see [Cluster Info](https://troubleshoot.sh/docs/collect/cl
50
50
51
51
## Check MySQL version using template functions
52
52
53
-
The examples below use the `mysql` collector and the `mysql` analyzer to check the version of MySQL running in the cluster.
53
+
The example below uses the `mysql` collector and the `mysql` analyzer to check the version of MySQL running in the cluster.
54
54
55
55
For more information, see [Collect > MySQL](https://troubleshoot.sh/docs/collect/mysql/) and [Analyze > MySQL](https://troubleshoot.sh/docs/analyze/mysql/) in the Troubleshoot documentation.
56
56
@@ -62,7 +62,7 @@ For more information about using Helm template functions to access values from t
62
62
63
63
## Check node memory
64
64
65
-
The examples below use the `nodeResources` analyzer to check that nodes in the cluster meet memory requirements. The `nodeResources` analyzer uses data from the default `clusterResources` collector. The `clusterResources` collector is automatically included.
65
+
The example below uses the `nodeResources` analyzer to check that nodes in the cluster meet memory requirements. The `nodeResources` analyzer uses data from the default `clusterResources` collector. The `clusterResources` collector is automatically included.
66
66
67
67
For more information, see [Cluster Resources](https://troubleshoot.sh/docs/collect/cluster-resources/) and [Node Resources](https://troubleshoot.sh/docs/analyze/node-resources/) in the Troubleshoot documentation.
68
68
@@ -74,7 +74,7 @@ For more information, see [Cluster Resources](https://troubleshoot.sh/docs/colle
74
74
75
75
## Check node storage class availability
76
76
77
-
The examples below use the `storageClass` analyzer to check that a required storage class is available in the nodes in the cluster. The `storageClass` analyzer uses data from the default `clusterResources` collector. The `clusterResources` collector is automatically included.
77
+
The example below uses the `storageClass` analyzer to check that a required storage class is available in the nodes in the cluster. The `storageClass` analyzer uses data from the default `clusterResources` collector. The `clusterResources` collector is automatically included.
78
78
79
79
For more information, see [Cluster Resources](https://troubleshoot.sh/docs/collect/cluster-resources/) and [Node Resources](https://troubleshoot.sh/docs/analyze/node-resources/) in the Troubleshoot documentation.
80
80
@@ -86,7 +86,7 @@ For more information, see [Cluster Resources](https://troubleshoot.sh/docs/colle
86
86
87
87
## Check node ephemeral storage
88
88
89
-
The examples below use the `nodeResources` analyzer to check the ephemeral storage available in the nodes in the cluster. The `nodeResources` analyzer uses data from the default `clusterResources` collector. The `clusterResources` collector is automatically included.
89
+
The example below uses the `nodeResources` analyzer to check the ephemeral storage available in the nodes in the cluster. The `nodeResources` analyzer uses data from the default `clusterResources` collector. The `clusterResources` collector is automatically included.
90
90
91
91
For more information, see [Cluster Resources](https://troubleshoot.sh/docs/collect/cluster-resources/) and [Node Resources](https://troubleshoot.sh/docs/analyze/node-resources/) in the Troubleshoot documentation.
92
92
@@ -98,7 +98,7 @@ For more information, see [Cluster Resources](https://troubleshoot.sh/docs/colle
98
98
99
99
## Check requirements are met by at least one node
100
100
101
-
The examples below use the `nodeResources` analyzer with filters to check that the requirements for memory, CPU cores, and architecture are met by at least one node in the cluster. The `nodeResources` analyzer uses data from the default `clusterResources` collector. The `clusterResources` collector is automatically included.
101
+
The example below uses the `nodeResources` analyzer with filters to check that the requirements for memory, CPU cores, and architecture are met by at least one node in the cluster. The `nodeResources` analyzer uses data from the default `clusterResources` collector. The `clusterResources` collector is automatically included.
102
102
103
103
For more information, see [Cluster Resources](https://troubleshoot.sh/docs/collect/cluster-resources/) and [Node Resources](https://troubleshoot.sh/docs/analyze/node-resources/) in the Troubleshoot documentation.
104
104
@@ -110,7 +110,7 @@ For more information, see [Cluster Resources](https://troubleshoot.sh/docs/colle
110
110
111
111
## Check total cpu cores across nodes
112
112
113
-
The examples below use the `nodeResources` analyzer to check total CPU cores across nodes in the cluster. The `nodeResources` analyzer uses data from the default `clusterResources` collector. The `clusterResources` collector is automatically included.
113
+
The example below uses the `nodeResources` analyzer to check total CPU cores across nodes in the cluster. The `nodeResources` analyzer uses data from the default `clusterResources` collector. The `clusterResources` collector is automatically included.
114
114
115
115
For more information, see [Cluster Resources](https://troubleshoot.sh/docs/collect/cluster-resources/) and [Node Resources](https://troubleshoot.sh/docs/analyze/node-resources/) in the Troubleshoot documentation.
Copy file name to clipboardExpand all lines: docs/vendor/support-bundle-examples.mdx
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ import RunPodsSecret from "../partials/support-bundles/_run-pods-secret.mdx"
10
10
11
11
# Example support bundle specs
12
12
13
-
This topic includes common examples of support bundle specifications. For more examples, see the [Troubleshoot example repository](https://github.com/replicatedhq/troubleshoot/tree/main/examples/support-bundle) in GitHub.
13
+
This topic includes example support bundle specifications. For more, see the [Troubleshoot example repository](https://github.com/replicatedhq/troubleshoot/tree/main/examples/support-bundle) in GitHub.
14
14
15
15
## Check application health
16
16
@@ -30,65 +30,65 @@ For more information, see [Deployment Status](https://troubleshoot.sh/docs/analy
30
30
31
31
If your application has its own API that serves status, metrics, performance data, and so on, this information can be collected and analyzed.
32
32
33
-
The examples below use the `http` collector and the `textAnalyze` analyzer to check that an HTTP request to the Slack API at `https://api.slack.com/methods/api.test` made from the cluster returns a successful response of `"status": 200,`.
33
+
The example below uses the `http` collector and the `textAnalyze` analyzer to check that an HTTP request to the Slack API at `https://api.slack.com/methods/api.test` made from the cluster returns a successful response of `"status": 200,`.
34
34
35
35
For more information, see [HTTP](https://troubleshoot.sh/docs/collect/http/) and [Regular Expression](https://troubleshoot.sh/docs/analyze/regex/) in the Troubleshoot documentation.
36
36
37
37
<HttpSecret/>
38
38
39
39
## Check Kubernetes version
40
40
41
-
The examples below use the `clusterVersion` analyzer to check the version of Kubernetes running in the cluster. The `clusterVersion` analyzer uses data from the default `clusterInfo` collector.
41
+
The example below uses the `clusterVersion` analyzer to check the version of Kubernetes running in the cluster. The `clusterVersion` analyzer uses data from the default `clusterInfo` collector.
42
42
43
43
For more information, see [Cluster Version](https://troubleshoot.sh/docs/analyze/cluster-version/) and [Cluster Info](https://troubleshoot.sh/docs/collect/cluster-info/) in the Troubleshoot documentation.
44
44
45
45
<K8sVersionSecret/>
46
46
47
47
## Check node resources
48
48
49
-
The examples below use the `nodeResources` analyzer to check that the minimum requirements are met for memory, CPU cores, number of nodes, and ephemeral storage. The `nodeResources` analyzer uses data from the default `clusterResources` collector.
49
+
The example below uses the `nodeResources` analyzer to check that the minimum requirements are met for memory, CPU cores, number of nodes, and ephemeral storage. The `nodeResources` analyzer uses data from the default `clusterResources` collector.
50
50
51
51
For more information, see [Cluster Resources](https://troubleshoot.sh/docs/collect/cluster-resources/) and [Node Resources](https://troubleshoot.sh/docs/analyze/node-resources/) in the Troubleshoot documentation.
52
52
53
53
<NodeResourcesSecret/>
54
54
55
55
## Check node status
56
56
57
-
The following examples use the `nodeResources`analyzers to check the status of the nodes in the cluster. The `nodeResources` analyzer uses data from the default `clusterResources` collector.
57
+
The following example uses the `nodeResources`analyzer to check the status of the nodes in the cluster. The `nodeResources` analyzer uses data from the default `clusterResources` collector.
58
58
59
59
For more information, see [Node Resources](https://troubleshoot.sh/docs/analyze/node-resources/) and [Cluster Resources](https://troubleshoot.sh/docs/collect/cluster-resources/) in the Troubleshoot documentation.
60
60
61
61
<NodeStatusSecret/>
62
62
63
63
## Collect logs using multiple selectors
64
64
65
-
The examples below use the `logs` collector to collect logs from various Pods where application workloads are running. They also use the `textAnalyze` collector to analyze the logs for a known error.
65
+
The example below uses the `logs` collector to collect logs from various Pods where application workloads are running. It also uses the `textAnalyze` collector to analyze the logs for a known error.
66
66
67
67
For more information, see [Pod Logs](https://troubleshoot.sh/docs/collect/logs/) and [Regular Expression](https://troubleshoot.sh/docs/analyze/regex/) in the Troubleshoot documentation.
68
68
69
-
You can use the `selector` attribute of the `logs` collector to find Pods that have the specified labels. Depending on the complexity of an application's labeling schema, you might need a few different declarations of the logs collector, as shown in the examples below. You can include the `logs` collector as many times as needed.
69
+
You can use the `selector` attribute of the `logs` collector to find Pods that have the specified labels. Depending on the complexity of an application's labeling schema, you might need a few different declarations of the logs collector, as shown in this example. You can include the `logs` collector as many times as needed.
70
70
71
71
<LogsSelectorsSecret/>
72
72
73
73
## Collect logs using `limits`
74
74
75
-
The examples below use the `logs` collector to collect Pod logs from the Pod where the application is running. These specifications use the `limits` field to set a `maxAge` and `maxLines` to limit the output provided.
75
+
The example below uses the `logs` collector to collect Pod logs from the Pod where the application is running. This specification uses the `limits` field to set a `maxAge` and `maxLines` to limit the output provided.
76
76
77
77
For more information, see [Pod Logs](https://troubleshoot.sh/docs/collect/logs/) in the Troubleshoot documentation.
78
78
79
79
<LogsLimitsSecret/>
80
80
81
81
## Collect Redis and MySQL server information
82
82
83
-
The following examples use the `redis` and `mysql` collectors to collect information about Redis and MySQL servers running in the cluster.
83
+
The following example uses the `redis` and `mysql` collectors to collect information about Redis and MySQL servers running in the cluster.
84
84
85
85
For more information, see [Redis](https://troubleshoot.sh/docs/collect/redis/) and [MySQL](https://troubleshoot.sh/docs/collect/mysql/) in the Troubleshoot documentation.
86
86
87
87
<RedisMysqlSecret/>
88
88
89
89
## Run and analyze a pod
90
90
91
-
The examples below use the `textAnalyze` analyzer to check that a command successfully executes in a Pod running in the cluster. The Pod specification is defined in the `runPod` collector.
91
+
The example below uses the `textAnalyze` analyzer to check that a command successfully executes in a Pod running in the cluster. The Pod specification is defined in the `runPod` collector.
92
92
93
93
For more information, see [Run Pods](https://troubleshoot.sh/docs/collect/run-pod/) and [Regular Expression](https://troubleshoot.sh/docs/analyze/regex/) in the Troubleshoot documentation.
0 commit comments