Skip to content

Commit 870723d

Browse files
travisamartintravisamartin
authored
Added Support topics and removed mentions of NMS from config topics (#38)
### Proposed changes This PR makes the following changes: - Adds Support topics: - Create a support package - Create a support package from a Helm installation - Where to go for support - Replaces mentions of NGINX Management Suite with NGINX Instance Manager
2 parents df71cde + a97e15a commit 870723d

File tree

10 files changed

+650
-227
lines changed

10 files changed

+650
-227
lines changed

‎content/nim/support/_index.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "Support"
3+
description: "How to get Support for F5 NGINX Management Suite"
4+
weight: 999
5+
url: /nginx-instance-manager/support/
6+
---

‎content/nim/support/contact-support.md‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
---
2+
docs: DOCS-817
3+
doctypes:
4+
- concept
5+
tags:
6+
- docs
7+
title: Where to go for support
8+
toc: true
9+
weight: 300
10+
---
11+
12+
## Support policy
13+
14+
F5 NGINX Instance Manager follows the support policy detailed in the knowledge base article: [K000140156](https://my.f5.com/manage/s/article/K000140156).
15+
16+
{{<important>}}
17+
Support licenses for NGINX Instance Manager **do not include** support for the NGINX instances being managed.
18+
19+
Community support is available for NGINX Open Source instances on the [NGINX mailing list](http://mailman.nginx.org/mailman/listinfo). If you need support for NGINX Plus or [prebuilt NGINX Open Source packages](https://nginx.org/en/linux_packages.html), you must [purchase an NGINX license](https://www.nginx.com/purchase-nginx/).
20+
{{</important>}}
21+
22+
---
23+
24+
## Contact NGINX support
25+
26+
For help with installing, troubleshooting, or using the NGINX Instance Manager, contact support through the [MyF5 Customer Portal](https://account.f5.com/myf5).
27+
28+
---
29+
30+
## Support script
31+
32+
The Support team might ask you to run one or both of the following scripts to troubleshoot issues. Attach the script outputs to your support case.
33+
34+
- `/usr/share/nginx-manager` – for troubleshooting issues with the NGINX Instance Manager host.
35+
- `/usr/share/nginx-agent` – for troubleshooting issues with a data plane instance running the NGINX Agent.
36+
37+
### Run the support script on the NGINX Instance Manager host
38+
39+
1. Open an SSH connection to the NGINX Instance Manager host and log in.
40+
2. Run the following command:
41+
42+
```bash
43+
/usr/share/nginx-manager/support.sh
44+
```
45+
46+
### Run the script on a data plane instance
47+
48+
1. Open an SSH connection to the data plane instance and log in.
49+
2. Run the following command:
50+
51+
```bash
52+
/usr/share/nginx-agent/support.sh
53+
```
54+
55+
### Collected information
56+
57+
The scripts collect the following information:
58+
59+
- System details (`/etc/os-release`).
60+
- Checks for installed NGINX, NGINX Instance Manager, and NGINX Agent instances.
61+
- NGINX data:
62+
- `nginx -T` (current configuration).
63+
- `nginx -V` (version and runtime details).
64+
- `/var/log/nginx/*` (log files).
65+
- NGINX Instance Manager log files:
66+
- `/var/log/nginx-manager/*`
67+
- API queries from NGINX Instance Manager:
68+
- `GET /api/v0/instances`
69+
- `GET /api/v0/scan`
70+
- `GET /api/v0/about/system`
71+
- `GET /api/v0/about/license`
72+
- NGINX Agent log files:
73+
- `/var/log/nginx-agent/*`
74+
75+
### Output file
76+
77+
The script creates a file in the `/tmp` directory, such as `/tmp/nginx-manager-log.tar.gz`. Review the file and **remove confidential information** before sharing it with F5.
78+
79+
For example, if your `/etc/nginx-manager` directory contains private keys or certificates, remove them using:
80+
81+
```bash
82+
gzip -d /tmp/nginx-manager-log.tar.gz
83+
84+
tar -f /tmp/nginx-manager-log.tar.gz \
85+
--delete /etc/nginx-manager/example.key \
86+
--delete /etc/nginx-manager/example.crt
87+
88+
gzip -9 /tmp/nginx-manager-log.tar.gz
89+
```
90+
91+
{{<note>}}Files shared with F5 are protected under the [F5 Support and Maintenance Privacy Statement](https://www.f5.com/company/policies/support-and-maintenance-privacy-statement).{{</note>}}
92+
93+
---
94+
95+
## Additional resources
96+
97+
### AskF5 knowledge base
98+
99+
Find solutions to common issues and corner cases on [AskF5](https://support.f5.com/csp/knowledge-center/software/NGINX?module=NGINX%20Instance%20Manager).
100+
101+
### NGINX training and professional services
102+
103+
Get expert guidance and hands-on support from [NGINX Professional Services](https://www.nginx.com/services/#package_detail_section).

‎content/nim/support/k8s-support-package.md‎

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
---
2+
docs: DOCS-1123
3+
doctypes:
4+
- reference
5+
- task
6+
tags:
7+
- docs
8+
title: Create a support package from a Helm installation
9+
toc: true
10+
weight: 200
11+
---
12+
13+
{{< include "/nim/decoupling/note-legacy-nms-references.md" >}}
14+
15+
## Overview
16+
17+
Use the Kubernetes support package script to collect system and service information for troubleshooting and debugging. The script packages the data into a tar archive that you can share with [NGINX Customer Support]({{< relref "nim/support/contact-support.md" >}}).
18+
19+
---
20+
21+
## Before you begin
22+
23+
To follow this guide, ensure you have:
24+
25+
- `bash` 4.0 or higher.
26+
27+
---
28+
29+
## Usage
30+
31+
The F5 NGINX Instance Manager Helm chart includes the `k8s-support-package.sh` script located at:
32+
33+
- `/support-package/k8s-support-package.sh`.
34+
35+
### Steps to create a support package
36+
37+
1. Download the latest NGINX Instance Manager Helm chart:
38+
39+
```bash
40+
helm repo add nginx-stable https://helm.nginx.com/stable
41+
helm repo update
42+
helm pull nginx-stable/nms
43+
tar zxvf nms-<version>.tgz
44+
```
45+
46+
2. Run the Kubernetes support package script. For available options, refer to the [arguments](#arguments) section:
47+
48+
```bash
49+
bash ./nms/charts/nms-hybrid/support-package/k8s-support-package.sh
50+
```
51+
52+
The support package is saved in the directory where the script is run.
53+
54+
3. Extract the package using the `tar` command:
55+
56+
```bash
57+
tar -xvf k8s-support-pkg-<timestamp>.tar.gz
58+
```
59+
60+
---
61+
62+
## Arguments
63+
64+
The table below lists arguments available for the Kubernetes support package script.
65+
66+
| Short | Long | Description | Example | Default |
67+
|-------|------------------------|------------------------------------------------------------|---------------|----------|
68+
| `-h` | `--help` | Prints information about the script arguments to `stdout`. | `--help` | N/A |
69+
| `-o` | `--output_dir` | Specifies the output directory for the tar archive. | `-o ~/output` | `$(pwd)` |
70+
| `-n` | `--namespace` | Specifies the namespace of the Helm installation. | `-n nms` | `<none>` |
71+
| `-xd` | `--exclude_databases` | Excludes Dqlite database backup data. | `-xd` | `False` |
72+
| `-xt` | `--exclude_timeseries` | Excludes ClickHouse time series data. | `-xt` | `False` |
73+
| `-m` | `--modules` | Includes specific modules in Dqlite database backup data. | `-m acm` | `False` |
74+
75+
---
76+
77+
## Package contents
78+
79+
The Kubernetes support package includes directories with detailed information about your cluster, namespace, application, and database state.
80+
81+
### k8s-support-package.log
82+
83+
A log of all output generated by the `k8s-support-package.sh` script.
84+
85+
### chart-files
86+
87+
A snapshot of the Helm chart files in the parent directory, excluding the directory where the script runs.
88+
89+
### version-info
90+
91+
Versions of:
92+
93+
- Helm chart
94+
- `kubectl` tool
95+
- `helm` tool
96+
- NGINX gateway
97+
- ClickHouse
98+
99+
### cluster-info
100+
101+
Cluster-related data, including:
102+
103+
- Cluster details
104+
- Node information
105+
- Storage class configurations
106+
107+
### namespace-info
108+
109+
Namespace-specific details, including:
110+
111+
- General namespace data
112+
- Events
113+
- API version
114+
- API services and resources
115+
116+
### app-info
117+
118+
Application-related information for NGINX Instance Manager:
119+
120+
- Deployments
121+
- Services
122+
- Persistent Volumes and Claims
123+
- Secrets and Configmaps
124+
- Pods
125+
126+
### pod-logs
127+
128+
Logs of processes for NGINX Instance Manager, NGINX gateway, and ClickHouse. Files in this directory follow the naming convention: `pod_name-<timestamp>.logs`.
129+
130+
### pod-system-info
131+
132+
Status and state details for each pod, including:
133+
134+
- Operating system version
135+
- Environment variables
136+
- Running processes
137+
138+
### dqlite
139+
140+
The script uses the `dqlite-backup` executable (located in `/etc/nms/scripts/` within relevant containers) to collect database dumps. Data is saved in:
141+
142+
- `dqlite/core`
143+
- `dqlite/dpm`
144+
- `dqlite/integrations`
145+
146+
If the `--modules` flag is specified, data is saved to `dqlite/<moduleName>`.
147+
148+
### timeseries
149+
150+
Contains metrics, events, and statistics from the `nms` ClickHouse database.

0 commit comments

Comments
 (0)