mirror of
https://hubproxy.babadafafafafa.cn/https://github.com/1Panel-dev/1Panel.git
synced 2026-09-20 08:03:55 +08:00
2a2e6607b8
* feat: support dynamic module build for OpenResty * feat: add dynamic module build page for OpenResty * refactor: drop auto fallback, gate dynamic build by version support - remove auto-to-static fallback; dynamic build failure now reports the error and hints switching to static build manually - gate dynamic builds on module support files (Dockerfile.modules + module.catalog.json) instead of version numbers, expose dynamicSupported in the modules API - collect repeated path/status/operate strings into constants - move nginx module regex patterns into utils/re with semantic helpers - reorganize nginx_module.go around the main build flows and inline single-use thin helpers * feat: limit nginx module build mode options by version support - build mode radio offers only dynamic and static (auto maps to dynamic for legacy data) - disable the dynamic option with a hint when the installed OpenResty version lacks dynamic build support * feat: complete i18n for nginx module pages Fill in the new nginx module keys for all eleven language files (translations other than zh/en are draft machine translations). * feat: probe dynamic module support on load and drop the auto build mode - probe each non-static module's configure params when loading the module list and report dynamicSupport=supported/unsupported up front - normalize the legacy auto build mode to dynamic * feat: clarify module build modes in the UI - build drawer lists dynamic modules (tagged, hot-reload) and static modules (tagged, full rebuild + container restart) separately - disable the dynamic option per module when its params do not support dynamic build, distinct from the version gate hint - drop the auto build mode wording everywhere and sync all eleven language files * feat: clarify purpose of the nginx module build drawer - add a purpose hint explaining dynamic (hot reload) vs static (full rebuild + container restart) - drop the per-module mode tags now that section headers carry the semantics - allow submitting with zero dynamic modules selected when static modules are present, so static-only users can trigger a build * feat: pass apt mirror through to dynamic module builds The mirror selected in the build dialog (or CONTAINER_PACKAGE_URL in the app env as fallback) is now forwarded as a build arg so the module builder uses the same apt source as the static build path. test-builder gains a --mirror option. * feat: add Lao translations for nginx module pages
172 lines
6.2 KiB
Markdown
172 lines
6.2 KiB
Markdown
# OpenResty Dynamic Module Linux Tests
|
|
|
|
These scripts test the local dynamic-module build path and collect diagnostics
|
|
from an installed 1Panel OpenResty instance. Run them on a disposable Linux
|
|
host with Docker access before testing on a production installation.
|
|
|
|
## Requirements
|
|
|
|
- Bash 4.3 or newer
|
|
- Docker Engine with the Compose v2 plugin
|
|
- `jq`, `python3`, `file`, `binutils`, `tar`, and GNU coreutils
|
|
- Internet access for runtime images and Ubuntu build packages
|
|
- Go, only when `--source-checks` is used
|
|
|
|
On Debian or Ubuntu:
|
|
|
|
```bash
|
|
sudo apt-get update
|
|
sudo apt-get install -y jq python3 file binutils tar
|
|
```
|
|
|
|
Make the scripts executable:
|
|
|
|
```bash
|
|
chmod +x scripts/openresty-modules/*.sh
|
|
```
|
|
|
|
## Builder Test
|
|
|
|
Start with one version and one small module:
|
|
|
|
```bash
|
|
./scripts/openresty-modules/test-builder.sh \
|
|
--appstore ../appstore \
|
|
--versions 1.31.1.1-0-noble \
|
|
--modules ngx_brotli \
|
|
--source-checks
|
|
```
|
|
|
|
Test every catalog module against all refactored OpenResty versions:
|
|
|
|
```bash
|
|
./scripts/openresty-modules/test-builder.sh --appstore ../appstore
|
|
```
|
|
|
|
Bypass Docker's module build cache when reproducing a compiler problem:
|
|
|
|
```bash
|
|
./scripts/openresty-modules/test-builder.sh \
|
|
--appstore ../appstore \
|
|
--versions 1.31.1.1-0-noble \
|
|
--modules geoip2 \
|
|
--no-cache \
|
|
--keep-context \
|
|
--keep-docker
|
|
```
|
|
|
|
The builder test performs these phases for every selected version:
|
|
|
|
1. Validate appstore JSON, shell scripts, Compose mounts, and Nginx include.
|
|
2. Pull and identify the exact target runtime image.
|
|
3. Convert catalog options to dynamic configure options.
|
|
4. Build every module with `Dockerfile.modules` and copy `/out` locally.
|
|
5. Record SHA-256, ELF metadata, compiler output, and runtime dependencies.
|
|
6. Validate individual modules for debugging. Individual failures are warnings
|
|
by default because modules may depend on an earlier module.
|
|
7. Validate all modules together in catalog `loadOrder`.
|
|
8. Start an isolated OpenResty master, add module configs, and hot reload.
|
|
9. Inject a missing module, prove `nginx -t` rejects it, restore the config,
|
|
and prove the running process remains healthy.
|
|
|
|
Use `--strict-individual` when every selected module is expected to load alone.
|
|
|
|
Use `--mirror URL` (environment variable `MIRROR`) to pass an apt mirror as
|
|
`CONTAINER_PACKAGE_URL` to module builds, matching the 1Panel module build.
|
|
|
|
Results are written to:
|
|
|
|
```text
|
|
openresty-module-test-results/<run-id>/
|
|
```
|
|
|
|
Important files:
|
|
|
|
- `summary.tsv`: result per OpenResty version
|
|
- `work/<version>/logs/build-*.log`: complete BuildKit output
|
|
- `work/<version>/logs/load-combined.log`: authoritative ABI/load-order test
|
|
- `work/<version>/artifacts.tsv`: module paths, checksums, and sizes
|
|
- `work/<version>/image-inspect.json`: exact target image identity
|
|
- `work/<version>/runtime/`: reload and rollback test logs
|
|
- `<result-dir>.tar.gz`: automatically created when an unexpected failure occurs
|
|
|
|
## Installed Instance Diagnostics
|
|
|
|
Find the OpenResty installation directory first. A common path is similar to:
|
|
|
|
```text
|
|
/opt/1panel/apps/openresty/openresty
|
|
```
|
|
|
|
Run the diagnostic collector:
|
|
|
|
```bash
|
|
./scripts/openresty-modules/diagnose-install.sh \
|
|
/opt/1panel/apps/openresty/openresty
|
|
```
|
|
|
|
Override container discovery when needed:
|
|
|
|
```bash
|
|
./scripts/openresty-modules/diagnose-install.sh \
|
|
/opt/1panel/apps/openresty/openresty \
|
|
--container 1Panel-openresty
|
|
```
|
|
|
|
The collector checks:
|
|
|
|
- `module.json` artifact paths and SHA-256 checksums
|
|
- managed `load_module` files and host/container path mapping
|
|
- read-only Compose mounts
|
|
- current container image ID versus enabled module target image IDs
|
|
- container state, Nginx build options, `nginx -t`, loaded module directives,
|
|
module checksums inside the container, `ldd`, and recent logs
|
|
|
|
The default report does not retain full `nginx -T` output. Use
|
|
`--full-config` only on a test host because the resulting archive may contain
|
|
credentials or private site configuration.
|
|
|
|
Module scripts are redacted from the copied state files by default. Container
|
|
logs and error strings can still contain site names, URLs, or command output;
|
|
review an archive before sharing it outside your team.
|
|
|
|
## Final Manual Matrix
|
|
|
|
Run this matrix through the 1Panel UI on a disposable installation. Collect a
|
|
diagnostic archive after each important transition.
|
|
|
|
1. Install the oldest selected OpenResty version with every module disabled.
|
|
2. Switch one module to `auto`, enable it, and build it locally.
|
|
3. Confirm `buildStatus=ready`, `compatibility=compatible`, and `nginx -t`.
|
|
4. Force rebuild it. Confirm the artifact path changes and the old config is
|
|
replaced only after the new artifact passes validation.
|
|
5. Enable all catalog modules and verify catalog load order with the builder
|
|
test and the installed-instance collector.
|
|
6. On the test host, make one module script return a failure. Confirm the old
|
|
managed config and old ready artifact remain active.
|
|
7. Restore the module definition and rebuild successfully.
|
|
8. Upgrade OpenResty. Confirm every enabled dynamic module has a ready build
|
|
whose target image ID matches the new running container.
|
|
9. Restart the container and host. Run the diagnostic collector again to prove
|
|
the persisted mounts and configs remain valid.
|
|
10. Switch a module to `static`, rebuild, then switch it back to `dynamic` and
|
|
verify that all enabled dynamic modules are regenerated for the new image.
|
|
|
|
## Failure Triage
|
|
|
|
| Symptom | First evidence to inspect |
|
|
| --- | --- |
|
|
| Docker build fails | `logs/build-<module>.log`, `inputs/<module>/` |
|
|
| `.so` missing | build log and the `module-output` stage `/out` checks |
|
|
| Individual load fails, combined passes | module dependency and `loadOrder` |
|
|
| Combined load fails | ABI mismatch, duplicate module, missing shared library |
|
|
| `ldd` shows `not found` | bundled `lib/`, RPATH, or future runtime packages |
|
|
| Checksum mismatch | interrupted copy, manual modification, stale state file |
|
|
| Target image mismatch | module was not rebuilt after image upgrade/rebuild |
|
|
| Builder passes, installed `nginx -t` fails | Compose mounts or managed config |
|
|
| Reload fails but old process runs | inspect rollback logs and old config snapshot |
|
|
|
|
Do not edit generated module state or managed config files while a 1Panel app
|
|
task is running. Preserve the result directory and archive before retrying a
|
|
failed build.
|