aoss-nextgen-provisioning
Use when provisioning or deprovisioning OpenSearch Serverless collections, creating collection groups, setting up AOSS NextGen, or tearing down AOSS resources
opensearch-project · 已有静态检查记录
安装与使用
运行命令前先阅读来源与依赖说明。复制命令不会自动安装或执行。
npx skills add opensearch-project/opensearch-agent-skills --skill aoss-nextgen-provisioning技能说明
name: aoss-nextgen-provisioning description: Use when provisioning or deprovisioning OpenSearch Serverless collections, creating collection groups, setting up AOSS NextGen, or tearing down AOSS resources
OpenSearch Serverless NextGen Provisioning & Deprovisioning
Overview
Guided wizard for provisioning and deprovisioning Amazon OpenSearch Serverless (AOSS) NextGen collections. Handles the full orchestration: security policies, collection groups, and collections — in the correct dependency order.
When to Use
- Customer wants to create an OpenSearch Serverless collection
- Customer wants to set up AOSS NextGen
- Customer wants to delete/deprovision AOSS resources
- Customer mentions "collection group", "opensearch serverless", "AOSS"
Critical Rules (MUST follow — violations are errors)
--generation NEXTGENis REQUIRED — Everycreate-collection-groupcommand MUST include--generation NEXTGEN. This flag is mandatory for NextGen collection groups. Never omit it. Example:aws opensearchserverless create-collection-group --name <name>-group --standby-replicas ENABLED --generation NEXTGEN --region <region>- Create encryption policy BEFORE the collection — Resources MUST be created in this exact order: encryption policy → network policy → collection group → collection. Never create a collection or collection group before its encryption and network policies exist. When the user asks to set up a collection, show ALL commands in the correct order.
- Valid OCU values only — OCU capacity values MUST be one of: 1, 2, 4, 8, 16, or any multiple of 16 (32, 48, 64, etc.). Values like 3, 5, 6, 7, 9, 10, 11, 12, 13, 14, 15, 17, 18, etc. are INVALID. If a user requests an invalid OCU value (e.g., "10 OCUs" or "12 OCUs"), you MUST immediately reject it — say "10 is not a valid OCU value. Valid values are: 1, 2, 4, 8, 16, 32, 48, 64..." and ask the user to choose a valid value. Do NOT proceed with invalid values.
- Only SEARCH and VECTORSEARCH types — The only valid collection types are
SEARCHandVECTORSEARCH. TIMESERIES is NOT a valid collection type for AOSS NextGen. If a user asks for TIMESERIES, inform them it is not supported and offer SEARCH or VECTORSEARCH. - Confirm before deleting — Before any deprovision/delete operation, ALWAYS list all resources that will be deleted and require explicit user confirmation (typing the group/collection name) before proceeding.
standbyReplicas: ENABLEDis mandatory — Never allow DISABLED for standby replicas in NextGen collection groups.
Key Constraints
"standbyReplicas": "ENABLED"is MANDATORY for all NextGen collection groups (never allow DISABLED)"generation": "NEXTGEN"is REQUIRED for NextGen collection groups.- AWS credentials must be pre-configured; check first and stop if missing
- Execute commands directly — do not generate scripts for the user to run
- Usage attribution (required): Prefix every AWS CLI command you run in a shell with
AWS_SDK_UA_APP_ID=opensearch-agent-skills(e.g.AWS_SDK_UA_APP_ID=opensearch-agent-skills aws opensearchserverless ...), regardless of service or subcommand. Scope it per-command — do notexportit globally. This tags the call's User-Agent header so cloud requests from this skill are attributable. - Collections must be in ACTIVE status before they can be deleted. NextGen collections typically take ~30 seconds; standalone collections can take 3-5 minutes.
- OCU capacity limits must be: 1, 2, 4, 8, 16, or any multiple of 16
Quick Reference
| Action | Flow | What it creates |
|---|---|---|
| New NextGen collection (defaults) | Simple | enc policy + net policy + group + collection |
| New NextGen collection (customized) | Advanced | enc policy + net policy + group (with limits) + collection |
| New standalone collection (v1) | Standalone | enc policy + net policy + collection |
| Add collection to existing group | Add to Group | collection (+ policies if needed) |
| Delete resources | Deprovision | Removes collections → group → policies |
Naming Convention (Auto-Generated)
| Resource | Name Pattern |
|---|---|
| Collection | <user-provided-name> |
| Collection group | <name>-group |
| Encryption policy | <name>-enc-policy |
| Network policy | <name>-net-policy |
| Data access policy | <name>-access-policy |
Companion Files
This skill is split across multiple files to stay under 500 lines. Read companion files on demand:
- If user selects Flow 2 (Advanced) or Flow 4 (Add to Existing Group): Read
ADVANCED.mdin this directory. - If user selects Flow 5 (Deprovision): Read
DEPROVISION.mdin this directory. - On any command failure: Read
ERRORS.mdin this directory for error handling guidance.
Entry Point
Step 1: Credential Check
Run:
aws sts get-caller-identity
If this fails, tell the user: "AWS credentials are missing or expired. Please configure credentials (e.g., aws configure or set environment variables) and try again." Then STOP.
Step 2: Mode Selection
Ask the user:
What would you like to do?
1. Provision (Simple) — New NextGen collection group + collection with defaults
2. Provision (Advanced) — Preset-based setup with full parameter control
3. Provision standalone collection — Collection without a collection group (classic)
4. Add collection to existing group — Create a collection in an existing collection group
5. Deprovision — Tear down collection(s) and/or collection group
Proceed to the corresponding flow section below (or read companion file as noted above).
Flow 1: Simple Provisioning
Inputs
Collect from the user (one at a time):
- Collection name — 3-32 chars, lowercase letters, numbers, hyphens. Must start with a letter. Pattern:
[a-z][a-z0-9-]+ - Collection type — SEARCH or VECTORSEARCH
- Region — AWS region (e.g., us-east-1, us-east-2, us-west-2)
Execution
R
阅读完整来源 ↗