apm-sizing-tool

KO | EN

gitlite — search

#hacktoberfest #ai #typescript #llm #machine-learning #deep-learning #docker #nodejs #awesome-list #security #mcp #ios #openai #open-source

apm-sizing-tool

(★ 1)

Pre-sales sizing tool for Synology ActiveProtect appliances — estimates node count, storage, and remote tiering capacity from a workload inventory.

apm-sizing-tool 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ActiveProtect Sizing Advisor

[![CI](https://github.com/synology-apm/apm-sizing-tool/actions/workflows/ci.yml/badge.svg)](https://github.com/synology-apm/apm-sizing-tool/actions/workflows/ci.yml)
[![Pages](https://img.shields.io/github/deployments/synology-apm/apm-sizing-tool/github-pages?label=pages)](https://synology-apm.github.io/apm-sizing-tool/)

Pre-sales sizing tool for Synology ActiveProtect appliances. Estimates appliance node count, local storage, and remote tiering capacity from a workload inventory with per-entry retention, growth, and change-rate policies.

**Live tool: <https://synology-apm.github.io/apm-sizing-tool/>**

## Getting started

The tool ships as a **single self-contained HTML file** — no server, no install, no data leaves the browser.

- **Online:** open <https://synology-apm.github.io/apm-sizing-tool/>.
- **Offline:** download the zip from the [latest release](https://github.com/synology-apm/apm-sizing-tool/releases), unzip it, and double-click `ActiveProtectSizingAdvisor.html` (works over `file://`). Keep `lang.js` beside the HTML for non-English languages; without it the tool runs in English only.

## AI assistant integration

The sizing logic is also packaged as a **skill/plugin** — install once and ask the assistant directly to size a scenario without opening the browser tool.

### Claude Desktop (Cowork)

**Prerequisite:** the Claude desktop app.

1. Open **Customize → Plugins → Add marketplace → Add from a repository**, and enter the URL `synology-apm/apm-sizing-tool`.
2. In **Plugins → Personal**, find **ActiveProtect Sizing Advisor** and click **+** to install.

### ChatGPT Desktop (Work)

**Prerequisite:** the ChatGPT desktop app.

1. Open **Plugins → Add marketplace**, and enter `synology-apm/apm-sizing-tool` as the source.
2. In **Plugins → Personal**, find **apm-sizing** and click **Install**.

Once installed, the skill activates automatically when you ask sizing questions. For example:

> "Size a workload with 150 VMs and 20 SQL databases, 90-day retention, 5-year forecast."

The assistant will compute recommended node count, throughput, local storage, and remote tiering — using the same formulas as the web tool.

## Features

- **Workload inventory** — describe your environment as rows of workloads. Each row carries its own policy: device/instance count, per-unit capacity, retention days, daily change rate, annual growth, and deduplication savings. Eight workload categories (endpoints, VMs, physical servers, file servers, databases, Microsoft 365 users, SharePoint/Teams sites, custom) seed benchmark-derived defaults, and quick-start presets (Small Business / MSP, Mid-size Enterprise, Microsoft 365) fill a complete scenario in one click.
- **Growth forecast** — projects total protected capacity over a 1–10 year horizon and charts it per workload.
- **Backup window analysis** — turns your daily backup window into the required throughput (MB/s) and storage footprint.
- **Appliance recommendations** — a baseline table across the ActiveProtect lineup (DP320, DP340, DP5200, DP7200, DP7400) showing per-model node counts, whether throughput or storage is the bottleneck, and the license packs required.
- **Remote tiering estimate** — splits retention between local (hot) storage and a remote cold tier, and sizes both, including the remote-to-local capacity ratio. Note that cold-tier recovery points cannot be recalled to local storage and do not support instant mount.
- **Share & print** — a share link encodes the entire scenario in the URL for handoff, and the report is print-friendly.
- **19 UI languages**, light/dark themes, WCAG 2.1 AA accessibility, and full offline operation.

## How it works

All sizing runs client-side as a pure compute pipeline — inputs are parsed, sized, and rendered entirely in your browser; nothing is uploaded anywhere. Results are estimates derived from benchmark assumptions and are meant to start a sizing conversation, not end one.

## Development

Requires Node ≥ 20 (CI uses 22).

```sh
npm ci                                        # one-time setup
make test                                     # quality gate: typecheck → unit tests + coverage → i18n
make build                                    # produce dist/ (single HTML + lang.js)
make test-dist                                # build, then verify the dist contract (no browser needed)
npx playwright install --with-deps chromium   # one-time, before E2E only (large download)
make e2e                                      # build → dist contract tests → Playwright E2E over file://
```

Dev loop: `npm run dev` (esbuild watch), open `dist/ActiveProtectSizingAdvisor.html` directly in a browser, edit `src/`, refresh.

`src/` is the only source of truth — `dist/` is generated and never committed; every shipped byte comes from `make build`.

### Project structure

```
src/            TypeScript app modules, index.html, styles.css
  compute.ts    sizing math (DOM-free, typechecked under tsconfig.pure.json)
  config.ts     appliance models, workload categories, presets
  i18n-core.ts  English dictionary + t()/tp() (source of truth for strings)
  lang.js       additional language dictionaries (plain JS, loaded optionally)
tests/
  unit/         vitest suites (happy-dom, fast-check) with coverage thresholds
  dist/         contract tests against the built file (structure + goldens)
  e2e/          Playwright smoke tests against the built file over file://
  fixtures/     golden sizing scenarios and frozen share-link artifacts
scripts/
  build.mjs     esbuild bundler → dist/ActiveProtectSizingAdvisor.html
```

The built file is two inline script bundles (i18n core, then the app) plus an optional external `lang.js`; a missing `lang.js` degrades gracefully to English.

### Testing

- `make test` — the browser-free quality gate: strict TypeScript typecheck (app + pure configs), unit tests with pinned coverage thresholds, and an i18n consistency check (key parity and placeholder matching across all dictionaries). Source-only: it never reads `dist/`.
- `make test-dist` — builds, then verifies the shipped-file contract (bundle structure and golden sizing numbers) against the fresh `dist/`; fails hard rather than skipping if the build is missing.
- `make e2e` — `make test-dist`, then Playwright end-to-end over `file://`.

## Disclaimer

Sizing results are pre-sales estimates based on lab benchmark assumptions. Actual requirements depend on your data profile, network, and configuration — validate final configurations with Synology before purchase.

## License

apm-sizing-tool

apm-sizing-tool 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

apm-sizing-tool

apm-sizing-tool 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README