Skip to content

Support ScaleType for Storage Pools and ONTAP mode pools #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gnaveen-netapp wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Support ScaleType for Storage Pools and ONTAP mode pools #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions GEMINI.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,17 +120,26 @@ Notes:
- Users often type `flex` in lowercase; the server accepts `serviceLevel` case-insensitively for pool creation (for example `flex` or `FLEX`).
- Minimum storage pool capacity (this project’s guidance):
- `FLEX`:
- `FILE` / `UNIFIED`: **1024 GiB**
- `UNIFIED_LARGE_CAPACITY`: **6 TiB (6144 GiB)**
- `FILE` / `UNIFIED` (default scale): **1024 GiB**
- `UNIFIED` (large capacity): **6 TiB (6144 GiB)**
- `STANDARD`, `PREMIUM`, `EXTREME`: **2048 GiB**
- Flex custom performance: users can optionally provide `totalThroughputMibps` (MiBps) when creating a **FLEX** pool. This is only supported in select regions; if the API rejects it, suggest using default performance or a supported region/zone.
- Manual QoS: `qosType` can be `AUTO` or `MANUAL` for storage pools. Manual QoS is supported for Standard/Premium/Extreme and **isn't available for Flex**. See the Google Cloud docs: `https://docs.cloud.google.com/netapp/volumes/docs/performance/optimize-performance#set_up_manual_qos_limits`.
- FLEX location rules:
- If `location` is a **zone** (e.g. `us-central1-a`), that satisfies “zone in location” for FLEX pool creation and the request body should omit `zone`/`replicaZone`.
- If `location` is a **region** (e.g. `us-central1`), FLEX pool creation requires both `zone` and `replicaZone`.
- StoragePoolType:
- Users can optionally provide `storagePoolType` (`FILE`, `UNIFIED`, `UNIFIED_LARGE_CAPACITY`).
- `UNIFIED` and `UNIFIED_LARGE_CAPACITY` are only supported for **FLEX** service level.
- Users can optionally provide `storagePoolType` (`FILE`, `UNIFIED`).
- `UNIFIED` is only supported for **FLEX** service level.
- ScaleType:
- `scaleType` is **only applicable to FLEX `UNIFIED` pools**. Do not send it for `FILE` pools or non-FLEX service levels (Standard/Premium/Extreme).
- **Only send `SCALE_TYPE_SCALEOUT`** when the user explicitly wants a large capacity FLEX `UNIFIED` pool. For all other FLEX `UNIFIED` pools, omit `scaleType` entirely — the API defaults to `SCALE_TYPE_DEFAULT`.
- Do not ask the user about `scaleType` unless they are creating a large capacity pool.
- Mode:
- `mode` is optional: `DEFAULT` (standard pool) or `ONTAP` (ONTAP expert mode pool).
- `ONTAP` mode requires `storagePoolType: UNIFIED` and `serviceLevel: FLEX`.
- Do not ask for `mode` unless the user explicitly requests ONTAP expert mode.
- When listing or getting pools, `mode` is returned in the response and indicates whether the pool is a standard or ONTAP expert mode pool.
- In simple terms:
- **FLEX** is the newer service level focused on flexibility (smaller minimum sizes and, in some regions, more independent performance scaling). It is also available in many more regions.
- **STANDARD / PREMIUM / EXTREME** are the classic tiers; Premium and Extreme are higher-performance tiers than Standard.
Expand Down
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,10 +113,12 @@ HTTP endpoint: `http://localhost:<port>/message`

**Service level guidance:**

- **FLEX** -- Smaller minimums, broader region availability, independent performance scaling. Minimum: 1024 GiB (FILE/UNIFIED) or 6144 GiB (UNIFIED_LARGE_CAPACITY).
- **FLEX** -- Smaller minimums, broader region availability, independent performance scaling. Minimum: 1024 GiB (FILE/UNIFIED) or 6144 GiB (UNIFIED large capacity).
- **STANDARD / PREMIUM / EXTREME** -- Classic tiers with fixed performance-to-capacity ratio. Minimum: 2048 GiB.
- `serviceLevel` is accepted case-insensitively (e.g. `flex` or `FLEX`).
- FLEX pools in a region-level location require both `zone` and `replicaZone`; zone-level locations satisfy this automatically.
- `storagePoolType` accepts `FILE` or `UNIFIED`; `UNIFIED` is only available for FLEX.
- `scaleType`: only set to `SCALE_TYPE_SCALEOUT` when creating a large capacity FLEX `UNIFIED` pool. Omit for all other pools (defaults to standard capacity).

### Volume Tools

Expand Down
8 changes: 4 additions & 4 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
"vitest": "^3.2.4"
},
"dependencies": {
"@google-cloud/netapp": "^0.16.0",
"@google-cloud/netapp": "^0.18.0",
"@google-cloud/local-auth": "3.0.1",
"@modelcontextprotocol/sdk": "^1.20.1",
"axios": "^1.6.3",
Expand Down
Loading
Loading